generated manpages from make_man.py
This commit is contained in:
Romain Bignon
parent
7b5e5f3289
commit
8caeab8853
20 changed files with 2706 additions and 441 deletions
236
man/videoob.1
236
man/videoob.1
|
|
@ -1,55 +1,177 @@
|
|||
.TH VIDEOOB 1 "02 August 2010"
|
||||
.TH VIDEOOB 1 "09 December 2010"
|
||||
.SH NAME
|
||||
videoob \- Video search and information
|
||||
videoob
|
||||
.SH SYNOPSIS
|
||||
.B videoob
|
||||
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..]
|
||||
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
|
||||
.br
|
||||
.B videoob
|
||||
[\-\-version] [\-\-help]
|
||||
[\-\-help] [\-\-version]
|
||||
|
||||
.SH DESCRIPTION
|
||||
.LP
|
||||
Weboob provides several applications to interact with a lot of websites.
|
||||
|
||||
This console application can be used to search videos on supported
|
||||
websites and to display information about them, including the direct link
|
||||
to the video file.
|
||||
Videoob is a console application to search videos on supported websites and to play them or get informations.
|
||||
|
||||
.SH COMMANDS
|
||||
.SS Supported websites:
|
||||
* arte (Arte french TV)
|
||||
.br
|
||||
* canalplus (Canal plus french TV)
|
||||
.br
|
||||
* ina (INA french video archives)
|
||||
.br
|
||||
* youjizz (Youjizz videos website)
|
||||
.br
|
||||
* youporn (Youporn videos website)
|
||||
.br
|
||||
* youtube (Youtube videos website)
|
||||
.SH VIDEOOB COMMANDS
|
||||
.TP
|
||||
\fBsearch\fR \fIpattern\fR
|
||||
search videos on the selected backends which match the specified pattern
|
||||
\fBinfo\fR \fIID\fR
|
||||
.br
|
||||
Get information about a video.
|
||||
.TP
|
||||
\fBinfo\fR \fIid\fR
|
||||
get information about a video
|
||||
\fBnsfw\fR [on | off]
|
||||
.br
|
||||
If argument is given, enable or disable the non\-suitable for work behavior.
|
||||
.br
|
||||
|
||||
.br
|
||||
If no argument is given, print the current behavior.
|
||||
.TP
|
||||
\fBplay\fR \fIID\fR
|
||||
.br
|
||||
Play a video with a found player.
|
||||
.TP
|
||||
\fBsearch\fR [\fIPATTERN\fR]
|
||||
.br
|
||||
Search for videos matching a PATTERN.
|
||||
.br
|
||||
|
||||
.br
|
||||
If PATTERN is not given, this command will search for the latest videos.
|
||||
.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 display enabled and available 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
|
||||
.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
|
||||
\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.
|
||||
.TP
|
||||
\fBquit\fR
|
||||
.br
|
||||
Quit the application.
|
||||
|
||||
.SH OPTIONS
|
||||
.SS Videoob options
|
||||
.TP
|
||||
\fB\-\-nsfw\fR
|
||||
return also results which are NSFW (Not Safe For Work)
|
||||
\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)
|
||||
|
||||
when this option isn't set, the adult content results are omitted
|
||||
.SS Results options
|
||||
.TP
|
||||
\fB\-c\fR, \fB\-\-condition\fR \fICONDITION\fR
|
||||
filter result items to display given a boolean condition
|
||||
.TP
|
||||
\fB\-n\fR, \fB\-\-count\fR \fICOUNT\fR
|
||||
get a maximum number of results (all backends merged)
|
||||
.TP
|
||||
\fB\-f\fR, \fB\-\-formatter\fR \fIFORMATTER\fR
|
||||
select the output formatter (htmltable,multiline,simple,table,webkit)
|
||||
.TP
|
||||
\fB\-s\fR, \fB\-\-select\fR \fIFIELDS\fR
|
||||
select return field keys to display (comma separated)
|
||||
.TP
|
||||
\fB\-\-no-header\fR
|
||||
do not display header
|
||||
.TP
|
||||
\fB\-\-no-keys\fR
|
||||
do not display field keys
|
||||
.SS Logging options
|
||||
.SH LOGGING OPTIONS
|
||||
.TP
|
||||
\fB\-d\fR, \fB\-\-debug\fR
|
||||
display debug messages
|
||||
|
|
@ -59,22 +181,44 @@ display only error messages
|
|||
.TP
|
||||
\fB\-v\fR, \fB\-\-verbose\fR
|
||||
display info messages
|
||||
.SS Misc options
|
||||
.TP
|
||||
\fB\-b\fR, \fB\-\-backends\fR \fIbackends\fR
|
||||
select backends to load
|
||||
\fB\-\-logging\-file=LOGGING_FILE\fR
|
||||
file to save logs
|
||||
.TP
|
||||
\fB\-\-version\fR
|
||||
display version of \fIweboob-config\fR
|
||||
\fB\-a\fR, \fB\-\-save\-responses\fR
|
||||
save every response
|
||||
|
||||
.SH RESULTS OPTIONS
|
||||
.TP
|
||||
\fB\-h\fR, \fB\-\-help\fR
|
||||
show the help message and exit
|
||||
\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, video_list,
|
||||
webkit)
|
||||
.TP
|
||||
\fB\-\-no\-header\fR
|
||||
do not display header
|
||||
.TP
|
||||
\fB\-\-no\-keys\fR
|
||||
do not display item keys
|
||||
|
||||
.SH COPYRIGHT
|
||||
Copyright(C) 2010 Christophe Benz, Romain Bignon
|
||||
Copyright(C) 2010 Christophe Benz, Romain Bignon, John Obbele
|
||||
.LP
|
||||
For full COPYRIGHT see COPYING file with weboob package.
|
||||
.LP
|
||||
.RE
|
||||
.SH FILES
|
||||
"~/.weboob/backends"
|
||||
"~/.weboob/backends"
|
||||
|
||||
.SH SEE ALSO
|
||||
Home page: http://weboob.org/Videoob
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue