Permalink
Browse files

document the logfile option

  • Loading branch information...
gregkh committed Jan 23, 2009
1 parent fa1ce0c commit 831399eedfdda3365e84ba2c5417b34d9ca4d08b
Showing with 34 additions and 1 deletion.
  1. +11 −1 bti.1
  2. +1 −0 bti.example
  3. +22 −0 bti.xml
View
12 bti.1
@@ -171,7 +171,7 @@ bti \- send a tweet to twitter\&.com or identi\&.ca from the command line
.SH "Synopsis"
.fam C
.HP \w'\fBbti\fR\ 'u
-\fBbti\fR [\fB\-\-account\ account\fR] [\fB\-\-password\ password\fR] [\fB\-\-host\ HOST_NAME\fR] [\fB\-\-proxy\ PROXY:PORT\fR] [\fB\-\-bash\fR] [\fB\-\-debug\fR] [\fB\-\-version\fR] [\fB\-\-help\fR]
+\fBbti\fR [\fB\-\-account\ account\fR] [\fB\-\-password\ password\fR] [\fB\-\-host\ HOST_NAME\fR] [\fB\-\-proxy\ PROXY:PORT\fR] [\fB\-\-logfile\ LOGFILE\fR] [\fB\-\-bash\fR] [\fB\-\-debug\fR] [\fB\-\-version\fR] [\fB\-\-help\fR]
.fam
.SH "DESCRIPTION"
.PP
@@ -202,6 +202,11 @@ Specify a http proxy value\&. This is not a required option, and only needed by
If \-\-proxy is not specified but the environment variable \'http_proxy\' is set the latter will be used\&.
.RE
.PP
+\fB\-\-logfile LOGFILE\fR
+.RS 4
+Specify a logfile for bti to write status messages to\&. LOGFILE is in relation to the user\'s home directory, not an absolute path to a file\&.
+.RE
+.PP
\fB\-\-debug\fR
.RS 4
Print a whole bunch of debugging messages to stdout\&.
@@ -263,6 +268,11 @@ The host you want to use to send the message to\&. Valid options are either "twi
The http proxy needed to send data out to the Internet\&.
.RE
.PP
+\fBlogfile\fR
+.RS 4
+The logfile name for bti to write what happened to\&. This file is relative to the user\'s home directory\&. If this file is not specified here or on the command line, no logging will be written to the disk\&.
+.RE
+.PP
There is an example config file called
\FCbti\&.example\F[]
in the source tree that shows the structure of the file if you need an example to work off of\&.
View
@@ -6,4 +6,5 @@
account=twitmaster
password=icanhascheezburger
host=identica
+logfile=.bti.log
#proxy=http://localhost:8080
View
22 bti.xml
@@ -30,6 +30,7 @@
<arg><option>--password password</option></arg>
<arg><option>--host HOST_NAME</option></arg>
<arg><option>--proxy PROXY:PORT</option></arg>
+ <arg><option>--logfile LOGFILE</option></arg>
<arg><option>--bash</option></arg>
<arg><option>--debug</option></arg>
<arg><option>--version</option></arg>
@@ -86,6 +87,16 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>--logfile LOGFILE</option></term>
+ <listitem>
+ <para>
+ Specify a logfile for bti to write status messages to. LOGFILE
+ is in relation to the user's home directory, not an absolute
+ path to a file.
+ </para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><option>--debug</option></term>
<listitem>
@@ -198,6 +209,17 @@
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>logfile</option></term>
+ <listitem>
+ <para>
+ The logfile name for bti to write what happened to.
+ This file is relative to the user's home directory. If this
+ file is not specified here or on the command line, no logging
+ will be written to the disk.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
<para>
There is an example config file called

0 comments on commit 831399e

Please sign in to comment.