weboob-devel/man/weboob-config.1
2010-08-02 14:35:12 +02:00

79 lines
1.9 KiB
Groff

.TH WEBOOB-CONFIG 1 "02 August 2010"
.SH NAME
weboob-config \- Weboob configuration
.SH SYNOPSIS
.B weboob-config
[\-dqv] \fIcommand\fR [arguments..]
.br
.B weboob-config
[\-\-version] [\-\-help]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
This application is used to configure weboob. You can list backends, and
add/list/remove configured backends.
.SH COMMANDS
.TP
\fBadd\fR \fIbackend_name\fR \fI[options..]\fR
add a configured backend. \fIbackend_name\fR is the name of the backend to add.
To list available backends, use the \fIbackends\fR command.
The options are specific to the backend. Use the \fIinfo\fR command to list
them for a backend.
If you don't specify any options, \fBweboob-config\fR prompts you for each
available options.
.TP
\fBlistconfigured\fR
list every configured backends.
.TP
\fBremove\fR \fIinstance_name\fR
remove a configured backend, by giving its instance name.
.TP
\fBedit\fR
edit the configuration files of instanced backends with your favorite editor
(default is vim)
.TP
\fBbackends\fR \fI[caps..]\fR
list every available backends. You can filter by capabilities.
Example:
.nf
$ weboob-config backends ICapDating ICapMessages
.fi
.TP
\fBinfo\fR \fIname\fR
display information about a backend (name, author, descriptions, options, etc.)
.TP
\fBapplications\fR \fI[caps..]\fR
list every weboob applications. You can filter by capabilities.
.SH OPTIONS
.SS 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
.SS Misc options
.TP
\fB\-\-version\fR
display version of \fIweboob-config\fR
.TP
\fB\-h\fR, \fB\-\-help\fR
show the help message and exit
.SH COPYRIGHT
Copyright(C) 2010 Christophe Benz, Romain Bignon
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"