source: doc/barnowl.1 @ d9fbfd8

Last change on this file since d9fbfd8 was d9fbfd8, checked in by David Benjamin <davidben@mit.edu>, 10 years ago
Reformat the man page to look more like others It doesn't look like anyone's actually consistent in man page formatting, but this looks decent. Also update it as it's rather stale in places.
  • Property mode set to 100644
File size: 2.0 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.  By default,
38\fBBarnOwl\fP uses \fI~/.barnowlconf\fP if it exists, and \fI~/.owlconf\fP otherwise.
39
40.TP
41\fB\-s\fP, \fB\-\-config\-dir\fP=\fIDIR\fP
42Specify an alternate configuration directory.  By default, \fBBarnOwl\fP uses
43\fI~/.owl/\fP.
44
45.TP
46\fB\-t\fP, \fB\-\-tty\fP=\fITTY\fP
47Specify the tty name to use for the zephyr location.
48
49.TP
50\fB\-v\fP, \fB\-\-version\fP
51Print the version number of \fBBarnOwl\fP and exit.
52
53.TP
54\fB\-d\fP, \fB\-\-debug\fP
55Enable debugging.  By default, debugging information is placed in
56\fI/var/tmp/barnowl\-debug.PID\fP.
57
58.TP
59\fB\-h\fP, \fB\-\-help\fP
60Print command\(hyline option help.
61
62.SH AUTHORS
63Written by Nelson Elhage and Alejandro Sedeno at the Massachusetts
64Institute of Technology.  Based on Owl by James Kretchmar.
65
66Comments, questions, and bug reports may be mailed to
67\fBbug\-barnowl@mit.edu\fP.
Note: See TracBrowser for help on using the repository browser.