[cineoob] man and doc
This commit is contained in:
Julien Veyssier
parent
a6430c96b3
commit
d1ff2b16fa
4 changed files with 253 additions and 4 deletions
247
man/cineoob.1
Normal file
247
man/cineoob.1
Normal file
|
|
@ -0,0 +1,247 @@
|
|||
.TH CINEOOB 1 "4 March 2013" "cienoob 0\&.f"
|
||||
.SH NAME
|
||||
cineoob \- search informations about movies and cinema personalities
|
||||
.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.
|
||||
|
||||
|
||||
.SS Supported websites:
|
||||
* Imdb (Internet Movie Database)
|
||||
.br
|
||||
.SH COMMANDS
|
||||
.TP
|
||||
\fBsearch_movie\fR [\fIPATTERN\fR]
|
||||
.br
|
||||
Search for a movie.
|
||||
.TP
|
||||
\fBsearch_person\fR [\fIPATTERN\fR]
|
||||
.br
|
||||
Search for a person.
|
||||
.TP
|
||||
\fBinfo_movie\fR \fIID\fR
|
||||
.br
|
||||
Get information about a movie.
|
||||
.TP
|
||||
\fBinfo_person\fR \fIID\fR
|
||||
.br
|
||||
Get information about a person.
|
||||
.TP
|
||||
\fBfilmography\fR \fIID\fR
|
||||
.br
|
||||
List movies related to a person.
|
||||
.TP
|
||||
\fBcasting\fR \fIID\fR
|
||||
.br
|
||||
List persons related to a movie.
|
||||
.TP
|
||||
\fBmovies_in_common\fR \fIID1\fR \fIID2\fR
|
||||
.br
|
||||
List movies in common between two person.
|
||||
.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, multiline, simple, 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) 2010-2012 Romain Bignon
|
||||
.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/weboorrents
|
||||
|
|
@ -15,7 +15,9 @@ suboob \- search and download subtitles
|
|||
Console application allowing to search for subtitles on various services and download them.
|
||||
|
||||
.SS Supported websites:
|
||||
* attilasub ("Attila s Website 2.0" french subtitles)
|
||||
* attilasub (Attila' s Website 2.0 french subtitles)
|
||||
* opensubtitles (Opensubtitles subtitle website)
|
||||
* Tvsubtitles (Tvsubtitle subtitle website)
|
||||
.br
|
||||
* opensubtitles (Opensubtitles subtitle website)
|
||||
.br
|
||||
|
|
|
|||
|
|
@ -18,11 +18,10 @@
|
|||
# along with weboob. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
|
||||
from weboob.capabilities.cinema import Movie, Person
|
||||
from weboob.capabilities.cinema import Person
|
||||
from weboob.capabilities.base import NotAvailable
|
||||
from weboob.tools.browser import BasePage
|
||||
|
||||
import string
|
||||
from datetime import datetime
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -144,7 +144,8 @@ class Cineoob(ReplApplication):
|
|||
VERSION = '0.f'
|
||||
COPYRIGHT = 'Copyright(C) 2013 Julien Veyssier'
|
||||
DESCRIPTION = "Console application allowing to search for movies and persons on various cinema databases " \
|
||||
", list persons related to a movie and list movies related to a person."
|
||||
", list persons related to a movie, list movies related to a person and list common movies " \
|
||||
"of two persons."
|
||||
SHORT_DESCRIPTION = "search movies and persons around cinema"
|
||||
CAPS = ICapCinema
|
||||
EXTRA_FORMATTERS = {'movie_list': MovieListFormatter,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue