generated manpages from make_man.py

This commit is contained in:
Romain Bignon 2010-12-09 12:04:39 +01:00
commit 8caeab8853
20 changed files with 2706 additions and 441 deletions

View file

@ -1,48 +1,183 @@
.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
.br
If you give only the ACCOUNT parameter, it lists all the
.br
available recipients for this account.
.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
.SS Results options
.TP
\fB\-c\fR, \fB\-\-condition\fR \fICONDITION\fR
filter result items to display given a boolean condition
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
get a maximum number of results (all backends merged)
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
select the output formatter (htmltable,multiline,simple,table,webkit)
.TP
\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
select return field keys to display (comma separated)
.TP
\fB\-\-no-header\fR
do not display header
.TP
\fB\-\-no-keys\fR
do not display field keys
.SS Logging options
\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

229
man/boobmsg.1 Normal file
View file

@ -0,0 +1,229 @@
.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

View file

@ -1,51 +1,155 @@
.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
.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
.SS Results options
.TP
\fB\-c\fR, \fB\-\-condition\fR \fICONDITION\fR
filter result items to display given a boolean condition
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
get a maximum number of results (all backends merged)
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
select the output formatter (htmltable,multiline,simple,table,webkit)
.TP
\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
select return field keys to display (comma separated)
.TP
\fB\-\-no-header\fR
do not display header
.TP
\fB\-\-no-keys\fR
do not display field keys
.SS Logging options
\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

190
man/geolooc.1 Normal file
View file

@ -0,0 +1,190 @@
.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
.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 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, 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 Romain Bignon
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"
.SH SEE ALSO
Home page: http://weboob.org/Geolooc

View file

@ -1,57 +1,171 @@
.TH HAVESEX 1 "02 August 2010"
.TH HAVESEX 1 "09 December 2010"
.SH NAME
havesex \- Interact with dating websites
havesex
.SH SYNOPSIS
.B havesex
[\-dqv] [\-b \fIbackends\fR]
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B havesex
[\-\-version] [\-\-help]
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
Havesex is a console interactive application which loads the configured
\fICapDating\fr backends.
Havesex is a console application to interact with dating websites and to help you to seduce women.
It helps draging on dating websites to have sex. It provides commands to have
interaction with girls, and some optimization services.
.SH COMMANDS
.SS Supported websites:
* aum (“Adopte un mec” french dating website)
.SH HAVESEX COMMANDS
.TP
\fBprofile\fR \fIid\fR
display a slut profile
\fBoptim\fR [list | start | edit | stop] \fIBACKEND\fR [\fIOPTIM\fR1 [\fIOPTIM\fR2 ...]]
.br
All dating backends offer optimization services. This command can be
.br
manage them.
.br
Use * us BACKEND value to apply command to all backends.
.br
.br
Commands:
.br
* list list all available optimizations of a backend
.br
* start start optimization services on a backend
.br
* edit configure an optimization service for a backend
.br
* stop stop optimization services on a backend
.TP
\fBstart\fR \fIoptimizations..\fR
start optimizations
\fBprofile\fR \fIID\fR
.br
Display a profile
.TP
\fBstop\fR \fIoptimizations..\fR
stop optimizations
\fBquery\fR \fIID\fR
.br
Send a query to someone.
.SH WEBOOB COMMANDS
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br
.SH OPTIMIZATIONS
Optimizations services are background tasks.
.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
.SS PROFILE_WALKER
This optimization service is used to walk on profiles. It is usefull to show girls you exist, when they can see who visite their profile.
.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
Note that in future, it will be associated with the SCORING optimization service.
.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
.SS VISIBILITY
This optimization is used to increase your visibility on website. It depends on each websites, so there isn't any explicit explanation.
.br
If the argument is "list", print the available formatters.
.br
For example, the AuM backend will reconnects to website every five minutes to go back on top research results.
.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
.SH CONFIGURATION
The file \fI~/.weboob/havesex\fR is the configuration of \fBhavesex\fR:
.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
.nf
[GLOBAL]
# Optimizations to auto-enable
optimizations = PROFILE_WALKER VISIBILITY
.fi
.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
.SS Logging 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
@ -61,16 +175,35 @@ 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, profile, 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 Romain Bignon
@ -79,5 +212,7 @@ For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"
"~/.weboob/havesex"
"~/.weboob/backends"
.SH SEE ALSO
Home page: http://weboob.org/Havesex

