From e61372569309082a38974f8d8ce71a75ba90523c Mon Sep 17 00:00:00 2001 From: Romain Bignon Date: Mon, 20 May 2013 21:29:39 +0200 Subject: [PATCH] add manpages for new applications --- man/booblyrics.1 | 230 ++++++++++++++++++++++++++++ man/cineoob.1 | 381 +++++++++++++++++++++++++++++++++++++++++++++++ man/cookboob.1 | 240 +++++++++++++++++++++++++++++ man/qcineoob.1 | 63 ++++++++ man/qcookboob.1 | 73 +++++++++ man/suboob.1 | 278 ++++++++++++++++++++++++++++++++++ 6 files changed, 1265 insertions(+) create mode 100644 man/booblyrics.1 create mode 100644 man/cineoob.1 create mode 100644 man/cookboob.1 create mode 100644 man/qcineoob.1 create mode 100644 man/qcookboob.1 create mode 100644 man/suboob.1 diff --git a/man/booblyrics.1 b/man/booblyrics.1 new file mode 100644 index 0000000000..e31a596042 --- /dev/null +++ b/man/booblyrics.1 @@ -0,0 +1,230 @@ +.\" -*- coding: utf-8 -*- +.TH BOOBLYRICS 1 "20 May 2013" "booblyrics 0\&.g" +.SH NAME +booblyrics \- search and display song lyrics +.SH SYNOPSIS +.B booblyrics +[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]] +.br +.B booblyrics +[\-\-help] [\-\-version] + +.SH DESCRIPTION +.LP + +Console application allowing to search for song lyrics on various websites. + +.SS Supported websites: +* parolesmania (Paroles Mania lyrics website) +.br +* parolesmusique (paroles\-musique lyrics website) +.br +* parolesnet (paroles.net lyrics website) +.br +* seeklyrics (SeekLyrics lyrics website) +.SH BOOBLYRICS COMMANDS +.TP +\fBget\fR \fIID\fR +.br +Display lyrics of the song. +.TP +\fBsearch\fR [artist | song] [\fIPATTERN\fR] +.br +Search lyrics by artist name or by song title. +.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, json, lyrics_get, lyrics_list, +multiline, simple, table, 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) 2013 Julien Veyssier +.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/booblyrics diff --git a/man/cineoob.1 b/man/cineoob.1 new file mode 100644 index 0000000000..5498dc368c --- /dev/null +++ b/man/cineoob.1 @@ -0,0 +1,381 @@ +.\" -*- coding: utf-8 -*- +.TH CINEOOB 1 "20 May 2013" "cineoob 0\&.g" +.SH NAME +cineoob \- search movies and persons around cinema +.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. + +.SH CINEOOB COMMANDS +.TP +\fBbiography\fR person\fI_ID\fR +.br +Show the complete biography of a person. +.TP +\fBcasting\fR movie\fI_ID\fR [\fIROLE\fR] +.br +List persons related to a movie. +.br +If ROLE is given, filter by ROLE +.TP +\fBfilmography\fR person\fI_ID\fR [\fIROLE\fR] +.br +List movies of a person. +.br +If ROLE is given, filter by ROLE +.TP +\fBgetfile_subtitle\fR subtitle\fI_ID\fR [\fIFILENAME\fR] +.br +Get the subtitle or archive file. +.br +FILENAME is where to write the file. If FILENAME is '\-', +.br +the file is written to stdout. +.TP +\fBgetfile_torrent\fR \fIID\fR [\fIFILENAME\fR] +.br +Get the .torrent file. +.br +FILENAME is where to write the file. If FILENAME is '\-', +.br +the file is written to stdout. +.TP +\fBinfo_movie\fR movie\fI_ID\fR +.br +Get information about a movie. +.TP +\fBinfo_person\fR person\fI_ID\fR +.br +Get information about a person. +.TP +\fBinfo_subtitle\fR subtitle\fI_ID\fR +.br +Get information about a subtitle. +.TP +\fBinfo_torrent\fR \fIID\fR +.br +Get information about a torrent. +.TP +\fBmovies_in_common\fR person\fI_ID\fR person\fI_ID\fR +.br +Get the list of common movies between two persons. +.TP +\fBpersons_in_common\fR movie\fI_ID\fR movie\fI_ID\fR +.br +Get the list of common persons between two movies. +.TP +\fBreleases\fR movie\fI_ID\fR [\fICOUNTRY\fR] +.br +Get releases dates of a movie. +.br +If COUNTRY is given, show release in this country. +.TP +\fBsearch_movie\fR [\fIPATTERN\fR] +.br +Search movies. +.TP +\fBsearch_movie_subtitle\fR language movie\fI_ID\fR +.br +Search subtitles of movie_ID. +.br + +.br +Language Abbreviation +.br +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.br +Arabic ar Esperanto eo Irish ga Russian ru +.br +Afrikaans af Estonian et Italian it Serbian sr +.br +Albanian sq Filipino tl Japanese ja Slovak sk +.br +Armenian hy Finnish fi Kannada kn Slovenian sl +.br +Azerbaijani az French fr Korean ko Spanish es +.br +Basque eu Galician gl Latin la Swahili sw +.br +Belarusian be Georgian ka Latvian lv Swedish sv +.br +Bengali bn German de Lithuanian lt Tamil ta +.br +Bulgarian bg Greek gr Macedonian mk Telugu te +.br +Catalan ca Gujarati gu Malay ms Thai th +.br +Chinese zh Haitian ht Maltese mt Turkish tr +.br +Croatian hr Hebrew iw Norwegian no Ukrainian uk +.br +Czech cz Hindi hi Persian fa Urdu ur +.br +Danish da Hungaric hu Polish pl Vietnamese vi +.br +Dutch nl Icelandic is Portuguese pt Welsh cy +.br +English en Indonesian id Romanian ro Yiddish yi +.br +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.TP +\fBsearch_movie_torrent\fR movie\fI_ID\fR +.br +Search torrents of movie_ID. +.TP +\fBsearch_person\fR [\fIPATTERN\fR] +.br +Search persons. +.TP +\fBsearch_subtitle\fR language [\fIPATTERN\fR] +.br +Search subtitles. +.br + +.br +Language Abbreviation +.br +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.br +Arabic ar Esperanto eo Irish ga Russian ru +.br +Afrikaans af Estonian et Italian it Serbian sr +.br +Albanian sq Filipino tl Japanese ja Slovak sk +.br +Armenian hy Finnish fi Kannada kn Slovenian sl +.br +Azerbaijani az French fr Korean ko Spanish es +.br +Basque eu Galician gl Latin la Swahili sw +.br +Belarusian be Georgian ka Latvian lv Swedish sv +.br +Bengali bn German de Lithuanian lt Tamil ta +.br +Bulgarian bg Greek gr Macedonian mk Telugu te +.br +Catalan ca Gujarati gu Malay ms Thai th +.br +Chinese zh Haitian ht Maltese mt Turkish tr +.br +Croatian hr Hebrew iw Norwegian no Ukrainian uk +.br +Czech cz Hindi hi Persian fa Urdu ur +.br +Danish da Hungaric hu Polish pl Vietnamese vi +.br +Dutch nl Icelandic is Portuguese pt Welsh cy +.br +English en Indonesian id Romanian ro Yiddish yi +.br +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.TP +\fBsearch_torrent\fR [\fIPATTERN\fR] +.br +Search torrents. +.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, json, movie_info, movie_list, +movie_releases, multiline, person_bio, person_info, person_list, simple, +subtitle_info, subtitle_list, 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) 2013 Julien Veyssier +.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/cineoob diff --git a/man/cookboob.1 b/man/cookboob.1 new file mode 100644 index 0000000000..22e4192f9f --- /dev/null +++ b/man/cookboob.1 @@ -0,0 +1,240 @@ +.\" -*- coding: utf-8 -*- +.TH COOKBOOB 1 "20 May 2013" "cookboob 0\&.g" +.SH NAME +cookboob \- search and consult recipes +.SH SYNOPSIS +.B cookboob +[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]] +.br +.B cookboob +[\-\-help] [\-\-version] + +.SH DESCRIPTION +.LP + +Console application allowing to search for recipes on various websites. + +.SS Supported websites: +* 750g (750g French recipe website) +.br +* allrecipes (Allrecipes English recipe website) +.br +* cuisineaz (Cuisine AZ French recipe website) +.br +* marmiton (Marmiton French recipe website) +.br +* supertoinette (Super Toinette, la cuisine familiale French recipe website) +.SH COOKBOOB COMMANDS +.TP +\fBexport\fR \fIID\fR [\fIFILENAME\fR] +.br +Export the recipe to a KRecipes XML file +.br +FILENAME is where to write the file. If FILENAME is '\-', +.br +the file is written to stdout. +.TP +\fBinfo\fR \fIID\fR +.br +Get information about a recipe. +.TP +\fBsearch\fR [\fIPATTERN\fR] +.br +Search recipes. +.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, json, multiline, recipe_info, +recipe_list, simple, table, 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) 2013 Julien Veyssier +.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/cookboob diff --git a/man/qcineoob.1 b/man/qcineoob.1 new file mode 100644 index 0000000000..501542796f --- /dev/null +++ b/man/qcineoob.1 @@ -0,0 +1,63 @@ +.\" -*- coding: utf-8 -*- +.TH QCINEOOB 1 "20 May 2013" "qcineoob 0\&.g" +.SH NAME +qcineoob \- search movies, people, torrent and subtitles +.SH SYNOPSIS +.B qcineoob +[\-h] [\-dqv] [\-b \fIbackends\fR] ... +.br +.B qcineoob +[\-\-help] [\-\-version] + +.SH DESCRIPTION +.LP + +Qt application allowing to search movies, people, torrent and subtitles. + +.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 COPYRIGHT +Copyright(C) 2013 Julien Veyssier +.LP +For full COPYRIGHT see COPYING file with weboob package. +.LP +.RE +.SH FILES +"~/.config/weboob/backends" + +"~/.config/weboob/qcineoob" + +.SH SEE ALSO +Home page: http://weboob.org/applications/qcineoob diff --git a/man/qcookboob.1 b/man/qcookboob.1 new file mode 100644 index 0000000000..d6e4abe8d8 --- /dev/null +++ b/man/qcookboob.1 @@ -0,0 +1,73 @@ +.\" -*- coding: utf-8 -*- +.TH QCOOKBOOB 1 "20 May 2013" "qcookboob 0\&.g" +.SH NAME +qcookboob \- search recipes +.SH SYNOPSIS +.B qcookboob +[\-h] [\-dqv] [\-b \fIbackends\fR] ... +.br +.B qcookboob +[\-\-help] [\-\-version] + +.SH DESCRIPTION +.LP + +Qt application allowing to search recipes. + +.SS Supported websites: +* 750g (750g French recipe website) +.br +* allrecipes (Allrecipes English recipe website) +.br +* cuisineaz (Cuisine AZ French recipe website) +.br +* marmiton (Marmiton French recipe website) +.br +* supertoinette (Super Toinette, la cuisine familiale French recipe website) +.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 COPYRIGHT +Copyright(C) 2013 Julien Veyssier +.LP +For full COPYRIGHT see COPYING file with weboob package. +.LP +.RE +.SH FILES +"~/.config/weboob/backends" + +"~/.config/weboob/qcookboob" + +.SH SEE ALSO +Home page: http://weboob.org/applications/qcookboob diff --git a/man/suboob.1 b/man/suboob.1 new file mode 100644 index 0000000000..2244d02617 --- /dev/null +++ b/man/suboob.1 @@ -0,0 +1,278 @@ +.\" -*- coding: utf-8 -*- +.TH SUBOOB 1 "20 May 2013" "suboob 0\&.g" +.SH NAME +suboob \- search and download subtitles +.SH SYNOPSIS +.B suboob +[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]] +.br +.B suboob +[\-\-help] [\-\-version] + +.SH DESCRIPTION +.LP + +Console application allowing to search for subtitles on various services and download them. + +.SS Supported websites: +* attilasub ("Attila's Website 2.0" French subtitles) +.br +* opensubtitles (Opensubtitles subtitle website) +.br +* podnapisi (Podnapisi movies and tv series subtitle website) +.br +* tvsubtitles (Tvsubtitles subtitle website) +.SH SUBOOB COMMANDS +.TP +\fBgetfile\fR \fIID\fR [\fIFILENAME\fR] +.br +Get the subtitle or archive file. +.br +FILENAME is where to write the file. If FILENAME is '\-', +.br +the file is written to stdout. +.TP +\fBinfo\fR \fIID\fR +.br +Get information about a subtitle. +.TP +\fBsearch\fR language [\fIPATTERN\fR] +.br +Search subtitles. +.br + +.br +Language Abbreviation +.br +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.br +Arabic ar Esperanto eo Irish ga Russian ru +.br +Afrikaans af Estonian et Italian it Serbian sr +.br +Albanian sq Filipino tl Japanese ja Slovak sk +.br +Armenian hy Finnish fi Kannada kn Slovenian sl +.br +Azerbaijani az French fr Korean ko Spanish es +.br +Basque eu Galician gl Latin la Swahili sw +.br +Belarusian be Georgian ka Latvian lv Swedish sv +.br +Bengali bn German de Lithuanian lt Tamil ta +.br +Bulgarian bg Greek gr Macedonian mk Telugu te +.br +Catalan ca Gujarati gu Malay ms Thai th +.br +Chinese zh Haitian ht Maltese mt Turkish tr +.br +Croatian hr Hebrew iw Norwegian no Ukrainian uk +.br +Czech cz Hindi hi Persian fa Urdu ur +.br +Danish da Hungaric hu Polish pl Vietnamese vi +.br +Dutch nl Icelandic is Portuguese pt Welsh cy +.br +English en Indonesian id Romanian ro Yiddish yi +.br +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- +.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, json, multiline, simple, subtitle_info, +subtitle_list, table, 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) 2013 Julien Veyssier +.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/suboob -- GitLab