Skip to content
weboob-config.1 3.15 KiB
Newer Older
Romain Bignon's avatar
Romain Bignon committed
.TH WEBOOB-CONFIG 1 "28 October 2012" "weboob-config 0\&.d"
Romain Bignon's avatar
Romain Bignon committed
.SH NAME
weboob-config
Romain Bignon's avatar
Romain Bignon committed
.SH SYNOPSIS
.B weboob\-config
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon's avatar
Romain Bignon committed
.br
.B weboob\-config
[\-\-help] [\-\-version]

Romain Bignon's avatar
Romain Bignon committed
.SH DESCRIPTION
.LP

Weboob\-Config is a console application to add/edit/remove backends, and to register new website accounts.

.SH WEBOOB\-CONFIG COMMANDS
.TP
\fBadd\fR \fINAME\fR [\fIOPTIONS\fR ...]
.br
Romain Bignon's avatar
Romain Bignon committed
Add a backend.
.TP
\fBapplications\fR
.br
Show applications.
Romain Bignon's avatar
Romain Bignon committed
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
Select used backends.
.br

.br
ACTION is one of the following (default: list):
.br
Romain Bignon's avatar
Romain Bignon committed
* enable         enable given backends
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* disable        disable given backends
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* only           enable given backends and disable the others
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* list           list backends
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* add            add a backend
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* register       register a new account on a website
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* edit           edit a backend
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* remove         remove a backend
.br
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
.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
Romain Bignon's avatar
Romain Bignon committed
\fBdisable\fR \fIBACKEND\fR
Romain Bignon's avatar
Romain Bignon committed
.br
Disable a backend
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBedit\fR \fIBACKEND\fR
Romain Bignon's avatar
Romain Bignon committed
Edit a backend
Romain Bignon's avatar
Romain Bignon committed
\fBenable\fR \fIBACKEND\fR
Romain Bignon's avatar
Romain Bignon committed
.br
Enable a disabled backend
.TP
\fBinfo\fR \fINAME\fR
.br
Romain Bignon's avatar
Romain Bignon committed
Display information about a module.
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBlist\fR [\fICAPS\fR ..]
Romain Bignon's avatar
Romain Bignon committed
Show backends.
Romain Bignon's avatar
Romain Bignon committed
\fBmodules\fR [\fICAPS\fR ...]
Romain Bignon's avatar
Romain Bignon committed
Show available modules.
.TP
\fBregister\fR \fIMODULE\fR
.br
Register a new account on a module.
.TP
\fBremove\fR \fINAME\fR
.br
Romain Bignon's avatar
Romain Bignon committed
Remove a backend.
.TP
\fBupdate\fR
.br
Update weboob.
Romain Bignon's avatar
Romain Bignon committed

.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
Romain Bignon's avatar
Romain Bignon committed
.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
Romain Bignon's avatar
Romain Bignon committed
.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
Romain Bignon's avatar
Romain Bignon committed
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
Romain Bignon's avatar
Romain Bignon committed

.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
Copyright(C) 2010-2012 Christophe Benz, Romain Bignon
Romain Bignon's avatar
Romain Bignon committed
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
"~/.config/weboob/backends" 

.SH SEE ALSO
Home page: http://weboob.org/applications/weboob-config