From b38782f1179d0aca70509592804ae17f5dd41f60 Mon Sep 17 00:00:00 2001 From: Romain Bignon Date: Sun, 8 May 2011 17:26:20 +0200 Subject: [PATCH] regenerate manpages --- man/boobank.1 | 36 +++--- man/boobathon.1 | 258 ++++++++++++++++++++++++++++++++++++++++ man/boobmsg.1 | 20 +++- man/chatoob.1 | 20 +++- man/galleroob.1 | 221 ++++++++++++++++++++++++++++++++++ man/geolooc.1 | 24 ++-- man/havesex.1 | 20 +++- man/masstransit.1 | 2 +- man/monboob.1 | 4 +- man/pastoob.1 | 212 +++++++++++++++++++++++++++++++++ man/qboobmsg.1 | 4 +- man/qhavesex.1 | 4 +- man/qvideoob.1 | 6 +- man/qwebcontentedit.1 | 4 +- man/radioob.1 | 34 ++++-- man/traveloob.1 | 20 +++- man/videoob-webserver.1 | 21 +++- man/videoob.1 | 20 +++- man/webcontentedit.1 | 20 +++- man/weboob-cli.1 | 2 +- man/weboob-config-qt.1 | 2 +- man/weboob-config.1 | 105 +++------------- man/weboob-debug.1 | 18 ++- man/weboorrents.1 | 20 +++- man/wetboobs.1 | 20 +++- 25 files changed, 926 insertions(+), 191 deletions(-) create mode 100644 man/boobathon.1 create mode 100644 man/galleroob.1 create mode 100644 man/pastoob.1 diff --git a/man/boobank.1 b/man/boobank.1 index 872b1dfbcf..df82b19542 100644 --- a/man/boobank.1 +++ b/man/boobank.1 @@ -1,4 +1,4 @@ -.TH BOOBANK 1 "01 April 2011" "boobank 0\&.7" +.TH BOOBANK 1 "08 May 2011" "boobank 0\&.8" .SH NAME boobank .SH SYNOPSIS @@ -11,7 +11,7 @@ boobank .SH DESCRIPTION .LP -Boobank is a console application to get bank accounts, display history and do transfer operations. +Console application allowing to list your bank accounts and get their balance, display accounts history and coming bank operations, and transfer money from an account to another (if available). .SS Supported websites: * bnporc (BNP Paribas french bank' website) @@ -37,19 +37,19 @@ Display old operations. .TP \fBlist\fR .br -List every available accounts. +List accounts. .TP -\fBtransfer\fR \fIACCOUNT\fR [\fITO\fR \fIAMOUNT\fR [\fIREASON\fR]] +\fBtransfer\fR \fIACCOUNT\fR [\fIRECIPIENT\fR \fIAMOUNT\fR [\fIREASON\fR]] .br Make a transfer beetwen two account .br -\- ACCOUNT the source account +\- ACCOUNT the source account .br -\- TO the recipient +\- RECIPIENT the recipient .br -\- AMOUNT amount to transfer +\- AMOUNT amount to transfer .br -\- REASON reason of transfer +\- REASON reason of transfer .br .br @@ -82,6 +82,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -150,6 +154,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -161,10 +173,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP @@ -208,8 +216,8 @@ 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) +select output formatter (account_list, csv, htmltable, multiline, +recipient_list, simple, table, transfer, webkit) .TP \fB\-\-no\-header\fR do not display header diff --git a/man/boobathon.1 b/man/boobathon.1 new file mode 100644 index 0000000000..0403b9c517 --- /dev/null +++ b/man/boobathon.1 @@ -0,0 +1,258 @@ +.TH BOOBATHON 1 "08 May 2011" "boobathon 0\&.8" +.SH NAME +boobathon +.SH SYNOPSIS +.B boobathon +[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIboobathon\fR +.br +.B boobathon +[\-\-help] [\-\-version] + +.SH DESCRIPTION +.LP + +Console application to participate to a Boobathon. + +.SS Supported websites: +* dlfp (Da Linux French Page) +.br +* mediawiki (Mediawiki wiki software application) +.br +* redmine (The Redmine project management web application) +.SH BOOBATHON COMMANDS +.TP +\fBaddtask\fR \fIBACKEND\fR \fICAPABILITY\fR +.br +Add a new task. +.TP +\fBcancel\fR +.br +Cancel the current task. +.TP +\fBclose\fR \fIWINNER\fR +.br +Close the event and set the winner. +.TP +\fBdone\fR +.br +Set the current task as done. +.TP +\fBedit\fR [event | me] +.br +Edit information about you or about event. +.TP +\fBinfo\fR +.br +Display information about this event. +.TP +\fBjoin\fR +.br +Join this event. +.TP +\fBleave\fR +.br +Leave this event. +.TP +\fBmembers\fR +.br +Display members informations. +.TP +\fBprogress\fR +.br +Display progress of members. +.TP +\fBremtask\fR \fITASK_ID\fR +.br +Remove a task. +.TP +\fBstart\fR [\fITASK_ID\fR] +.br +Start a task. If you don't give a task ID, the first available +.br +task will be taken. +.TP +\fBtasks\fR +.br +Display all tasks of members. +.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 +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.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 +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.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. + +.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 +.TP +\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR +file to export result + +.SH COPYRIGHT +Copyright(C) 2011 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/Boobathon diff --git a/man/boobmsg.1 b/man/boobmsg.1 index d9b47db0ed..4b6e76151f 100644 --- a/man/boobmsg.1 +++ b/man/boobmsg.1 @@ -1,4 +1,4 @@ -.TH BOOBMSG 1 "01 April 2011" "boobmsg 0\&.7" +.TH BOOBMSG 1 "08 May 2011" "boobmsg 0\&.8" .SH NAME boobmsg .SH SYNOPSIS @@ -11,7 +11,7 @@ boobmsg .SH DESCRIPTION .LP -Boobmsg is a console application to send messages on supported websites and to display messages threads and contents. +Console application allowing to send messages on various websites and to display message threads and contents. .SS Supported websites: * aum (“Adopte un mec” french dating website) @@ -92,6 +92,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -160,6 +164,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -171,10 +183,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP diff --git a/man/chatoob.1 b/man/chatoob.1 index e8337471ec..6bdcee0c83 100644 --- a/man/chatoob.1 +++ b/man/chatoob.1 @@ -1,4 +1,4 @@ -.TH CHATOOB 1 "01 April 2011" "chatoob 0\&.7" +.TH CHATOOB 1 "08 May 2011" "chatoob 0\&.8" .SH NAME chatoob .SH SYNOPSIS @@ -11,7 +11,7 @@ chatoob .SH DESCRIPTION .LP -Chatoob is a console application to chat with contacts. +Console application allowing to chat with contacts on various websites. .SS Supported websites: * aum (“Adopte un mec” french dating website) @@ -54,6 +54,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -122,6 +126,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -133,10 +145,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP diff --git a/man/galleroob.1 b/man/galleroob.1 new file mode 100644 index 0000000000..572593e805 --- /dev/null +++ b/man/galleroob.1 @@ -0,0 +1,221 @@ +.TH GALLEROOB 1 "08 May 2011" "galleroob 0\&.8" +.SH NAME +galleroob +.SH SYNOPSIS +.B galleroob +[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]] +.br +.B galleroob +[\-\-help] [\-\-version] + +.SH DESCRIPTION +.LP + +galleroob browses and downloads web image galleries + +.SS Supported websites: +* ehentai (E\-hentai galleries) +.SH GALLEROOB COMMANDS +.TP +\fBdownload\fR \fIID\fR [\fIFIRST\fR [\fIFOLDER\fR]] +.br +Download a gallery. +.br + +.br +Begins at page FIRST (default: 0) and saves to FOLDER (default: title) +.TP +\fBinfo\fR \fIID\fR +.br +Get information about a gallery. +.TP +\fBsearch\fR \fIPATTERN\fR +.br +List galleries matching a PATTERN. +.br + +.br +If PATTERN is not given, the command will list all the galleries +.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 +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.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 +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.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. + +.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, gallery_list, htmltable, multiline, simple, table, +webkit) +.TP +\fB\-\-no\-header\fR +do not display header +.TP +\fB\-\-no\-keys\fR +do not display item keys +.TP +\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR +file to export result + +.SH COPYRIGHT +None +.LP +For full COPYRIGHT see COPYING file with weboob package. +.LP +.RE +.SH FILES +"~/.weboob/backends" + +.SH SEE ALSO +Home page: http://weboob.org/Galleroob diff --git a/man/geolooc.1 b/man/geolooc.1 index aecd6f9549..d6be860103 100644 --- a/man/geolooc.1 +++ b/man/geolooc.1 @@ -1,4 +1,4 @@ -.TH GEOLOOC 1 "01 April 2011" "geolooc 0\&.7" +.TH GEOLOOC 1 "08 May 2011" "geolooc 0\&.8" .SH NAME geolooc .SH SYNOPSIS @@ -11,12 +11,12 @@ geolooc .SH DESCRIPTION .LP -Geolooc is a console application to get geolocalization of IP addresses. +Console application allowing to geolocalize IP addresses. .SS Supported websites: -* geolocip (IP Adresses geolocalisation with the site www.geolocip.com) +* geolocip (IP Addresses geolocalisation with the site www.geolocip.com) .br -* ipinfodb (IP Adresses geolocalisation with the site ipinfodb.com) +* ipinfodb (IP Addresses geolocalisation with the site ipinfodb.com) .SH WEBOOB COMMANDS .TP \fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]... @@ -43,6 +43,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -111,6 +115,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -122,10 +134,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP diff --git a/man/havesex.1 b/man/havesex.1 index 8827007144..4455da4ea9 100644 --- a/man/havesex.1 +++ b/man/havesex.1 @@ -1,4 +1,4 @@ -.TH HAVESEX 1 "01 April 2011" "havesex 0\&.7" +.TH HAVESEX 1 "08 May 2011" "havesex 0\&.8" .SH NAME havesex .SH SYNOPSIS @@ -11,7 +11,7 @@ havesex .SH DESCRIPTION .LP -Havesex is a console application to interact with dating websites and to help you to seduce women. +Console application allowing to interact with various dating websites and to optimize seduction algorithmically. .SS Supported websites: * aum (“Adopte un mec” french dating website) @@ -70,6 +70,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -138,6 +142,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -149,10 +161,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP diff --git a/man/masstransit.1 b/man/masstransit.1 index 26818214eb..904bcbdff7 100644 --- a/man/masstransit.1 +++ b/man/masstransit.1 @@ -1,4 +1,4 @@ -.TH MASSTRANSIT 1 "01 April 2011" "masstransit 0\&.7" +.TH MASSTRANSIT 1 "08 May 2011" "masstransit 0\&.8" .SH NAME masstransit .SH SYNOPSIS diff --git a/man/monboob.1 b/man/monboob.1 index d7b2139425..ee3dcaa608 100644 --- a/man/monboob.1 +++ b/man/monboob.1 @@ -1,4 +1,4 @@ -.TH MONBOOB 1 "01 April 2011" "monboob 0\&.7" +.TH MONBOOB 1 "08 May 2011" "monboob 0\&.8" .SH NAME monboob .SH SYNOPSIS @@ -11,7 +11,7 @@ monboob .SH DESCRIPTION .LP -Monboob is a daemon to send messages on supported website by email, and can be used to send replies. +Daemon allowing to regularly check for new messages on various websites, and send an email for each message, and post a reply to a message on a website. .SS Supported websites: * aum (“Adopte un mec” french dating website) diff --git a/man/pastoob.1 b/man/pastoob.1 new file mode 100644 index 0000000000..f72060a49f --- /dev/null +++ b/man/pastoob.1 @@ -0,0 +1,212 @@ +.TH PASTOOB 1 "08 May 2011" "pastoob 0\&.8" +.SH NAME +pastoob +.SH SYNOPSIS +.B pastoob +[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]] +.br +.B pastoob +[\-\-help] [\-\-version] + +.SH DESCRIPTION +.LP + +Console application allowing to post and get pastes from pastebins. + +.SS Supported websites: +* pastealacon (Paste a la con paste tool) +.br +* pastebin (Pastebin paste tool) +.SH PASTOOB COMMANDS +.TP +\fBget\fR \fIID\fR +.br +Get a paste contents. +.TP +\fBpost\fR [\fIFILENAME\fR] +.br +Submit a new paste. +.br +The filename can be '\-' for reading standard input (pipe). +.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 +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.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 +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.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. + +.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 +.TP +\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR +file to export result + +.SH COPYRIGHT +Copyright(C) 2011 Laurent Bachelier +.LP +For full COPYRIGHT see COPYING file with weboob package. +.LP +.RE +.SH FILES +"~/.weboob/backends" + +.SH SEE ALSO +Home page: http://weboob.org/Pastoob diff --git a/man/qboobmsg.1 b/man/qboobmsg.1 index bbc00b8da5..26ae110dc7 100644 --- a/man/qboobmsg.1 +++ b/man/qboobmsg.1 @@ -1,4 +1,4 @@ -.TH QBOOBMSG 1 "01 April 2011" "qboobmsg 0\&.7" +.TH QBOOBMSG 1 "08 May 2011" "qboobmsg 0\&.8" .SH NAME qboobmsg .SH SYNOPSIS @@ -11,7 +11,7 @@ qboobmsg .SH DESCRIPTION .LP -QBoobMsg is a graphical application to read messages on supported website and reply to them. +Qt application allowing to read messages on various websites and reply to them. .SS Supported websites: * aum (“Adopte un mec” french dating website) diff --git a/man/qhavesex.1 b/man/qhavesex.1 index 5cb1d0d3c5..3ec6af4eaf 100644 --- a/man/qhavesex.1 +++ b/man/qhavesex.1 @@ -1,4 +1,4 @@ -.TH QHAVESEX 1 "01 April 2011" "qhavesex 0\&.7" +.TH QHAVESEX 1 "08 May 2011" "qhavesex 0\&.8" .SH NAME qhavesex .SH SYNOPSIS @@ -11,7 +11,7 @@ qhavesex .SH DESCRIPTION .LP -QHaveSex is a graphical application to interact with dating websites and help you to seduce women. +Qt application allowing to interact with various dating websites. .SS Supported websites: * aum (“Adopte un mec” french dating website) diff --git a/man/qvideoob.1 b/man/qvideoob.1 index 82454fa7e8..236c8e4374 100644 --- a/man/qvideoob.1 +++ b/man/qvideoob.1 @@ -1,4 +1,4 @@ -.TH QVIDEOOB 1 "01 March 2011" "qvideoob 0\&.6" +.TH QVIDEOOB 1 "08 May 2011" "qvideoob 0\&.8" .SH NAME qvideoob .SH SYNOPSIS @@ -11,13 +11,15 @@ qvideoob .SH DESCRIPTION .LP -QVideoob is a graphical application to search videos on supported websites and play them. +Qt application allowing to search videos on various websites and play them. .SS Supported websites: * arte (Arte french TV) .br * canalplus (Canal plus french TV) .br +* dailymotion (Dailymotion videos website) +.br * ina (INA french video archives) .br * youjizz (Youjizz videos website) diff --git a/man/qwebcontentedit.1 b/man/qwebcontentedit.1 index 9ee6a78c1d..3aea9de19f 100644 --- a/man/qwebcontentedit.1 +++ b/man/qwebcontentedit.1 @@ -1,4 +1,4 @@ -.TH QWEBCONTENTEDIT 1 "01 April 2011" "qwebcontentedit 0\&.7" +.TH QWEBCONTENTEDIT 1 "08 May 2011" "qwebcontentedit 0\&.8" .SH NAME qwebcontentedit .SH SYNOPSIS @@ -11,7 +11,7 @@ qwebcontentedit .SH DESCRIPTION .LP -Qt application for managing content on supported websites +Qt application allowing to manage contents of various websites. .SS Supported websites: * dlfp (Da Linux French Page) diff --git a/man/radioob.1 b/man/radioob.1 index 22c3cdd215..3fc50cb765 100644 --- a/man/radioob.1 +++ b/man/radioob.1 @@ -1,4 +1,4 @@ -.TH RADIOOB 1 "01 April 2011" "radioob 0\&.7" +.TH RADIOOB 1 "08 May 2011" "radioob 0\&.8" .SH NAME radioob .SH SYNOPSIS @@ -11,9 +11,13 @@ radioob .SH DESCRIPTION .LP -Radioob is a console application to list radios, play them and get informations like the current song. +Console application allowing to search for web radio stations, listen to them and get information like the current song. .SS Supported websites: +* franceinter (The france inter french radio) +.br +* lemouv (The le mouv' french radio) +.br * ouifm (The Ouï FM french radio) .SH RADIOOB COMMANDS .TP @@ -21,17 +25,17 @@ Radioob is a console application to list radios, play them and get informations .br Get information about a radio. .TP -\fBlist\fR [\fIPATTERN\fR] +\fBplay\fR \fIID\fR +.br +Play a radio with a found player. +.TP +\fBsearch\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]... @@ -58,6 +62,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -126,6 +134,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -137,10 +153,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP diff --git a/man/traveloob.1 b/man/traveloob.1 index b32a4488a2..5c9c0a26bd 100644 --- a/man/traveloob.1 +++ b/man/traveloob.1 @@ -1,4 +1,4 @@ -.TH TRAVELOOB 1 "01 April 2011" "traveloob 0\&.7" +.TH TRAVELOOB 1 "08 May 2011" "traveloob 0\&.8" .SH NAME traveloob .SH SYNOPSIS @@ -11,7 +11,7 @@ traveloob .SH DESCRIPTION .LP -Traveloob is a console application to get timelines. +Console application allowing to search for train stations and get departure times. .SS Supported websites: * canaltp (French trains) @@ -52,6 +52,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -120,6 +124,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -131,10 +143,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP diff --git a/man/videoob-webserver.1 b/man/videoob-webserver.1 index a34a5def00..af60246cb8 100644 --- a/man/videoob-webserver.1 +++ b/man/videoob-webserver.1 @@ -1,4 +1,4 @@ -.TH VIDEOOB-WEBSERVER 1 "01 April 2011" "videoob-webserver 0\&.7" +.TH VIDEOOB-WEBSERVER 1 "08 May 2011" "videoob-webserver 0\&.8" .SH NAME videoob-webserver .SH SYNOPSIS @@ -8,6 +8,25 @@ videoob-webserver .B videoob\-webserver [\-\-help] [\-\-version] +.SH DESCRIPTION +.LP + +WSGI web server application allowing to search for videos on various websites. + +.SS Supported websites: +* arte (Arte french TV) +.br +* canalplus (Canal plus french TV) +.br +* dailymotion (Dailymotion videos website) +.br +* ina (INA french video archives) +.br +* youjizz (Youjizz videos website) +.br +* youporn (Youporn videos website) +.br +* youtube (Youtube videos website) .SH OPTIONS .TP \fB\-\-version\fR diff --git a/man/videoob.1 b/man/videoob.1 index 064003b182..ed8c55692d 100644 --- a/man/videoob.1 +++ b/man/videoob.1 @@ -1,4 +1,4 @@ -.TH VIDEOOB 1 "01 April 2011" "videoob 0\&.7" +.TH VIDEOOB 1 "08 May 2011" "videoob 0\&.8" .SH NAME videoob .SH SYNOPSIS @@ -11,7 +11,7 @@ videoob .SH DESCRIPTION .LP -Videoob is a console application to search videos on supported websites and to play them or get informations. +Console application allowing to search for videos on various websites, play and download them and get information. .SS Supported websites: * arte (Arte french TV) @@ -82,6 +82,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -150,6 +154,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -161,10 +173,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP diff --git a/man/webcontentedit.1 b/man/webcontentedit.1 index 4fa17d1b53..40184e6089 100644 --- a/man/webcontentedit.1 +++ b/man/webcontentedit.1 @@ -1,4 +1,4 @@ -.TH WEBCONTENTEDIT 1 "01 April 2011" "webcontentedit 0\&.7" +.TH WEBCONTENTEDIT 1 "08 May 2011" "webcontentedit 0\&.8" .SH NAME webcontentedit .SH SYNOPSIS @@ -11,7 +11,7 @@ webcontentedit .SH DESCRIPTION .LP -Webcontentedit is a console application to display and edit contents on supported websites. +Console application allowing to display and edit contents on various websites. .SS Supported websites: * dlfp (Da Linux French Page) @@ -54,6 +54,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -122,6 +126,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -133,10 +145,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP diff --git a/man/weboob-cli.1 b/man/weboob-cli.1 index 227762e366..066e96de45 100644 --- a/man/weboob-cli.1 +++ b/man/weboob-cli.1 @@ -1,4 +1,4 @@ -.TH WEBOOB-CLI 1 "01 April 2011" "weboob-cli 0\&.7" +.TH WEBOOB-CLI 1 "08 May 2011" "weboob-cli 0\&.8" .SH NAME weboob-cli .SH SYNOPSIS diff --git a/man/weboob-config-qt.1 b/man/weboob-config-qt.1 index 3e74e813b6..1881e0f4e4 100644 --- a/man/weboob-config-qt.1 +++ b/man/weboob-config-qt.1 @@ -1,4 +1,4 @@ -.TH WEBOOB-CONFIG-QT 1 "01 April 2011" "weboob-config-qt 0\&.7" +.TH WEBOOB-CONFIG-QT 1 "08 May 2011" "weboob-config-qt 0\&.8" .SH NAME weboob-config-qt .SH SYNOPSIS diff --git a/man/weboob-config.1 b/man/weboob-config.1 index 3cb31f6586..b5ff489707 100644 --- a/man/weboob-config.1 +++ b/man/weboob-config.1 @@ -1,4 +1,4 @@ -.TH WEBOOB-CONFIG 1 "01 April 2011" "weboob-config 0\&.7" +.TH WEBOOB-CONFIG 1 "08 May 2011" "weboob-config 0\&.8" .SH NAME weboob-config .SH SYNOPSIS @@ -25,6 +25,10 @@ Add a configured backend. .br Show applications. .TP +\fBbackends\fR [\fICAPS\fR ...] +.br +Show available backends. +.TP \fBconfirm\fR \fIBACKEND\fR .br For a backend which support CapAccount, parse a confirmation mail @@ -37,15 +41,23 @@ subscribe. .br It takes mail from stdin. Use it with postfix for example. .TP +\fBdisable\fR \fINAME\fR +.br +Disable a backend +.TP \fBedit\fR \fINAME\fR .br Edit a backend .TP +\fBenable\fR \fINAME\fR +.br +Enable a disabled backend +.TP \fBinfo\fR \fINAME\fR .br Display information about a backend. .TP -\fBlist\fR +\fBlist\fR [\fICAPS\fR ..] .br Show configured backends. .TP @@ -56,95 +68,6 @@ Register a new account on a backend. \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 - -.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 diff --git a/man/weboob-debug.1 b/man/weboob-debug.1 index 54a5c721fb..b6f71b13ee 100644 --- a/man/weboob-debug.1 +++ b/man/weboob-debug.1 @@ -1,4 +1,4 @@ -.TH WEBOOB-DEBUG 1 "01 April 2011" "weboob-debug 0\&.7" +.TH WEBOOB-DEBUG 1 "08 May 2011" "weboob-debug 0\&.8" .SH NAME weboob-debug .SH SYNOPSIS @@ -46,6 +46,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -114,6 +118,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -125,10 +137,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP diff --git a/man/weboorrents.1 b/man/weboorrents.1 index 28261ea59c..2c9a236f69 100644 --- a/man/weboorrents.1 +++ b/man/weboorrents.1 @@ -1,4 +1,4 @@ -.TH WEBOORRENTS 1 "01 April 2011" "weboorrents 0\&.7" +.TH WEBOORRENTS 1 "08 May 2011" "weboorrents 0\&.8" .SH NAME weboorrents .SH SYNOPSIS @@ -11,7 +11,7 @@ weboorrents .SH DESCRIPTION .LP -Weboorrents is a console application to search torrents on supported trackers and to download .torrent files. +Console application allowing to search for torrents on various trackers and download .torrent files. .SS Supported websites: * gazelle (gazelle bittorrent tracker) @@ -64,6 +64,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -132,6 +136,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -143,10 +155,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP diff --git a/man/wetboobs.1 b/man/wetboobs.1 index 027d7e57e3..2b8f0621c4 100644 --- a/man/wetboobs.1 +++ b/man/wetboobs.1 @@ -1,4 +1,4 @@ -.TH WETBOOBS 1 "01 April 2011" "wetboobs 0\&.7" +.TH WETBOOBS 1 "08 May 2011" "wetboobs 0\&.8" .SH NAME wetboobs .SH SYNOPSIS @@ -11,7 +11,7 @@ wetboobs .SH DESCRIPTION .LP -Wetboobs is a console application to display weather and forecasts in your city. +Console application allowing to display weather and forecasts in your city. .SS Supported websites: * meteofrance (Get forecasts from the MeteoFrance website) @@ -60,6 +60,10 @@ ACTION is one of the following (default: list): .br * remove remove a backend .TP +\fBcd\fR \fIPATH\fR +.br +Follow a path. +.TP \fBcondition\fR [\fIEXPRESSION\fR | off] .br If an argument is given, set the condition expression used to filter the results. @@ -128,6 +132,14 @@ Availables: debug, info, warning, error. .br * default is an alias for warning .TP +\fBls\fR +.br +List objects in current path. +.TP +\fBquit\fR +.br +Quit the application. +.TP \fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full" .br If an argument is given, set the selected fields. @@ -139,10 +151,6 @@ $full selects all fields using as much http requests as necessary. .br If no argument is given, print the currently selected fields. -.TP -\fBquit\fR -.br -Quit the application. .SH OPTIONS .TP -- GitLab