Updating documents

[gregoa/bti.git] / bti.1

diff --git a/bti.1 b/bti.1
index 4c2fd45ca0855a293fd2d96a699f9fef95035c13..ea3b887f0d4a9d229caba338bb1fb3401b63fb8a 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\-\-action\ action\fR] [\fB\-\-user\ screenname\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


@@ -188,6 +188,16 @@ Specify the twitter\&.com or identi\&.ca account name\&.
 Specify the password of your twitter\&.com or identi\&.ca account\&.
 .RE
 .PP
 Specify the password of your twitter\&.com or identi\&.ca account\&.
 .RE
 .PP

+\fB\-\-action action\fR
+.RS 4
+Specify the action which you want to perform\&.  Valid options are "update" to send a message, "friends" to see your friends timeline, "public" to track public timeline, "replies" to see replies to your messages and "user" to see a specific user timeline\&.
+.RE
+.PP
+\fB\-\-user screenname\fR
+.RS 4
+Specify the user you want to see his/her messages while the action is "user"\&.
+.RE
+.PP

 \fB\-\-host HOST_NAME\fR
 .RS 4
 Specify the host which you want to send your message to\&. Valid options are "twitter" to send to twitter\&.com and "identica" to send to identi\&.ca\&.
 \fB\-\-host HOST_NAME\fR
 .RS 4
 Specify the host which you want to send your message to\&. Valid options are "twitter" to send to twitter\&.com and "identica" to send to identi\&.ca\&.


@@ -199,7 +209,12 @@ If no host is specified, the default is to send to twitter\&.com\&.
 .RS 4
 Specify a http proxy value\&. This is not a required option, and only needed by systems that are behind a http proxy\&.
 .sp
 .RS 4
 Specify a http proxy value\&. This is not a required option, and only needed by systems that are behind a http proxy\&.
 .sp

-If no host is specified, the default is to send to twitter\&.com\&.
+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
 .RE
 .PP
 \fB\-\-debug\fR


@@ -253,6 +268,16 @@ The twitter\&.com or identi\&.ca account name you wish to use to send this messa
 The twitter\&.com or identi\&.ca password for the account you wish to use to send this message with\&.
 .RE
 .PP
 The twitter\&.com or identi\&.ca password for the account you wish to use to send this message with\&.
 .RE
 .PP

+\fBaction\fR
+.RS 4
+Specify the action which you want to perform\&.  Valid options are "update" to send a message, "friends" to see your friends timeline, "public" to track public timeline, "replies" to see replies to your messages and "user" to see a specific user timeline\&.
+.RE
+.PP
+\fBscreenname\fR
+.RS 4
+Specify the user you want to see his/her messages while the action is "user"\&.
+.RE
+.PP

 \fBhost\fR
 .RS 4
 The host you want to use to send the message to\&. Valid options are either "twitter" or "identica" to send to twitter\&.com or identi\&.ca respectively\&.
 \fBhost\fR
 .RS 4
 The host you want to use to send the message to\&. Valid options are either "twitter" or "identica" to send to twitter\&.com or identi\&.ca respectively\&.


@@ -263,9 +288,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