comparoob.1 7.65 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 COMPAROOB 1 "06 January 2019" "comparoob 1\&.4"
4
.SH NAME
5
comparoob \- compare products
6 7 8 9 10 11 12 13 14 15 16 17 18
.SH SYNOPSIS
.B comparoob
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B comparoob
[\-\-help] [\-\-version]

.SH DESCRIPTION
.LP

Console application to compare products.

.SS Supported websites:
Florent Fourcot's avatar
Florent Fourcot committed
19 20
* lacentrale (Vehicule prices at LaCentrale.fr)
.br
21 22 23
* prixcarburants (French governement website to compare fuel prices)
.SH COMPAROOB COMMANDS
.TP
Romain Bignon's avatar
Romain Bignon committed
24 25 26 27
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Florent Fourcot's avatar
Florent Fourcot committed
28 29 30
\fBinfo\fR \fIID\fR
.br
Get information about a product.
31
.TP
Florent Fourcot's avatar
Florent Fourcot committed
32 33 34 35 36
\fBprices\fR [\fIPATTERN\fR]
.br
Display prices for a product. If a pattern is supplied, do not prompt
.br
what product to compare.
Florent Fourcot's avatar
Florent Fourcot committed
37 38 39 40
.br

.br
Default is limited to 10 results.
41 42 43 44 45 46 47 48 49 50
.SH WEBOOB 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
51
* enable         enable given backends
52
.br
Romain Bignon's avatar
Romain Bignon committed
53
* disable        disable given backends
54
.br
Romain Bignon's avatar
Romain Bignon committed
55
* only           enable given backends and disable the others
56
.br
Romain Bignon's avatar
Romain Bignon committed
57
* list           list backends
58
.br
Romain Bignon's avatar
Romain Bignon committed
59
* add            add a backend
60
.br
Romain Bignon's avatar
Romain Bignon committed
61
* register       register a new account on a website
62
.br
Romain Bignon's avatar
Romain Bignon committed
63
* edit           edit a backend
64
.br
Romain Bignon's avatar
Romain Bignon committed
65 66 67
* remove         remove a backend
.br
* list\-modules   list modules
68 69 70 71 72 73 74 75 76 77 78
.TP
\fBcd\fR [\fIPATH\fR]
.br
Follow a path.
.br
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
.TP
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent Fourcot's avatar
Florent Fourcot committed
79
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
.br
If the "off" value is given, conditional filtering is disabled.
.br

.br
If no argument is given, print the current condition expression.
.TP
\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.
.TP
\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.
.TP
\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
Florent Fourcot's avatar
Florent Fourcot committed
137
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
138 139 140 141
.br
List objects in current path.
.br
If an argument is given, list the specified path.
Florent Fourcot's avatar
Florent Fourcot committed
142
.br
Florent Fourcot's avatar
Florent Fourcot committed
143
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent Fourcot's avatar
Florent Fourcot committed
144 145 146
.br
return results as soon as possible.
.br
Florent Fourcot's avatar
Florent Fourcot committed
147
Use \-d option to display information about a collection (and to not
Florent Fourcot's avatar
Florent Fourcot committed
148 149 150
.br
display the content of it). It has the same behavior than the well
.br
Florent Fourcot's avatar
Florent Fourcot committed
151
known UNIX "ls" command.
Florent Fourcot's avatar
Florent Fourcot committed
152 153 154 155
.br

.br
Default is limited to 40 results.
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
.TP
\fBquit\fR
.br
Quit the application.
.TP
\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)
Florent Fourcot's avatar
Florent Fourcot committed
183 184 185
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
186 187 188
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
189 190 191
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
192 193 194
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
195 196 197 198

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
199
display debug messages. Set up it twice to more verbosity
200 201 202 203 204 205 206 207 208 209 210 211
.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
212 213 214
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
215 216 217 218

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
219 220
filter result items to display given a boolean expression. See CONDITION section
for the syntax
221 222
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
223
limit number of results (from each backends)
224 225 226 227 228 229 230
.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
231 232
select output formatter (csv, htmltable, json, json_line, multiline, price,
prices, simple, table, webkit)
233 234 235 236 237 238 239 240 241 242
.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
243
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
244
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
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
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
265 266 267 268
.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
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
.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
286
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
287 288
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
289 290 291 292 293
.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
294

295
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
296
Copyright(C) 2012-2019 Romain Bignon
297
.LP
Florent Fourcot's avatar
Florent Fourcot committed
298
For full copyright information see the COPYING file in the weboob package.
299 300 301 302 303 304 305
.LP
.RE
.SH FILES
"~/.config/weboob/backends" 

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