videoob.1 8.99 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 VIDEOOB 1 "27 February 2019" "videoob 1\&.5"
Romain Bignon's avatar
Romain Bignon committed
4
.SH NAME
5
videoob \- search and play videos
Romain Bignon's avatar
Romain Bignon committed
6 7
.SH SYNOPSIS
.B videoob
8
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon's avatar
Romain Bignon committed
9 10
.br
.B videoob
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 videos on various websites, play and download them and get information.
Romain Bignon's avatar
Romain Bignon committed
17

18
.SS Supported websites:
Florent Fourcot's avatar
Florent Fourcot committed
19 20
* allocine (AlloCiné French cinema database service)
.br
Romain Bignon's avatar
Romain Bignon committed
21
* arte (Arte French and German TV)
22
.br
Romain Bignon's avatar
Romain Bignon committed
23
* canalplus (Canal Plus French TV)
24
.br
Romain Bignon's avatar
Romain Bignon committed
25
* dailymotion (Dailymotion video streaming website)
Romain Bignon's avatar
Romain Bignon committed
26
.br
Romain Bignon's avatar
Romain Bignon committed
27
* francetelevisions (France Télévisions video website)
28
.br
Florent Fourcot's avatar
Florent Fourcot committed
29 30
* funmooc (France\-Université\-Numérique MOOC website)
.br
Romain Bignon's avatar
Romain Bignon committed
31
* ina (INA French TV video archives)
Romain Bignon's avatar
Romain Bignon committed
32
.br
Romain Bignon's avatar
Romain Bignon committed
33
* peertube (Peertube)
Romain Bignon's avatar
Romain Bignon committed
34
.br
Florent Fourcot's avatar
Florent Fourcot committed
35 36
* pornhub (Pornhub pornographic video streaming website)
.br
Florent Fourcot's avatar
Florent Fourcot committed
37
* rmll (Videos from RMLL)
38
.br
Romain Bignon's avatar
Romain Bignon committed
39 40
* vimeo (Vimeo video streaming website)
.br
Florent Fourcot's avatar
Florent Fourcot committed
41 42
* vine (vine website)
.br
Romain Bignon's avatar
Romain Bignon committed
43 44
* xhamster (xhamster website)
.br
Romain Bignon's avatar
Romain Bignon committed
45
* youjizz (YouJizz pornographic video streaming website)
46
.br
Romain Bignon's avatar
Romain Bignon committed
47
* youporn (YouPorn pornographic video streaming website)
Romain Bignon's avatar
Romain Bignon committed
48 49
.br
* youtube (YouTube video streaming website)
50
.SH VIDEOOB COMMANDS
Romain Bignon's avatar
Romain Bignon committed
51
.TP
Romain Bignon's avatar
Romain Bignon committed
52 53 54 55
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Romain Bignon's avatar
Romain Bignon committed
56 57 58
\fBdownload\fR \fIID\fR [\fIFILENAME\fR]
.br
Download a video
Florent Fourcot's avatar
Florent Fourcot committed
59 60 61 62 63 64 65 66 67 68
.br

.br
Braces\-enclosed tags are replaced with data fields. Use the 'info'
.br
command to see what fields are available on a given video.
.br

.br
Example: download KdRRge4XYIo@youtube '{title}.{ext}'
Romain Bignon's avatar
Romain Bignon committed
69
.TP
Florent Fourcot's avatar
Florent Fourcot committed
70
\fBinfo\fR \fIID\fR [\fIID\fR2 [...]]
71 72
.br
Get information about a video.
Romain Bignon's avatar
Romain Bignon committed
73
.TP
74 75 76 77
\fBnsfw\fR [on | off]
.br
If argument is given, enable or disable the non\-suitable for work behavior.
.br
Romain Bignon's avatar
Romain Bignon committed
78

79 80 81 82 83 84
.br
If no argument is given, print the current behavior.
.TP
\fBplay\fR \fIID\fR
.br
Play a video with a found player.
Romain Bignon's avatar
Romain Bignon committed
85
.TP
Florent Fourcot's avatar
Florent Fourcot committed
86 87 88
\fBplaylist\fR cmd [args]
.br
playlist add ID [ID2 ID3 ...]
Florent Fourcot's avatar
Florent Fourcot committed
89 90 91 92 93 94
.br
playlist remove ID [ID2 ID3 ...]
.br
playlist export [FILENAME]
.br
playlist display
Florent Fourcot's avatar
Florent Fourcot committed
95 96 97 98
.br
playlist download [PATH]
.br
playlist play
Florent Fourcot's avatar
Florent Fourcot committed
99
.TP
Romain Bignon's avatar
Romain Bignon committed
100
\fBsearch\fR \fIPATTERN\fR
101 102
.br
Search for videos matching a PATTERN.
Florent Fourcot's avatar
Florent Fourcot committed
103 104 105 106
.br

