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