stv0g/spectrum2
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Docs update

Browse source
This commit is contained in:
HanzZ 2012-09-11 14:10:08 +02:00
parent dd8aa60ca8
commit 5d76ba0214
6 changed files with 15 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/guide/backends.textile
View file

@ -1,5 +1,4 @@
Spectrum 2 introduces backends. Backends are external application which provides a way how to connect to legacy networks, so it's possible to use
even different libraries than Libpurple to connect the legacy network. However, Libpurple is still the best library to use so far.
Spectrum 2 introduces backends. Backends are external application which provides a way how to connect to legacy networks, so it's possible to use even different libraries than Libpurple to connect the legacy network. However, Libpurple is still the best library to use so far.
This page contains the list of currently supported backends with the basic information about them.
@ -13,10 +12,10 @@ Backends are switched in Spectrum 2 config file using the following option:
h2. List of backends
|_. Name|_. Supported networks|_. Default path to backend|
|Libpurple backend|AIM, Jabber, Facebook, GTalk, ICQ, MSN, Yahoo|/usr/bin/spectrum2_libpurple_backend|
|Swiften backend|Jabber, Facebook, GTalk|/usr/bin/spectrum2_swiften_backend|
|SLibCommuni backend|IRC|/usr/bin/spectrum2_libcommuni_backend|
|Frotz backend|Allows playing interactive-fiction games|/usr/bin/spectrum2_frotz_backend|
|Skype backend|Skype using the official client|/usr/bin/spectrum2_skype_backend|
|SMSTools3 backend|SMS using connected mobile phone|/usr/bin/spectrum2_smstools3_backend|
|Twitter backend|Twitter|/usr/bin/spectrum2_twitter_backend|
|Libpurple backend|AIM, Jabber, Facebook, GTalk, ICQ, MSN, Yahoo|@/usr/bin/spectrum2_libpurple_backend@|
|Swiften backend|Jabber, Facebook, GTalk|@/usr/bin/spectrum2_swiften_backend@|
|SLibCommuni backend|IRC|@/usr/bin/spectrum2_libcommuni_backend@|
|Frotz backend|Allows playing interactive-fiction games|@/usr/bin/spectrum2_frotz_backend@|
|Skype backend|Skype using the official client|@/usr/bin/spectrum2_skype_backend@|
|SMSTools3 backend|SMS using connected mobile phone|@/usr/bin/spectrum2_smstools3_backend@|
|Twitter backend|Twitter|@/usr/bin/spectrum2_twitter_backend@|

2
docs/guide/index.textile
View file

@ -23,7 +23,7 @@ h2. Backends
* "Backends overview":backends.html
* "Libpurple backend":libpurple.html
* "Swiften backend":swiften.html
* "Libcommuni backend":swiften.html
* "Libcommuni backend":libcommuni.html
* "Skype backend":skype.html
* "Twitter backend":twitter.html

4
docs/guide/libpurple.textile
View file

@ -7,8 +7,8 @@ h2. Configuration
You have to choose this backend in Spectrum 2 configuration file to use it:
<pre>
[service]
backend=/usr/bin/spectrum2_libpurple_backend
[service]
backend=/usr/bin/spectrum2_libpurple_backend
</pre>
There is also special configuration variable in "service" called @protocol@ which decides which Libpurple's protocol will be used:

2
docs/guide/template.html
View file

@ -103,7 +103,7 @@ a img{
img{ display: block; max-width: 100%; }
code {
body.code {
border: 1px solid #FB7A31;
background: #FFC;
}

2
docs/guide/tutorial_gateway_mode.textile
View file

@ -1,6 +1,6 @@
h2. Before you start
* Check that you really want to run Spectrum 2 in gateway mode and not in server mode. The difference is documentation on "What is Spectrum 2?":about.html page.
* Check that you really want to run Spectrum 2 in gateway mode and not in server mode. The difference is documentation on "What is Spectrum 2":about.html page.
* Install Spectrum 2. Installation is covered in "Installation section on the main page":index.html.
h2. Configure your XMPP server

16
docs/guide/twitter.textile
View file

@ -1,6 +1,6 @@
h2. Description
Libpurple backend is backend based on Librpurple library supporting all the networks supported by libpurple
Twitter backend is backend created during Summer of Code. It allows users to connect Twitter network.
h2. Configuration
@ -8,17 +8,5 @@ You have to choose this backend in Spectrum 2 configuration file to use it:
<pre>
[service]
backend=/usr/bin/spectrum2_libpurple_backend
backend=/usr/bin/spectrum2_twitter_backend
</pre>
There is also special configuration variable in "service" called @protocol@ which decides which Libpurple's protocol will be used:
|_. Protocol variable|_. Description|
|prpl-jabber| Jabber/Facebook/GTalk|
|prpl-aim|AIM|
|prpl-icq|ICQ|
|prpl-msn|MSN|
|prpl-yahoo|Yahoo|
|prpl-gg|Gadu Gadu|
|prpl-novell|Groupwise|