source: perl/modules/Twitter/README @ 5756999

release-1.7release-1.8release-1.9
Last change on this file since 5756999 was 5756999, checked in by Nelson Elhage <nelhage@mit.edu>, 11 years ago
Twitter: Update README to reflect that it's now built in.
  • Property mode set to 100644
File size: 4.2 KB
Line 
1NAME
2  Twitter.par - Twitter support for BarnOwl
3
4DESCRIPTION
5  The Twitter module implements Twitter support for BarnOwl. It also
6  supports automatic mirroring of some subset of Zephyrs you send to
7  Twitter.
8
9SYNOPSIS
10  (1) Configure your Twitter credentials in ~/.owl/twitter in the
11  following format:
12----------8<----------cut here----------8<----------
13{
14 "user":"nelhage",
15 "password":"sekrit"
16}
17----------8<----------end cut ----------8<----------
18  (2) Run ":reload-module Twitter" inside BarnOwl
19  (3) Start receiving tweets in BarnOwl!
20      You can send tweets with the ":twitter" command.
21
22MIRRORING ZEPHYRS TO TWITTER
23  If you set the twitter:class, twitter:instance, and twitter:opcode
24  BarnOwl variables, BarnOwl will resend zephyrs matching those fields
25  as tweets coming from you.
26
27  By default, these default to -c $YOUR_USERNAME -i status -O twitter.
28  Setting twitter:opcode to "" will cause "normal" (i.e. no opcode)
29  messages to that class/instance to be mirrored. A value of '*' works
30  as a "match-anything" wildcard for any of the fields.
31
32POLLING
33  Twitter.par polls for normal messages once a minute, and direct
34  messages every other minute. To disable polling, you can unset the
35  'twitter:poll' variable in BarnOwl.
36
37IDENTI.CA SUPPORT
38  Twitter.par supports other Twitter-compatible microblogging services,
39  like identi.ca. To enable this, set the 'service' parameter in your
40  config hash to the API URL of your service. You may also need to set
41  'apihost' and 'apirealm'. See Net::Twitter or your blogging service's
42  documentation for more information.
43
44MULTIPLE ACCOUNTS
45
46  Twitter.par also supports using multiple Twitter and
47  Twitter-compatible microblogging accounts from the same instance.
48  To enable this, add additional hashes to your ~/.owl/twitter file as
49  a JSON list, e.g.
50----------8<----------cut here----------8<----------
51[
52  {
53   "account_nickname": "twitter",
54   "user": "nelhage",
55   "password": "sekrit",
56   "default": true,
57   "publish_tweets": true
58  },
59  {
60   "account_nickname": "identica",
61   "service": "http://identi.ca/api",
62   "user": "nelhage",
63   "password": "sekriter",
64   "publish_tweets": true
65  }
66  {
67   "account_nickname": "sipb",
68   "user": "sipb",
69   "password":"m0ars3krit",
70   "poll_for_tweets": false,
71   "poll_for_dms": false,
72  }
73]
74----------8<----------end cut ----------8<----------
75
76Outgoing tweets sent via ":twitter" without an explicit sender, or
77mirrored from zephyr, go to every account with "publish_tweets" set.
78
79Outgoing direct messages and @-replies without an explicit sender come
80from whichever account has "default" set. If no account has "default",
81the first account is assumed to have "default" set. It is an error to
82have more than one account with "default" set to true.
83
84There are several account-specific parameters that control the
85behavior of Twitter.par when using multiple accounts:
86
87* account_nickname (string, required if multiple accounts are in use)
88    Specify a short name by which you can refer to the account, eg.
89    "identica" (eg. :twitter-direct nelhage identica would send a
90    direct message to @nelhage on identi.ca from your account
91    nicknamed "identica").
92
93* default (boolean, default false)
94    If true, @-replies or direct messages you send without specifying
95    an account will be sent using this account.  If no account has
96    this parameter, such messages will be sent using the first account
97    listed.
98
99* poll_for_tweets (boolean, default true)
100    If true, tweets sent by users this account follows will be
101    displayed in your BarnOwl message list.
102
103* poll_for_dms (boolean, default true)
104    If true, direct messages sent to this account will be displayed in
105    your BarnOwl message list.
106
107* publish_tweets (boolean, default false)
108    If true, tweets you send without specifying an account (either
109    with the :twitter command or mirrored from a zephyr class) will be
110    published to this account.
111
112    If only one account is specified, it defaults to publish_tweets =
113    true.
114
115* show_mentions (boolean, default true)
116    If true, BarnOwl will show all tweets that mention this account's
117    username, regardless of whether or not this account is following
118    the sender. Has no effect if poll_for_tweets is false.
Note: See TracBrowser for help on using the repository browser.