document the logfile option
[gregoa/bti.git] / bti.1
diff --git a/bti.1 b/bti.1
index e8413d6a92e2b587f365ac24c27a10b5fe2428dd..f3237a78c3f3bcb8d18bb1c8c93029f29ca493e6 100644 (file)
--- a/bti.1
+++ b/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
 .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
 .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
 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\&.
 \fB\-\-debug\fR
 .RS 4
 Print a whole bunch of debugging messages to stdout\&.
@@ -263,9 +268,30 @@ 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
 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\&.
 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\&.
+.PP
+Configuration options have the following priority:
+.PP
+.RS 4
+command line option
+.RE
+.PP
+.RS 4
+config file option
+.RE
+.PP
+.RS 4
+environment variables
+.RE
+.PP
+For example, command line options always override any config file option, or any environment variables\&.
 .SH "AUTHOR"
 .PP
 Written by Greg Kroah\-Hartman
 .SH "AUTHOR"
 .PP
 Written by Greg Kroah\-Hartman