Changeset a3874bce


Ignore:
Timestamp:
Sep 14, 2009, 10:39:16 PM (12 years ago)
Author:
Nelson Elhage <nelhage@mit.edu>
Branches:
master, release-1.7, release-1.8, release-1.9
Children:
9a26328
Parents:
26f9e2e
Message:
Update README.

Improve documentation formatting, and update for new parameter names
and semantics.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • README

    r159aaad ra3874bce  
    2828Twitter.par also supports using multiple Twitter and Twitter-compatible
    2929microblogging accounts from the same instance.  To enable this, add
    30 additional hashes to your ~/.owl/twitter file (wrapped in a JSON list,
    31 eg. [{"account_nickname":"twitter","user":"nelhage","password":"sekrit"},
    32 {"account_nickname":"identica","service":"http://identi.ca/api",
    33 "user":"nelhage","password":"sekriter"}]
     30additional hashes to your ~/.owl/twitter file as a JSON list, e.g.
     31----------8<----------cut here----------8<----------
     32[
     33  {
     34   "account_nickname": "twitter",
     35   "user": "nelhage",
     36   "password": "sekrit",
     37   "default": true,
     38   "publish_tweets": true
     39  },
     40  {
     41   "account_nickname": "identica",
     42   "service": "http://identi.ca/api",
     43   "user": "nelhage",
     44   "password": "sekriter",
     45   "publish_tweets": true
     46  }
     47  {
     48   "account_nickname": "sipb",
     49   "user": "sipb",
     50   "password":"m0ars3krit",
     51   "poll_for_tweets": false,
     52   "poll_for_dms": false,
     53  }
     54]
     55----------8<----------cut here----------8<----------
    3456
    35 By default, public messages (excluding at-replies) are sent to all
    36 accounts listed except those with publish_tweets set to false.
     57Outgoing tweets sent via ":twitter" without an explicit sender, or
     58mirrored from zephyr, go to every account with "publish_tweets" set.
    3759
    38 There are several additional account-specific parameters that control the
     60Outgoing direct messages and @-replies without an explicit sender come
     61from whichever account has "default" set. If no account has "default",
     62the first account is assumed to have "default" set. It is an error to
     63have more than one account with "default" set to true.
     64
     65There are several account-specific parameters that control the
    3966behavior of Twitter.par when using multiple accounts:
    4067
    4168* account_nickname (string, required if multiple accounts are in use)
    4269    Specify a short name by which you can refer to the account, eg.
    43     "identica" (eg. :twitter-direct nelhage identica would send a direct
    44     message to @nelhage on identi.ca from your account nicknamed "identica").
    45 * default_sender (boolean, default false)
    46     If true, direct messages and at-replies you send without specifying an
    47     account will be sent using this account.  If no account has this parameter,
    48     such messages will be sent using the first account listed.
     70    "identica" (eg. :twitter-direct nelhage identica would send a
     71    direct message to @nelhage on identi.ca from your account
     72    nicknamed "identica").
     73
     74* default (boolean, default false)
     75    If true, @-replies or direct messages you send without specifying
     76    an account will be sent using this account.  If no account has
     77    this parameter, such messages will be sent using the first account
     78    listed.
     79
    4980* poll_for_tweets (boolean, default true)
    50     If true, tweets sent by your friends on this account will be displayed
    51     in your BarnOwl message list.
     81    If true, tweets sent by users this account follows will be
     82    displayed in your BarnOwl message list.
     83
    5284* poll_for_dms (boolean, default true)
    53     If true, Direct Messages sent to you by your friends on this account
    54     will be displayed in your BarnOwl message list.
    55 * publish_tweets (boolean, default true)
    56     If true, tweets you send without specifying an account (either with the
    57     :twitter command or mirrored from a zephyr class) will be published to
    58     this account.
     85    If true, direct messages sent to this account will be displayed in
     86    your BarnOwl message list.
     87
     88* publish_tweets (boolean, default false)
     89    If true, tweets you send without specifying an account (either
     90    with the :twitter command or mirrored from a zephyr class) will be
     91    published to this account.
     92
     93* show_mentions (boolean, default true)
     94    If true, BarnOwl will show all tweets that mention this account's
     95    username, regardless of whether or not this account is following
     96    the sender. Has no effect if poll_for_tweets is false.
Note: See TracChangeset for help on using the changeset viewer.