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