Merge branch 'master' of git://github.com/zigdon/twirssi

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

diff --git a/html/using.html b/html/using.html
index c2a2928c7e465b2ea9dea8db9e01f9dd200983ef..485d50e47c24c904b3c401d2d30287bebb3121b5 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>
-  <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
@@ -10,7 +13,9 @@
 
 <h3>Posting Commands</h3>
 <ul>
-  <li><code>/tweet &lt;status&gt;</code> - Post a status update</li>
+  <li><code>/tweet &lt;status&gt;</code> - Post a status update.  Note, if
+      http://twitter.com is too slow, twirssi will give up after the preset
+      timeout.  See the setting for twitter_timeout. </li>
   <li><code>/tweet_as &lt;account&gt; &lt;status&gt;</code> - Post a status
       update as an alternate account</li>
   <li><code>/dm &lt;username&gt; &lt;message&gt;</code> - Send a direct message to username</li>
@@ -36,6 +41,12 @@
 <h3>Other Commands</h3>
 <ul>
   <li><code>/twitter_follow &lt;username&gt;</code> - Start following username</li>
+  <li><code>/twitter_add_follow_extra &lt;username&gt;</code> - Show all the
+      posts by username, even for people who you do not follow</li>
+  <li><code>/twitter_del_follow_extra &lt;username&gt;</code> - Stop showing
+      all the posts by username</li>
+  <li><code>/twitter_list_follow_extra</code> - Show the list of all the
+      usernames in the extra follow loop</li>
   <li><code>/twitter_list_subscriptions</code> - List all the existing search
       subscriptions for all accounts.</li>
   <li><code>/twitter_login &lt;username&gt; &lt;password&gt;</code> - Log in to twitter</li>
@@ -43,6 +54,8 @@
   <li><code>/twitter_switch &lt;username&gt;</code> - Start using the named account as the default</li>
 
   <li><code>/twitter_unfollow &lt;username&gt;</code> - Stop following username</li>
+  <li><code>/twitter_block &lt;username&gt;</code> - Block username</li>
+  <li><code>/twitter_unblock &lt;username&gt;</code> - Unblock username</li>
   <li><code>/twitter_updates</code> - Poll for updates manually</li>
   <li><code>/twitter_subscribe &lt;keyword&gt;</code> - Add a search
       subscription for the current account.</li>
@@ -58,10 +71,13 @@
 </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
-  <a href="http://search.cpan.org/~davecross/WWW-Shorten-2.01/lib/WWW/Shorten.pm#SYNOPSIS"
+  <a href="http://search.cpan.org/search?query=www%3A%3Ashorten&mode=module"
       >WWW::Shorten</a></li>
   <li><code>short_url_args</code> - Some of the WWW::Shorten modules require
       additional arguments, such as a username or API key.  Enter those here if
@@ -110,6 +126,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> 
+  <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
@@ -119,6 +138,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_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>