manpages of applications

This commit is contained in:
Romain Bignon 2010-08-02 14:35:12 +02:00
commit 26c9598b28
14 changed files with 931 additions and 0 deletions

78
man/weboorrents.1 Normal file
View file

@ -0,0 +1,78 @@
.TH WEBOORRENTS 1 "02 August 2010"
.SH NAME
weboorrents \- Torrents search and get
.SH SYNOPSIS
.B weboorrents
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..]
.br
.B weboorrents
[\-\-version] [\-\-help]
.SH DESCRIPTION
.LP
Weboob provides several applications to interact with a lot of websites.
This console application can be used to search torrents on support trackers
and to display information about them, and get the \fB.torrent\fR file.
.SH COMMANDS
.TP
\fBsearch\fR \fIpattern\fR
search torrents on the selected backends which match the specified pattern
.TP
\fBinfo\fR \fIid\fR
get information about a torrent
.TP
\fBgetfile\fR \fIid\fR \fIdest\fR
get the \fB.torrent\fR file of the specific torrent
the file is sent to output if \fIdest\fR is '-'
.SH OPTIONS
.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
.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
.SS Misc options
.TP
\fB\-b\fR, \fB\-\-backends\fR \fIbackends\fR
select backends to load
.TP
\fB\-\-version\fR
display version of \fIweboob-config\fR
.TP
\fB\-h\fR, \fB\-\-help\fR
show the help message and exit
.SH COPYRIGHT
Copyright(C) 2010 Romain Bignon
.LP
For full COPYRIGHT see COPYING file with weboob package.
.LP
.RE
.SH FILES
"~/.weboob/backends"