source: doc/barnowl.1

release-1.9
Last change on this file was 8135737, checked in by David Benjamin <davidben@mit.edu>, 9 years ago
rename default config file to .owl/init.pl motivations: to make clear that the config file is a perl script, which runs before and is neither shadowed nor superceded by .owl/startup. fix doc wording per andersk more doc fixes from andersk clean up the else-case logic, per andersk
  • Property mode set to 100644
File size: 2.3 KB
Line 
1.TH BARNOWL 1 "24 Jun 2011"
2.SH NAME
3BarnOwl \- tty\(hybased zephyr client
4.SH SYNOPSIS
5.B barnowl
6[\-n]
7[\-d]
8[\-D]
9[\-v]
10[\-h]
11[\-c \fICONFIGFILE\fP]
12[\-t \fITTY\fP]
13[\-s \fICONFIGDIR\fP]
14.br
15.SH DESCRIPTION
16.B BarnOwl
17is a fully integrated tty\(hybased instant messaging client.  Currently
18it supports AOL Instant Messenger, MIT Zephyr, Jabber, IRC, and Twitter.  It is
19curses\(hybased, allows for emacs\(hystyle editing of outgoing messages, and
20uses Perl as an extension and configuration language.  \fBBarnOwl\fP will
21also run happily without a configuration file.
22
23Once \fBBarnOwl\fP is started, typing \(oqh\(cq will display a help screen.
24Typing \(oq:\(cq enters command mode, allowing the user to type a \fBBarnOwl\fP
25command line.
26
27.SH OPTIONS
28The following command\-line options are avilable when running \fBBarnOwl\fP:
29.TP
30\fB\-n\fP, \fB\-\-no\-subs\fP
31Do not subscribe to zephyr messages on startup.  By default, \fBBarnOwl\fP
32subscribes to the default subscriptions and to anything found in
33\fI~/.zephyr.subs\fP.  When this option is used, no subscriptions are loaded.
34
35.TP
36\fB\-c\fP, \fB\-\-config\-file\fP=\fIFILE\fP
37Specify an alternate config file for \fBBarnOwl\fP to use.  The config file is
38an arbitrary Perl script evaluated in the \fImain\fP package, and if it
39overrides the \fIBarnOwl::startup\fP method that is run when \fBBarnOwl\fP
40starts.  (Compare \fI~/.owl/startup\fP, which contains \fBBarnOwl\fP commands
41that are run at startup after the config file is loaded.)
42
43By default, \fBBarnOwl\fP uses the first of \fI~/.owl/init.pl\fP,
44\fI~/.barnowlconf\fP, or \fI~/.owlconf\fP that exists.
45
46.TP
47\fB\-s\fP, \fB\-\-config\-dir\fP=\fIDIR\fP
48Specify an alternate configuration directory.  By default, \fBBarnOwl\fP uses
49\fI~/.owl/\fP.
50
51.TP
52\fB\-t\fP, \fB\-\-tty\fP=\fITTY\fP
53Specify the tty name to use for the zephyr location.
54
55.TP
56\fB\-v\fP, \fB\-\-version\fP
57Print the version number of \fBBarnOwl\fP and exit.
58
59.TP
60\fB\-d\fP, \fB\-\-debug\fP
61Enable debugging.  By default, debugging information is placed in
62\fI/var/tmp/barnowl\-debug.PID\fP.
63
64.TP
65\fB\-h\fP, \fB\-\-help\fP
66Print command\(hyline option help.
67
68.SH AUTHORS
69Written by Nelson Elhage and Alejandro Sedeno at the Massachusetts
70Institute of Technology.  Based on Owl by James Kretchmar.
71
72Comments, questions, and bug reports may be mailed to
73\fBbug\-barnowl@mit.edu\fP.
Note: See TracBrowser for help on using the repository browser.