generated manpages from make_man.py

man/boobank.1

@@ -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
+Boobank is a console application to get bank accounts, display history and do transfer operations.
-and display your accounts amount.
 
-.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
+\fBtransfer\fR \fIACCOUNT\fR [\fITO\fR \fIAMOUNT\fR [\fIREASON\fR]]
-display the coming operations on a specific account.
+.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
+\fB\-\-version\fR
-filter result items to display given a boolean condition
+show program's version number and exit
 .TP
-\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
+\fB\-h\fR, \fB\-\-help\fR
-get a maximum number of results (all backends merged)
+show this help message and exit
 .TP
-\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
+\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
-select the output formatter (htmltable,multiline,simple,table,webkit)
+what backend(s) to enable (comma separated)
-.TP
+
-\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
+.SH LOGGING OPTIONS
-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
 .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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-select backends to load
+file to save logs
 .TP
-\fB\-\-version\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-display version of \fIweboob-config\fR
+save every response
+
+.SH RESULTS OPTIONS
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
-show the help message and exit
+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

man/boobmsg.1

@@ -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

man/chatoob.1

@@ -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
+Chatoob is a console application to chat with contacts.
-to list contacts, send messages and display received ones.
 
-.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
+\fBsend\fR \fICONTACT\fR \fIMESSAGE\fR
-send a message to a contact
+.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
+\fB\-\-version\fR
-filter result items to display given a boolean condition
+show program's version number and exit
 .TP
-\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
+\fB\-h\fR, \fB\-\-help\fR
-get a maximum number of results (all backends merged)
+show this help message and exit
 .TP
-\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
+\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
-select the output formatter (htmltable,multiline,simple,table,webkit)
+what backend(s) to enable (comma separated)
-.TP
+
-\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
+.SH LOGGING OPTIONS
-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
 .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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-select backends to load
+file to save logs
 .TP
-\fB\-\-version\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-display version of \fIweboob-config\fR
+save every response
+
+.SH RESULTS OPTIONS
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
-show the help message and exit
+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

man/geolooc.1

@@ -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

man/havesex.1

@@ -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
+Havesex is a console application to interact with dating websites and to help you to seduce women.
-\fICapDating\fr backends.
 
-It helps draging on dating websites to have sex. It provides commands to have
+.SS Supported websites:
-interaction with girls, and some optimization services.
+* aum (“Adopte un mec” french dating website)
-
+.SH HAVESEX COMMANDS
-.SH COMMANDS
 .TP
-\fBprofile\fR \fIid\fR
+\fBoptim\fR [list | start | edit | stop] \fIBACKEND\fR [\fIOPTIM\fR1 [\fIOPTIM\fR2 ...]]
-display a slut profile
+.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
+\fBprofile\fR \fIID\fR
-start optimizations
+.br
+Display a profile
 .TP
-\fBstop\fR \fIoptimizations..\fR
+\fBquery\fR \fIID\fR
-stop optimizations
+.br
+Send a query to someone.
+.SH WEBOOB COMMANDS
+.TP
+\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
+.br
+Select used backends.
+.br
 
-.SH OPTIMIZATIONS
+.br
-Optimizations services are background tasks.
+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
+.br
-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.
+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
+.br
-This optimization is used to increase your visibility on website. It depends on each websites, so there isn't any explicit explanation.
+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
+.br
-The file \fI~/.weboob/havesex\fR is the configuration of \fBhavesex\fR:
+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
+.br
-[GLOBAL]
+If webkit_mechanize_browser Python module is installed, HTML is displayed in a WebKit GUI.
-# Optimizations to auto-enable
+.TP
-optimizations = PROFILE_WALKER VISIBILITY
+\fBlogging\fR [\fILEVEL\fR]
-.fi
+.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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-select backends to load
+file to save logs
 .TP
