weboob-config.1 5.59 KB
Newer Older
1
.\" -*- coding: utf-8 -*-
Florent Fourcot's avatar
Florent Fourcot committed
2
.\" This file was generated automatically by tools/make_man.sh.
Romain Bignon's avatar
Romain Bignon committed
3
.TH WEBOOB-CONFIG 1 "27 February 2019" "weboob-config 1\&.5"
Romain Bignon's avatar
Romain Bignon committed
4
.SH NAME
5
weboob-config \- manage backends or register new accounts
Romain Bignon's avatar
Romain Bignon committed
6
.SH SYNOPSIS
7 8
.B weboob\-config
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon's avatar
Romain Bignon committed
9
.br
10 11 12
.B weboob\-config
[\-\-help] [\-\-version]

Romain Bignon's avatar
Romain Bignon committed
13 14 15
.SH DESCRIPTION
.LP

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

.SH WEBOOB\-CONFIG COMMANDS
.TP
Florent Fourcot's avatar
Florent Fourcot committed
20
\fBadd\fR \fIMODULE_NAME\fR [\fIBACKEND_NAME\fR] [\fIPARAMETERS\fR ...]
21
.br
Florent Fourcot's avatar
Florent Fourcot committed
22 23 24 25 26 27 28
Create a backend from a module. By default, if BACKEND_NAME is omitted,
.br
that's the module name which is used.
.br

.br
You can specify parameters from command line in form "key=value".
29 30 31 32 33 34 35 36 37
.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
Romain Bignon's avatar
Romain Bignon committed
38

39 40 41
.br
It takes mail from stdin. Use it with postfix for example.
.TP
Romain Bignon's avatar
Romain Bignon committed
42 43 44 45
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Romain Bignon's avatar
Romain Bignon committed
46
\fBdisable\fR \fINAME\fR
Romain Bignon's avatar
Romain Bignon committed
47
.br
Romain Bignon's avatar
Romain Bignon committed
48
Disable a backend.
Romain Bignon's avatar
Romain Bignon committed
49
.TP
Romain Bignon's avatar
Romain Bignon committed
50
\fBedit\fR \fIBACKEND\fR
51
.br
Romain Bignon's avatar
Romain Bignon committed
52
Edit a backend
53
.TP
Romain Bignon's avatar
Romain Bignon committed
54
\fBenable\fR \fINAME\fR
Romain Bignon's avatar
Romain Bignon committed
55
.br
Romain Bignon's avatar
Romain Bignon committed
56
Enable a backend.
Romain Bignon's avatar
Romain Bignon committed
57
.TP
58 59
\fBinfo\fR \fINAME\fR
.br
Romain Bignon's avatar
Romain Bignon committed
60 61
Display information about a module.
.TP
Romain Bignon's avatar
Romain Bignon committed
62
\fBlist\fR [\fICAPS\fR ..]
63
.br
Romain Bignon's avatar
Romain Bignon committed
64
Show backends.
65
.TP
Romain Bignon's avatar
Romain Bignon committed
66
\fBmodules\fR [\fICAPS\fR ...]
67
.br
Romain Bignon's avatar
Romain Bignon committed
68 69 70 71 72
Show available modules.
.TP
\fBregister\fR \fIMODULE\fR
.br
Register a new account on a module.
73 74 75
.TP
\fBremove\fR \fINAME\fR
.br
Romain Bignon's avatar
Romain Bignon committed
76 77 78 79 80
Remove a backend.
.TP
\fBupdate\fR
.br
Update weboob.
Romain Bignon's avatar
Romain Bignon committed
81 82

.SH OPTIONS
83 84 85 86 87 88 89 90 91
.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 Fourcot's avatar
Florent Fourcot committed
92 93 94
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
95 96 97
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
98 99 100
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
101 102 103
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
104 105

.SH LOGGING OPTIONS
Romain Bignon's avatar
Romain Bignon committed
106 107
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
108
display debug messages. Set up it twice to more verbosity
Romain Bignon's avatar
Romain Bignon committed
109 110 111 112 113 114 115
.TP
\fB\-q\fR, \fB\-\-quiet\fR
display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.TP
116 117
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
Romain Bignon's avatar
Romain Bignon committed
118
.TP
119 120
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
Florent Fourcot's avatar
Florent Fourcot committed
121 122 123
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
124 125 126 127

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
128 129
filter result items to display given a boolean expression. See CONDITION section
for the syntax
130 131
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
132
limit number of results (from each backends)
133 134 135 136 137 138 139
.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
Florent Fourcot's avatar
Florent Fourcot committed
140 141
select output formatter (csv, htmltable, info_formatter, json, json_line,
multiline, simple, table, webkit)
142 143 144 145 146 147
.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
148 149 150
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
Romain Bignon's avatar
Romain Bignon committed
151

Florent Fourcot's avatar
Florent Fourcot committed
152
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
153
The \-c and \-\-condition is a flexible way to filter and get only interesting results. It supports conditions on numerical values, dates, durations and strings. Dates are given in YYYY\-MM\-DD or YYYY\-MM\-DD HH:MM format. Durations look like XhYmZs where X, Y and Z are integers. Any of them may be omitted. For instance, YmZs, XhZs or Ym are accepted.
Florent Fourcot's avatar
Florent Fourcot committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
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
Florent Fourcot's avatar
Florent Fourcot committed
174 175 176 177
.LP
You can make a expression combinations with the keywords \fB" AND "\fR, \fB" OR "\fR an \fB" LIMIT "\fR.
.LP
The \fBLIMIT\fR keyword can be used to limit the number of items upon which running the expression. \fBLIMIT\fR can only be placed at the end of the expression followed by the number of elements you want.
Florent Fourcot's avatar
Florent Fourcot committed
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
.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
Florent Fourcot's avatar
Florent Fourcot committed
195
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
196 197
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
198 199 200 201 202
.PP
.nf
.B boobank history account@backend \-\-condition 'date>2013\-12\-01  LIMIT 10'
.fi
Get transactions after the 2th December in the last 10 transactions
Florent Fourcot's avatar
Florent Fourcot committed
203

Romain Bignon's avatar
Romain Bignon committed
204
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
205
Copyright(C) 2010-2019 Christophe Benz, Romain Bignon
Romain Bignon's avatar
Romain Bignon committed
206
.LP
Florent Fourcot's avatar
Florent Fourcot committed
207
For full copyright information see the COPYING file in the weboob package.
Romain Bignon's avatar
Romain Bignon committed
208 209 210
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
211 212 213 214
"~/.config/weboob/backends" 

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