Getting Started
- Load the script in irssi:
/script load twirssi.pl - Log in to twitter:
/twitter_login username. To use an account on identi.ca, just append @identica to the user name, and make sureNet::Identicais installed. If you want twirssi to automatically log in on startup, edit thetwitter_usernamessetting. - Post updates:
/tweet I got #twirssi working! - Every 5 minutes, new updates from twitter will be posted to the named
window. To manually poll, you can always type
/twitter_updates, though if you do it too often, twitter will block your access for a while
Posting Commands
/tweet <status>- 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./tweet_as <account> <status>- Post a status update as an alternate account/dm <username> <message>- Send a direct message to username/dm_as <account> <username> <message>- Send a direct message to username from the specified account/twitter_reply <username>:<num>- Reply to a particular tweet (see twirssi_track_replies variable)./twitter_reply_as <account> <username>:<num>- Same as /twitter_reply but allowing specifying an account to reply from./reply <username>:<num>- Same as /twitter_reply, but only if the twirssi_use_reply_aliases is set to true (off by default)./reply_as <account> <username>:<num>- Same as /twitter_reply_as, but only if the twirssi_use_reply_aliases is set to true (off by default)./retweet <username>:<num> [comment]- Retweet someone else, with an optional comment./retweet_as <account> <username>:<num> [comment]- Retweet someone else, using an alternate account, with an optional comment./retweet_to <username>:<num> [-<net_tag>] [-channel | -nick] <target> [comment]- Retweet, with an optional comment, to a twirssi channel/nick target (like </MSG>)./twitter_broadcast <status>- Tweet to alltwirssi_broadcast_usersaccounts or (if that setting is empty) all logged-in accounts.
Window/Channel Commands
/twirssi_set_window <type> <tag> <window>- Send certain tweet updates to a given window.Typecan be one oftweet,reply,dm,search,sender,error,default.Tagis an account name (that you are logged in as, e.g.username@service), search term or (for typesender) the sender's username.Windowis the name of the window to (create and) display the updates. Ifwindowis-(hyphen), remove the setting./twirssi_list_windows- List all the existing windows (see/twirssi_set_window)./twirssi_set_channel <[-]type> <tag> <net_tag> <channel>) Sendtypetwitter results that correspond totagto the givenchannelon servernet_tag.Typecan be one of:tweet,reply,dm,search,sender,erroror*. Atypeof*indicates a wildcard, andtagmust then be qualified with Service:user@Service. Iftypestarts with-(hyphen) then remove that setting.Tagis an account or a search term (or*for wildcarding)./twirssi_list_channels- List all the existing channels (see/twirssi_set_channel).
Other Commands
/twirssi_oauth <account> <PIN>- supply a PIN for OAUTH./twitter_follow [- Start following username (with-w] <username>-w, send their tweets to a window of the same name)./twitter_add_follow_extra <username>- Show all the posts by username, even for people who you do not follow/twitter_del_follow_extra <username>- Stop showing all the posts by username/twitter_info <username>:<num>- Show details about a remembered tweet. See twirssi_track_replies variable./twitter_user [- Get the recent timeline for the username (with-w] <username>-w, send their tweets to a window of the same name). Also used to obtain tweets so as to retweet them directly./twitter_dms- Get recent direct messages for the current user./twitter_dms_as <account>- Use/twitter_dmsfor <account>./twitter_list_follow_extra- Show the list of all the usernames in the extra follow loop/twitter_list_subscriptions- List all the existing search subscriptions for all accounts./twitter_login <username> <password>- Log in to twitter/twitter_logout [<username>]- Log out the current account, or the named account/twitter_switch <username>- Start using the named account as the default/twitter_unfollow <username>- Stop following username./twitter_block <username>- Block username./twitter_unblock <username>- Unblock username./twitter_updates- Poll for updates manually./twitter_spam <username>- Report spam./twitter_fav <username>:<num>- Favourite a tweet./twitter_unfav <username>:<num>- Undo a /twitter_fav./twitter_search <keyword>- Do a one-time search using the current account./twitter_subscribe [- Add a search subscription for the current account (with-w] <keyword>-wsend the results to a window of the same name)./twitter_unsubscribe <keyword>- Remove an existing search subscription from the current account./twitter_device_updates <none|im|sms>- Set delivery device. Note that IM delivery is currently disabled by Twitter, and there are no timeline when it might be restored./twirssi_version- Report the current version number./twirssi_upgrade- Check for a new version of twirssi, and download it if it's there./twirssi_reload- Reload the script (if the script has changed)./twirssi_dump- Report the current state of the data./twitter_delete <nick:id>- Remove a tweet from cache./twirssi_wipe [-f | -A]- With no argument, removes tweet info for non-friends. With the-fargument, removes all tweet info (i.e. also wipe friends). (Caution! With the-Aargument, will remove all tweet/channel/window info and settings.)/twitter_listinfo [ <nick> [ <list_name> ] ]- Show the named list (or all lists) for the given nick (or current user).
Settings Info
These are set by the /set command - /set bitlbee_server will show the
current value, /set bitlbee_server bitlbee_tag will set it to
bitlbee_tag.
Look-and-feel Settings
show_own_tweets- Should our own tweets be displayed? Defaults to on.tweet_to_away- Set to on to post non-@reply updates as your away messagetweet_window_input- Enable tweeting directly by writing to the twitter window. Off by defaulttwirssi_retweet_format- 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 section that should be omitted if no comment was provided.twirssi_retweeted_format- The format to use when displaying retweets. Default: "RT $n: $t" (if "",twirssi_retweet_formatis used). Seetwirssi_retweet_formatfor formatting.twirssi_retweet_to_expand- Whether to expand URLs when usingretweet_to. Default is On.twirssi_hilights- Should messages containing your @nick be considered IRC hilights. (default on)twirssi_nick_color- 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.twirssi_hilight_color- Color that hilights should be for the twirssi window. (default %M)twirssi_unshorten_color- Color that unshortened URL links will display as, when enabled. (default %b)twirssi_replies_autonick- 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 replytwirssi_topic_color- If set, #topics will be shown in the color set. (default: %r)twirssi_timestamp_format- This string defines the format of timestamps (see strftime, default is "%H:%M:%S").twirssi_ignored_accounts- A comma-separated list of own accounts to ignore.twirssi_ignored_tags- A comma-separated list of words that will make tweets containing them to be ignored.twirssi_stripped_tags- A comma-separated list of words that are removed from tweets.twirssi_ignored_twits- A comma-separated list of other's accounts to ignore (e.g. in subscriptions).twirssi_use_reply_aliases- Enable /reply and /reply_as as aliases to /twitter_reply and /twitter_reply_as. Requires a reload of twirssi to take effect. (default off)twirssi_always_shorten- When false (the default), URLs will only be shortened if the tweet would be too long. When true, URLs will always be shortenedtwirssi_charset- Default: utf8.twirssi_mini_whale- Default: Off. When On, show just one line (instead of the really big fail-whale) after a substantial outage period.twirssi_ymd_color- Default: %r. The color to use when showing dates in timestamps.twitter_search_results- Default: 5. How many results to show for the initial search.twitter_autosearch_results- 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.twirssi_tweet_max_chars- Default: 280. Maximum tweet length in characters.retweet_show- Default: Off. When set to On, you will see your own (non-classic) retweets in your timeline.retweet_classic- Default: Off. When set to On, a retweet is a full tweet including the text of the original.twitter_user_results- Default: 20. Limit tweets shown by/twitter_useror/twitter_follow. Can be a number (of tweets, e.g.20; or of days, e.g.21d), or both (e.g.20 21d, most restrictive wins).
Network and File Settings
bitlbee_server- What is the server tag for bitlbee (used for away messages)short_url_provider- What service to use to shorten urls - pick from WWW::Shortenshort_url_domains- List of domains for expanding URLs, space-separated (e.g."t.co bit.ly").short_url_args- Some of the WWW::Shorten modules require additional arguments, such as a username or API key. Enter those here if needed, comma-separated.twitter_poll_interval- 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.twitter_poll_schedule- Vary the polling interval with time, using a comma-separated list of tuples of the formathhmm-hhmm:interval(e.g.2330-0745:900,0200-0600:2500). Each tuple gives the interval for a time period. Later tuples take precedence. If no period applies, reverts totwitter_poll_interval.twitter_friends_poll- How often should the updated friends list be retrieved from the server. By default, only once every 10 minutestwitter_blocks_poll- How often should the updated blocks list be retrieved from the server. By default, only once every 15 minutes.twitter_timeout- 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.twirssi_notify_timeouts- If set, twirssi will emit a message when twitter is being so slow that it fails to retrieve updates. (default on)twirssi_avoid_ssl- Default off. If off, twirssi will attempt to use SSL for all network communications. Changes take effect next time twirssi is loaded.twirssi_oauth_store- Path where OAUTH credentials are stored.twirssi_replies_store- Location where the /reply map is to be stored.twirssi_poll_store- Location where last checkpoints are stored. This is only useful iftwirssi_force_firstis set.twirssi_id_store- File path for the tweet cache.twirssi_logging- If On, twirssi windows are logged to files determined by theautolog_path(system/log) setting - wherein "$tag" is "twirssi". (default is Off)twirssi_track_replies- The number of tweets per user to remember - individual IDs. If non-zero (the default is 100), incoming tweets will show a:numappended to them. This is required for /reply and /twitter_reply functionality.twirssi_force_first- Default: off. If On, show tweets timed before load/reload of script. See alsotwirssi_reload.
Account Settings
twirssi_default_service- Default: Twitter. Can be Identica.twitter_passwords- A comma-separated list of passwords to auto-login. DEPRECATED.twitter_update_usernames- A comma-separated list of usernames to give priority when updating (first is most important).twitter_usernames- A comma-separated list of usernames to auto-login. Note that the last one will be the default account used after startup.twirssi_broadcast_users- see/twitter_broadcastcommand.twirssi_use_oauth- Default: On. Login using OAUTH.
Window Settings
twitter_window- Default: twitter. The name of the irssi window which will display twitter updates (but see also/twitter_set_window.twirssi_window_priority- Default: account. The preference for choosing which window will display twitter updates. A setting ofaccountmeans 'prefer follower';sendermeans 'prefer tweeter'.
Upgrading/Developing Twirssi Settings
twirssi_location- Location of the twirssi.pl script, used by/twirssi_upgradetwirssi_upgrade_beta- 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.twirssi_upgrade_branch- Default "master". The name of the branch - at Github - from which you want to (beta) update twirssi.twirssi_upgrade_dev- Default "gedge". Get (beta) updates to twirssi from this account at github.com.twirssi_debug- Default "off". Shows debugging.twirssi_debug_win_name- Default "". Window name to receive debugging.