Changes in / [1eafdfa:47a5e46]


Ignore:
Files:
244 added
7 deleted
2 edited

Legend:

Unmodified
Added
Removed

  • .gitignore

    r9a26328 r7d03c8d  
     1*.a
     2*.o
     3*.par
    14*~
    2 blib/
    3 inc/
     5.#*
     6.*.swp
     7.deps
    48META.yml
    59Makefile
    6 Twitter.par
     10Makefile.in
     11Makefile.old
     12TAGS
     13\#*#
     14aclocal.m4
     15autom4te.cache
     16barnowl.bin
     17zcrypt
     18blib
     19config.cache
     20config.h
     21config.h.in
     22config.log
     23config.status
     24configure
     25core
     26depcomp
     27install-sh
     28jabber.log
     29missing
     30owl_prototypes.h
     31owl_prototypes.h.new
     32perl_tester
     33perlglue.c
     34perlwrap.c
    735pm_to_blib
     36stamp-h1
     37tester
     38varstubs.c

  • README

    rfe184d4 r62c91c1  
    1 NAME
    2   Twitter.par - Twitter support for BarnOwl
     1BarnOwl - owl, with more ponies
    32
    4 DESCRIPTION
    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.
     3Based on owl 2.1.11, by James Kretchmar (http://www.ktools.org)
    84
    9 SYNOPSIS
    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) Copy Twitter.par into ~/.owl/modules/
    19   (3) Run ":reload-module Twitter" inside BarnOwl
    20   (4) Start receiving tweets in BarnOwl!
    21       You can send tweets with the ":twitter" command.
     5This project is a work in progress.
     6We guarantee no stability of form or function.
    227
    23 MIRRORING ZEPHYRS TO TWITTER
    24   If you set the twitter:class, twitter:instance, and twitter:opcode
    25   BarnOwl variables, BarnOwl will resend zephyrs matching those fields
    26   as tweets coming from you.
     8Notes:
     9-----
     10This project's perl/lib/ contains the lib directories from the
     11following CPAN modules:
    2712
    28   By default, these default to -c $YOUR_USERNAME -i status -O twitter.
    29   Setting twitter:opcode to "" will cause "normal" (i.e. no opcode)
    30   messages to that class/instance to be mirrored. A value of '*' works
    31   as a "match-anything" wildcard for any of the fields.
     13Net::Jabber
     14Net::XMPP
     15XML::Stream
    3216
    33 POLLING
    34   Twitter.par polls for normal messages once a minute, and direct
    35   messages every other minute. To disable polling, you can unset the
    36   'twitter:poll' variable in BarnOwl.
     17They have been modified slightly for the needs of this project.
    3718
    38 IDENTI.CA SUPPORT
    39   Twitter.par supports other Twitter-compatible microblogging services,
    40   like identi.ca. To enable this, set the 'service' parameter in your
    41   config hash to the API URL of your service. You may also need to set
    42   'apihost' and 'apirealm'. See Net::Twitter or your blogging service's
    43   documentation for more information.
     19BarnOwl currently requires the following perl modules off of CPAN:
    4420
    45 MULTIPLE ACCOUNTS
     21PAR
     22Net::DNS
     23Authen::SASL::Perl
     24IO::Socket::SSL
     25Digest::SHA1
    4626
    47   Twitter.par also supports using multiple Twitter and
    48   Twitter-compatible microblogging accounts from the same instance.
    49   To enable this, add additional hashes to your ~/.owl/twitter file as
    50   a JSON list, e.g.
    51 ----------8<----------cut here----------8<----------
    52 [
    53   {
    54    "account_nickname": "twitter",
    55    "user": "nelhage",
    56    "password": "sekrit",
    57    "default": true,
    58    "publish_tweets": true
    59   },
    60   {
    61    "account_nickname": "identica",
    62    "service": "http://identi.ca/api",
    63    "user": "nelhage",
    64    "password": "sekriter",
    65    "publish_tweets": true
    66   }
    67   {
    68    "account_nickname": "sipb",
    69    "user": "sipb",
    70    "password":"m0ars3krit",
    71    "poll_for_tweets": false,
    72    "poll_for_dms": false,
    73   }
    74 ]
    75 ----------8<----------end cut ----------8<----------
     27(Note that these are all available as Debian packages)
     28We plan to soon add targets to the Makefile to check for and install
     29these for you.
    7630
    77 Outgoing tweets sent via ":twitter" without an explicit sender, or
    78 mirrored from zephyr, go to every account with "publish_tweets" set.
     31The IRC module requires:
    7932
    80 Outgoing direct messages and @-replies without an explicit sender come
    81 from whichever account has "default" set. If no account has "default",
    82 the first account is assumed to have "default" set. It is an error to
    83 have more than one account with "default" set to true.
     33Net::IRC
     34Class::Accessor
    8435
    85 There are several account-specific parameters that control the
    86 behavior of Twitter.par when using multiple accounts:
     36The WordWrap module requires:
    8737
    88 * account_nickname (string, required if multiple accounts are in use)
    89     Specify a short name by which you can refer to the account, eg.
    90     "identica" (eg. :twitter-direct nelhage identica would send a
    91     direct message to @nelhage on identi.ca from your account
    92     nicknamed "identica").
    93 
    94 * default (boolean, default false)
    95     If true, @-replies or direct messages you send without specifying
    96     an account will be sent using this account.  If no account has
    97     this parameter, such messages will be sent using the first account
    98     listed.
    99 
    100 * poll_for_tweets (boolean, default true)
    101     If true, tweets sent by users this account follows will be
    102     displayed in your BarnOwl message list.
    103 
    104 * poll_for_dms (boolean, default true)
    105     If true, direct messages sent to this account will be displayed in
    106     your BarnOwl message list.
    107 
    108 * publish_tweets (boolean, default false)
    109     If true, tweets you send without specifying an account (either
    110     with the :twitter command or mirrored from a zephyr class) will be
    111     published to this account.
    112 
    113     If only one account is specified, it defaults to publish_tweets =
    114     true.
    115 
    116 * show_mentions (boolean, default true)
    117     If true, BarnOwl will show all tweets that mention this account's
    118     username, regardless of whether or not this account is following
    119     the sender. Has no effect if poll_for_tweets is false.
     38Text::Autoformat
Note: See TracChangeset for help on using the changeset viewer.