weboob-repos.1 5.37 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-REPOS 1 "27 February 2019" "weboob-repos 1\&.5"
Romain Bignon's avatar
Romain Bignon committed
4
.SH NAME
5
weboob-repos \- manage a weboob repository
Romain Bignon's avatar
Romain Bignon committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
.SH SYNOPSIS
.B weboob\-repos
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B weboob\-repos
[\-\-help] [\-\-version]

.SH DESCRIPTION
.LP

Weboob\-repos is a console application to manage a Weboob Repository.

.SH WEBOOB\-REPOS 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
28
* enable         enable given backends
Romain Bignon's avatar
Romain Bignon committed
29
.br
Romain Bignon's avatar
Romain Bignon committed
30
* disable        disable given backends
Romain Bignon's avatar
Romain Bignon committed
31
.br
Romain Bignon's avatar
Romain Bignon committed
32
* only           enable given backends and disable the others
Romain Bignon's avatar
Romain Bignon committed
33
.br
Romain Bignon's avatar
Romain Bignon committed
34
* list           list backends
Romain Bignon's avatar
Romain Bignon committed
35
.br
Romain Bignon's avatar
Romain Bignon committed
36
* add            add a backend
Romain Bignon's avatar
Romain Bignon committed
37
.br
Romain Bignon's avatar
Romain Bignon committed
38
* register       register a new account on a website
Romain Bignon's avatar
Romain Bignon committed
39
.br
Romain Bignon's avatar
Romain Bignon committed
40
* edit           edit a backend
Romain Bignon's avatar
Romain Bignon committed
41
.br
Romain Bignon's avatar
Romain Bignon committed
42 43 44
* remove         remove a backend
.br
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
.TP
\fBbuild\fR \fISOURCE\fR \fIREPOSITORY\fR
.br
Build backends contained in SOURCE to REPOSITORY.
.br

.br
Example:
.br
$ weboob\-repos build $HOME/src/weboob/modules /var/www/updates.weboob.org/0.a/
.TP
\fBcreate\fR \fINAME\fR [\fIPATH\fR]
.br
Create a new repository. If PATH is missing, create repository
.br
on the current directory.
Romain Bignon's avatar
Romain Bignon committed
61 62 63 64
.TP
\fBdebug\fR
.br
Launch a debug Python shell
Romain Bignon's avatar
Romain Bignon committed
65 66 67 68 69 70 71 72 73 74 75

.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 Fourcot's avatar
Florent Fourcot committed
76 77 78
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
79 80 81
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
82 83 84
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
85 86 87
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
Romain Bignon's avatar
Romain Bignon committed
88 89 90 91

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
92
display debug messages. Set up it twice to more verbosity
Romain Bignon's avatar
Romain Bignon committed
93 94 95 96 97 98 99 100 101 102 103 104
.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
Florent Fourcot's avatar
Florent Fourcot committed
105 106 107
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
Romain Bignon's avatar
Romain Bignon committed
108 109 110 111

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
112 113
filter result items to display given a boolean expression. See CONDITION section
for the syntax
Romain Bignon's avatar
Romain Bignon committed
114 115
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
116
limit number of results (from each backends)
Romain Bignon's avatar
Romain Bignon committed
117 118 119 120 121 122 123
.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
124 125
select output formatter (csv, htmltable, json, json_line, multiline, simple,
table, webkit)
Romain Bignon's avatar
Romain Bignon committed
126 127 128 129 130 131 132 133 134 135
.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 Fourcot's avatar
Florent Fourcot committed
136
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
137
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
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
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
158 159 160 161
.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
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
.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
179
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
180 181
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
182 183 184 185 186
.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
187

Romain Bignon's avatar
Romain Bignon committed
188
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
189
Copyright(C) 2012-2019 Romain Bignon
Romain Bignon's avatar
Romain Bignon committed
190
.LP
Florent Fourcot's avatar
Florent Fourcot committed
191
For full copyright information see the COPYING file in the weboob package.
Romain Bignon's avatar
Romain Bignon committed
192 193 194
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
195 196 197 198
"~/.config/weboob/backends" 

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