-\fB\-\-version\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-display version of \fIweboob-config\fR
+save every response
+
+.SH RESULTS OPTIONS
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
-show the help message and exit
+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/backends" 
- "~/.weboob/havesex"
+
+.SH SEE ALSO
+Home page: http://weboob.org/Havesex

man/monboob.1

@@ -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
+Monboob is a daemon to send messages on supported website by email, and can be used to send replies.
-and send them to an email address.
 
-Use the \fB-S\fR option to launch a SMTP server which relays mails to the backend
+.SS Supported websites:
-as a reply.
+* aum (“Adopte un mec” french dating website)
-
+.br
-The \fBpost\fR command can also be called to answer to a specific message.
+* bouygues (Bouygues french mobile phone provider)
-
+.br
-.SH COMMANDS
+* dlfp (Da Linux French Page)
-.TP
+.br
-\fBrun\fR
+* fourchan (4chan website)
-run the process (it does NOT put monboob in background)
+.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
+.br
-
+Pipe with a mail to post message.
-.SH CONFIGURATION
+.TP
-The file \fI~/.weboob/monboob\fR is the configuration of \fBmonboob\fR:
+\fBrun\fR
-
+.br
-.nf
+Run the fetching daemon.
-[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
 
 .SH OPTIONS
-.SS Monboob options
 .TP
-\fB\-S\fR, \fB\-\-smtpd\fR \fI[bind:]port\fR
+\fB\-\-version\fR
-run a SMTP server which relays each received mails to the backend
+show program's version number and exit
-.SS Logging options
+.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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-select backends to load
+file to save logs
 .TP
-\fB\-\-version\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-display version of \fIweboob-config\fR
+save every response
+
+.SH RESULTS OPTIONS
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
-show the help message and exit
+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/backends" 
- "~/.weboob/monboob"
+
+"~/.weboob/monboob"
+
+.SH SEE ALSO
+Home page: http://weboob.org/Monboob

man/qboobmsg.1

@@ -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
+QBoobMsg is a graphical application to read messages on supported website and reply to them.
-(which implement the \fIICapMessages\fR capability).
 
+.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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-select backends to load
+file to save logs
 .TP
-\fB\-\-version\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-display version of \fIweboob-config\fR
+save every response
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-show the help message and exit
 
 .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

man/qhavesex.1

@@ -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
+QHaveSex is a graphical application to interact with dating websites and help you to seduce women.
-drag girls, to send and receive messages, to chat with them, to plan
-dating, provides a calendar and some sexual statistics.
 
+.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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-select backends to load
+file to save logs
 .TP
-\fB\-\-version\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-display version of \fIweboob-config\fR
+save every response
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-show the help message and exit
 
 .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

man/qvideoob.1

@@ -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
+QVideoob is a graphical application to search videos on supported websites and play them.
-backends, and to get their meta data, including their direct URL, or to play
-them in an embedded frame.
 
+.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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-select backends to load
+file to save logs
 .TP
-\fB\-\-version\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-display version of \fIweboob-config\fR
+save every response
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-show the help message and exit
 
 .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

man/radioob.1

@@ -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

man/traveloob.1

@@ -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
+Traveloob is a console application to get timelines.
-station. It interacts with travel websites (train, airplanes, etc.).
 
-.SH COMMANDS
+.SS Supported websites:
+* canaltp (French trains)
+.br
+* transilien (Transports in Paris)
+.SH TRAVELOOB COMMANDS
 .TP
-\fBstations\fR \fIpattern\fR
+\fBdepartures\fR \fISTATION\fR [\fIARRIVAL\fR]
-search stations containing the specific pattern
+.br
+List all departures for a given station.
 .TP
-\fBdepartures\fR \fIstation\fR \fI[arrival]\fR
+\fBstations\fR \fIPATTERN\fR
-display the timeline of a specific station
+.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
+.br
-arrival station
+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
+\fB\-\-version\fR
-filter result items to display given a boolean condition
+show program's version number and exit
 .TP
-\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
+\fB\-h\fR, \fB\-\-help\fR
-get a maximum number of results (all backends merged)
+show this help message and exit
 .TP
-\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
+\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
-select the output formatter (htmltable,multiline,simple,table,webkit)
+what backend(s) to enable (comma separated)
-.TP
+
-\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
+.SH LOGGING OPTIONS
-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
 .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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-select backends to load
+file to save logs
 .TP
-\fB\-\-version\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-display version of \fIweboob-config\fR
+save every response
+
+.SH RESULTS OPTIONS
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
-show the help message and exit
+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

man/videoob-webserver.1

@@ -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
+.B videoob\-webserver
-[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..]
+[\-h] [\-dqv] [\-b \fIbackends\fR] ...
 .br
-.B videoob-webserver
+.B videoob\-webserver
-[\-\-version] [\-\-help]
+[\-\-help] [\-\-version]
-.SH DESCRIPTION
-.LP
-Weboob provides several applications to interact with a lot of websites.
 
-This webserver application can be used to search videos on supported
+.SH OPTIONS
-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
 .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"

man/videoob.1

@@ -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
+Videoob is a console application to search videos on supported websites and to play them or get informations.
-websites and to display information about them, including the direct link
-to the video file.
 
-.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
+\fBinfo\fR \fIID\fR
-search videos on the selected backends which match the specified pattern
+.br
+Get information about a video.
 .TP
-\fBinfo\fR \fIid\fR
+\fBnsfw\fR [on | off]
-get information about a video
+.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
+\fB\-\-version\fR
-return also results which are NSFW (Not Safe For Work)
+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
+.SH LOGGING OPTIONS
-.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
 .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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-select backends to load
+file to save logs
 .TP
-\fB\-\-version\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-display version of \fIweboob-config\fR
+save every response
+
+.SH RESULTS OPTIONS
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
-show the help message and exit
+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

man/webcontentedit.1

@@ -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

man/weboob-cli.1

@@ -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" 

man/weboob-config-qt.1

@@ -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
+.B weboob\-config\-qt
-[\-dqv]
+[\-h] [\-dqv] [\-b \fIbackends\fR] ...
 .br
-.B weboob-config-qt
+.B weboob\-config\-qt
-[\-\-version] [\-\-help]
+[\-\-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,
+weboob\-config\-qt is a graphical application to add/edit/remove backends, and to register new website accounts.
-and add/list/remove configured backends.
 
 .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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-display version of \fIweboob-config\fR
+file to save logs
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-show the help message and exit
+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

man/weboob-config.1

@@ -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
+.B weboob\-config
-[\-dqv] \fIcommand\fR [arguments..]
+[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
 .br
-.B weboob-config
+.B weboob\-config
-[\-\-version] [\-\-help]
+[\-\-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
+Weboob\-Config is a console application to add/edit/remove backends, and to register new website accounts.
-add/list/remove configured backends.
 
-.SH COMMANDS
+.SS Supported websites:
+
+.SH WEBOOB\-CONFIG COMMANDS
 .TP
-\fBadd\fR \fIbackend_name\fR \fI[options..]\fR
+\fBadd\fR \fINAME\fR [\fIOPTIONS\fR ...]
-add a configured backend. \fIbackend_name\fR is the name of the backend to add.
+.br
-To list available backends, use the \fIbackends\fR command.
+Add a configured backend.
-
-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.
 .TP
-\fBlistconfigured\fR
+\fBapplications\fR
-list every configured backends.
+.br
+Show applications.
 .TP
-\fBremove\fR \fIinstance_name\fR
+\fBconfirm\fR \fIBACKEND\fR
-remove a configured backend, by giving its instance name.
+.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
+.br
-(default is vim)
+Edit configuration file.
 .TP
-\fBbackends\fR \fI[caps..]\fR
+\fBinfo\fR \fINAME\fR
-list every available backends. You can filter by capabilities.
+.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:
+.br
-.nf
+If no argument is given, print the current condition expression.
-$ weboob-config backends ICapDating ICapMessages
-.fi
 .TP
-\fBinfo\fR \fIname\fR
+\fBcount\fR [\fINUMBER\fR | off]
-display information about a backend (name, author, descriptions, options, etc.)
+.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
+\fBformatter\fR [list | \fIFORMATTER\fR [\fICOMMAND\fR] | option \fIOPTION_NAME\fR [on | off]]
-list every weboob applications. You can filter by capabilities.
+.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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-display version of \fIweboob-config\fR
+file to save logs
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-show the help message and exit
+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" 

man/weboob-debug.1

@@ -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

man/weboorrents.1

@@ -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
+Weboorrents is a console application to search torrents on supported trackers and to download .torrent files.
-and to display information about them, and get the \fB.torrent\fR file.
 
-.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
+\fBgetfile\fR \fIID\fR \fIFILENAME\fR
-search torrents on the selected backends which match the specified pattern
+.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
+\fBinfo\fR \fIID\fR
-get information about a torrent
+.br
+Get information about a torrent.
 .TP
-\fBgetfile\fR \fIid\fR \fIdest\fR
+\fBsearch\fR [\fIPATTERN\fR]
-get the \fB.torrent\fR file of the specific torrent
+.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
+\fB\-\-version\fR
-filter result items to display given a boolean condition
+show program's version number and exit
 .TP
-\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
+\fB\-h\fR, \fB\-\-help\fR
-get a maximum number of results (all backends merged)
+show this help message and exit
 .TP
-\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
+\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
-select the output formatter (htmltable,multiline,simple,table,webkit)
+what backend(s) to enable (comma separated)
-.TP
+
-\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
+.SH LOGGING OPTIONS
-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
 .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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-select backends to load
+file to save logs
 .TP
-\fB\-\-version\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-display version of \fIweboob-config\fR
+save every response
+
+.SH RESULTS OPTIONS
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
-show the help message and exit
+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

man/wetboobs.1

@@ -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
+Wetboobs is a console application to display weather and forecasts in your city.
-the forecasts.
 
-.SH COMMANDS
+.SS Supported websites:
+* meteofrance (Get forecasts from the MeteoFrance website)
+.br
+* yahoo (Yahoo)
+.SH WETBOOBS COMMANDS
 .TP
-\fBsearch\fR \fIpattern\fR
+\fBcurrent\fR \fICITY_ID\fR
-search city IDs from a pattern
+.br
+Get current weather for specified city. Use the 'search' command to find
+.br
+its ID.
 .TP
-\fBcurrent\fR \fIcity\fR
+\fBforecasts\fR \fICITY_ID\fR
-view the current weather of a specified city (from its ID)
+.br
+Get forecasts for specified city. Use the 'search' command to find
+.br
+its ID.
 .TP
-\fBforecasts\fR \fIcity\fR
+\fBsearch\fR \fIPATTERN\fR
-display forecasts of a specified city (from its ID)
+.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
+\fB\-\-version\fR
-filter result items to display given a boolean condition
+show program's version number and exit
 .TP
-\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
+\fB\-h\fR, \fB\-\-help\fR
-get a maximum number of results (all backends merged)
+show this help message and exit
 .TP
-\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
+\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
-select the output formatter (htmltable,multiline,simple,table,webkit)
+what backend(s) to enable (comma separated)
-.TP
+
-\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
+.SH LOGGING OPTIONS
-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
 .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
+\fB\-\-logging\-file=LOGGING_FILE\fR
-select backends to load
+file to save logs
 .TP
-\fB\-\-version\fR
+\fB\-a\fR, \fB\-\-save\-responses\fR
-display version of \fIweboob-config\fR
+save every response
+
+.SH RESULTS OPTIONS
 .TP
-\fB\-h\fR, \fB\-\-help\fR
+\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
-show the help message and exit
+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