weboob-devel/man/cineoob.1
2013-05-20 21:29:39 +02:00

381 lines
9.7 KiB
Groff

.\" -*- coding: utf-8 -*-
.TH CINEOOB 1 "20 May 2013" "cineoob 0\&.g"
.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.
.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
\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.
.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
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.TP
\fBsearch_movie_torrent\fR movie\fI_ID\fR
.br
Search torrents of movie_ID.
.TP
\fBsearch_person\fR [\fIPATTERN\fR]
.br
Search persons.
.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
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
.TP
\fBsearch_torrent\fR [\fIPATTERN\fR]
.br
Search torrents.
.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
If an argument is given, set the condition expression used to filter the results.
.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
\fBinspect\fR \fIBACKEND_NAME\fR
.br
Display the HTML string of the current page of the specified backend's browser.
.br
.br
If webkit_mechanize_browser Python module is installed, HTML is displayed in a WebKit GUI.
.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
\fBls\fR [\-d] [\fIPATH\fR]
.br
List objects in current path.
.br
If an argument is given, list the specified path.
.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
.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
display debug messages
.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
.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
filter result items to display given a boolean expression
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
get a maximum number of results (all backends merged)
.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
select output formatter (csv, htmltable, json, 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
.SH COPYRIGHT
Copyright(C) 2013 Julien Veyssier
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.config/weboob/backends"
.SH SEE ALSO
Home page: http://weboob.org/applications/cineoob