cineoob.1 13.3 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 CINEOOB 1 "27 February 2019" "cineoob 1\&.5"
4 5 6 7 8 9 10 11 12 13 14 15 16 17
.SH NAME
cineoob \- search movies and persons around cinema
.SH SYNOPSIS
.B cineoob
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B cineoob
[\-\-help] [\-\-version]

.SH DESCRIPTION
.LP

Console application allowing to search for movies and persons on various cinema databases , list persons related to a movie, list movies related to a person and list common movies of two persons.

Florent Fourcot's avatar
Florent Fourcot committed
18 19 20 21 22 23 24 25 26 27 28
.SS Supported websites:
* allocine (AlloCiné French cinema database service)
.br
* btmon (BTMon BitTorrent database)
.br
* cpasbien (Cpasbien Torrents BitTorrent tracker)
.br
* imdb (Internet Movie Database service)
.br
* kickass (Kickass Torrents BitTorrent tracker)
.br
Romain Bignon's avatar
Romain Bignon committed
29 30
* limetorrents (Limetorrents BitTorrent tracker)
.br
Florent Fourcot's avatar
Florent Fourcot committed
31 32 33 34 35 36 37 38 39 40 41
* opensubtitles (Opensubtitles subtitle website)
.br
* piratebay (The Pirate Bay BitTorrent tracker)
.br
* podnapisi (Podnapisi movies and tv series subtitle website)
.br
* t411 (T411 BitTorrent tracker)
.br
* torrentz (Torrentz Search Engine.)
.br
* tvsubtitles (Tvsubtitles subtitle website)
Romain Bignon's avatar
Romain Bignon committed
42 43
.br
* yggtorrent (YGG BitTorrent tracker)
44 45 46 47 48 49 50 51 52 53 54 55
.SH CINEOOB COMMANDS
.TP
\fBbiography\fR  person\fI_ID\fR
.br
Show the complete biography of a person.
.TP
\fBcasting\fR  movie\fI_ID\fR  [\fIROLE\fR]
.br
List persons related to a movie.
.br
If ROLE is given, filter by ROLE
.TP
Romain Bignon's avatar
Romain Bignon committed
56 57 58 59
\fBdebug\fR
.br
Launch a debug Python shell
.TP
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
\fBfilmography\fR  person\fI_ID\fR  [\fIROLE\fR]
.br
List movies of a person.
.br
If ROLE is given, filter by ROLE
.TP
\fBgetfile_subtitle\fR subtitle\fI_ID\fR [\fIFILENAME\fR]
.br
Get the subtitle or archive file.
.br
FILENAME is where to write the file. If FILENAME is '\-',
.br
the file is written to stdout.
.TP
\fBgetfile_torrent\fR \fIID\fR [\fIFILENAME\fR]
.br
Get the .torrent file.
.br
FILENAME is where to write the file. If FILENAME is '\-',
.br
the file is written to stdout.
.TP
\fBinfo_movie\fR  movie\fI_ID\fR
.br
Get information about a movie.
.TP
\fBinfo_person\fR  person\fI_ID\fR
.br
Get information about a person.
.TP
\fBinfo_subtitle\fR subtitle\fI_ID\fR
.br
Get information about a subtitle.
.TP
\fBinfo_torrent\fR \fIID\fR
.br
Get information about a torrent.
.TP
\fBmovies_in_common\fR  person\fI_ID\fR  person\fI_ID\fR
.br
Get the list of common movies between two persons.
.TP
\fBpersons_in_common\fR  movie\fI_ID\fR  movie\fI_ID\fR
.br
Get the list of common persons between two movies.
.TP
\fBreleases\fR  movie\fI_ID\fR [\fICOUNTRY\fR]
.br
Get releases dates of a movie.
.br
If COUNTRY is given, show release in this country.
.TP
\fBsearch_movie\fR  [\fIPATTERN\fR]
.br
Search movies.
Florent Fourcot's avatar
Florent Fourcot committed
115 116 117 118
.br

.br
Default is limited to 10 results.
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 154 155 156 157 158 159 160 161 162
.TP
\fBsearch_movie_subtitle\fR language movie\fI_ID\fR
.br
Search subtitles of movie_ID.
.br

.br
Language  Abbreviation
.br
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.br
Arabic      ar          Esperanto   eo          Irish       ga          Russian     ru
.br
Afrikaans   af          Estonian    et          Italian     it          Serbian     sr
.br
Albanian    sq          Filipino    tl          Japanese    ja          Slovak      sk
.br
Armenian    hy          Finnish     fi          Kannada     kn          Slovenian   sl
.br
Azerbaijani az          French      fr          Korean      ko          Spanish     es
.br
Basque      eu          Galician    gl          Latin       la          Swahili     sw
.br
Belarusian  be          Georgian    ka          Latvian     lv          Swedish     sv
.br
Bengali     bn          German      de          Lithuanian  lt          Tamil       ta
.br
Bulgarian   bg          Greek       gr          Macedonian  mk          Telugu      te
.br
Catalan     ca          Gujarati    gu          Malay       ms          Thai        th
.br
Chinese     zh          Haitian     ht          Maltese     mt          Turkish     tr
.br
Croatian    hr          Hebrew      iw          Norwegian   no          Ukrainian   uk
.br
Czech       cz          Hindi       hi          Persian     fa          Urdu        ur
.br
Danish      da          Hungaric    hu          Polish      pl          Vietnamese  vi
.br
Dutch       nl          Icelandic   is          Portuguese  pt          Welsh       cy
.br
English     en          Indonesian  id          Romanian    ro          Yiddish     yi
.br
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
Florent Fourcot's avatar
Florent Fourcot committed
163 164 165 166
.br

