forked from zigdon/twirssi
-
Notifications
You must be signed in to change notification settings - Fork 1
/
using.html
284 lines (280 loc) · 17.9 KB
/
using.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<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</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. If you want twirssi to automatically log in on startup, edit
the <code>twitter_usernames</code> setting.</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 you do it too often, twitter will block your access for a while</li>
</ul>
<h3>Posting Commands</h3>
<ul>
<li><code>/tweet <status></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 <account> <status></code> - Post a status
update as an alternate account</li>
<li><code>/dm <username> <message></code> - Send a direct message to username</li>
<li><code>/dm_as <account> <username> <message></code> -
Send a direct message to username from the specified account</li>
<li><code>/twitter_reply <username>:<num></code> - Reply to a
particular tweet (see twirssi_track_replies variable).</li>
<li><code>/twitter_reply_as <account> <username>:<num></code>
- Same as /twitter_reply but allowing specifying an account to reply from.</li>
<li><code>/reply <username>:<num></code> - Same as
/twitter_reply, but only if the twirssi_use_reply_aliases is set to true
(off by default).</li>
<li><code>/reply_as <account> <username>:<num></code> -
Same as /twitter_reply_as, but only if the twirssi_use_reply_aliases is
set to true (off by default).</li>
<li><code>/retweet <username>:<num> [comment]</code> - Retweet
someone else, with an optional comment.</li>
<li><code>/retweet_as <account> <username>:<num>
[comment]</code> - Retweet someone else, using an alternate account, with
an optional comment.</li>
<li><code>/retweet_to <username>:<num> [-<net_tag>] [-channel | -nick] <target> [comment]</code> -
Retweet, with an optional comment, to a twirssi channel/nick target (like </MSG>).</li>
<li><code>/twitter_broadcast <status></code> - Tweet to all
<code>twirssi_broadcast_users</code> accounts
or (if that setting is empty) all logged-in accounts.</li>
</ul>
<h3>Window/Channel Commands</h3>
<ul>
<li><code>/twirssi_set_window <type> <tag> <window></code> -
Send certain tweet updates to a given window.
<code>Type</code> can be one of
<code>tweet</code>, <code>reply</code>, <code>dm</code>, <code>search</code>,
<code>sender</code>, <code>error</code>, <code>default</code>.
<code>Tag</code> is an account name (that you are logged in as,
e.g. <code>username@service</code>), search term
or (for type <code>sender</code>) the sender's username.
<code>Window</code> is the name of the window to (create and) display the updates.
If <code>window</code> is <code>-</code> (hyphen), remove the setting.
</li>
<li><code>/twirssi_list_windows</code> - List all the existing windows
(see <code>/twirssi_set_window</code>).</li>
<li><code>/twirssi_set_channel <[-]type> <tag> <net_tag> <channel></code>)
Send <code>type</code> twitter results that correspond to <code>tag</code>
to the given <code>channel</code> on server <code>net_tag</code>.
<code>Type</code> can be one of: <code>tweet</code>, <code>reply</code>, <code>dm</code>,
<code>search</code>, <code>sender</code>, <code>error</code> or <code>*</code>.
A <code>type</code> of <code>*</code> indicates a wildcard,
and <code>tag</code> must then be qualified with Service: <code>user@Service</code>.
If <code>type</code> starts with <code>-</code> (hyphen) then remove that setting.
<code>Tag</code> is an account or a search term (or <code>*</code> for wildcarding).
</li>
<li><code>/twirssi_list_channels</code> - List all the existing channels
(see <code>/twirssi_set_channel</code>).</li>
</ul>
<h3>Other Commands</h3>
<ul>
<li><code>/twirssi_oauth <account> <PIN></code> - supply a PIN for OAUTH.</li>
<li><code>/twitter_follow [<code>-w</code>] <username></code> - Start following username
(with <code>-w</code>, send their tweets to a window of the same name).</li>
<li><code>/twitter_add_follow_extra <username></code> - Show all the
posts by username, even for people who you do not follow</li>
<li><code>/twitter_del_follow_extra <username></code> - Stop showing
all the posts by username</li>
<li><code>/twitter_info <username>:<num></code> - Show details about
a remembered tweet. See twirssi_track_replies variable.</li>
<li><code>/twitter_user [<code>-w</code>] <username></code> - Get the recent timeline
for the username (with <code>-w</code>, send their tweets to a window of the same name).
Also used to obtain tweets so as to retweet them directly.</li>
<li><code>/twitter_dms</code> - Get recent direct messages for the current user.</li>
<li><code>/twitter_dms_as <account></code> - Use <code>/twitter_dms</code>
for <account>.</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 <username> <password></code> - Log in to twitter</li>
<li><code>/twitter_logout [<username>]</code> - Log out the current account, or the named account</li>
<li><code>/twitter_switch <username></code> - Start using the named account as the default</li>
<li><code>/twitter_unfollow <username></code> - Stop following username.</li>
<li><code>/twitter_block <username></code> - Block username.</li>
<li><code>/twitter_unblock <username></code> - Unblock username.</li>
<li><code>/twitter_updates</code> - Poll for updates manually.</li>
<li><code>/twitter_spam <username></code> - Report spam.</li>
<li><code>/twitter_fav <username>:<num></code> - Favourite a tweet.</li>
<li><code>/twitter_unfav <username>:<num></code> - Undo a /twitter_fav.</li>
<li><code>/twitter_search <keyword></code> - Do a one-time search
using the current account.</li>
<li><code>/twitter_subscribe [<code>-w</code>] <keyword></code> - Add a search
subscription for the current account (with <code>-w</code> send the results
to a window of the same name).</li>
<li><code>/twitter_unsubscribe <keyword></code> - Remove an existing search
subscription from the current account.</li>
<li><code>/twitter_device_updates <none|im|sms></code> - Set delivery
device. Note that IM delivery is currently disabled by Twitter, and there
are no timeline when it might be restored.</li>
<li><code>/twirssi_version</code> - Report the current version number.</li>
<li><code>/twirssi_upgrade</code> - Check for a new version of twirssi, and
download it if it's there.</li>
<li><code>/twirssi_reload</code> - Reload the script (if the script has changed).</li>
<li><code>/twirssi_dump</code> - Report the current state of the data.</li>
<li><code>/twitter_delete <nick:id></code> - Remove a tweet from cache.</li>
<li><code>/twirssi_wipe [-f | -A]</code> - With no argument, removes tweet info for non-friends.
With the <code>-f</code> argument, removes all tweet info (i.e. also wipe friends).
(<strong>Caution!</strong> With the <code>-A</code> argument, will remove
<strong>all</strong> tweet/channel/window info and settings.)</li>
<li><code>/twitter_listinfo [ <nick> [ <list_name> ] ]</code> -
Show the named list (or all lists) for the given nick (or current user).</li>
</ul>
<h3>Settings Info</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>
<h3>Look-and-feel Settings</h3>
<ul>
<li><code>show_own_tweets</code> - Should our own tweets be displayed? Defaults to on.</li>
<li><code>tweet_to_away</code> - Set to on to post non-@reply updates as your away message</li>
<li><code>tweet_window_input</code> - Enable tweeting directly by writing to
the twitter window. Off by default</li>
<li><code>twirssi_retweet_format</code> - The format to use when retweeting.
Default value is "RT $n: "$t" ${-- $c$}". $n is the nick that's being
retweeted; $t is the text of the original tweet; $c is the text of the
optional comment attached; ${ and $} mark the seciton that should be
omitted if no comment was provided.
<li><code>twirssi_hilights</code> - Should messages containing your @nick be
considered IRC hilights. (default on)</li>
<li><code>twirssi_nick_color</code> - If set, @nicks will be shown in the
color set. (default: %B). Note that the theme variables (twirssi_tweet,
twirssi_search, twirssi_reply, twirssi_dm) should be updated as
well.</li>
<li><code>twirssi_hilight_color</code> - Color that hilights should be for
the twirssi window. (default %M)</li>
<li><code>twirssi_unshorten_color</code> - Color that unshortened URL links
will display as, when enabled. (default %b)</li>
<li><code>twirssi_replies_autonick</code> - On by default. If on, /reply
will make sure the reply begins with @nick. If off, you can reply to
someone, but not have their name on the reply</li>
<li><code>twirssi_topic_color</code> - If set, #topics will be shown in the
color set. (default: %r)</li>
<li><code>twirssi_timestamp_format</code> - This string defines the format
of timestamps (see strftime, default is "%H:%M:%S").</li>
<li><code>twirssi_ignored_accounts</code> - A comma-separated list of own
accounts to ignore.</li>
<li><code>twirssi_ignored_tags</code> - A comma-separated list of words
that will make tweets containing them to be ignored.</li>
<li><code>twirssi_stripped_tags</code> - A comma-separated list of words
that are removed from tweets.</li>
<li><code>twirssi_ignored_twits</code> - A comma-separated list of other's
accounts to ignore (e.g. in subscriptions).</li>
<li><code>twirssi_use_reply_aliases</code> - Enable /reply and /reply_as as
aliases to /twitter_reply and /twitter_reply_as. Requires a reload of
twirssi to take effect. (default off)</li>
<li><code>twirssi_always_shorten</code> - When false (the default), URLs will
only be shortened if the tweet would be too long. When true, URLs will
always be shortened</li>
<li><code>twirssi_charset</code> - Default: utf8.</li>
<li><code>twirssi_mini_whale</code> - Default: Off. When On, show just one line
(instead of the really big fail-whale) after a substantial outage period.</li>
<li><code>twirssi_ymd_color</code> - Default: %r. The color to use when showing
dates in timestamps.</li>
<li><code>twitter_search_results</code> - Default: 5. How many results to
show for the initial search.</li>
<li><code>twitter_autosearch_results</code> - How many results should be displayed
for autosearches. An autosearch is an automatic search for every hashtag that
you have written in a /tweet. Think of it as "tell me what others have
recently written on my topics". Default is 0 which deactivates the
autosearch feature.</li>
<li><code>retweet_show</code> - Default: Off. When set to On, you will see
your own (non-classic) retweets in your timeline.</li>
<li><code>retweet_classic</code> - Default: Off. When set to On, a retweet
is a full tweet including the text of the original.</li>
<li><code>twitter_user_results</code> - Default: 20. Limit tweets shown
by <code>/twitter_user</code> or <code>/twitter_follow</code>.
Can be a number (of tweets, e.g. <code>20</code>; or of days, e.g. <code>21d</code>),
or both (e.g. <code>20 21d</code>, most restrictive wins).</li>
</ul>
<h3>Network and File Settings</h3>
<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/search?query=www%3A%3Ashorten&mode=module"
>WWW::Shorten</a></li>
<li><code>short_url_domains</code> - List of domains for expanding URLs,
space-separated (e.g. <code>"t.co bit.ly"</code>).</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
needed, comma-separated.</li>
<li><code>twitter_poll_interval</code> - How often should new messages be
requested from twitter (in seconds). Default is every 5 minutes. Keep
in mind that twitter will rate limit your user (or IP) if you hit them
too often. Hardcoded minimum is one minute.</li>
<li><code>twitter_poll_schedule</code> - Vary the polling interval with time,
using a comma-separated list of tuples of the format <code>hhmm-hhmm:interval</code>
(e.g. <code>2330-0745:900,0200-0600:2500</code>). Each tuple gives the interval
for a time period. Later tuples take precedence. If no period applies,
reverts to <code>twitter_poll_interval</code>.</li>
<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_blocks_poll</code> - How often should the updated blocks
list be retrieved from the server. By default, only once every 15
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>twirssi_notify_timeouts</code> - If set, twirssi will emit a
message when twitter is being so slow that it fails to retrieve
updates. (default on)</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>twirssi_oauth_store</code> - Path where OAUTH credentials are stored.</li>
<li><code>twirssi_replies_store</code> - Location where the /reply map is to be stored.</li>
<li><code>twirssi_poll_store</code> - Location where last checkpoints are stored.
This is only useful if <code>twirssi_force_first</code> is set.</li>
<li><code>twirssi_id_store</code> - File path for the tweet cache.</li>
<li><code>twirssi_logging</code> - If On, twirssi windows are logged to files
determined by the <code>autolog_path</code> (system/log) setting -
wherein "$tag" is "twirssi". (default is Off)</li>
<li><code>twirssi_track_replies</code> - The number of tweets per user to
remember - individual IDs. If non-zero (the default is 100), incoming
tweets will show a <code>:num</code> appended to them. This is required
for /reply and /twitter_reply functionality.</li>
<li><code>twirssi_force_first</code> - Default: off. If On, show tweets timed
before load/reload of script. See also <code>twirssi_reload</code>.</li>
</ul>
<h3>Account Settings</h3>
<ul>
<li><code>twirssi_default_service</code> - Default: Twitter. Can be Identica.</li>
<li><code>twitter_passwords</code> - A comma-separated list of passwords to auto-login.
DEPRECATED.</li>
<li><code>twitter_update_usernames</code> - A comma-separated list of usernames to
give priority when updating (first is most important).</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>twirssi_broadcast_users</code> - see <code>/twitter_broadcast</code> command.</li>
<li><code>twirssi_use_oauth</code> - Default: On. Login using OAUTH.</li>
</ul>
<h3>Window Settings</h3>
<ul>
<li><code>twitter_window</code> - Default: twitter. The name of the irssi window
which will display twitter updates (but see also <code>/twitter_set_window</code>.</li>
<li><code>twirssi_window_priority</code> - Default: account. The preference
for choosing which window will display twitter updates.
A setting of <code>account</code> means 'prefer follower';
<code>sender</code> means 'prefer tweeter'.</li>
</ul>
<h3>Upgrading/Developing Twirssi Settings</h3>
<ul>
<li><code>twirssi_location</code> - Location of the twirssi.pl script, used
by <code>/twirssi_upgrade</code></li>
<li><code>twirssi_upgrade_beta</code> - Default On. If On, /twirssi_upgrade
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_upgrade_branch</code> - Default "master". The name of the
branch - at Github - from which you want to (beta) update twirssi.</li>
<li><code>twirssi_upgrade_dev</code> - Default "gedge". Get (beta) updates
to twirssi from this account at <a href="http://github.com/">github.com</a>.</li>
<li><code>twirssi_debug</code> - Default "off". Shows debugging.</li>
<li><code>twirssi_debug_win_name</code> - Default "".
Window name to receive debugging.</li>
</ul>