Skip to content
boobtracker.1 8.28 KiB
Newer Older
.\" -*- coding: utf-8 -*-
Florent's avatar
Florent committed
.TH BOOBTRACKER 1 "19 May 2014" "boobtracker 0\&.i"
Romain Bignon's avatar
Romain Bignon committed
.SH NAME
boobtracker \- manage bug tracking issues
Romain Bignon's avatar
Romain Bignon committed
.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 create, edit, view bug tracking issues.
Romain Bignon's avatar
Romain Bignon committed

.SS Supported websites:
Florent's avatar
Florent committed
* github (GitHub issues tracking)
.br
Romain Bignon's avatar
Romain Bignon committed
* 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
Florent's avatar
Florent committed
.br

.br
Default is limited to 10 results.
Romain Bignon's avatar
Romain Bignon committed
.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
Romain Bignon's avatar
Romain Bignon committed
* enable         enable given backends
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* disable        disable given backends
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* only           enable given backends and disable the others
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* list           list backends
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* add            add a backend
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* register       register a new account on a website
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* edit           edit a backend
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* remove         remove a backend
.br
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
.TP
\fBcd\fR [\fIPATH\fR]
.br
Follow a path.
.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
Florent's avatar
Florent committed
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
Romain Bignon's avatar
Romain Bignon committed
.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
Florent's avatar
Florent committed
\fBls\fR [\-d] [\-\fIU\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.
Florent's avatar
Florent committed
.br
Florent's avatar
Florent committed
Use \-U option to not sort results. It allows to use a "fast path" to
.br
return results as soon as possible.
.br
Use \-d option to display informations about a collection (and to not
.br
display the content of it). It has the same behavior than the well
.br
know UNIX "ls" command.
Florent's avatar
Florent committed
.br

.br
Default is limited to 40 results.
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)
Florent's avatar
Florent committed
.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
Romain Bignon's avatar
Romain Bignon committed

.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
Florent's avatar
Florent committed
\fB\-\-tracker=TRACKER\fR
.TP
Romain Bignon's avatar
Romain Bignon committed
\fB\-\-category=CATEGORY\fR
.TP
\fB\-\-status=STATUS\fR
Florent's avatar
Florent committed
.TP
\fB\-\-priority=PRIORITY\fR
.TP
\fB\-\-start=START\fR
.TP
\fB\-\-due=DUE\fR
Romain Bignon's avatar
Romain Bignon committed

.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
Florent's avatar
Florent committed
filter result items to display given a boolean expression. See CONDITION section
for the syntax
Romain Bignon's avatar
Romain Bignon committed
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent's avatar
Florent committed
limit number of results (from each backends)
Romain Bignon's avatar
Romain Bignon committed
.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, json,
Florent's avatar
Florent committed
json_line, multiline, simple, table, webkit)
Romain Bignon's avatar
Romain Bignon committed
.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

Florent's avatar
Florent committed
.SH CONDITION
Florent's avatar
Florent committed
The \-c and \-\-condition is a flexible way to sort and get only interesting results. It supports conditions on numerical values, dates, and strings. Dates are given in YYYY\-MM\-DD format.
Florent's avatar
Florent committed
The syntax of one expression is "\fBfield operator value\fR". The field to test is always the left member of the expression.
.LP
The field is a member of the objects returned by the command. For example, a bank account has "balance", "coming" or "label" fields.
.SS The following operators are supported:
.TP
=
Test if object.field is equal to the value.
.TP
!=
Test if object.field is not equal to the value.
.TP
>
Test if object.field is greater than the value. If object.field is date, return true if value is before that object.field.
.TP
<
Test if object.field is less than the value. If object.field is date, return true if value is after that object.field.
.TP
|
This operator is available only for string fields. It works like the Unix standard \fBgrep\fR command, and returns True if the pattern specified in the value is in object.field.
.SS Expression combination
You can make a expression combinations with the keywords \fB" AND "\fR and \fB" OR "\fR.

.SS Examples:
.nf
.B boobank ls \-\-condition 'label=Livret A'
.fi
Display only the "Livret A" account.
.PP
.nf
.B boobank ls \-\-condition 'balance>10000'
.fi
Display accounts with a lot of money.
.PP
.nf
.B boobank history account@backend \-\-condition 'label|rewe'
.fi
Get transactions containing "rewe".
.PP
.nf
Florent's avatar
Florent committed
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent's avatar
Florent committed
.fi
Get transactions betweens the 2th December and 8th December 2013.

Romain Bignon's avatar
Romain Bignon committed
.SH COPYRIGHT
Copyright(C) 2011 Romain Bignon
.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

.SH SEE ALSO
Romain Bignon's avatar
Romain Bignon committed
Home page: http://weboob.org/applications/boobtracker