View file

@ -1,55 +1,59 @@
.TH MONBOOB 1 "02 August 2010"
.TH MONBOOB 1 "09 December 2010"
.SH NAME
monboob \- Get messages in your Mail User Agent and answer
monboob
.SH SYNOPSIS
.B monboob
[\-dqv] [\-b \fIbackends\fR] [\-S \fIport\fR] \fIcommand\fR [arguments..]
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B monboob
[\-\-version] [\-\-help]
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
Monboob is a daemon application which retrieves every X seconds new messages
and send them to an email address.
Monboob is a daemon to send messages on supported website by email, and can be used to send replies.
Use the \fB-S\fR option to launch a SMTP server which relays mails to the backend
as a reply.
The \fBpost\fR command can also be called to answer to a specific message.
.SH COMMANDS
.TP
\fBrun\fR
run the process (it does NOT put monboob in background)
.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 MONBOOB COMMANDS
.TP
\fBpost\fR
pipe a mail with this command to parse it and post the reply to the equivalent backend
.SH CONFIGURATION
The file \fI~/.weboob/monboob\fR is the configuration of \fBmonboob\fR:
.nf
[DEFAULT]
# Interval to check new messages
interval = 300
# Domain of the *From:* email address
domain = weboob.example.com
# Recipient of emails
recipient = romain@example.com
# SMTP server to use
smtp = mail.example.org
# Send emails in HTML or in plaintext
html = 0
.fi
.br
Pipe with a mail to post message.
.TP
\fBrun\fR
.br
Run the fetching daemon.
.SH OPTIONS
.SS Monboob options
.TP
\fB\-S\fR, \fB\-\-smtpd\fR \fI[bind:]port\fR
run a SMTP server which relays each received mails to the backend
.SS Logging options
\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 MONBOOB OPTIONS
.TP
\fB\-S SMTPD\fR, \fB\-\-smtpd=SMTPD\fR
run a fake smtpd server and set the port
.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
display debug messages
@ -59,16 +63,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 Romain Bignon
@ -77,5 +99,9 @@ For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"
"~/.weboob/monboob"
"~/.weboob/backends"
"~/.weboob/monboob"
.SH SEE ALSO
Home page: http://weboob.org/Monboob

View file

@ -1,21 +1,44 @@
.TH QBOOBMSG 1 "02 August 2010"
.TH QBOOBMSG 1 "09 December 2010"
.SH NAME
qboobmsg \- View messages and reply (Qt Application)
qboobmsg
.SH SYNOPSIS
.B qboobmsg
[\-dqv] [\-b \fIbackends\fR]
[\-h] [\-dqv] [\-b \fIbackends\fR] ...
.br
.B qboobmsg
[\-\-version] [\-\-help]
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
This graphical application displays every messages for the selected backends
(which implement the \fIICapMessages\fR capability).
QBoobMsg is a graphical application to read messages on supported website and reply to them.
.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 OPTIONS
.SS Logging 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
@ -25,16 +48,12 @@ 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
.TP
\fB\-h\fR, \fB\-\-help\fR
show the help message and exit
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
.SH COPYRIGHT
Copyright(C) 2010 Romain Bignon
@ -43,4 +62,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/Qboobmsg

View file

@ -1,22 +1,32 @@
.TH QHAVESEX 1 "02 August 2010"
.TH QHAVESEX 1 "09 December 2010"
.SH NAME
qhavesex \- View messages and reply (Qt Application)
qhavesex
.SH SYNOPSIS
.B qhavesex
[\-dqv] [\-b \fIbackends\fR]
[\-h] [\-dqv] [\-b \fIbackends\fR] ...
.br
.B qhavesex
[\-\-version] [\-\-help]
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
This graphical application interacts with dating websites to help you to
drag girls, to send and receive messages, to chat with them, to plan
dating, provides a calendar and some sexual statistics.
QHaveSex is a graphical application to interact with dating websites and help you to seduce women.
.SS Supported websites:
* aum (“Adopte un mec” french dating website)
.SH OPTIONS
.SS Logging 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
@ -26,16 +36,12 @@ 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
.TP
\fB\-h\fR, \fB\-\-help\fR
show the help message and exit
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
.SH COPYRIGHT
Copyright(C) 2010 Romain Bignon
@ -44,4 +50,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/Qhavesex

View file

