Skip to content
videoob.1 5.65 KiB
Newer Older
Romain Bignon's avatar
Romain Bignon committed
.TH VIDEOOB 1 "28 October 2012" "videoob 0\&.d"
Romain Bignon's avatar
Romain Bignon committed
.SH NAME
Romain Bignon's avatar
Romain Bignon committed
.SH SYNOPSIS
.B videoob
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon's avatar
Romain Bignon committed
.br
.B videoob
[\-\-help] [\-\-version]

Romain Bignon's avatar
Romain Bignon committed
.SH DESCRIPTION
.LP

Romain Bignon's avatar
Romain Bignon committed
Console application allowing to search for videos on various websites, play and download them and get information.
.SS Supported websites:
Romain Bignon's avatar
Romain Bignon committed
* arte (Arte French and German TV)
Romain Bignon's avatar
Romain Bignon committed
* canalplus (Canal Plus French TV)
Romain Bignon's avatar
Romain Bignon committed
* cappedtv (Capped.tv demoscene website)
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* dailymotion (Dailymotion video streaming website)
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* europarl (Europarl parliamentary video streaming website)
.br
Romain Bignon's avatar
Romain Bignon committed
* francetelevisions (France Télévisions video website)
Romain Bignon's avatar
Romain Bignon committed
* gdcvault (Game Developers Conferences Vault video streaming website)
.br
Romain Bignon's avatar
Romain Bignon committed
* ina (INA French TV video archives)
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* nolifetv (NolifeTV French video streaming website)
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* radiofrance (Radios of Radio France: Inter, Info, Bleu, Culture, Musique, FIP, Le Mouv')
Romain Bignon's avatar
Romain Bignon committed
* trictractv (TricTrac.tv video website)
.br
* vimeo (Vimeo video streaming website)
.br
Romain Bignon's avatar
Romain Bignon committed
* youjizz (YouJizz pornographic video streaming website)
Romain Bignon's avatar
Romain Bignon committed
* youporn (YouPorn pornographic video streaming website)
.br
* youtube (YouTube video streaming website)
.SH VIDEOOB COMMANDS
Romain Bignon's avatar
Romain Bignon committed
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBdownload\fR \fIID\fR [\fIFILENAME\fR]
.br
Download a video
.TP
\fBinfo\fR \fIID\fR
.br
Get information about a video.
Romain Bignon's avatar
Romain Bignon committed
.TP
\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.
Romain Bignon's avatar
Romain Bignon committed
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBsearch\fR \fIPATTERN\fR
.br
Search for videos matching a PATTERN.
.SH WEBOOB COMMANDS
Romain Bignon's avatar
Romain Bignon committed
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br

.br
ACTION is one of the following (default: list):
.br
Romain Bignon's avatar
Romain Bignon committed
* enable         enable given backends
Romain Bignon's avatar
Romain Bignon committed
* disable        disable given backends
Romain Bignon's avatar
Romain Bignon committed
* only           enable given backends and disable the others
Romain Bignon's avatar
Romain Bignon committed
* list           list backends
Romain Bignon's avatar
Romain Bignon committed
* add            add a backend
Romain Bignon's avatar
Romain Bignon committed
* register       register a new account on a website
Romain Bignon's avatar
Romain Bignon committed
* edit           edit a backend
Romain Bignon's avatar
Romain Bignon committed
* remove         remove a backend
.br
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBcd\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
.br
Follow a path.
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
.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.
Romain Bignon's avatar
Romain Bignon committed
.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.
Romain Bignon's avatar
Romain Bignon committed
.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.
Romain Bignon's avatar
Romain Bignon committed
.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.
Romain Bignon's avatar
Romain Bignon committed
.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
Romain Bignon's avatar
Romain Bignon committed
\fBls\fR [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
.br
If an argument is given, list the specified path.
Romain Bignon's avatar
Romain Bignon committed
.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)

.SH LOGGING OPTIONS
Romain Bignon's avatar
Romain Bignon committed
.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
Romain Bignon's avatar
Romain Bignon committed
.TP
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response

.SH RESULTS OPTIONS
Romain Bignon's avatar
Romain Bignon committed
.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, video_list,
webkit)
.TP
\fB\-\-no\-header\fR
do not display header
.TP
\fB\-\-no\-keys\fR
do not display item keys
Romain Bignon's avatar
Romain Bignon committed
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
Romain Bignon's avatar
Romain Bignon committed

.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
Copyright(C) 2010-2011 Christophe Benz, Romain Bignon, John Obbele
Romain Bignon's avatar
Romain Bignon committed
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
"~/.config/weboob/backends" 
Romain Bignon's avatar
Romain Bignon committed
Home page: http://weboob.org/applications/videoob