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