@ -1,22 +1,42 @@
.TH QVIDEOOB 1 "02 August 2010"
.TH QVIDEOOB 1 "09 December 2010"
.SH NAME
qvideoob \- Search and play videos
qvideoob
.SH SYNOPSIS
.B qvideoob
[\-dqv] [\-b \fIbackends\fR]
[\-h] [\-dqv] [\-b \fIbackends\fR] ...
.br
.B qvideoob
[\-\-version] [\-\-help]
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
This graphical application can be used to search videos on \fIICapVideo\fR
backends, and to get their meta data, including their direct URL, or to play
them in an embedded frame.
QVideoob is a graphical application to search videos on supported websites and play them.
.SS Supported websites:
* arte (Arte french TV)
.br
* canalplus (Canal plus french TV)
.br
* ina (INA french video archives)
.br
* youjizz (Youjizz videos website)
.br
* youporn (Youporn videos website)
.br
* youtube (Youtube videos website)
.SH OPTIONS
.SS Logging 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
@ -26,16 +46,12 @@ 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
.TP
\fB\-h\fR, \fB\-\-help\fR
show the help message and exit
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
.SH COPYRIGHT
Copyright(C) 2010 Romain Bignon
@ -44,4 +60,9 @@ For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"
"~/.weboob/backends"
"~/.weboob/qvideoob"
.SH SEE ALSO
Home page: http://weboob.org/Qvideoob

206
man/radioob.1 Normal file
View file

@ -0,0 +1,206 @@
.TH RADIOOB 1 "09 December 2010"
.SH NAME
radioob
.SH SYNOPSIS
.B radioob
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B radioob
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Radioob is a console application to list radios, play them and get informations like the current song.
.SS Supported websites:
* ouifm (The Ouï FM french radio)
.SH RADIOOB COMMANDS
.TP
\fBinfo\fR \fIID\fR
.br
Get information about a radio.
.TP
\fBlist\fR [\fIPATTERN\fR]
.br
List radios matching a PATTERN.
.br
.br
If PATTERN is not given, this command will list all the radios.
.TP
\fBplay\fR \fIID\fR
.br
Play a radio with a found player.
.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 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, multiline, radio_list, 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 Romain Bignon
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"
.SH SEE ALSO
Home page: http://weboob.org/Radioob

View file

@ -1,51 +1,153 @@
.TH TRAVELOOB 1 "02 August 2010"
.TH TRAVELOOB 1 "09 December 2010"
.SH NAME
traveloob \- Transport informations
traveloob
.SH SYNOPSIS
.B traveloob
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..]
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B traveloob
[\-\-version] [\-\-help]
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
This console application can be used to look at timelines of a specific
station. It interacts with travel websites (train, airplanes, etc.).
Traveloob is a console application to get timelines.
.SH COMMANDS
.SS Supported websites:
* canaltp (French trains)
.br
* transilien (Transports in Paris)
.SH TRAVELOOB COMMANDS
.TP
\fBstations\fR \fIpattern\fR
search stations containing the specific pattern
\fBdepartures\fR \fISTATION\fR [\fIARRIVAL\fR]
.br
List all departures for a given station.
.TP
\fBdepartures\fR \fIstation\fR \fI[arrival]\fR
display the timeline of a specific station
\fBstations\fR \fIPATTERN\fR
.br
Search stations.
.SH WEBOOB COMMANDS
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br
it's possible to specify only the departures for a specific
arrival station
.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
.SS Results options
.TP
\fB\-c\fR, \fB\-\-condition\fR \fICONDITION\fR
filter result items to display given a boolean condition
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
get a maximum number of results (all backends merged)
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
select the output formatter (htmltable,multiline,simple,table,webkit)
.TP
\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
select return field keys to display (comma separated)
.TP
\fB\-\-no-header\fR
do not display header
.TP
\fB\-\-no-keys\fR
do not display field keys
.SS Logging options
\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 +157,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 Romain Bignon
@ -73,4 +193,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/Traveloob

View file

