diff --git a/man/boobank.1 b/man/boobank.1 new file mode 100644 index 00000000..50dbd454 --- /dev/null +++ b/man/boobank.1 @@ -0,0 +1,73 @@ +.TH BOOBANK 1 "02 August 2010" +.SH NAME +boobank \- Bank operations +.SH SYNOPSIS +.B boobank +[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..] +.br +.B boobank +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +Boobank is a console application which loads the configured \fIICapBank\fR backends +and display your accounts amount. + +.SH COMMANDS +.TP +\fBlist\fR +list every accounts, with the amount of money. +.TP +\fBcoming\fR \fIid\fR +display the coming operations on a specific account. + +.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" diff --git a/man/chatoob.1 b/man/chatoob.1 new file mode 100644 index 00000000..7490c8b0 --- /dev/null +++ b/man/chatoob.1 @@ -0,0 +1,76 @@ +.TH CHATOOB 1 "02 August 2010" +.SH NAME +chatoob \- Chat client +.SH SYNOPSIS +.B chatoob +[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..] +.br +.B chatoob +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +Chatoob is a console application which loads the configured \fIICapChat\fR backends +to list contacts, send messages and display received ones. + +.SH COMMANDS +.TP +\fBlist\fR +list online contacts +.TP +\fBmessages\fR +list received messages +.TP +\fBsend\fR \fIid\fR \fImessage\fR +send a message to a contact + +.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 Christophe Benz +.LP +For full COPYRIGHT see COPYING file with weboob package. +.LP +.RE +.SH FILES + "~/.weboob/backends" diff --git a/man/havesex.1 b/man/havesex.1 new file mode 100644 index 00000000..af36e19e --- /dev/null +++ b/man/havesex.1 @@ -0,0 +1,83 @@ +.TH HAVESEX 1 "02 August 2010" +.SH NAME +havesex \- Interact with dating websites +.SH SYNOPSIS +.B havesex +[\-dqv] [\-b \fIbackends\fR] +.br +.B havesex +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +Havesex is a console interactive application which loads the configured +\fICapDating\fr backends. + +It helps draging on dating websites to have sex. It provides commands to have +interaction with girls, and some optimization services. + +.SH COMMANDS +.TP +\fBprofile\fR \fIid\fR +display a slut profile +.TP +\fBstart\fR \fIoptimizations..\fR +start optimizations +.TP +\fBstop\fR \fIoptimizations..\fR +stop optimizations + +.SH OPTIMIZATIONS +Optimizations services are background tasks. + +.SS PROFILE_WALKER +This optimization service is used to walk on profiles. It is usefull to show girls you exist, when they can see who visite their profile. + +Note that in future, it will be associated with the SCORING optimization service. + +.SS VISIBILITY +This optimization is used to increase your visibility on website. It depends on each websites, so there isn't any explicit explanation. + +For example, the AuM backend will reconnects to website every five minutes to go back on top research results. + +.SH CONFIGURATION +The file \fI~/.weboob/havesex\fR is the configuration of \fBhavesex\fR: + +.nf +[GLOBAL] +# Optimizations to auto-enable +optimizations = PROFILE_WALKER VISIBILITY +.fi + +.SH OPTIONS +.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" + "~/.weboob/havesex" diff --git a/man/masstransit.1 b/man/masstransit.1 new file mode 100644 index 00000000..c65ec372 --- /dev/null +++ b/man/masstransit.1 @@ -0,0 +1,46 @@ +.TH MASSTRANSIT 1 "02 August 2010" +.SH NAME +masstransit \- Transport information for N900 +.SH SYNOPSIS +.B masstransit +[\-dqv] [\-b \fIbackends\fR] +.br +.B masstransit +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +This graphical application for Nokia N900 phones is used to know timelines +of stations for transports (train, airplanes, etc.) + +.SH OPTIONS +.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 Julien Hébert +.LP +For full COPYRIGHT see COPYING file with weboob package. +.LP +.RE +.SH FILES + "~/.weboob/backends" diff --git a/man/monboob.1 b/man/monboob.1 new file mode 100644 index 00000000..d373d1ca --- /dev/null +++ b/man/monboob.1 @@ -0,0 +1,81 @@ +.TH MONBOOB 1 "02 August 2010" +.SH NAME +monboob \- Get messages in your Mail User Agent and answer +.SH SYNOPSIS +.B monboob +[\-dqv] [\-b \fIbackends\fR] [\-S \fIport\fR] \fIcommand\fR [arguments..] +.br +.B monboob +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +Monboob is a daemon application which retrieves every X seconds new messages +and send them to an email address. + +Use the \fB-S\fR option to launch a SMTP server which relays mails to the backend +as a reply. + +The \fBpost\fR command can also be called to answer to a specific message. + +.SH COMMANDS +.TP +\fBrun\fR +run the process (it does NOT put monboob in background) +.TP +\fBpost\fR +pipe a mail with this command to parse it and post the reply to the equivalent backend + +.SH CONFIGURATION +The file \fI~/.weboob/monboob\fR is the configuration of \fBmonboob\fR: + +.nf +[DEFAULT] +# Interval to check new messages +interval = 300 +# Domain of the *From:* email address +domain = weboob.example.com +# Recipient of emails +recipient = romain@example.com +# SMTP server to use +smtp = mail.example.org +# Send emails in HTML or in plaintext +html = 0 +.fi + +.SH OPTIONS +.SS Monboob options +.TP +\fB\-S\fR, \fB\-\-smtpd\fR \fI[bind:]port\fR +run a SMTP server which relays each received mails to the backend +.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" + "~/.weboob/monboob" diff --git a/man/qboobmsg.1 b/man/qboobmsg.1 new file mode 100644 index 00000000..47c9695c --- /dev/null +++ b/man/qboobmsg.1 @@ -0,0 +1,46 @@ +.TH QBOOBMSG 1 "02 August 2010" +.SH NAME +qboobmsg \- View messages and reply (Qt Application) +.SH SYNOPSIS +.B qboobmsg +[\-dqv] [\-b \fIbackends\fR] +.br +.B qboobmsg +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +This graphical application displays every messages for the selected backends +(which implement the \fIICapMessages\fR capability). + +.SH OPTIONS +.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" diff --git a/man/qhavesex.1 b/man/qhavesex.1 new file mode 100644 index 00000000..aa046529 --- /dev/null +++ b/man/qhavesex.1 @@ -0,0 +1,47 @@ +.TH QHAVESEX 1 "02 August 2010" +.SH NAME +qhavesex \- View messages and reply (Qt Application) +.SH SYNOPSIS +.B qhavesex +[\-dqv] [\-b \fIbackends\fR] +.br +.B qhavesex +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +This graphical application interacts with dating websites to help you to +drag girls, to send and receive messages, to chat with them, to plan +dating, provides a calendar and some sexual statistics. + +.SH OPTIONS +.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" diff --git a/man/qvideoob.1 b/man/qvideoob.1 new file mode 100644 index 00000000..bab2c4e3 --- /dev/null +++ b/man/qvideoob.1 @@ -0,0 +1,47 @@ +.TH QVIDEOOB 1 "02 August 2010" +.SH NAME +qvideoob \- Search and play videos +.SH SYNOPSIS +.B qvideoob +[\-dqv] [\-b \fIbackends\fR] +.br +.B qvideoob +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +This graphical application can be used to search videos on \fIICapVideo\fR +backends, and to get their meta data, including their direct URL, or to play +them in an embedded frame. + +.SH OPTIONS +.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" diff --git a/man/travel.1 b/man/travel.1 new file mode 100644 index 00000000..fa619fbf --- /dev/null +++ b/man/travel.1 @@ -0,0 +1,76 @@ +.TH TRAVEL 1 "02 August 2010" +.SH NAME +travel \- Transport informations +.SH SYNOPSIS +.B travel +[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..] +.br +.B travel +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +This console application can be used to look at timelines of a specific +station. It interacts with travel websites (train, airplanes, etc.). + +.SH COMMANDS +.TP +\fBstations\fR \fIpattern\fR +search stations containing the specific pattern +.TP +\fBdepartures\fR \fIstation\fR \fI[arrival]\fR +display the timeline of a specific station + +it's possible to specify only the departures for a specific +arrival station + +.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" diff --git a/man/videoob.1 b/man/videoob.1 new file mode 100644 index 00000000..f1757746 --- /dev/null +++ b/man/videoob.1 @@ -0,0 +1,80 @@ +.TH VIDEOOB 1 "02 August 2010" +.SH NAME +videoob \- Video search and information +.SH SYNOPSIS +.B videoob +[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..] +.br +.B videoob +[\-\-version] [\-\-help] +.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. + +.SH COMMANDS +.TP +\fBsearch\fR \fIpattern\fR +search videos on the selected backends which match the specified pattern +.TP +\fBinfo\fR \fIid\fR +get information about a video + +.SH OPTIONS +.SS Videoob options +.TP +\fB\-\-nsfw\fR +return also results which are NSFW (Not Safe For Work) + +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 +.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 Christophe Benz, Romain Bignon +.LP +For full COPYRIGHT see COPYING file with weboob package. +.LP +.RE +.SH FILES + "~/.weboob/backends" diff --git a/man/weboob-config-qt.1 b/man/weboob-config-qt.1 new file mode 100644 index 00000000..605e79d8 --- /dev/null +++ b/man/weboob-config-qt.1 @@ -0,0 +1,43 @@ +.TH WEBOOB-CONFIG-QT 1 "02 August 2010" +.SH NAME +weboob-config-qt \- Weboob configuration (Qt Application) +.SH SYNOPSIS +.B weboob-config-qt +[\-dqv] +.br +.B weboob-config-qt +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +This graphical application is used to configure weboob. You can list backends, +and add/list/remove configured backends. + +.SH OPTIONS +.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\-\-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" diff --git a/man/weboob-config.1 b/man/weboob-config.1 new file mode 100644 index 00000000..35da76fc --- /dev/null +++ b/man/weboob-config.1 @@ -0,0 +1,79 @@ +.TH WEBOOB-CONFIG 1 "02 August 2010" +.SH NAME +weboob-config \- Weboob configuration +.SH SYNOPSIS +.B weboob-config +[\-dqv] \fIcommand\fR [arguments..] +.br +.B weboob-config +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +This application is used to configure weboob. You can list backends, and +add/list/remove configured backends. + +.SH COMMANDS +.TP +\fBadd\fR \fIbackend_name\fR \fI[options..]\fR +add a configured backend. \fIbackend_name\fR is the name of the backend to add. +To list available backends, use the \fIbackends\fR command. + +The options are specific to the backend. Use the \fIinfo\fR command to list +them for a backend. + +If you don't specify any options, \fBweboob-config\fR prompts you for each +available options. +.TP +\fBlistconfigured\fR +list every configured backends. +.TP +\fBremove\fR \fIinstance_name\fR +remove a configured backend, by giving its instance name. +.TP +\fBedit\fR +edit the configuration files of instanced backends with your favorite editor +(default is vim) +.TP +\fBbackends\fR \fI[caps..]\fR +list every available backends. You can filter by capabilities. + +Example: +.nf +$ weboob-config backends ICapDating ICapMessages +.fi +.TP +\fBinfo\fR \fIname\fR +display information about a backend (name, author, descriptions, options, etc.) +.TP +\fBapplications\fR \fI[caps..]\fR +list every weboob applications. You can filter by capabilities. + +.SH OPTIONS +.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\-\-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 Christophe Benz, Romain Bignon +.LP +For full COPYRIGHT see COPYING file with weboob package. +.LP +.RE +.SH FILES + "~/.weboob/backends" diff --git a/man/weboorrents.1 b/man/weboorrents.1 new file mode 100644 index 00000000..8781dc40 --- /dev/null +++ b/man/weboorrents.1 @@ -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" diff --git a/man/wetboobs.1 b/man/wetboobs.1 new file mode 100644 index 00000000..6848b849 --- /dev/null +++ b/man/wetboobs.1 @@ -0,0 +1,76 @@ +.TH WETBOOBS 1 "02 August 2010" +.SH NAME +wetboobs \- View weather +.SH SYNOPSIS +.B wetboobs +[\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcommand\fR [arguments..] +.br +.B wetboobs +[\-\-version] [\-\-help] +.SH DESCRIPTION +.LP +Weboob provides several applications to interact with a lot of websites. + +This console application can be used to view the current weather and +the forecasts. + +.SH COMMANDS +.TP +\fBsearch\fR \fIpattern\fR +search city IDs from a pattern +.TP +\fBcurrent\fR \fIcity\fR +view the current weather of a specified city (from its ID) +.TP +\fBforecasts\fR \fIcity\fR +display forecasts of a specified city (from its ID) + +.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"