Skip to content
cineoob.1 13.3 KiB
Newer Older
.\" -*- coding: utf-8 -*-
Florent's avatar
Florent committed
.\" This file was generated automatically by tools/make_man.sh.
Romain Bignon's avatar
Romain Bignon committed
.TH CINEOOB 1 "27 February 2019" "cineoob 1\&.5"
.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's avatar
Florent committed
.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
* limetorrents (Limetorrents BitTorrent tracker)
.br
Florent's avatar
Florent committed
* 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
.br
* yggtorrent (YGG BitTorrent tracker)
.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
\fBdebug\fR
.br
Launch a debug Python shell
.TP
\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's avatar
Florent committed
.br

.br
Default is limited to 10 results.
.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's avatar
Florent committed
.br

.br
Default is limited to 10 results.
.TP
\fBsearch_movie_torrent\fR movie\fI_ID\fR
.br
Search torrents of movie_ID.
Florent's avatar
Florent committed
.br

.br
Default is limited to 10 results.
.TP
\fBsearch_person\fR  [\fIPATTERN\fR]
.br
Search persons.
Florent's avatar
Florent committed
.br

.br
Default is limited to 10 results.
.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's avatar
Florent committed
.br

.br
Default is limited to 10 results.
.TP
\fBsearch_torrent\fR [\fIPATTERN\fR]
.br
Search torrents.
Florent's avatar
Florent committed
.br

.br
Default is limited to 10 results.
.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's avatar
Florent committed
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
Florent's avatar
Florent committed
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
.br
List objects in current path.
.br
If an argument is given, list the specified path.
Florent's avatar
Florent committed
.br
Florent's avatar
Florent committed
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent's avatar
Florent committed
.br
return results as soon as possible.
.br
Florent's avatar
Florent committed
Use \-d option to display information about a collection (and to not
Florent's avatar
Florent committed
.br
display the content of it). It has the same behavior than the well
.br
Florent's avatar
Florent committed
known UNIX "ls" command.
Florent's avatar
Florent committed
.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's avatar
Florent committed
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent's avatar
Florent committed
display debug messages. Set up it twice to more verbosity
.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's avatar
Florent committed
.TP
\fB\-\-export\-session\fR
log browser session cookies after login

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent's avatar
Florent committed
filter result items to display given a boolean expression. See CONDITION section
for the syntax
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent's avatar
Florent committed
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's avatar
Florent committed
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)
.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's avatar
Florent committed
.SH CONDITION
Florent's avatar
Florent committed
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's avatar
Florent committed
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's avatar
Florent committed
.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's avatar
Florent committed
.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's avatar
Florent committed
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent's avatar
Florent committed
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent's avatar
Florent committed
.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's avatar
Florent committed

.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
Copyright(C) 2013-2019 Julien Veyssier
Florent's avatar
Florent committed
For full copyright information see the COPYING file in the weboob package.
.LP
.RE
.SH FILES
"~/.config/weboob/backends" 

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