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