X-Git-Url: https://git.toastfreeware.priv.at/gregoa/bti.git/blobdiff_plain/78fd871efc6bf2d9c982d2d2e3457cb2b228f4d6..82745b5e7bb83fd3a0f32a1f57c056610297a7ff:/bti.1

diff --git a/bti.1 b/bti.1
index ce744c8..8654686 100644
--- a/bti.1
+++ b/bti.1
@@ -167,11 +167,11 @@
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
 .SH "Name"
-bti \- send a tweet to twitter\&.com or identi\&.ca from the command line
+bti \- send a tweet to twitter\&.com or identi\&.ca (or any custom laconi\&.ca installation) 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\-\-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\-\-page\ PAGENUMBER\fR] [\fB\-\-bash\fR] [\fB\-\-shrink\-urls\fR] [\fB\-\-debug\fR] [\fB\-\-dry\-run\fR]  [\fB\-\-verbose\fR] [\fB\-\-version\fR] [\fB\-\-help\fR]
 .fam
 .SH "DESCRIPTION"
 .PP
@@ -188,18 +188,66 @@ Specify the twitter\&.com or identi\&.ca account name\&.
 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\'s timeline\&.
+.RE
+.PP
+\fB\-\-user screenname\fR
+.RS 4
+Specify the user you want to see his/her messages while the action is "user"\&.
+.sp
+If no screenname is specified, the default is account name\&.
+.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\&.
 .sp
+If you want to send the message to a custom laconi\&.ca installation, you should specify the API URI\&. For example identi\&.ca\'s URI is: https://identi\&.ca/api/statuses\&.
+.sp
 If no host is specified, the default is to send to twitter\&.com\&.
 .RE
 .PP
+\fB\-\-proxy PROXY:PORT\fR
+.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 \-\-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\-\-shrink\-urls\fR
+.RS 4
+Scans the tweet text for valid URL patterns and passes each through the supplied bti\-shrink\-urls script\&. The script will pass the URL to a web service that shrinks the URLs, making it more suitable for micro\-blogging\&.
+.sp
+Currently, only http://2tu\&.us/ is used as a URL shrinking service\&.
+.RE
+.PP
 \fB\-\-debug\fR
 .RS 4
 Print a whole bunch of debugging messages to stdout\&.
 .RE
 .PP
+\fB\-\-page PAGENUMBER\fR
+.RS 4
+When the action is to retrieve updates, it usually retrieves only one page\&. If this option is used, the page number can be specified\&.
+.RE
+.PP
+\fB\-\-dry\-run\fR
+.RS 4
+Performs all steps that would normally be done for a given action, but will not connect to the service to post or retrieve data\&.
+.RE
+.PP
+\fB\-\-verbose\fR
+.RS 4
+Verbose mode
+.RE
+.PP
 \fB\-\-bash\fR
 .RS 4
 Add the working directory and a \'$\' in the tweet message to help specify it is coming from a command line\&. Don\'t put the working directory and the \'$\' in the tweet message\&.
@@ -246,15 +294,64 @@ 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
+\fBaction 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\'s timeline\&.
+.RE
+.PP
+\fBuser screenname\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\&.
+.sp
+If you want to send the message to a custom laconi\&.ca installation, you should specify the API URI\&. For example identi\&.ca\'s URI is: https://identi\&.ca/api/statuses\&.
+.RE
+.PP
+\fBproxy\fR
+.RS 4
+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
+\fBshrink\-urls\fR
+.RS 4
+Setting this variable to \'true\' or \'yes\' will enable the URL shrinking feature\&. This is equivalent to using the \-\-shrink\-urls option\&.
+.RE
+.PP
+\fBverbose\fR
+.RS 4
+Setting this variable to \'true\' or \'yes\' will enable the Verbose mode\&.
 .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\&.
+.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
-\FCgreg@kroah\&.com\F[]\&.
+<\FCgreg@kroah\&.com\F[]> and Amir Mohammad Saied
+<\FCamirsaied@gmail\&.com\F[]>\&.