Skip to content
boobathon.1 7.23 KiB
Newer Older
.\" -*- coding: utf-8 -*-
Florent's avatar
Florent committed
.TH BOOBATHON 1 "08 January 2014" "boobathon 0\&.h"
Romain Bignon's avatar
Romain Bignon committed
.SH NAME
boobathon \- participate in a Boobathon
Romain Bignon's avatar
Romain Bignon committed
.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:
Romain Bignon's avatar
Romain Bignon committed
* dlfp (Da Linux French Page news website)
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* mediawiki (Wikis running MediaWiki, like Wikipedia)
Romain Bignon's avatar
Romain Bignon committed
.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
Romain Bignon's avatar
Romain Bignon committed
Display members information.
Romain Bignon's avatar
Romain Bignon committed
.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
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
Romain Bignon's avatar
Romain Bignon committed
\fBcd\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
.br
Follow a path.
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
.TP
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent's avatar
Florent committed
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
Romain Bignon's avatar
Romain Bignon committed
.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
Florent's avatar
Florent committed
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
.br
If an argument is given, list the specified path.
Florent's avatar
Florent committed
.br
Use \-U option to not sort results.
.br

.br
Default is limited to 40 results.
Romain Bignon's avatar
Romain Bignon committed
.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)
Florent's avatar
Florent committed
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Romain Bignon's avatar
Romain Bignon committed

.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
Florent's avatar
Florent committed
filter result items to display given a boolean expression. See CONDITION section
for the syntax
Romain Bignon's avatar
Romain Bignon committed
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent's avatar
Florent committed
limit number of results (from each backends)
Romain Bignon's avatar
Romain Bignon committed
.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, json, multiline, simple, table, webkit)
Romain Bignon's avatar
Romain Bignon committed
.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

Florent's avatar
Florent committed
.SH CONDITION
The -c and --condition is a flexible way to sort and get only interesting results. It supports conditions on numerical values, dates, and strings. Dates are given in YYYY-MM-DD format.
The syntax of one expression is "\fBfield operator value\fR". The field to test is always the left member of the expression.
.LP
The field is a member of the objects returned by the command. For example, a bank account has "balance", "coming" or "label" fields.
.SS The following operators are supported:
.TP
=
Test if object.field is equal to the value.
.TP
!=
Test if object.field is not equal to the value.
.TP
>
Test if object.field is greater than the value. If object.field is date, return true if value is before that object.field.
.TP
<
Test if object.field is less than the value. If object.field is date, return true if value is after that object.field.
.TP
|
This operator is available only for string fields. It works like the Unix standard \fBgrep\fR command, and returns True if the pattern specified in the value is in object.field.
.SS Expression combination
You can make a expression combinations with the keywords \fB" AND "\fR and \fB" OR "\fR.

.SS Examples:
.nf
.B boobank ls \-\-condition 'label=Livret A'
.fi
Display only the "Livret A" account.
.PP
.nf
.B boobank ls \-\-condition 'balance>10000'
.fi
Display accounts with a lot of money.
.PP
.nf
.B boobank history account@backend \-\-condition 'label|rewe'
.fi
Get transactions containing "rewe".
.PP
.nf
.B boobank history account@backend \-\-condition 'date>2013-12-01 AND date<2013-12-09'
.fi
Get transactions betweens the 2th December and 8th December 2013.

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

.SH SEE ALSO
Romain Bignon's avatar
Romain Bignon committed
Home page: http://weboob.org/applications/boobathon