comparoob.1 6.76 KB
Newer Older
1
.\" -*- coding: utf-8 -*-
Florent Fourcot's avatar
Florent Fourcot committed
2 3
.\" This file was generated automatically by tools/make_man.sh.
.TH COMPAROOB 1 "03 September 2014" "comparoob 0\&.j"
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
Florent Fourcot's avatar
Florent Fourcot committed
24 25 26
\fBinfo\fR \fIID\fR
.br
Get information about a product.
27
.TP
Florent Fourcot's avatar
Florent Fourcot committed
28 29 30 31 32
\fBprices\fR [\fIPATTERN\fR]
.br
Display prices for a product. If a pattern is supplied, do not prompt
.br
what product to compare.
33 34 35 36 37 38 39 40 41 42
.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
43
* enable         enable given backends
44
.br
Romain Bignon's avatar
Romain Bignon committed
45
* disable        disable given backends
46
.br
Romain Bignon's avatar
Romain Bignon committed
47
* only           enable given backends and disable the others
48
.br
Romain Bignon's avatar
Romain Bignon committed
49
* list           list backends
50
.br
Romain Bignon's avatar
Romain Bignon committed
51
* add            add a backend
52
.br
Romain Bignon's avatar
Romain Bignon committed
53
* register       register a new account on a website
54
.br
Romain Bignon's avatar
Romain Bignon committed
55
* edit           edit a backend
56
.br
Romain Bignon's avatar
Romain Bignon committed
57 58 59
* remove         remove a backend
.br
* list\-modules   list modules
60 61 62 63 64 65 66 67 68 69 70
.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
71
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
72 73 74 75 76 77 78 79 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
.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
129
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
130 131 132 133
.br
List objects in current path.
.br
If an argument is given, list the specified path.
Florent Fourcot's avatar
Florent Fourcot committed
134
.br
Florent Fourcot's avatar
Florent Fourcot committed
135
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent Fourcot's avatar
Florent Fourcot committed
136 137 138
.br
return results as soon as possible.
.br
Florent Fourcot's avatar
Florent Fourcot committed
139
Use \-d option to display information about a collection (and to not
Florent Fourcot's avatar
Florent Fourcot committed
140 141 142 143
.br
display the content of it). It has the same behavior than the well
.br
know UNIX "ls" command.
Florent Fourcot's avatar
Florent Fourcot committed
144 145 146 147
.br

.br
Default is limited to 40 results.
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
.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
175 176 177
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
178 179 180
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201

.SH LOGGING OPTIONS
.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
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
.TP
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
202 203
filter result items to display given a boolean expression. See CONDITION section
for the syntax
204 205
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
206
limit number of results (from each backends)
207 208 209 210 211 212 213
.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
214 215
select output formatter (csv, htmltable, json, json_line, multiline, price,
prices, simple, table, webkit)
216 217 218 219 220 221 222 223 224 225
.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
226
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
227
The \-c and \-\-condition is a flexible way to sort and get only interesting results. It supports conditions on numerical values, dates, and strings. Dates are given in YYYY\-MM\-DD format.
Florent Fourcot's avatar
Florent Fourcot committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
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
You can make a expression combinations with the keywords \fB" AND "\fR and \fB" OR "\fR.

.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
267
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
268 269 270
.fi
Get transactions betweens the 2th December and 8th December 2013.

271 272 273 274 275 276 277 278 279 280 281
.SH COPYRIGHT
Copyright(C) 2012 Romain Bignon
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.config/weboob/backends" 

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