.br
Default is limited to 10 results.
167 168 169 170
.TP
\fBsearch_movie_torrent\fR movie\fI_ID\fR
.br
Search torrents of movie_ID.
Florent Fourcot's avatar
Florent Fourcot committed
171 172 173 174
.br

.br
Default is limited to 10 results.
175 176 177 178
.TP
\fBsearch_person\fR  [\fIPATTERN\fR]
.br
Search persons.
Florent Fourcot's avatar
Florent Fourcot committed
179 180 181 182
.br

.br
Default is limited to 10 results.
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
.TP
\fBsearch_subtitle\fR language [\fIPATTERN\fR]
.br
Search subtitles.
.br

.br
Language  Abbreviation
.br
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.br
Arabic      ar          Esperanto   eo          Irish       ga          Russian     ru
.br
Afrikaans   af          Estonian    et          Italian     it          Serbian     sr
.br
Albanian    sq          Filipino    tl          Japanese    ja          Slovak      sk
.br
Armenian    hy          Finnish     fi          Kannada     kn          Slovenian   sl
.br
Azerbaijani az          French      fr          Korean      ko          Spanish     es
.br
Basque      eu          Galician    gl          Latin       la          Swahili     sw
.br
Belarusian  be          Georgian    ka          Latvian     lv          Swedish     sv
.br
Bengali     bn          German      de          Lithuanian  lt          Tamil       ta
.br
Bulgarian   bg          Greek       gr          Macedonian  mk          Telugu      te
.br
Catalan     ca          Gujarati    gu          Malay       ms          Thai        th
.br
Chinese     zh          Haitian     ht          Maltese     mt          Turkish     tr
.br
Croatian    hr          Hebrew      iw          Norwegian   no          Ukrainian   uk
.br
Czech       cz          Hindi       hi          Persian     fa          Urdu        ur
.br
Danish      da          Hungaric    hu          Polish      pl          Vietnamese  vi
.br
Dutch       nl          Icelandic   is          Portuguese  pt          Welsh       cy
.br
English     en          Indonesian  id          Romanian    ro          Yiddish     yi
.br
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
Florent Fourcot's avatar
Florent Fourcot committed
227 228 229 230
.br

.br
Default is limited to 10 results.
231 232 233 234
.TP
\fBsearch_torrent\fR [\fIPATTERN\fR]
.br
Search torrents.
Florent Fourcot's avatar
Florent Fourcot committed
235 236 237 238
.br

.br
Default is limited to 10 results.
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 267 268 269 270 271 272 273 274 275 276
.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
Florent Fourcot's avatar
Florent Fourcot committed
277
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
.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
335
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
336 337 338 339
.br
List objects in current path.
.br
If an argument is given, list the specified path.
Florent Fourcot's avatar
Florent Fourcot committed
340
.br
Florent Fourcot's avatar
Florent Fourcot committed
341
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent Fourcot's avatar
Florent Fourcot committed
342 343 344
.br
return results as soon as possible.
.br
Florent Fourcot's avatar
Florent Fourcot committed
345
Use \-d option to display information about a collection (and to not
Florent Fourcot's avatar
Florent Fourcot committed
346 347 348
.br
display the content of it). It has the same behavior than the well
.br
Florent Fourcot's avatar
Florent Fourcot committed
349
known UNIX "ls" command.
Florent Fourcot's avatar
Florent Fourcot committed
350 351 352 353
.br

.br
Default is limited to 40 results.
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
.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
387 388 389
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
390 391 392
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
393 394 395 396

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
397
display debug messages. Set up it twice to more verbosity
398 399 400 401 402 403 404 405 406 407 408 409
.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
410 411 412
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
413 414 415 416

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
417 418
filter result items to display given a boolean expression. See CONDITION section
for the syntax
419 420
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
421
limit number of results (from each backends)
422 423 424 425 426 427 428
.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
429 430 431
select output formatter (csv, htmltable, json, json_line, movie_info,
movie_list, movie_releases, multiline, person_bio, person_info, person_list,
simple, subtitle_info, subtitle_list, table, torrent_info, torrent_list, webkit)
432 433 434 435 436 437 438 439 440 441
.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
442
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
443
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
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
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
464 465 466 467
.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
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
.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
485
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
486 487
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
488 489 490 491 492
.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
493

494
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
495
Copyright(C) 2013-2019 Julien Veyssier
496
.LP
Florent Fourcot's avatar
Florent Fourcot committed
497
For full copyright information see the COPYING file in the weboob package.
498 499 500 501 502 503 504
.LP
.RE
.SH FILES
"~/.config/weboob/backends" 

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