Add login docs for identica, twitter_timeout setting.

[twirssi-net-twitter-lite.git] / html / using.html

diff --git a/html/using.html b/html/using.html
index c2a2928c7e465b2ea9dea8db9e01f9dd200983ef..e8e7aedee79ff092d9fcb90f4dbfb2e617b66331 100644 (file)
--- a/html/using.html
+++ b/html/using.html
@@ -1,7 +1,10 @@
 <h3>Getting Started</h3>
 <ul>
   <li>Load the script in irssi: <code>/script load twirssi.pl</code></li>
 <h3>Getting Started</h3>
 <ul>
   <li>Load the script in irssi: <code>/script load twirssi.pl</code></li>

-  <li>Log in to twitter: <code>/twitter_login username password</code></li>
+  <li>Log in to twitter: <code>/twitter_login username password</code>.  To use
+      an account on <a href="http://identi.ca/">identi.ca</a>, just append
+      @identica to the user name, and make sure <code>Net::Identica</code> is
+      installed.</li>

   <li>Post updates: <code>/tweet I got twirssi working!</code></li>
   <li>Every 5 minutes, new updates from twitter will be posted to the named
   window.  To manually poll, you can always type <code>/twitter_updates</code>, though if
   <li>Post updates: <code>/tweet I got twirssi working!</code></li>
   <li>Every 5 minutes, new updates from twitter will be posted to the named
   window.  To manually poll, you can always type <code>/twitter_updates</code>, though if


@@ -58,6 +61,9 @@
 </ul>
 
 <h3>Settings</h3>
 </ul>
 
 <h3>Settings</h3>

+<p>These are set by the /set command - <code>/set bitlbee_server</code> will show the
+current value, <code>/set bitlbee_server bitlbee_tag</code> will set it to
+<code>bitlbee_tag</code>.</p>

 <ul>
   <li><code>bitlbee_server</code> - What is the server tag for bitlbee (used for away messages)</li>
   <li><code>short_url_provider</code> - What service to use to shorten urls - pick from
 <ul>
   <li><code>bitlbee_server</code> - What is the server tag for bitlbee (used for away messages)</li>
   <li><code>short_url_provider</code> - What service to use to shorten urls - pick from


@@ -110,6 +116,9 @@
       will try to grab the most recent version from github, instead of the latest
       released version.  Note that beta versions might have more bugs than the
       released version.</li> 
       will try to grab the most recent version from github, instead of the latest
       released version.  Note that beta versions might have more bugs than the
       released version.</li> 

+  <li><code>twirssi_avoid_ssl</code> - Default off.  If off, twirssi will
+      attempt to use SSL for all network communications.  Changes take effect
+      next time twirssi is loaded.</li>

 
   <li><code>twitter_passwords</code> - A comma separated list of passwords to auto-login</li>
   <li><code>twitter_poll_interval</code> - How often should new messages be
 
   <li><code>twitter_passwords</code> - A comma separated list of passwords to auto-login</li>
   <li><code>twitter_poll_interval</code> - How often should new messages be


@@ -119,6 +128,9 @@
   <li><code>twitter_friends_poll</code> - How often should the updated friends
       list be retrieved from the server.  By default, only once every 10
       minutes</li>
   <li><code>twitter_friends_poll</code> - How often should the updated friends
       list be retrieved from the server.  By default, only once every 10
       minutes</li>

+  <li><code>twitter_timeout</code> - How long should we wait before giving up
+      on a twitter operation.  Should help avoid irssi pinging out of IRC
+      servers when twitter is slow.</li>

   <li><code>twitter_usernames</code> - A comma separated list of usernames to auto-login.  Note that the last one will be the default account used after startup.</li>
   <li><code>twitter_window</code> - Which irssi window should twitter updates be sent to</li>
 </ul>
   <li><code>twitter_usernames</code> - A comma separated list of usernames to auto-login.  Note that the last one will be the default account used after startup.</li>
   <li><code>twitter_window</code> - Which irssi window should twitter updates be sent to</li>
 </ul>