boobtracker.1 9 KB
Newer Older
1
.\" -*- coding: utf-8 -*-
Florent Fourcot's avatar
Florent Fourcot committed
2
.\" This file was generated automatically by tools/make_man.sh.
Romain Bignon's avatar
Romain Bignon committed
3
.TH BOOBTRACKER 1 "27 February 2019" "boobtracker 1\&.5"
Romain Bignon's avatar
Romain Bignon committed
4
.SH NAME
5
boobtracker \- manage bug tracking issues
Romain Bignon's avatar
Romain Bignon committed
6 7 8 9 10 11 12 13 14 15
.SH SYNOPSIS
.B boobtracker
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B boobtracker
[\-\-help] [\-\-version]

.SH DESCRIPTION
.LP

16
Console application allowing to create, edit, view bug tracking issues.
Romain Bignon's avatar
Romain Bignon committed
17 18

.SS Supported websites:
Romain Bignon's avatar
Romain Bignon committed
19 20
* asana (Asana)
.br
Florent Fourcot's avatar
Florent Fourcot committed
21 22
* github (GitHub issues tracking)
.br
Romain Bignon's avatar
Romain Bignon committed
23 24 25 26 27 28 29 30 31 32 33
* 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
Romain Bignon's avatar
Romain Bignon committed
34 35 36 37
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Romain Bignon's avatar
Romain Bignon committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
\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 Fourcot's avatar
Florent Fourcot committed
103 104 105 106
.br

.br
Default is limited to 10 results.
Romain Bignon's avatar
Romain Bignon committed
107 108 109 110 111 112 113 114 115 116
.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
117
* enable         enable given backends
Romain Bignon's avatar
Romain Bignon committed
118
.br
Romain Bignon's avatar
Romain Bignon committed
119
* disable        disable given backends
Romain Bignon's avatar
Romain Bignon committed
120
.br
Romain Bignon's avatar
Romain Bignon committed
121
* only           enable given backends and disable the others
Romain Bignon's avatar
Romain Bignon committed
122
.br
Romain Bignon's avatar
Romain Bignon committed
123
* list           list backends
Romain Bignon's avatar
Romain Bignon committed
124
.br
Romain Bignon's avatar
Romain Bignon committed
125
* add            add a backend
Romain Bignon's avatar
Romain Bignon committed
126
.br
Romain Bignon's avatar
Romain Bignon committed
127
* register       register a new account on a website
Romain Bignon's avatar
Romain Bignon committed
128
.br
Romain Bignon's avatar
Romain Bignon committed
129
* edit           edit a backend
Romain Bignon's avatar
Romain Bignon committed
130
.br
Romain Bignon's avatar
Romain Bignon committed
131 132 133
* remove         remove a backend
.br
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
134 135 136 137 138
.TP
\fBcd\fR [\fIPATH\fR]
.br
Follow a path.
.br
Romain Bignon's avatar
Romain Bignon committed
139 140 141
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
Romain Bignon's avatar
Romain Bignon committed
142 143 144
.TP
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent Fourcot's avatar
Florent Fourcot committed
145
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
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
.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
\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 Fourcot's avatar
Florent Fourcot committed
203
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
204 205
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
206 207
.br
If an argument is given, list the specified path.
Florent Fourcot's avatar
Florent Fourcot committed
208
.br
Florent Fourcot's avatar
Florent Fourcot committed
209
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent Fourcot's avatar
Florent Fourcot committed
210 211 212
.br
return results as soon as possible.
.br
Florent Fourcot's avatar
Florent Fourcot committed
213
Use \-d option to display information about a collection (and to not
Florent Fourcot's avatar
Florent Fourcot committed
214 215 216
.br
display the content of it). It has the same behavior than the well
.br
Florent Fourcot's avatar
Florent Fourcot committed
217
known UNIX "ls" command.
Florent Fourcot's avatar
Florent Fourcot committed
218 219 220 221
.br

.br
Default is limited to 40 results.
Romain Bignon's avatar
Romain Bignon committed
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
.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 Fourcot's avatar
Florent Fourcot committed
249 250 251
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
252 253 254
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
255 256 257
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
258 259 260
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
Romain Bignon's avatar
Romain Bignon committed
261 262 263 264 265 266 267 268 269 270 271

.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 Fourcot's avatar
Florent Fourcot committed
272 273
\fB\-\-tracker=TRACKER\fR
.TP
Romain Bignon's avatar
Romain Bignon committed
274 275 276
\fB\-\-category=CATEGORY\fR
.TP
\fB\-\-status=STATUS\fR
Florent Fourcot's avatar
Florent Fourcot committed
277 278 279 280 281 282
.TP
\fB\-\-priority=PRIORITY\fR
.TP
\fB\-\-start=START\fR
.TP
\fB\-\-due=DUE\fR
Romain Bignon's avatar
Romain Bignon committed
283 284 285 286

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
287
display debug messages. Set up it twice to more verbosity
Romain Bignon's avatar
Romain Bignon committed
288 289 290 291 292 293 294 295 296 297 298 299
.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
Florent Fourcot's avatar
Florent Fourcot committed
300 301 302
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
Romain Bignon's avatar
Romain Bignon committed
303 304 305 306

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
307 308
filter result items to display given a boolean expression. See CONDITION section
for the syntax
Romain Bignon's avatar
Romain Bignon committed
309 310
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
311
limit number of results (from each backends)
Romain Bignon's avatar
Romain Bignon committed
312 313 314 315 316 317 318
.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
319
select output formatter (csv, htmltable, issue_info, issues_list, json,
Florent Fourcot's avatar
Florent Fourcot committed
320
json_line, multiline, simple, table, webkit)
Romain Bignon's avatar
Romain Bignon committed
321 322 323 324 325 326 327 328 329 330
.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 Fourcot's avatar
Florent Fourcot committed
331
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
332
The \-c and \-\-condition is a flexible way to filter and get only interesting results. It supports conditions on numerical values, dates, durations and strings. Dates are given in YYYY\-MM\-DD or YYYY\-MM\-DD HH:MM format. Durations look like XhYmZs where X, Y and Z are integers. Any of them may be omitted. For instance, YmZs, XhZs or Ym are accepted.
Florent Fourcot's avatar
Florent Fourcot committed
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
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
Florent Fourcot's avatar
Florent Fourcot committed
353 354 355 356
.LP
You can make a expression combinations with the keywords \fB" AND "\fR, \fB" OR "\fR an \fB" LIMIT "\fR.
.LP
The \fBLIMIT\fR keyword can be used to limit the number of items upon which running the expression. \fBLIMIT\fR can only be placed at the end of the expression followed by the number of elements you want.
Florent Fourcot's avatar
Florent Fourcot committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
.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 Fourcot's avatar
Florent Fourcot committed
374
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
375 376
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
377 378 379 380 381
.PP
.nf
.B boobank history account@backend \-\-condition 'date>2013\-12\-01  LIMIT 10'
.fi
Get transactions after the 2th December in the last 10 transactions
Florent Fourcot's avatar
Florent Fourcot committed
382

Romain Bignon's avatar
Romain Bignon committed
383
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
384
Copyright(C) 2011-2019 Romain Bignon
Romain Bignon's avatar
Romain Bignon committed
385
.LP
Florent Fourcot's avatar
Florent Fourcot committed
386
For full copyright information see the COPYING file in the weboob package.
Romain Bignon's avatar
Romain Bignon committed
387 388 389
.LP
.RE
.SH FILES
Romain Bignon's avatar
Romain Bignon committed
390
"~/.config/weboob/backends" 
Romain Bignon's avatar
Romain Bignon committed
391 392

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