209 lines
4.3 KiB
Groff
209 lines
4.3 KiB
Groff
.TH WEBOOB-CONFIG 1 "01 March 2011" "weboob-config 0\&.6"
|
|
.SH NAME
|
|
weboob-config
|
|
.SH SYNOPSIS
|
|
.B weboob\-config
|
|
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
|
|
.br
|
|
.B weboob\-config
|
|
[\-\-help] [\-\-version]
|
|
|
|
.SH DESCRIPTION
|
|
.LP
|
|
|
|
Weboob\-Config is a console application to add/edit/remove backends, and to register new website accounts.
|
|
|
|
.SS Supported websites:
|
|
|
|
.SH WEBOOB\-CONFIG COMMANDS
|
|
.TP
|
|
\fBadd\fR \fINAME\fR [\fIOPTIONS\fR ...]
|
|
.br
|
|
Add a configured backend.
|
|
.TP
|
|
\fBapplications\fR
|
|
.br
|
|
Show applications.
|
|
.TP
|
|
\fBconfirm\fR \fIBACKEND\fR
|
|
.br
|
|
For a backend which support CapAccount, parse a confirmation mail
|
|
.br
|
|
after using the 'register' command to automatically confirm the
|
|
.br
|
|
subscribe.
|
|
.br
|
|
|
|
.br
|
|
It takes mail from stdin. Use it with postfix for example.
|
|
.TP
|
|
\fBedit\fR \fINAME\fR
|
|
.br
|
|
Edit a backend
|
|
.TP
|
|
\fBinfo\fR \fINAME\fR
|
|
.br
|
|
Display information about a backend.
|
|
.TP
|
|
\fBlist\fR
|
|
.br
|
|
Show configured backends.
|
|
.TP
|
|
\fBregister\fR \fINAME\fR
|
|
.br
|
|
Register a new account on a backend.
|
|
.TP
|
|
\fBremove\fR \fINAME\fR
|
|
.br
|
|
Remove a configured backend.
|
|
.SH WEBOOB COMMANDS
|
|
.TP
|
|
\fBbackends\fR [\fICAPS\fR ...]
|
|
.br
|
|
Show available backends.
|
|
.TP
|
|
\fBcondition\fR [\fIEXPRESSION\fR | off]
|
|
.br
|
|
If an argument is given, set the condition expression used to filter the results.
|
|
.br
|
|
If the "off" value is given, conditional filtering is disabled.
|
|
.br
|
|
|
|
.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
|
|
.TP
|
|
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
|
|
file to export result
|
|
|
|
.SH COPYRIGHT
|
|
Copyright(C) 2010-2011 Christophe Benz, Romain Bignon
|
|
.LP
|
|
For full COPYRIGHT see COPYING file with weboob package.
|
|
.LP
|
|
.RE
|
|
.SH FILES
|
|
"~/.weboob/backends"
|