wetboobs.1 7.92 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 WETBOOBS 1 "27 February 2019" "wetboobs 1\&.5"
Romain Bignon's avatar
Romain Bignon committed
4
.SH NAME
5
wetboobs \- display weather and forecasts
Romain Bignon's avatar
Romain Bignon committed
6 7
.SH SYNOPSIS
.B wetboobs
8
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon's avatar
Romain Bignon committed
9 10
.br
.B wetboobs
11 12
[\-\-help] [\-\-version]

Romain Bignon's avatar
Romain Bignon committed
13 14 15
.SH DESCRIPTION
.LP

Romain Bignon's avatar
Romain Bignon committed
16
Console application allowing to display weather and forecasts in your city.
Romain Bignon's avatar
Romain Bignon committed
17

Florent Fourcot's avatar
Florent Fourcot committed
18
.SS Supported websites:
Florent Fourcot's avatar
Florent Fourcot committed
19 20
* ilmatieteenlaitos (Get forecasts from the Ilmatieteenlaitos.fi website)
.br
Florent Fourcot's avatar
Florent Fourcot committed
21 22
* lameteoagricole (lameteoagricole website)
.br
Florent Fourcot's avatar
Florent Fourcot committed
23 24 25 26
* meteofrance (Get forecasts from the MeteoFrance website)
.br
* weather (Get forecasts from weather.com)
.br
Florent Fourcot's avatar
Florent Fourcot committed
27
* yahoo (Yahoo! Weather.)
28
.SH WETBOOBS COMMANDS
Romain Bignon's avatar
Romain Bignon committed
29
.TP
Romain Bignon's avatar
Romain Bignon committed
30
\fBcities\fR \fIPATTERN\fR
31
.br
Romain Bignon's avatar
Romain Bignon committed
32
Search cities.
Florent Fourcot's avatar
Florent Fourcot committed
33 34 35 36
.br

.br
Default is limited to 10 results.
Romain Bignon's avatar
Romain Bignon committed
37 38
.TP
\fBcurrent\fR \fICITY_ID\fR
39
.br
Romain Bignon's avatar
Romain Bignon committed
40
Get current weather for specified city. Use the 'cities' command to find them.
Romain Bignon's avatar
Romain Bignon committed
41
.TP
Romain Bignon's avatar
Romain Bignon committed
42 43 44 45
\fBdebug\fR
.br
Launch a debug Python shell
.TP
46 47
\fBforecasts\fR \fICITY_ID\fR
.br
Romain Bignon's avatar
Romain Bignon committed
48
Get forecasts for specified city. Use the 'cities' command to find them.
49 50 51 52 53 54
.SH WEBOOB COMMANDS
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br
Romain Bignon's avatar
Romain Bignon committed
55

56 57 58
.br
ACTION is one of the following (default: list):
.br
Romain Bignon's avatar
Romain Bignon committed
59
* enable         enable given backends
60
.br
Romain Bignon's avatar
Romain Bignon committed
61
* disable        disable given backends
62
.br
Romain Bignon's avatar
Romain Bignon committed
63
* only           enable given backends and disable the others
64
.br
Romain Bignon's avatar
Romain Bignon committed
65
* list           list backends
66
.br
Romain Bignon's avatar
Romain Bignon committed
67
* add            add a backend
68
.br
Romain Bignon's avatar
Romain Bignon committed
69
* register       register a new account on a website
70
.br
Romain Bignon's avatar
Romain Bignon committed
71
* edit           edit a backend
72
.br
Romain Bignon's avatar
Romain Bignon committed
73 74 75
* remove         remove a backend
.br
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
76
.TP
Romain Bignon's avatar
Romain Bignon committed
77
\fBcd\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
78 79
.br
Follow a path.
Romain Bignon's avatar
Romain Bignon committed
80
.br
Romain Bignon's avatar
Romain Bignon committed
81 82 83
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
84
.TP
85 86
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent Fourcot's avatar
Florent Fourcot committed
87
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
88 89 90 91 92 93
.br
If the "off" value is given, conditional filtering is disabled.
.br

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

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

.SH LOGGING OPTIONS
Romain Bignon's avatar
Romain Bignon committed
205 206
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
207
display debug messages. Set up it twice to more verbosity
Romain Bignon's avatar
Romain Bignon committed
208 209 210 211 212 213 214
.TP
\fB\-q\fR, \fB\-\-quiet\fR
display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.TP
215 216
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
Romain Bignon's avatar
Romain Bignon committed
217
.TP
218 219
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
Florent Fourcot's avatar
Florent Fourcot committed
220 221 222
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
223 224

.SH RESULTS OPTIONS
Romain Bignon's avatar
Romain Bignon committed
225
.TP
226
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
227 228
filter result items to display given a boolean expression. See CONDITION section
for the syntax
229 230
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
231
limit number of results (from each backends)
232 233 234 235 236 237 238
.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
239
select output formatter (cities, csv, current, forecasts, htmltable, json,
Florent Fourcot's avatar
Florent Fourcot committed
240
json_line, multiline, simple, table, webkit)
241 242 243 244 245 246
.TP
\fB\-\-no\-header\fR
do not display header
.TP
\fB\-\-no\-keys\fR
do not display item keys
Romain Bignon's avatar
Romain Bignon committed
247 248 249
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
Romain Bignon's avatar
Romain Bignon committed
250

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

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

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