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

.SH DESCRIPTION
.LP

Weboob\-Debug is a console application to debug backends.

.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
28 29 30
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
31 32 33
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
34 35 36
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
37 38 39 40

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
41
display debug messages. Set up it twice to more verbosity
42 43 44 45 46 47 48 49 50 51 52 53
.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
54 55 56
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
57

Romain Bignon's avatar
Romain Bignon committed
58
.SH WEBOOB\-DEBUG OPTIONS
Romain Bignon's avatar
Romain Bignon committed
59
.TP
Romain Bignon's avatar
Romain Bignon committed
60 61
\fB\-B\fR, \fB\-\-bpython\fR
Prefer bpython over ipython
62

Florent Fourcot's avatar
Florent Fourcot committed
63
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
64
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
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
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
85 86 87 88
.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
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
.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
106
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
107 108
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
109 110 111 112 113
.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
114

115
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
116
Copyright(C) 2010-2019 Christophe Benz
117
.LP
Florent Fourcot's avatar
Florent Fourcot committed
118
For full copyright information see the COPYING file in the weboob package.
119 120 121
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
122
"~/.config/weboob/backends" 
123 124

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