Commit 8caeab88 authored by Romain Bignon's avatar Romain Bignon

generated manpages from make_man.py

parent 7b5e5f32
.TH BOOBANK 1 "02 August 2010"
.TH BOOBANK 1 "09 December 2010"
.SH NAME
boobank \- Bank operations
boobank
.SH SYNOPSIS
.B boobank
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..]
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B boobank
[\-\-version] [\-\-help]
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
Boobank is a console application which loads the configured \fIICapBank\fR backends
and display your accounts amount.
Boobank is a console application to get bank accounts, display history and do transfer operations.
.SH COMMANDS
.SS Supported websites:
* bnporc (BNP Paribas french bank' website)
.br
* bp (La banque postale, French bank)
.br
* cragr (Credit Agricole french bank's website)
.br
* creditmutuel (Crédit Mutuel french bank)
.br
* lcl (Le Credit Lyonnais crappy french bank)
.br
* societegenerale (Société Générale french bank' website)
.SH BOOBANK COMMANDS
.TP
\fBcoming\fR \fIID\fR
.br
Display all future operations.
.TP
\fBhistory\fR \fIID\fR
.br
Display old operations.
.TP
\fBlist\fR
list every accounts, with the amount of money.
.br
List every available accounts.
.TP
\fBcoming\fR \fIid\fR
display the coming operations on a specific account.
\fBtransfer\fR \fIACCOUNT\fR [\fITO\fR \fIAMOUNT\fR [\fIREASON\fR]]
.br
Make a transfer beetwen two account
.br
\- ACCOUNT the source account
.br
\- TO the recipient
.br
\- AMOUNT amount to transfer
.br
\- REASON reason of transfer
.br
.SH OPTIONS
.SS Results options
.br
If you give only the ACCOUNT parameter, it lists all the
.br
available recipients for this account.
.SH WEBOOB COMMANDS
.TP
\fB\-c\fR, \fB\-\-condition\fR \fICONDITION\fR
filter result items to display given a boolean condition
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br
.br
ACTION is one of the following (default: list):
.br
* enable enable given backends
.br
* disable disable given backends
.br
* only enable given backends and disable the others
.br
* list display enabled and available backends
.br
* add add a backend
.br
* register register a new account on a website
.br
* edit edit a backend
.br
* remove remove a backend
.TP
\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
get a maximum number of results (all backends merged)
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
If an argument is given, set the condition expression used to filter the results.
.br
If the "off" value is given, conditional filtering is disabled.
.br
.br
If no argument is given, print the current condition expression.
.TP
\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
select the output formatter (htmltable,multiline,simple,table,webkit)
\fBcount\fR [\fINUMBER\fR | off]
.br
If an argument is given, set the maximum number of results fetched.
.br
NUMBER must be at least 1.
.br
"off" value disables counting, and allows infinite searches.
.br
.br
If no argument is given, print the current count value.
.TP
\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
select return field keys to display (comma separated)
\fBformatter\fR [list | \fIFORMATTER\fR [\fICOMMAND\fR] | option \fIOPTION_NAME\fR [on | off]]
.br
If a FORMATTER is given, set the formatter to use.
.br
You can add a COMMAND to apply the formatter change only to
.br
a given command.
.br
.br
If the argument is "list", print the available formatters.
.br
.br
If the argument is "option", set the formatter options.
.br
Valid options are: header, keys.
.br
If on/off value is given, set the value of the option.
.br
If not, print the current value for the option.
.br
.br
If no argument is given, print the current formatter.
.TP
\fB\-\-no-header\fR
do not display header
\fBinspect\fR \fIBACKEND_NAME\fR
.br
Display the HTML string of the current page of the specified backend's browser.
.br
.br
If webkit_mechanize_browser Python module is installed, HTML is displayed in a WebKit GUI.
.TP
\fB\-\-no-keys\fR
do not display field keys
.SS Logging options
\fBlogging\fR [\fILEVEL\fR]
.br
Set logging level.
.br
.br
Availables: debug, info, warning, error.
.br
* quiet is an alias for error
.br
* default is an alias for warning
.TP
\fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full"
.br
If an argument is given, set the selected fields.
.br
$direct selects all fields loaded in one http request.
.br
$full selects all fields using as much http requests as necessary.
.br
.br
If no argument is given, print the currently selected fields.
.TP
\fBquit\fR
.br
Quit the application.
.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
what backend(s) to enable (comma separated)
.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
display debug messages
......@@ -52,22 +187,44 @@ display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.SS Misc options
.TP
\fB\-b\fR, \fB\-\-backends\fR \fIbackends\fR
select backends to load
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
.TP
\fB\-\-version\fR
display version of \fIweboob-config\fR
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
.SH RESULTS OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show the help message and exit
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
filter result items to display given a boolean expression
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
get a maximum number of results (all backends merged)
.TP
\fB\-s SELECT\fR, \fB\-\-select=SELECT\fR
select result item keys to display (comma separated)
.SH FORMATTING OPTIONS
.TP
\fB\-f FORMATTER\fR, \fB\-\-formatter=FORMATTER\fR
select output formatter (account_list, csv, htmltable, multiline, simple, table,
transfer, webkit)
.TP
\fB\-\-no\-header\fR
do not display header
.TP
\fB\-\-no\-keys\fR
do not display item keys
.SH COPYRIGHT
Copyright(C) 2010 Romain Bignon
Copyright(C) 2010 Romain Bignon, Christophe Benz
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"
"~/.weboob/backends"
.SH SEE ALSO
Home page: http://weboob.org/Boobank
.TH BOOBMSG 1 "09 December 2010"
.SH NAME
boobmsg
.SH SYNOPSIS
.B boobmsg
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B boobmsg
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Boobmsg is a console application to send messages on supported websites and to display messages threads and contents.
.SS Supported websites:
* aum (“Adopte un mec” french dating website)
.br
* bouygues (Bouygues french mobile phone provider)
.br
* dlfp (Da Linux French Page)
.br
* fourchan (4chan website)
.br
* newsfeed (Loads RSS and Atom feeds from any website)
.br
* orange (Orange french mobile phone provider)
.br
* sfr (SFR french mobile phone provider)
.SH BOOBMSG COMMANDS
.TP
\fBlist\fR
.br
Display all threads.
.TP
\fBpost\fR \fIRECEIVER\fR@\fIBACKEND\fR[,\fIRECEIVER\fR@\fIBACKEND\fR[...]] [\fITEXT\fR]
.br
Post a message to the specified receivers.
.br
Multiple receivers are separated by a comma.
.br
.br
If no text is supplied on command line, the content of message is read on stdin.
.TP
\fBshow\fR \fIMESSAGE\fR
.br
Read a message
.TP
\fBstatus\fR
.br
Display status information about a backend.
.SH WEBOOB COMMANDS
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br
.br
ACTION is one of the following (default: list):
.br
* enable enable given backends
.br
* disable disable given backends
.br
* only enable given backends and disable the others
.br
* list display enabled and available backends
.br
* add add a backend
.br
* register register a new account on a website
.br
* edit edit a backend
.br
* remove remove a backend
.TP
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
If an argument is given, set the condition expression used to filter the results.
.br
If the "off" value is given, conditional filtering is disabled.
.br
.br
If no argument is given, print the current condition expression.
.TP
\fBcount\fR [\fINUMBER\fR | off]
.br
If an argument is given, set the maximum number of results fetched.
.br
NUMBER must be at least 1.
.br
"off" value disables counting, and allows infinite searches.
.br
.br
If no argument is given, print the current count value.
.TP
\fBformatter\fR [list | \fIFORMATTER\fR [\fICOMMAND\fR] | option \fIOPTION_NAME\fR [on | off]]
.br
If a FORMATTER is given, set the formatter to use.
.br
You can add a COMMAND to apply the formatter change only to
.br
a given command.
.br
.br
If the argument is "list", print the available formatters.
.br
.br
If the argument is "option", set the formatter options.
.br
Valid options are: header, keys.
.br
If on/off value is given, set the value of the option.
.br
If not, print the current value for the option.
.br
.br
If no argument is given, print the current formatter.
.TP
\fBinspect\fR \fIBACKEND_NAME\fR
.br
Display the HTML string of the current page of the specified backend's browser.
.br
.br
If webkit_mechanize_browser Python module is installed, HTML is displayed in a WebKit GUI.
.TP
\fBlogging\fR [\fILEVEL\fR]
.br
Set logging level.
.br
.br
Availables: debug, info, warning, error.
.br
* quiet is an alias for error
.br
* default is an alias for warning
.TP
\fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full"
.br
If an argument is given, set the selected fields.
.br
$direct selects all fields loaded in one http request.
.br
$full selects all fields using as much http requests as necessary.
.br
.br
If no argument is given, print the currently selected fields.
.TP
\fBquit\fR
.br
Quit the application.
.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
what backend(s) to enable (comma separated)
.SH BOOBMSG OPTIONS
.TP
\fB\-e\fR, \fB\-\-skip\-empty\fR
Don't send messages with an empty body.
.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
display debug messages
.TP
\fB\-q\fR, \fB\-\-quiet\fR
display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.TP
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
.TP
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
filter result items to display given a boolean expression
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
get a maximum number of results (all backends merged)
.TP
\fB\-s SELECT\fR, \fB\-\-select=SELECT\fR
select result item keys to display (comma separated)
.SH FORMATTING OPTIONS
.TP
\fB\-f FORMATTER\fR, \fB\-\-formatter=FORMATTER\fR
select output formatter (csv, htmltable, msg, msglist, multiline, simple, table,
webkit)
.TP
\fB\-\-no\-header\fR
do not display header
.TP
\fB\-\-no\-keys\fR
do not display item keys
.SH COPYRIGHT
Copyright(C) 2010 Christophe Benz
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"
.SH SEE ALSO
Home page: http://weboob.org/Boobmsg
.TH CHATOOB 1 "02 August 2010"
.TH CHATOOB 1 "09 December 2010"
.SH NAME
chatoob \- Chat client
chatoob
.SH SYNOPSIS
.B chatoob
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..]
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B chatoob
[\-\-version] [\-\-help]
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
Chatoob is a console application which loads the configured \fIICapChat\fR backends
to list contacts, send messages and display received ones.
Chatoob is a console application to chat with contacts.
.SH COMMANDS
.SS Supported websites:
* aum (“Adopte un mec” french dating website)
.SH CHATOOB COMMANDS
.TP
\fBlist\fR
list online contacts
.br
List all contacts.
.TP
\fBmessages\fR
list received messages
.br
Get messages.
.TP
\fBsend\fR \fIid\fR \fImessage\fR
send a message to a contact
\fBsend\fR \fICONTACT\fR \fIMESSAGE\fR
.br
Send a message to the specified contact.
.SH WEBOOB COMMANDS
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br
.SH OPTIONS
.SS Results options
.br
ACTION is one of the following (default: list):
.br
* enable enable given backends
.br
* disable disable given backends
.br
* only enable given backends and disable the others
.br
* list display enabled and available backends
.br
* add add a backend
.br
* register register a new account on a website
.br
* edit edit a backend
.br
* remove remove a backend
.TP
\fB\-c\fR, \fB\-\-condition\fR \fICONDITION\fR
filter result items to display given a boolean condition
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
If an argument is given, set the condition expression used to filter the results.
.br
If the "off" value is given, conditional filtering is disabled.
.br
.br
If no argument is given, print the current condition expression.
.TP
\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
get a maximum number of results (all backends merged)
\fBcount\fR [\fINUMBER\fR | off]
.br
If an argument is given, set the maximum number of results fetched.
.br
NUMBER must be at least 1.
.br
"off" value disables counting, and allows infinite searches.
.br
.br
If no argument is given, print the current count value.
.TP
\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
select the output formatter (htmltable,multiline,simple,table,webkit)
\fBformatter\fR [list | \fIFORMATTER\fR [\fICOMMAND\fR] | option \fIOPTION_NAME\fR [on | off]]
.br
If a FORMATTER is given, set the formatter to use.
.br
You can add a COMMAND to apply the formatter change only to
.br
a given command.
.br
.br
If the argument is "list", print the available formatters.
.br
.br
If the argument is "option", set the formatter options.
.br
Valid options are: header, keys.
.br
If on/off value is given, set the value of the option.
.br
If not, print the current value for the option.
.br
.br
If no argument is given, print the current formatter.
.TP
\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
select return field keys to display (comma separated)
\fBinspect\fR \fIBACKEND_NAME\fR
.br
Display the HTML string of the current page of the specified backend's browser.
.br
.br
If webkit_mechanize_browser Python module is installed, HTML is displayed in a WebKit GUI.
.TP
\fB\-\-no-header\fR
do not display header
\fBlogging\fR [\fILEVEL\fR]
.br
Set logging level.
.br
.br
Availables: debug, info, warning, error.
.br
* quiet is an alias for error
.br
* default is an alias for warning
.TP
\fB\-\-no-keys\fR
do not display field keys
.SS Logging options
\fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full"
.br
If an argument is given, set the selected fields.
.br
$direct selects all fields loaded in one http request.
.br
$full selects all fields using as much http requests as necessary.
.br
.br
If no argument is given, print the currently selected fields.
.TP
\fBquit\fR
.br
Quit the application.
.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
what backend(s) to enable (comma separated)
.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
display debug messages
......@@ -55,16 +159,34 @@ display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.SS Misc options
.TP
\fB\-b\fR, \fB\-\-backends\fR \fIbackends\fR
select backends to load
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
.TP
\fB\-\-version\fR
display version of \fIweboob-config\fR
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
.SH RESULTS OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show the help message and exit
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
filter result items to display given a boolean expression
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
get a maximum number of results (all backends merged)
.TP
\fB\-s SELECT\fR, \fB\-\-select=SELECT\fR
select result item keys to display (comma separated)
.SH FORMATTING OPTIONS
.TP
\fB\-f FORMATTER\fR, \fB\-\-formatter=FORMATTER\fR
select output formatter (csv, htmltable, multiline, simple, table, webkit)
.TP
\fB\-\-no\-header\fR
do not display header
.TP
\fB\-\-no\-keys\fR
do not display item keys
.SH COPYRIGHT
Copyright(C) 2010 Christophe Benz
......@@ -73,4 +195,7 @@ For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"
"~/.weboob/backends"
.SH SEE ALSO
Home page: http://weboob.org/Chatoob
.TH GEOLOOC 1 "09 December 2010"
.SH NAME
geolooc
.SH SYNOPSIS
.B geolooc
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B geolooc
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Geolooc is a console application to get geolocalization of IP addresses.
.SS Supported websites:
* geolocip (IP Adresses geolocalisation with the site www.geolocip.com)
.br
* ipinfodb (IP Adresses geolocalisation with the site ipinfodb.com)
.SH WEBOOB COMMANDS
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br
.br
ACTION is one of the following (default: list):
.br
* enable enable given backends
.br
* disable disable given backends
.br
* only enable given backends and disable the others
.br
* list display enabled and available backends
.br
* add add a backend
.br
* register register a new account on a website
.br
* edit edit a backend
.br
* remove remove a backend
.TP
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
If an argument is given, set the condition expression used to filter the results.
.br
If the "off" value is given, conditional filtering is disabled.
.br
.br
If no argument is given, print the current condition expression.
.TP
\fBcount\fR [\fINUMBER\fR | off]
.br
If an argument is given, set the maximum number of results fetched.
.br
NUMBER must be at least 1.
.br
"off" value disables counting, and allows infinite searches.
.br
.br
If no argument is given, print the current count value.
.TP
\fBformatter\fR [list | \fIFORMATTER\fR [\fICOMMAND\fR] | option \fIOPTION_NAME\fR [on | off]]
.br
If a FORMATTER is given, set the formatter to use.
.br
You can add a COMMAND to apply the formatter change only to
.br
a given command.
.br