traveloob.1 8.27 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 TRAVELOOB 1 "13 February 2020" "traveloob 2\&.0"
Romain Bignon's avatar
Romain Bignon committed
4
.SH NAME
5
traveloob \- search for train stations and departures
Romain Bignon's avatar
Romain Bignon committed
6
.SH SYNOPSIS
7
.B traveloob
8
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon's avatar
Romain Bignon committed
9
.br
10
.B traveloob
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 search for train stations and get departure times.
Romain Bignon's avatar
Romain Bignon committed
17

18
.SS Supported websites:
Florent Fourcot's avatar
Florent Fourcot committed
19 20
* blablacar (blablacar website)
.br
Romain Bignon's avatar
Romain Bignon committed
21
* transilien (Public transportation in the Paris area)
22 23
.SH TRAVELOOB 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
\fBdepartures\fR \fISTATION\fR [\fIARRIVAL\fR [\fIDATE\fR]]]
29 30
.br
List all departures for a given station.
Florent Fourcot's avatar
Florent Fourcot committed
31
.br
Florent Fourcot's avatar
Florent Fourcot committed
32 33
The format for the date is "yyyy\-mm\-dd HH:MM" or "HH:MM".
.br
Florent Fourcot's avatar
Florent Fourcot committed
34 35 36

.br
Default is limited to 10 results.
Romain Bignon's avatar
Romain Bignon committed
37
.TP
Romain Bignon's avatar
Romain Bignon committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
\fBroadmap\fR \fIDEPARTURE\fR \fIARRIVAL\fR
.br
Display the roadmap to travel from DEPARTURE to ARRIVAL.
.br

.br
Command\-line parameters:
.br
\-\-departure\-time TIME    requested departure time
.br
\-\-arrival\-time TIME      requested arrival time
.br

.br
TIME might be in form "yyyy\-mm\-dd HH:MM" or "HH:MM".
.br

.br
Example:
.br
> roadmap Puteaux Aulnay\-sous\-Bois \-\-arrival\-time 22:00
.TP
60 61 62
\fBstations\fR \fIPATTERN\fR
.br
Search stations.
Florent Fourcot's avatar
Florent Fourcot committed
63 64 65 66
.br

.br
Default is limited to 10 results.
67
.SH WEBOOB COMMANDS
Romain Bignon's avatar
Romain Bignon committed
68
.TP
69 70 71 72
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br
Romain Bignon's avatar
Romain Bignon committed
73

74 75 76
.br
ACTION is one of the following (default: list):
.br
Romain Bignon's avatar
Romain Bignon committed
77
* enable         enable given backends
78
.br
Romain Bignon's avatar
Romain Bignon committed
79
* disable        disable given backends
80
.br
Romain Bignon's avatar
Romain Bignon committed
81
* only           enable given backends and disable the others
82
.br
Romain Bignon's avatar
Romain Bignon committed
83
* list           list backends
84
.br
Romain Bignon's avatar
Romain Bignon committed
85
* add            add a backend
86
.br
Romain Bignon's avatar
Romain Bignon committed
87
* register       register a new account on a website
88
.br
Romain Bignon's avatar
Romain Bignon committed
89
* edit           edit a backend
90
.br
Romain Bignon's avatar
Romain Bignon committed
91 92 93
* remove         remove a backend
.br
* list\-modules   list modules
94
.TP
Romain Bignon's avatar
Romain Bignon committed
95
\fBcd\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
96 97
.br
Follow a path.
Romain Bignon's avatar
Romain Bignon committed
98
.br
Romain Bignon's avatar
Romain Bignon committed
99 100 101
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
102
.TP
103 104
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent Fourcot's avatar
Florent Fourcot committed
105
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
106 107 108
.br
If the "off" value is given, conditional filtering is disabled.
.br
Romain Bignon's avatar
Romain Bignon committed
109

110 111
.br
If no argument is given, print the current condition expression.
Romain Bignon's avatar
Romain Bignon committed
112
.TP
113 114 115 116 117 118 119 120 121 122 123
\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.
Romain Bignon's avatar
Romain Bignon committed
124
.TP
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
\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
150
.TP
151 152 153 154 155 156 157 158 159 160 161
\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
162
.TP
Florent Fourcot's avatar
Florent Fourcot committed
163
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
164 165
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
166 167
.br
If an argument is given, list the specified path.
Florent Fourcot's avatar
Florent Fourcot committed
168
.br
Florent Fourcot's avatar
Florent Fourcot committed
169
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent Fourcot's avatar
Florent Fourcot committed
170 171 172
.br
return results as soon as possible.
.br
Florent Fourcot's avatar
Florent Fourcot committed
173
Use \-d option to display information about a collection (and to not
Florent Fourcot's avatar
Florent Fourcot committed
174 175 176
.br
display the content of it). It has the same behavior than the well
.br
Florent Fourcot's avatar
Florent Fourcot committed
177
known UNIX "ls" command.
Florent Fourcot's avatar
Florent Fourcot committed
178 179 180 181
.br

.br
Default is limited to 40 results.
Romain Bignon's avatar
Romain Bignon committed
182 183 184 185 186
.TP
\fBquit\fR
.br
Quit the application.
.TP
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
\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
209 210 211
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
212 213 214
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
215 216 217
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
218 219 220
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
221

Romain Bignon's avatar
Romain Bignon committed
222 223 224 225 226 227
.SH TRAVELOOB OPTIONS
.TP
\fB\-\-departure\-time=DEPARTURE_TIME\fR
.TP
\fB\-\-arrival\-time=ARRIVAL_TIME\fR

228
.SH LOGGING OPTIONS
Romain Bignon's avatar
Romain Bignon committed
229 230
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
231
display debug messages. Set up it twice to more verbosity
Romain Bignon's avatar
Romain Bignon committed
232 233 234 235 236 237 238
.TP
\fB\-q\fR, \fB\-\-quiet\fR
display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.TP
239 240
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
Romain Bignon's avatar
Romain Bignon committed
241
.TP
242 243
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
Florent Fourcot's avatar
Florent Fourcot committed
244 245 246
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
247 248

.SH RESULTS OPTIONS
Romain Bignon's avatar
Romain Bignon committed
249
.TP
250
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
251 252
filter result items to display given a boolean expression. See CONDITION section
for the syntax
253 254
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
255
limit number of results (from each backends)
256 257 258 259 260 261 262
.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
263 264
select output formatter (csv, departures, htmltable, json, json_line, multiline,
simple, stations, table, webkit)
265 266 267 268 269 270
.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
271 272 273
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
Romain Bignon's avatar
Romain Bignon committed
274

Florent Fourcot's avatar
Florent Fourcot committed
275
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
276
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
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
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
297 298 299 300
.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
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
.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
318
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
319 320
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
321 322 323 324 325
.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
326

Romain Bignon's avatar
Romain Bignon committed
327
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
328
Copyright(C) 2010-2020 Romain Bignon
Romain Bignon's avatar
Romain Bignon committed
329
.LP
Florent Fourcot's avatar
Florent Fourcot committed
330
For full copyright information see the COPYING file in the weboob package.
Romain Bignon's avatar
Romain Bignon committed
331 332 333
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
334
"~/.config/weboob/backends" 
335 336

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