X-Git-Url: https://git.toastfreeware.priv.at/gregoa/bti.git/blobdiff_plain/ba2443406bef1596eefd344daedfd3ca23b7ea34..37a84bdcca02fc32e9e44c60ce297da2479ffc0a:/bti.xml diff --git a/bti.xml b/bti.xml index 96f424a..ae08e4f 100644 --- a/bti.xml +++ b/bti.xml @@ -28,10 +28,20 @@ bti + + + + + + + + + + @@ -60,13 +70,38 @@ + + + + + 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. Default is "update". + + + + + + + + Specify the user whose messages you want to see when the + action is "user". + + + 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. + send to identi.ca. + + 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 If no host is specified, the default is to send to twitter.com. @@ -86,12 +121,104 @@ + + + + + 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. + + + + + + + + Specify a config file for bti to read from. By default, bti + looks in the ~/.bti file for config values. This default + location can be overridden by setting a specific file with this + option. + + + + + + + + Status ID of a single post to which you want to create a threaded + reply to. + + + For twitter, this is ignored unless the message starts with the + @name of the owner of the post with the status ID. + + + For status.net, this can link any two messages into context with + each other. Status.net will also link a message that contains an + @name without this without regard to context. + + + + + + + + Status ID of a single post which you want to retweet. + + + + + + + + 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. + + + The following URL shrinking services are available: + http://2tu.us/ (default) and http://bit.ly / http://j.mp + + + See the documentation for bti-shrink-urls for the configuration options. + + + Print a whole bunch of debugging messages to stdout. + + + + + When the action is to retrieve updates, it usually retrieves + only one page. If this option is used, the page number can be + specified. + + + + + + + + Performs all steps that would normally be done for a given + action, but will not connect to the service to post or retrieve data. + + + + + + + + Verbose mode. Print status IDs and timestamps. + + + @@ -100,11 +227,20 @@ help specify it is coming from a command line. Don't put the working directory and the '$' in the tweet message. + + + This option implies . + + + + + + - This mode also does not report back any errors that might have - happened when sending the message, and it sends it in the - background, returning immediately, allowing the process to - continue on. + Do not report back any errors that might have + happened when sending the message, and send it in the + background, returning immediately, allowing the user + to continue on. @@ -133,7 +269,7 @@ out. - It's primary focus is to allow you to log everything that you + Its primary focus is to allow you to log everything that you type into a bash shell, in a crazy, "this is what I'm doing right now!" type of way, letting the world follow along with you constant moving between directories and refreshing your email @@ -158,7 +294,7 @@ The account and password can be stored in a configuration file in the users home directory in a file named - .bti The structure of this file is as + .bti. The structure of this file is as follows: @@ -180,6 +316,27 @@ + + + + + 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. + + + + + + + + Specify the user you want to see his/her messages while the + action is "user". + + + @@ -187,6 +344,10 @@ 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. + + 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. @@ -198,7 +359,50 @@ - + + + + + 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. + + + + + + + + The status ID to which all notices will be linked to. + + + There is no sane reason for a need to have this set in a + config file. One such reason is to have all your messages + as children to a particular status. + + + + + + + + Setting this variable to 'true' or 'yes' will enable the URL + shrinking feature. This is equivalent to using the + --shrink-urls option. + + + + + + + + Setting this variable to 'true' or 'yes' will enable the + verbose mode. + + + + There is an example config file called bti.example in the source tree that shows @@ -223,12 +427,15 @@ For example, command line options always override any config file - option, or any environment variables. + option, or any environment variables. Unless a config file is + specified by the command line. At that point, the new config file is + read, and any previous options set by a command line option, would be + overridden. AUTHOR - Written by Greg Kroah-Hartman greg@kroah.com. + Written by Greg Kroah-Hartman <greg@kroah.com> and Amir Mohammad Saied <amirsaied@gmail.com>.