| 1 | .TH barnowl 1 "23 Jun 2008" |
|---|
| 2 | .SH NAME |
|---|
| 3 | BarnOwl \- tty based zephyr client |
|---|
| 4 | .SH SYNOPSIS |
|---|
| 5 | .B barnowl |
|---|
| 6 | [ \-n |
|---|
| 7 | ] |
|---|
| 8 | [ \-d |
|---|
| 9 | ] |
|---|
| 10 | [ \-D |
|---|
| 11 | ] |
|---|
| 12 | [ \-v |
|---|
| 13 | ] |
|---|
| 14 | [ \-h |
|---|
| 15 | ] |
|---|
| 16 | [ \-c |
|---|
| 17 | .I configfile |
|---|
| 18 | ] |
|---|
| 19 | [ \-t |
|---|
| 20 | .I tty |
|---|
| 21 | ] |
|---|
| 22 | [ \-s |
|---|
| 23 | .I configdir |
|---|
| 24 | ] |
|---|
| 25 | .br |
|---|
| 26 | .SH DESCRIPTION |
|---|
| 27 | .B BarnOwl |
|---|
| 28 | is a fully integrated tty based instant messaging client. Currently |
|---|
| 29 | it supports AOL Instant Messenger, MIT Zephyr, and Jabber. It is |
|---|
| 30 | curses-based, allows for emacs-style editing of outgoing messages and |
|---|
| 31 | uses perl as an extension and configuration language. BarnOwl will |
|---|
| 32 | also run happily without a configuration file. |
|---|
| 33 | |
|---|
| 34 | Once BarnOwl is started, typing 'h' will display a help screen. |
|---|
| 35 | Typing \':\' enters command mode, allowing the user to type a BarnOwl |
|---|
| 36 | command line. |
|---|
| 37 | |
|---|
| 38 | .PP |
|---|
| 39 | .SH USE |
|---|
| 40 | The following command line options are avilable when running BarnOwl: |
|---|
| 41 | |
|---|
| 42 | .B \-n |
|---|
| 43 | .IP |
|---|
| 44 | Do not subscribe to zephyr messages on startup. By default BarnOwl |
|---|
| 45 | subscribes to the default subscriptions and to anything found in |
|---|
| 46 | ~/.zephyr.subs. When this option is used no subscriptions are loaded. |
|---|
| 47 | .LP |
|---|
| 48 | |
|---|
| 49 | .B \-c \fIconfigfile\fP |
|---|
| 50 | .IP |
|---|
| 51 | Specifiy an alternate config file for BarnOwl to use. By default, |
|---|
| 52 | BarnOwl uses ~/.barnowlconf if it exists, and ~/.owlconf otherwise. |
|---|
| 53 | .LP |
|---|
| 54 | |
|---|
| 55 | .B \-s \fIconfigdir\fP |
|---|
| 56 | .IP |
|---|
| 57 | Specify an alternate configuration directory. By default, BarnOwl uses |
|---|
| 58 | ~/.owl/. |
|---|
| 59 | .LP |
|---|
| 60 | |
|---|
| 61 | .B \-t \fItty\fP |
|---|
| 62 | .IP |
|---|
| 63 | Specifiy the tty name to use for the zephyr location. |
|---|
| 64 | .LP |
|---|
| 65 | |
|---|
| 66 | .B \-v |
|---|
| 67 | .IP |
|---|
| 68 | Print the version number of BarnOwl and exit. |
|---|
| 69 | .LP |
|---|
| 70 | |
|---|
| 71 | .B \-d |
|---|
| 72 | .IP |
|---|
| 73 | Enable debugging. By default debugging information is placed in |
|---|
| 74 | /var/tmp/owldebug. |
|---|
| 75 | .LP |
|---|
| 76 | |
|---|
| 77 | .B \-D |
|---|
| 78 | .IP |
|---|
| 79 | Enable debugging, but first delete any existing debugging file. |
|---|
| 80 | .LP |
|---|
| 81 | |
|---|
| 82 | .B \-h |
|---|
| 83 | .IP |
|---|
| 84 | Print command line option help. |
|---|
| 85 | .LP |
|---|
| 86 | |
|---|
| 87 | .SH AUTHOR |
|---|
| 88 | Written by Nelson Elhage and Alejandro Sedeno at the Massachusetts |
|---|
| 89 | Institute of Technology. Based on Owl by James Kretchmar. |
|---|
| 90 | |
|---|
| 91 | Comments, questions, and bug reports may be mailed to |
|---|
| 92 | \fBbug-barnowl@mit.edu\fP. |
|---|
