generated manpages from make_man.py

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
-[\-dqv] \fIcommand\fR [arguments..]
+.B weboob\-config
+[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
 .br
-.B weboob-config
-[\-\-version] [\-\-help]
+.B weboob\-config
+[\-\-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
-add/list/remove configured backends.
+Weboob\-Config is a console application to add/edit/remove backends, and to register new website accounts.
 
-.SH COMMANDS
+.SS Supported websites:
+
+.SH WEBOOB\-CONFIG 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.
+\fBadd\fR \fINAME\fR [\fIOPTIONS\fR ...]
+.br
+Add a configured backend.
 .TP
-\fBlistconfigured\fR
-list every configured backends.
+\fBapplications\fR
+.br
+Show applications.
 .TP
-\fBremove\fR \fIinstance_name\fR
-remove a configured backend, by giving its instance name.
+\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
-edit the configuration files of instanced backends with your favorite editor
-(default is vim)
+.br
+Edit configuration file.
 .TP
-\fBbackends\fR \fI[caps..]\fR
-list every available backends. You can filter by capabilities.
+\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
 
-Example:
-.nf
-$ weboob-config backends ICapDating ICapMessages
-.fi
+.br
+If no argument is given, print the current condition expression.
 .TP
-\fBinfo\fR \fIname\fR
-display information about a backend (name, author, descriptions, options, etc.)
+\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
-\fBapplications\fR \fI[caps..]\fR
-list every weboob applications. You can filter by capabilities.
+\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 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
-display version of \fIweboob-config\fR
+\fB\-\-logging\-file=LOGGING_FILE\fR
+file to save logs
 .TP
-\fB\-h\fR, \fB\-\-help\fR
-show the help message and exit
+\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, Romain Bignon
@@ -76,4 +203,4 @@ For full COPYRIGHT see COPYING file with weboob package.
 .LP
 .RE
 .SH FILES
- "~/.weboob/backends"
+"~/.weboob/backends"