libtransport.git Changeset - 5d76ba0214bb

Changeset - 5d76ba0214bb

Parent rev.

Child rev.

[Not reviewed]

0 6 0

HanzZ - 13 years ago 2012-09-11 14:10:08
hanzz.k@gmail.com

Docs update

5 files changed with 13 insertions and 26 deletions:

docs/guide/backends.textile

docs/guide/index.textile

docs/guide/template.html

docs/guide/tutorial_gateway_mode.textile

docs/guide/twitter.textile

0 comments (0 inline, 0 general)

docs/guide/backends.textile

➞

Show inline comments

 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.
 h2. How to change backend
 Backends are switched in Spectrum 2 config file using the following option:
 |_. Section|_. Option|_. Value|
 |service|backend|Full path to the backend binary|
 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@|

docs/guide/index.textile

➞

Show inline comments

@@ @@ -14,25 +14,25 @@ h2. Configuration @@
 * "Configuration file description":config_file.html
 * "MySQL Support":mysql.html
 * "PostgreSQL Support":postgresql.html
 * "Using SSL in server mode":server_ssl.html
 * "Logging":logging.html
 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
 h2. Management
 * "spectrum2_manager tool":spectrum2_manager.html
 * "Munin integration":munin.html
 h2. Development
 * "Spectrum 2 architecture":developer_arch.html
 * "Low level backend creation":developer_lowlevel.html

docs/guide/template.html

➞

Show inline comments

@@ @@ -94,25 +94,25 @@ a:active{ color: #742CAC; } @@
 a.headerlink{ visibility: hidden; }
 	:hover > a.headerlink { visibility: visible; }
 a img{
 	border: 0;
 	outline: 0;
+}
 img{ display: block; max-width: 100%; }
 code {
+body.code {
 	border: 1px solid #FB7A31;
 	background: #FFC;
+}
 pre {
  white-space: pre-wrap;
  white-space: -moz-pre-wrap;
  white-space: -o-pre-wrap;
 border: 1px solid #FB7A31;
 background: #FFC;
 padding:5px;
 padding-left: 15px;

docs/guide/tutorial_gateway_mode.textile

➞

Show inline comments

 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
 XMPP server configuration is addressed on "Configure XMPP server page":configure_xmpp_server.html.
 h2. Configure Spectrum 2
 Default config file is located at @/etc/spectrum2/transports/spectrum.cfg.example@. To successfully connect Spectrum 2 to your server, change the following options in the following categories and remove the .example suffix (you can name the file as you want, but it has to have .cfg suffix):
 |_. Category|_. Option|_. Change to value|_. Meaning|
 |service|server_mode|0| Spectrum 2 will act as gateway.|

docs/guide/twitter.textile

➞

Show inline comments

 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
 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|

0 comments (0 inline, 0 general)