html/using.html

   1 <h3>Getting Started</h3>
   2 <ul>
   3   <li>Load the script in irssi: <code>/script load twirssi.pl</code></li>
   4   <li>Log in to twitter: <code>/twitter_login username password</code>.  To use
   5       an account on <a href="http://identi.ca/">identi.ca</a>, just append
   6       @identica to the user name, and make sure <code>Net::Identica</code> is
   7       installed.</li>
   8   <li>Post updates: <code>/tweet I got twirssi working!</code></li>
   9   <li>Every 5 minutes, new updates from twitter will be posted to the named
  10   window.  To manually poll, you can always type <code>/twitter_updates</code>, though if
  11   you do it too often, twitter will block your access for a while</li>
  12 </ul>
  13
  14 <h3>Posting Commands</h3>
  15 <ul>
  16   <li><code>/tweet &lt;status&gt;</code> - Post a status update.  Note, if
  17       http://twitter.com is too slow, twirssi will give up after the preset
  18       timeout.  See the setting for twitter_timeout. </li>
  19   <li><code>/tweet_as &lt;account&gt; &lt;status&gt;</code> - Post a status
  20       update as an alternate account</li>
  21   <li><code>/dm &lt;username&gt; &lt;message&gt;</code> - Send a direct message to username</li>
  22   <li><code>/dm_as &lt;account&gt; &lt;username&gt; &lt;message&gt;</code> -
  23       Send a direct message to username from the specified account</li>
  24   <li><code>/twitter_reply &lt;username&gt;:&lt;num&gt;</code> - Reply to a
  25       particular tweet.  Only 100 are remembered for each user, and this can be
  26       completely disabled by changing the twirssi_track_replies variable.</li>
  27   <li><code>/twitter_reply_as &lt;account&gt; &lt;username&gt;:&lt;num&gt;</code>
  28       - Same as /twitter_reply but allowing specifying an account to reply from.</li>
  29   <li><code>/reply &lt;username&gt;:&lt;num&gt;</code> - Same as
  30       /twitter_reply, but only if the twirssi_use_reply_aliases is set to true
  31       (off by default).</li>
  32   <li><code>/reply_as &lt;account&gt; &lt;username&gt;:&lt;num&gt;</code> -
  33       Same as /twitter_reply_as, but only if the twirssi_use_reply_aliases is
  34       set to true (off by default).</li>
  35   <li><code>/retweet &lt;username&gt;:&lt;num&gt; [comment]</code> - Retweet
  36       someone else, with an optional comment.</li>
  37   <li><code>/retweet_as &lt;account&gt; &lt;username&gt;:&lt;num&gt;
  38       [comment]</code> - Retweet someone else, using an alternate account, with
  39       an optional comment.</li>
  40 </ul>
  41 <h3>Other Commands</h3>
  42 <ul>
  43   <li><code>/twitter_follow &lt;username&gt;</code> - Start following username</li>
  44   <li><code>/twitter_add_follow_extra &lt;username&gt;</code> - Show all the
  45       posts by username, even for people who you do not follow</li>
  46   <li><code>/twitter_del_follow_extra &lt;username&gt;</code> - Stop showing
  47       all the posts by username</li>
  48   <li><code>/twitter_list_follow_extra</code> - Show the list of all the
  49       usernames in the extra follow loop</li>
  50   <li><code>/twitter_list_subscriptions</code> - List all the existing search
  51       subscriptions for all accounts.</li>
  52   <li><code>/twitter_login &lt;username&gt; &lt;password&gt;</code> - Log in to twitter</li>
  53   <li><code>/twitter_logout [&lt;username&gt;]</code> - Log out the current account, or the named account</li>
  54   <li><code>/twitter_switch &lt;username&gt;</code> - Start using the named account as the default</li>
  55
  56   <li><code>/twitter_unfollow &lt;username&gt;</code> - Stop following username</li>
  57   <li><code>/twitter_block &lt;username&gt;</code> - Block username</li>
  58   <li><code>/twitter_unblock &lt;username&gt;</code> - Unblock username</li>
  59   <li><code>/twitter_updates</code> - Poll for updates manually</li>
  60   <li><code>/twitter_subscribe &lt;keyword&gt;</code> - Add a search
  61       subscription for the current account.</li>
  62   <li><code>/twitter_unsubscribe &lt;keyword&gt;</code> - Remove an existing search
  63       subscription from the current account.</li>
  64   <li><code>/twitter_device_updates &lt;none|im|sms&gt;</code> - Set delivery
  65       device.  Note that IM delivery is currently disabled by Twitter, and there
  66       are no timeline when it might be restored.</li>
  67   <li><code>/twirssi_version</code> - Report the current version number</li>
  68
  69   <li><code>/twirssi_upgrade</code> - Check for a new version of twirssi, and
  70       download it if it's there</li>
  71 </ul>
  72
  73 <h3>Settings</h3>
  74 <p>These are set by the /set command - <code>/set bitlbee_server</code> will show the
  75 current value, <code>/set bitlbee_server bitlbee_tag</code> will set it to
  76 <code>bitlbee_tag</code>.</p>
  77 <ul>
  78   <li><code>bitlbee_server</code> - What is the server tag for bitlbee (used for away messages)</li>
  79   <li><code>short_url_provider</code> - What service to use to shorten urls - pick from
  80   <a href="http://search.cpan.org/search?query=www%3A%3Ashorten&mode=module"
  81       >WWW::Shorten</a></li>
  82   <li><code>short_url_args</code> - Some of the WWW::Shorten modules require
  83       additional arguments, such as a username or API key.  Enter those here if
  84       needed, comma separated.</li>
  85   <li><code>twirssi_always_shorten</code> - When false (the default), URLs will
  86       only be shortened if the tweet would be too long.  When true, URLs will
  87       always be shortened</li>
  88   <li><code>show_own_tweets</code> - Should our own tweets be displayed?  Defaults to on.</li>
  89   <li><code>show_reply_context</code> - When set to on, and someone you follow is replying
  90       to someone you are not, the tweet that generated the reply will be pulled and
  91       shown.  Defaults to off.</li>
  92   <li><code>tweet_to_away</code> - Set to on to post non-@reply updates as your away message</li>
  93   <li><code>tweet_window_input</code> - Enable tweeting directly by writing to
  94       the twitter window.  Off by default</li>
  95   <li><code>twirssi_retweet_format</code> - The format to use when retweeting.
  96       Default value is "RT $n: "$t" ${-- $c$}".  $n is the nick that's being
  97       retweeted; $t is the text of the original tweet;  $c is the text of the
  98       optional comment attached;  ${ and $} mark the seciton that should be
  99       omitted if no comment was provided.
 100
 101   <li><code>twirssi_hilights</code> - Should messages containing your @nick be
 102       considered IRC hilights.  (default on)</li>
 103   <li><code>twirssi_location</code> - Location of the twirssi.pl script, used
 104       by <code>/twirssi_upgrade</code></li>
 105   <li><code>twirssi_nick_color</code> - If set, @nicks will be shown in the
 106       color set. (default: %B).  Note that the theme variables (twirssi_tweet,
 107       twirssi_search, twirssi_reply, twirssi_dm) should be updated as
 108       well.</li>
 109   <li><code>twirssi_notify_timeouts</code> - If set, twirssi will emite a
 110       message when twitter is being so slow that it fails to retrieve
 111       updates.  (default on)</li>
 112   <li><code>twirssi_replies_autonick</code> - On by default.  If on, /reply
 113       will make sure the reply begins with @nick.  If off, you can reply to
 114       someone, but not have their name on the reply</li>
 115   <li><code>twirssi_replies_store</code> - Location where the /reply map is to be stored.</li>
 116   <li><code>twirssi_topic_color</code> - If set, #topics will be shown in the
 117       color set. (default: %r)</li>
 118   <li><code>twirssi_track_replies</code> - Should twirssi keep track of
 119       individual IDs of incoming twitters?  If enabled (which is the default)
 120       incoming tweets will show a :num appended to them.  This is requried for
 121       /reply and /twitter_reply functionallity.</li>
 122   <li><code>twirssi_use_reply_aliases</code> - Enable /reply and /reply_as as
 123       aliases to /twitter_reply and /twitter_reply_as.  Requires a reload of
 124       twirssi to take effect.  (default off)</li>
 125   <li><code>twirssi_upgrade_beta</code> - Default off.  If on, /twirssi_upgrade
 126       will try to grab the most recent version from github, instead of the latest
 127       released version.  Note that beta versions might have more bugs than the
 128       released version.</li>
 129   <li><code>twirssi_avoid_ssl</code> - Default off.  If off, twirssi will
 130       attempt to use SSL for all network communications.  Changes take effect
 131       next time twirssi is loaded.</li>
 132
 133   <li><code>twitter_passwords</code> - A comma separated list of passwords to auto-login</li>
 134   <li><code>twitter_poll_interval</code> - How often should new messages be
 135       requested from twitter (in seconds).  Default is every 5 minutes.  Keep
 136       in mind that twitter will rate limit your user (or IP) if you hit them
 137       too often.  Hardcoded minimum is one minute.</li>
 138   <li><code>twitter_friends_poll</code> - How often should the updated friends
 139       list be retrieved from the server.  By default, only once every 10
 140       minutes</li>
 141   <li><code>twitter_timeout</code> - How long should we wait before giving up
 142       on a twitter operation.  Should help avoid irssi pinging out of IRC
 143       servers when twitter is slow.</li>
 144   <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>
 145   <li><code>twitter_window</code> - Which irssi window should twitter updates be sent to</li>
 146 </ul>
 147