The new woob repository is here: https://gitlab.com/woob/woob. This gitlab will be removed soon.

boobank.1 5.79 KB
Newer Older
Romain Bignon's avatar
Romain Bignon committed
1
.TH BOOBANK 1 "28 October 2012" "boobank 0\&.d"
Romain Bignon's avatar
Romain Bignon committed
2
.SH NAME
3
boobank
Romain Bignon's avatar
Romain Bignon committed
4 5
.SH SYNOPSIS
.B boobank
6
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon's avatar
Romain Bignon committed
7 8
.br
.B boobank
9 10
[\-\-help] [\-\-version]

Romain Bignon's avatar
Romain Bignon committed
11 12 13
.SH DESCRIPTION
.LP

Romain Bignon's avatar
Romain Bignon committed
14
Console application allowing to list your bank accounts and get their balance, display accounts history and coming bank operations, and transfer money from an account to another (if available).
Romain Bignon's avatar
Romain Bignon committed
15

16
.SS Supported websites:
Romain Bignon's avatar
Romain Bignon committed
17 18
* banquepopulaire (Banque Populaire French bank website)
.br
Romain Bignon's avatar
Romain Bignon committed
19
* bnporc (BNP Paribas French bank website)
20
.br
Romain Bignon's avatar
Romain Bignon committed
21
* boursorama (Boursorama French bank website)
Romain Bignon's avatar
Romain Bignon committed
22
.br
Romain Bignon's avatar
Romain Bignon committed
23
* bp (La Banque Postale French bank website)
24
.br
Romain Bignon's avatar
Romain Bignon committed
25 26 27 28 29 30
* bred (Bred French bank website)
.br
* caissedepargne (Caisse d'Épargne French bank website)
.br
* cic (CIC French bank website)
.br
Romain Bignon's avatar
Romain Bignon committed
31
* cmb (Crédit Mutuel de Bretagne French bank website)
Romain Bignon's avatar
Romain Bignon committed
32
.br
Romain Bignon's avatar
Romain Bignon committed
33
* cragr (Crédit Agricole French bank website)
34
.br
Romain Bignon's avatar
Romain Bignon committed
35
* creditmutuel (Crédit Mutuel French bank website)
36
.br
Romain Bignon's avatar
Romain Bignon committed
37 38
* fortuneo (Fortuneo French bank website)
.br
Romain Bignon's avatar
Romain Bignon committed
39
* hsbc (HSBC France bank website)
Romain Bignon's avatar
Romain Bignon committed
40
.br
Romain Bignon's avatar
Romain Bignon committed
41
* ing (ING Direct French bank website)
Romain Bignon's avatar
Romain Bignon committed
42
.br
Romain Bignon's avatar
Romain Bignon committed
43
* lcl (Le Crédit Lyonnais French bank website)
44
.br
Romain Bignon's avatar
Romain Bignon committed
45
* societegenerale (Société Générale French bank website)
46 47 48 49
.SH BOOBANK COMMANDS
.TP
\fBcoming\fR \fIID\fR
.br
Romain Bignon's avatar
Romain Bignon committed
50
Display future transactions.
51 52 53
.TP
\fBhistory\fR \fIID\fR
.br
Romain Bignon's avatar
Romain Bignon committed
54
Display history of transactions.
Romain Bignon's avatar
Romain Bignon committed
55 56
.TP
\fBlist\fR
57
.br
Romain Bignon's avatar
Romain Bignon committed
58
List accounts.
Romain Bignon's avatar
Romain Bignon committed
59
.TP
Romain Bignon's avatar
Romain Bignon committed
60
\fBtransfer\fR \fIACCOUNT\fR [\fIRECIPIENT\fR \fIAMOUNT\fR [\fIREASON\fR]]
61 62 63
.br
Make a transfer beetwen two account
.br
Romain Bignon's avatar
Romain Bignon committed
64
\- ACCOUNT    the source account
65
.br
Romain Bignon's avatar
Romain Bignon committed
66
\- RECIPIENT  the recipient
67
.br
Romain Bignon's avatar
Romain Bignon committed
68
\- AMOUNT     amount to transfer
69
.br
Romain Bignon's avatar
Romain Bignon committed
70
\- REASON     reason of transfer
71
.br
Romain Bignon's avatar
Romain Bignon committed
72

73 74 75 76 77
.br
If you give only the ACCOUNT parameter, it lists all the
.br
available recipients for this account.
.SH WEBOOB COMMANDS
Romain Bignon's avatar
Romain Bignon committed
78
.TP
79 80 81 82 83 84 85 86
\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
87 88 89
* enable         enable given backends
.br
* disable        disable given backends
90
.br
Romain Bignon's avatar
Romain Bignon committed
91
* only           enable given backends and disable the others
92
.br
Romain Bignon's avatar
Romain Bignon committed
93
* list           list backends
94
.br
Romain Bignon's avatar
Romain Bignon committed
95
* add            add a backend
96
.br
Romain Bignon's avatar
Romain Bignon committed
97
* register       register a new account on a website
98
.br
Romain Bignon's avatar
Romain Bignon committed
99
* edit           edit a backend
100
.br
Romain Bignon's avatar
Romain Bignon committed
101
* remove         remove a backend
102
.br
Romain Bignon's avatar
Romain Bignon committed
103
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
104
.TP
Romain Bignon's avatar
Romain Bignon committed
105
\fBcd\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
106 107
.br
Follow a path.
Romain Bignon's avatar
Romain Bignon committed
108
.br
Romain Bignon's avatar
Romain Bignon committed
109 110 111
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
112
.TP
113 114 115 116 117 118 119 120 121
\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

.br
If no argument is given, print the current condition expression.
Romain Bignon's avatar
Romain Bignon committed
122
.TP
123 124 125 126 127 128 129 130 131 132 133
\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.
Romain Bignon's avatar
Romain Bignon committed
134
.TP
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
\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.
Romain Bignon's avatar
Romain Bignon committed
160
.TP
161 162 163 164 165 166 167
\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.
Romain Bignon's avatar
Romain Bignon committed
168
.TP
169 170 171 172 173 174 175 176 177 178 179 180
\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
Romain Bignon's avatar
Romain Bignon committed
181
\fBls\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
182 183
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
184 185
.br
If an argument is given, list the specified path.
Romain Bignon's avatar
Romain Bignon committed
186 187 188 189 190
.TP
\fBquit\fR
.br
Quit the application.
.TP
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
\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)

.SH LOGGING OPTIONS
Romain Bignon's avatar
Romain Bignon committed
215 216 217 218 219 220 221 222 223 224
.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
225 226
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
Romain Bignon's avatar
Romain Bignon committed
227
.TP
228 229 230 231
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response

.SH RESULTS OPTIONS
Romain Bignon's avatar
Romain Bignon committed
232
.TP
233 234 235 236 237 238 239 240 241 242 243 244
\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
Romain Bignon's avatar
Romain Bignon committed
245 246
select output formatter (account_list, csv, htmltable, multiline, ops_list,
pretty_qif, qif, recipient_list, simple, table, transfer, webkit)
247 248 249 250 251 252
.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
253 254 255
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
Romain Bignon's avatar
Romain Bignon committed
256 257

.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
258
Copyright(C) 2010-2011 Romain Bignon, Christophe Benz
Romain Bignon's avatar
Romain Bignon committed
259 260 261 262 263
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
264
"~/.config/weboob/backends" 
265 266

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