@ -1,30 +1,40 @@
.TH VIDEOOB-WEBSERVER 1 "12 October 2010"
.TH VIDEOOB-WEBSERVER 1 "09 December 2010"
.SH NAME
videoob-webserver \- Video search and information, WSGI webserver
videoob-webserver
.SH SYNOPSIS
.B videoob-webserver
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..]
.B videoob\-webserver
[\-h] [\-dqv] [\-b \fIbackends\fR] ...
.br
.B videoob-webserver
[\-\-version] [\-\-help]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
.B videoob\-webserver
[\-\-help] [\-\-version]
This webserver application can be used to search videos on supported
websites and to display information about them, including the direct link
to the video file.
.SS Misc options
.TP
\fB\-b\fR, \fB\-\-backends\fR \fIbackends\fR
select backends to load
.SH OPTIONS
.TP
\fB\-\-version\fR
display version of \fIweboob-config\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show the help message and exit
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
.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 COPYRIGHT
Copyright(C) 2010 Christophe Benz
@ -33,4 +43,6 @@ For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"
"~/.weboob/backends"
"~/.weboob/videoob-webserver"

View file

@ -1,55 +1,177 @@
.TH VIDEOOB 1 "02 August 2010"
.TH VIDEOOB 1 "09 December 2010"
.SH NAME
videoob \- Video search and information
videoob
.SH SYNOPSIS
.B videoob
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..]
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B videoob
[\-\-version] [\-\-help]
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
This console application can be used to search videos on supported
websites and to display information about them, including the direct link
to the video file.
Videoob is a console application to search videos on supported websites and to play them or get informations.
.SH COMMANDS
.SS Supported websites:
* arte (Arte french TV)
.br
* canalplus (Canal plus french TV)
.br
* ina (INA french video archives)
.br
* youjizz (Youjizz videos website)
.br
* youporn (Youporn videos website)
.br
* youtube (Youtube videos website)
.SH VIDEOOB COMMANDS
.TP
\fBsearch\fR \fIpattern\fR
search videos on the selected backends which match the specified pattern
\fBinfo\fR \fIID\fR
.br
Get information about a video.
.TP
\fBinfo\fR \fIid\fR
get information about a video
\fBnsfw\fR [on | off]
.br
If argument is given, enable or disable the non\-suitable for work behavior.
.br
.br
If no argument is given, print the current behavior.
.TP
\fBplay\fR \fIID\fR
.br
Play a video with a found player.
.TP
\fBsearch\fR [\fIPATTERN\fR]
.br
Search for videos matching a PATTERN.
.br
.br
If PATTERN is not given, this command will search for the latest videos.
.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
.SS Videoob options
.TP
\fB\-\-nsfw\fR
return also results which are NSFW (Not Safe For Work)
\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)
when this option isn't set, the adult content results are omitted
.SS Results options
.TP
\fB\-c\fR, \fB\-\-condition\fR \fICONDITION\fR
filter result items to display given a boolean condition
.TP
\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
get a maximum number of results (all backends merged)
.TP
\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
select the output formatter (htmltable,multiline,simple,table,webkit)
.TP
\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
select return field keys to display (comma separated)
.TP
\fB\-\-no-header\fR
do not display header
.TP
\fB\-\-no-keys\fR
do not display field keys
.SS Logging options
.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
display debug messages
@ -59,22 +181,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 (csv, htmltable, multiline, simple, table, video_list,
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, Romain Bignon
Copyright(C) 2010 Christophe Benz, Romain Bignon, John Obbele
.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/Videoob

193
man/webcontentedit.1 Normal file
View file

@ -0,0 +1,193 @@
.TH WEBCONTENTEDIT 1 "09 December 2010"
.SH NAME
webcontentedit
.SH SYNOPSIS
.B webcontentedit
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B webcontentedit
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Webcontentedit is a console application to display and edit contents on supported websites.
.SS Supported websites:
* redmine (The Redmine project management web application)
.SH WEBCONTENTEDIT COMMANDS
.TP
\fBedit\fR \fIID\fR
.br
Edit a content with $EDITOR, then push it on the website.
.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 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, 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 Romain Bignon
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"
.SH SEE ALSO
Home page: http://weboob.org/Webcontentedit

76
man/weboob-cli.1 Normal file
View file

@ -0,0 +1,76 @@
.TH WEBOOB-CLI 1 "09 December 2010"
.SH NAME
weboob-cli
.SH SYNOPSIS
.B weboob\-cli
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcapability\fR \fImethod\fR [\fIarguments\fR..]
.br
.B weboob\-cli
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob\-Cli is a console application to call a specific method on backends which implement the given capability.
.SS Supported websites:
.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
.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, 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 Romain Bignon
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"

View file

@ -1,21 +1,30 @@
.TH WEBOOB-CONFIG-QT 1 "02 August 2010"
.TH WEBOOB-CONFIG-QT 1 "09 December 2010"
.SH NAME
weboob-config-qt \- Weboob configuration (Qt Application)
weboob-config-qt
.SH SYNOPSIS
.B weboob-config-qt
[\-dqv]
.B weboob\-config\-qt
[\-h] [\-dqv] [\-b \fIbackends\fR] ...
.br
.B weboob-config-qt
[\-\-version] [\-\-help]
.B weboob\-config\-qt
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
This graphical application is used to configure weboob. You can list backends,
and add/list/remove configured backends.
weboob\-config\-qt is a graphical application to add/edit/remove backends, and to register new website accounts.
.SH OPTIONS
.SS Logging 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
@ -25,13 +34,12 @@ display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.SS Misc options
.TP
\fB\-\-version\fR
display version of \fIweboob-config\fR
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
.TP
\fB\-h\fR, \fB\-\-help\fR
show the help message and exit
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
.SH COPYRIGHT
Copyright(C) 2010 Romain Bignon
@ -40,4 +48,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/Qweboobcfg

View file

@ -1,57 +1,163 @@
.TH WEBOOB-CONFIG 1 "02 August 2010"
.TH WEBOOB-CONFIG 1 "09 December 2010"
.SH NAME
weboob-config \- Weboob configuration
weboob-config
.SH SYNOPSIS
.B weboob-config
[\-dqv] \fIcommand\fR [arguments..]
.B weboob\-config
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B weboob-config
[\-\-version] [\-\-help]
.B weboob\-config
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
This application is used to configure weboob. You can list backends, and
add/list/remove configured backends.
Weboob\-Config is a console application to add/edit/remove backends, and to register new website accounts.
.SH COMMANDS
.SS Supported websites:
.SH WEBOOB\-CONFIG COMMANDS
.TP
\fBadd\fR \fIbackend_name\fR \fI[options..]\fR
add a configured backend. \fIbackend_name\fR is the name of the backend to add.
To list available backends, use the \fIbackends\fR command.
The options are specific to the backend. Use the \fIinfo\fR command to list
them for a backend.
If you don't specify any options, \fBweboob-config\fR prompts you for each
available options.
\fBadd\fR \fINAME\fR [\fIOPTIONS\fR ...]
.br
Add a configured backend.
.TP
\fBlistconfigured\fR
list every configured backends.
\fBapplications\fR
.br
Show applications.
.TP
\fBremove\fR \fIinstance_name\fR
remove a configured backend, by giving its instance name.
\fBconfirm\fR \fIBACKEND\fR
.br
For a backend which support CapAccount, parse a confirmation mail
.br
after using the 'register' command to automatically confirm the
.br
subscribe.
.br
.br
It takes mail from stdin. Use it with postfix for example.
.TP
\fBedit\fR
edit the configuration files of instanced backends with your favorite editor
(default is vim)
.br
Edit configuration file.
.TP
\fBbackends\fR \fI[caps..]\fR
list every available backends. You can filter by capabilities.
\fBinfo\fR \fINAME\fR
.br
Display information about a backend.
.TP
\fBlist\fR
.br
Show configured backends.
.TP
\fBregister\fR \fINAME\fR
.br
Register a new account on a backend.
.TP
\fBremove\fR \fINAME\fR
.br
Remove a configured backend.
.SH WEBOOB COMMANDS
.TP
\fBbackends\fR [\fICAPS\fR ...]
.br
Show available backends.
.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
Example:
.nf
$ weboob-config backends ICapDating ICapMessages
.fi
.br
If no argument is given, print the current condition expression.
.TP
\fBinfo\fR \fIname\fR
display information about a backend (name, author, descriptions, options, etc.)
\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
\fBapplications\fR \fI[caps..]\fR
list every weboob applications. You can filter by capabilities.
\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
.SS Logging 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
@ -61,13 +167,34 @@ display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.SS Misc options
.TP
\fB\-\-version\fR
display version of \fIweboob-config\fR
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
.TP
\fB\-h\fR, \fB\-\-help\fR
show the help message and exit
\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, 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, Romain Bignon
@ -76,4 +203,4 @@ For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"
"~/.weboob/backends"

193
man/weboob-debug.1 Normal file
View file

@ -0,0 +1,193 @@
.TH WEBOOB-DEBUG 1 "09 December 2010"
.SH NAME
weboob-debug
.SH SYNOPSIS
.B weboob\-debug
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B weboob\-debug
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob\-Debug is a console application to debug backends.
.SS Supported websites:
.SH WEBOOBDEBUG COMMANDS
.TP
\fBshell\fR \fIBACKEND\fR
.br
Debug 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 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, 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/Weboobdebug

View file

@ -1,53 +1,165 @@
.TH WEBOORRENTS 1 "02 August 2010"
.TH WEBOORRENTS 1 "09 December 2010"
.SH NAME
weboorrents \- Torrents search and get
weboorrents
.SH SYNOPSIS
.B weboorrents
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..]
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B weboorrents
[\-\-version] [\-\-help]
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
This console application can be used to search torrents on support trackers
and to display information about them, and get the \fB.torrent\fR file.
Weboorrents is a console application to search torrents on supported trackers and to download .torrent files.
.SH COMMANDS
.SS Supported websites:
* gazelle (gazelle bittorrent tracker)
.br
* isohunt (isohunt.com bittorrent tracker)
.br
* kickass (kickasstorrent.com bittorrent tracker)
.br
* piratebay (the pirate bay bittorrent tracker)
.SH WEBOORRENTS COMMANDS
.TP
\fBsearch\fR \fIpattern\fR
search torrents on the selected backends which match the specified pattern
\fBgetfile\fR \fIID\fR \fIFILENAME\fR
.br
Get the .torrent file.
.br
FILENAME is where to write the file. If FILENAME is '\-',
.br
the file is written to stdout.
.TP
\fBinfo\fR \fIid\fR
get information about a torrent
\fBinfo\fR \fIID\fR
.br
Get information about a torrent.
.TP
\fBgetfile\fR \fIid\fR \fIdest\fR
get the \fB.torrent\fR file of the specific torrent
\fBsearch\fR [\fIPATTERN\fR]
.br
Search torrents.
.SH WEBOOB COMMANDS
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br
the file is sent to output if \fIdest\fR is '-'
.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
.SS Results options
.TP
\fB\-c\fR, \fB\-\-condition\fR \fICONDITION\fR
filter result items to display given a boolean condition
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
get a maximum number of results (all backends merged)
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
select the output formatter (htmltable,multiline,simple,table,webkit)
.TP
\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
select return field keys to display (comma separated)
.TP
\fB\-\-no-header\fR
do not display header
.TP
\fB\-\-no-keys\fR
do not display field keys
.SS Logging options
\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
@ -57,16 +169,35 @@ 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, torrent_info,
torrent_list, 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
@ -75,4 +206,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/Weboorrents