.br
Default is limited to 10 results.
107
.SH WEBOOB COMMANDS
Romain Bignon's avatar
Romain Bignon committed
108
.TP
109 110 111 112 113 114 115 116
\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
117
* enable         enable given backends
118
.br
Romain Bignon's avatar
Romain Bignon committed
119
* disable        disable given backends
120
.br
Romain Bignon's avatar
Romain Bignon committed
121
* only           enable given backends and disable the others
122
.br
Romain Bignon's avatar
Romain Bignon committed
123
* list           list backends
124
.br
Romain Bignon's avatar
Romain Bignon committed
125
* add            add a backend
126
.br
Romain Bignon's avatar
Romain Bignon committed
127
* register       register a new account on a website
128
.br
Romain Bignon's avatar
Romain Bignon committed
129
* edit           edit a backend
130
.br
Romain Bignon's avatar
Romain Bignon committed
131 132 133
* remove         remove a backend
.br
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
134
.TP
Romain Bignon's avatar
Romain Bignon committed
135
\fBcd\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
136 137
.br
Follow a path.
Romain Bignon's avatar
Romain Bignon committed
138
.br
Romain Bignon's avatar
Romain Bignon committed
139 140 141
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
142
.TP
143 144
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent Fourcot's avatar
Florent Fourcot committed
145
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
146 147 148 149 150 151
.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
152
.TP
153 154 155 156 157 158 159 160 161 162 163
\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
164
.TP
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
\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
190
.TP
191 192 193 194 195 196 197 198 199 200 201 202
\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
203
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
204 205
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
206 207
.br
If an argument is given, list the specified path.
Florent Fourcot's avatar
Florent Fourcot committed
208
.br
Florent Fourcot's avatar
Florent Fourcot committed
209
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent Fourcot's avatar
Florent Fourcot committed
210 211 212
.br
return results as soon as possible.
.br
Florent Fourcot's avatar
Florent Fourcot committed
213
Use \-d option to display information about a collection (and to not
Florent Fourcot's avatar
Florent Fourcot committed
214 215 216
.br
display the content of it). It has the same behavior than the well
.br
Florent Fourcot's avatar
Florent Fourcot committed
217
known UNIX "ls" command.
Florent Fourcot's avatar
Florent Fourcot committed
218 219 220 221
.br

.br
Default is limited to 40 results.
Romain Bignon's avatar
Romain Bignon committed
222 223 224 225 226
.TP
\fBquit\fR
.br
Quit the application.
.TP
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
\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
249 250 251
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
252 253 254
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
255 256 257
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
258 259 260
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
261 262

.SH LOGGING OPTIONS
Romain Bignon's avatar
Romain Bignon committed
263 264
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
265
display debug messages. Set up it twice to more verbosity
Romain Bignon's avatar
Romain Bignon committed
266 267 268 269 270 271 272
.TP
\fB\-q\fR, \fB\-\-quiet\fR
display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.TP
273 274
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
Romain Bignon's avatar
Romain Bignon committed
275
.TP
276 277
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
Florent Fourcot's avatar
Florent Fourcot committed
278 279 280
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
281 282

.SH RESULTS OPTIONS
Romain Bignon's avatar
Romain Bignon committed
283
.TP
284
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
285 286
filter result items to display given a boolean expression. See CONDITION section
for the syntax
287 288
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
289
limit number of results (from each backends)
290 291 292 293 294 295 296
.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
297 298
select output formatter (csv, htmltable, json, json_line, multiline, simple,
table, video_list, webkit)
299 300 301 302 303 304
.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
305 306 307
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
Romain Bignon's avatar
Romain Bignon committed
308

Florent Fourcot's avatar
Florent Fourcot committed
309
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
310
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
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
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
331 332 333 334
.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
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
.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
352
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
353 354
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
355 356 357 358 359
.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
360

Romain Bignon's avatar
Romain Bignon committed
361
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
362
Copyright(C) 2010-2019 Christophe Benz, Romain Bignon, John Obbele
Romain Bignon's avatar
Romain Bignon committed
363
.LP
Florent Fourcot's avatar
Florent Fourcot committed
364
For full copyright information see the COPYING file in the weboob package.
Romain Bignon's avatar
Romain Bignon committed
365 366 367
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
368
"~/.config/weboob/backends" 
369 370

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