boobsize.1 8.32 KB
Newer Older
Florent Fourcot's avatar
Florent Fourcot committed
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 BOOBSIZE 1 "06 January 2019" "boobsize 1\&.4"
Florent Fourcot's avatar
Florent Fourcot committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
.SH NAME
boobsize \- display sensors and gauges values
.SH SYNOPSIS
.B boobsize
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B boobsize
[\-\-help] [\-\-version]

.SH DESCRIPTION
.LP

Console application allowing to display various sensors and gauges values.

.SS Supported websites:
* dresdenwetter (Private wetter station Dresden)
.br
* jcvelaux (City bike renting availability information.
Romain Bignon's avatar
Romain Bignon committed
22
Cities: Rouen, Toulouse, Luxembourg, Valence, Stockholm, Goteborg, Santander, Amiens, Lillestrom, Mulhouse, Lyon, Ljubljana, Seville, Namur, Nancy, Creteil, Bruxelles\-Capitale, Cergy\-Pontoise, Vilnius, Toyama, Kazan, Marseille, Nantes, Besancon)
Florent Fourcot's avatar
Florent Fourcot committed
23
.br
Florent Fourcot's avatar
Florent Fourcot committed
24 25
* mareeinfo (Un module qui permet d' aller a la pêche aux moules totalement informé)
.br
Florent Fourcot's avatar
Florent Fourcot committed
26 27
* ratp (RATP network status)
.br
Florent Fourcot's avatar
Florent Fourcot committed
28 29
* sachsen (Level of Sachsen river)
.br
Florent Fourcot's avatar
Florent Fourcot committed
30
* vlille (Lille bike renting availability information)
Florent Fourcot's avatar
Florent Fourcot committed
31 32
.SH BOOBSIZE COMMANDS
.TP
Romain Bignon's avatar
Romain Bignon committed
33 34 35 36
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Florent Fourcot's avatar
Florent Fourcot committed
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 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 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
\fBdetails\fR \fIGAUGE_ID\fR
.br
Display details of all sensors of the gauge.
.TP
\fBhistory\fR \fISENSOR_ID\fR
.br
Get history of a specific sensor (use 'search' to find a gauge, and sensors GAUGE_ID to list sensors attached to the gauge).
.TP
\fBlast_sensor_measure\fR \fISENSOR_ID\fR
.br
Get last measure of a sensor.
.TP
\fBsearch\fR [\fIPATTERN\fR]
.br
Display all gauges. If PATTERN is specified, search on a pattern.
.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
* enable         enable given backends
.br
* disable        disable given backends
.br
* only           enable given backends and disable the others
.br
* list           list backends
.br
* add            add a backend
.br
* register       register a new account on a website
.br
* edit           edit a backend
.br
* remove         remove a backend
.br
* list\-modules   list modules
.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
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
.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
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
.br
List objects in current path.
.br
If an argument is given, list the specified path.
.br
Florent Fourcot's avatar
Florent Fourcot committed
154
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent Fourcot's avatar
Florent Fourcot committed
155 156 157
.br
return results as soon as possible.
.br
Florent Fourcot's avatar
Florent Fourcot committed
158
Use \-d option to display information about a collection (and to not
Florent Fourcot's avatar
Florent Fourcot committed
159 160 161
.br
display the content of it). It has the same behavior than the well
.br
Florent Fourcot's avatar
Florent Fourcot committed
162
known UNIX "ls" command.
Florent Fourcot's avatar
Florent Fourcot committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
.br

.br
Default is limited to 40 results.
.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)
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
200 201 202
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
203 204 205
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
Florent Fourcot's avatar
Florent Fourcot committed
206 207 208 209

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
210
display debug messages. Set up it twice to more verbosity
Florent Fourcot's avatar
Florent Fourcot committed
211 212 213 214 215 216 217 218 219 220 221 222
.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
223 224 225
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
Florent Fourcot's avatar
Florent Fourcot committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
filter result items to display given a boolean expression. See CONDITION section
for the syntax
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
limit number of results (from each backends)
.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
242 243
select output formatter (csv, gauge_list, htmltable, json, json_line, multiline,
simple, table, webkit)
Florent Fourcot's avatar
Florent Fourcot committed
244 245 246 247 248 249 250 251 252 253 254
.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

.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
255
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
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
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
276 277 278 279
.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
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
.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
297
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
298 299
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
300 301 302 303 304
.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
305 306

.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
307
Copyright(C) 2013-2019 Florent Fourcot
Florent Fourcot's avatar
Florent Fourcot committed
308
.LP
Florent Fourcot's avatar
Florent Fourcot committed
309
For full copyright information see the COPYING file in the weboob package.
Florent Fourcot's avatar
Florent Fourcot committed
310 311 312 313 314 315 316
.LP
.RE
.SH FILES
"~/.config/weboob/backends" 

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