qflatboob.1 3.96 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 QFLATBOOB 1 "27 February 2019" "qflatboob 1\&.5"
4
.SH NAME
5
qflatboob \- search for housing
6 7 8 9 10 11 12 13 14 15
.SH SYNOPSIS
.B qflatboob
[\-h] [\-dqv] [\-b \fIbackends\fR] ...
.br
.B qflatboob
[\-\-help] [\-\-version]

.SH DESCRIPTION
.LP

16
Qt application to search for housing.
17 18

.SS Supported websites:
Romain Bignon's avatar
Romain Bignon committed
19 20
* avendrealouer (avendrealouer website)
.br
Florent Fourcot's avatar
Florent Fourcot committed
21 22 23 24
* entreparticuliers (entreparticuliers.com website)
.br
* explorimmo (explorimmo website)
.br
Romain Bignon's avatar
Romain Bignon committed
25 26
* foncia (Foncia housing website.)
.br
Florent Fourcot's avatar
Florent Fourcot committed
27 28
* leboncoin (search house on leboncoin website)
.br
Florent Fourcot's avatar
Florent Fourcot committed
29 30
* logicimmo (logicimmo website)
.br
31 32 33 34 35 36 37 38 39 40 41 42 43
* pap (French housing website)
.br
* seloger (French housing website)
.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
44 45 46
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
47 48 49
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Romain Bignon's avatar
Romain Bignon committed
50 51 52
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
53 54 55 56

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
57
display debug messages. Set up it twice to more verbosity
58 59 60 61 62 63 64 65 66 67 68 69
.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
Romain Bignon's avatar
Romain Bignon committed
70 71 72
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
73

Florent Fourcot's avatar
Florent Fourcot committed
74
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
75
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
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
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
96 97 98 99
.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
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
.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
117
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
118 119
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
120 121 122 123 124
.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
125

126
.SH COPYRIGHT
Florent Fourcot's avatar
Florent Fourcot committed
127
Copyright(C) 2010-2014 Romain Bignon
128
.LP
Florent Fourcot's avatar
Florent Fourcot committed
129
For full copyright information see the COPYING file in the weboob package.
130 131 132
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
133
"~/.config/weboob/backends" 
134

Romain Bignon's avatar
Romain Bignon committed
135
"~/.config/weboob/qflatboob"
136 137 138

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