add missing manpages
This commit is contained in:
Romain Bignon
parent
822bd8c59d
commit
ac24cfa774
2 changed files with 411 additions and 0 deletions
291
man/boobtracker.1
Normal file
291
man/boobtracker.1
Normal file
|
|
@ -0,0 +1,291 @@
|
|||
.TH BOOBTRACKER 1 "05 February 2012" "boobtracker 0\&.a"
|
||||
.SH NAME
|
||||
boobtracker
|
||||
.SH SYNOPSIS
|
||||
.B boobtracker
|
||||
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
|
||||
.br
|
||||
.B boobtracker
|
||||
[\-\-help] [\-\-version]
|
||||
|
||||
.SH DESCRIPTION
|
||||
.LP
|
||||
|
||||
Console application allowing to send messages on various websites and to display message threads and contents.
|
||||
|
||||
.SS Supported websites:
|
||||
* redmine (The Redmine project management web application)
|
||||
.SH BOOBTRACKER COMMANDS
|
||||
.TP
|
||||
\fBattach\fR \fIISSUE\fR \fIFILENAME\fR
|
||||
.br
|
||||
Attach a file to an issue (Not implemented yet).
|
||||
.TP
|
||||
\fBcomment\fR \fIISSUE\fR [\fITEXT\fR]
|
||||
.br
|
||||
Comment an issue. If no text is given, enter it in standard input.
|
||||
.TP
|
||||
\fBedit\fR \fIISSUE\fR [\fIKEY\fR [\fIVALUE\fR]]
|
||||
.br
|
||||
Edit an issue.
|
||||
.br
|
||||
If you are not in interactive mode, you can use these parameters:
|
||||
.br
|
||||
\-\-title TITLE
|
||||
.br
|
||||
\-\-assignee ASSIGNEE
|
||||
.br
|
||||
\-\-target\-version VERSION
|
||||
.br
|
||||
\-\-category CATEGORY
|
||||
.br
|
||||
\-\-status STATUS
|
||||
.TP
|
||||
\fBget\fR \fIISSUE\fR
|
||||
.br
|
||||
Get an issue and display it.
|
||||
.TP
|
||||
\fBlogtime\fR \fIISSUE\fR \fIHOURS\fR [\fITEXT\fR]
|
||||
.br
|
||||
Log spent time on an issue.
|
||||
.TP
|
||||
\fBpost\fR \fIPROJECT\fR
|
||||
.br
|
||||
Post a new issue.
|
||||
.br
|
||||
|
||||
.br
|
||||
If you are not in interactive mode, you can use these parameters:
|
||||
.br
|
||||
\-\-title TITLE
|
||||
.br
|
||||
\-\-assignee ASSIGNEE
|
||||
.br
|
||||
\-\-target\-version VERSION
|
||||
.br
|
||||
\-\-category CATEGORY
|
||||
.br
|
||||
\-\-status STATUS
|
||||
.TP
|
||||
\fBremove\fR \fIISSUE\fR
|
||||
.br
|
||||
Remove an issue.
|
||||
.TP
|
||||
\fBsearch\fR \fIPROJECT\fR
|
||||
.br
|
||||
List issues for a project.
|
||||
.br
|
||||
|
||||
.br
|
||||
You can use these filters from command line:
|
||||
.br
|
||||
\-\-author AUTHOR
|
||||
.br
|
||||
\-\-title TITLE_PATTERN
|
||||
.br
|
||||
\-\-assignee ASSIGNEE
|
||||
.br
|
||||
\-\-target\-version VERSION
|
||||
.br
|
||||
\-\-category CATEGORY
|
||||
.br
|
||||
\-\-status STATUS
|
||||
.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
|
||||
\fBcd\fR [\fIPATH\fR]
|
||||
.br
|
||||
Follow a path.
|
||||
.br
|
||||
If empty, return 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
|
||||
.br
|
||||
List objects in current 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)
|
||||
|
||||
.SH BOOBTRACKER OPTIONS
|
||||
.TP
|
||||
\fB\-\-author=AUTHOR\fR
|
||||
.TP
|
||||
\fB\-\-title=TITLE\fR
|
||||
.TP
|
||||
\fB\-\-assignee=ASSIGNEE\fR
|
||||
.TP
|
||||
\fB\-\-target\-version=VERSION\fR
|
||||
.TP
|
||||
\fB\-\-category=CATEGORY\fR
|
||||
.TP
|
||||
\fB\-\-status=STATUS\fR
|
||||
|
||||
.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, issue_info, issues_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) 2011 Romain Bignon
|
||||
.LP
|
||||
For full COPYRIGHT see COPYING file with weboob package.
|
||||
.LP
|
||||
.RE
|
||||
.SH FILES
|
||||
"~/.weboob/backends"
|
||||
|
||||
.SH SEE ALSO
|
||||
Home page: http://weboob.org/Boobtracker
|
||||
120
man/weboob-repos.1
Normal file
120
man/weboob-repos.1
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
.TH WEBOOB-REPOS 1 "05 February 2012" "weboob-repos 0\&.a"
|
||||
.SH NAME
|
||||
weboob-repos
|
||||
.SH SYNOPSIS
|
||||
.B weboob\-repos
|
||||
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
|
||||
.br
|
||||
.B weboob\-repos
|
||||
[\-\-help] [\-\-version]
|
||||
|
||||
.SH DESCRIPTION
|
||||
.LP
|
||||
|
||||
Weboob\-repos is a console application to manage a Weboob Repository.
|
||||
|
||||
.SS Supported websites:
|
||||
|
||||
.SH WEBOOB\-REPOS 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
|
||||
\fBbuild\fR \fISOURCE\fR \fIREPOSITORY\fR
|
||||
.br
|
||||
Build backends contained in SOURCE to REPOSITORY.
|
||||
.br
|
||||
|
||||
.br
|
||||
Example:
|
||||
.br
|
||||
$ weboob\-repos build $HOME/src/weboob/modules /var/www/updates.weboob.org/0.a/
|
||||
.TP
|
||||
\fBcreate\fR \fINAME\fR [\fIPATH\fR]
|
||||
.br
|
||||
Create a new repository. If PATH is missing, create repository
|
||||
.br
|
||||
on the current directory.
|
||||
|
||||
.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
|
||||
.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, 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) 2012 Romain Bignon
|
||||
.LP
|
||||
For full COPYRIGHT see COPYING file with weboob package.
|
||||
.LP
|
||||
.RE
|
||||
.SH FILES
|
||||
"~/.weboob/backends"
|
||||
Loading…
Add table
Add a link
Reference in a new issue