View file

@ -1,51 +1,161 @@
.TH WETBOOBS 1 "02 August 2010"
.TH WETBOOBS 1 "09 December 2010"
.SH NAME
wetboobs \- View weather
wetboobs
.SH SYNOPSIS
.B wetboobs
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..]
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B wetboobs
[\-\-version] [\-\-help]
[\-\-help] [\-\-version]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
This console application can be used to view the current weather and
the forecasts.
Wetboobs is a console application to display weather and forecasts in your city.
.SH COMMANDS
.SS Supported websites:
* meteofrance (Get forecasts from the MeteoFrance website)
.br
* yahoo (Yahoo)
.SH WETBOOBS COMMANDS
.TP
\fBsearch\fR \fIpattern\fR
search city IDs from a pattern
\fBcurrent\fR \fICITY_ID\fR
.br
Get current weather for specified city. Use the 'search' command to find
.br
its ID.
.TP
\fBcurrent\fR \fIcity\fR
view the current weather of a specified city (from its ID)
\fBforecasts\fR \fICITY_ID\fR
.br
Get forecasts for specified city. Use the 'search' command to find
.br
its ID.
.TP
\fBforecasts\fR \fIcity\fR
display forecasts of a specified city (from its ID)
\fBsearch\fR \fIPATTERN\fR
.br
Search cities.
.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
.SS Results options
.TP
\fB\-c\fR, \fB\-\-condition\fR \fICONDITION\fR
filter result items to display given a boolean condition
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
get a maximum number of results (all backends merged)
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
select the output formatter (htmltable,multiline,simple,table,webkit)
.TP
\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
select return field keys to display (comma separated)
.TP
\fB\-\-no-header\fR
do not display header
.TP
\fB\-\-no-keys\fR
do not display field keys
.SS Logging options
\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 +165,35 @@ 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 (cities, csv, current, forecasts, 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 Romain Bignon
@ -73,4 +202,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/Wetboobs