diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/git-bug-export.1 | 77 | ||||
| -rw-r--r-- | doc/man/git-bug.1 | 2 | ||||
| -rw-r--r-- | doc/md/git-bug.md | 25 | ||||
| -rw-r--r-- | doc/md/git-bug_export.md | 39 |
4 files changed, 135 insertions, 8 deletions
diff --git a/doc/man/git-bug-export.1 b/doc/man/git-bug-export.1 new file mode 100644 index 00000000..a6c1b1c5 --- /dev/null +++ b/doc/man/git-bug-export.1 @@ -0,0 +1,77 @@ +.nh +.TH "GIT\-BUG" "1" "Apr 2019" "Generated from git\-bug's source code" "" + +.SH NAME +.PP +git\-bug\-export \- Export bugs as a series of operations. + + +.SH SYNOPSIS +.PP +\fBgit\-bug export [QUERY] [flags]\fP + + +.SH DESCRIPTION +.PP +Export bugs as a series of operations. + +.PP +You can pass an additional query to filter and order the list. This query can be expressed either with a simple query language, flags, a natural language full text search, or a combination of the aforementioned. + + +.SH OPTIONS +.PP +\fB\-s\fP, \fB\-\-status\fP=[] + Filter by status. Valid values are [open,closed] + +.PP +\fB\-a\fP, \fB\-\-author\fP=[] + Filter by author + +.PP +\fB\-p\fP, \fB\-\-participant\fP=[] + Filter by participant + +.PP +\fB\-A\fP, \fB\-\-actor\fP=[] + Filter by actor + +.PP +\fB\-l\fP, \fB\-\-label\fP=[] + Filter by label + +.PP +\fB\-t\fP, \fB\-\-title\fP=[] + Filter by title + +.PP +\fB\-n\fP, \fB\-\-no\fP=[] + Filter by absence of something. Valid values are [label] + +.PP +\fB\-b\fP, \fB\-\-by\fP="creation" + Sort the results by a characteristic. Valid values are [id,creation,edit] + +.PP +\fB\-d\fP, \fB\-\-direction\fP="asc" + Select the sorting direction. Valid values are [asc,desc] + +.PP +\fB\-h\fP, \fB\-\-help\fP[=false] + help for export + + +.SH EXAMPLE +.PP +.RS + +.nf +See ls + +.fi +.RE + + +.SH SEE ALSO +.PP +\fBgit\-bug(1)\fP diff --git a/doc/man/git-bug.1 b/doc/man/git-bug.1 index 9bf59164..1599d8b4 100644 --- a/doc/man/git-bug.1 +++ b/doc/man/git-bug.1 @@ -29,4 +29,4 @@ the same git remote you are already using to collaborate with other people. .SH SEE ALSO .PP -\fBgit-bug-bridge(1)\fP, \fBgit-bug-bug(1)\fP, \fBgit-bug-commands(1)\fP, \fBgit-bug-label(1)\fP, \fBgit-bug-pull(1)\fP, \fBgit-bug-push(1)\fP, \fBgit-bug-termui(1)\fP, \fBgit-bug-user(1)\fP, \fBgit-bug-version(1)\fP, \fBgit-bug-webui(1)\fP, \fBgit-bug-wipe(1)\fP +\fBgit\-bug\-add(1)\fP, \fBgit\-bug\-bridge(1)\fP, \fBgit\-bug\-commands(1)\fP, \fBgit\-bug\-comment(1)\fP, \fBgit\-bug\-deselect(1)\fP, \fBgit\-bug\-export(1)\fP, \fBgit\-bug\-label(1)\fP, \fBgit\-bug\-ls(1)\fP, \fBgit\-bug\-ls\-id(1)\fP, \fBgit\-bug\-ls\-label(1)\fP, \fBgit\-bug\-pull(1)\fP, \fBgit\-bug\-push(1)\fP, \fBgit\-bug\-rm(1)\fP, \fBgit\-bug\-select(1)\fP, \fBgit\-bug\-show(1)\fP, \fBgit\-bug\-status(1)\fP, \fBgit\-bug\-termui(1)\fP, \fBgit\-bug\-title(1)\fP, \fBgit\-bug\-user(1)\fP, \fBgit\-bug\-version(1)\fP, \fBgit\-bug\-webui(1)\fP, \fBgit-bug-wipe(1)\fP diff --git a/doc/md/git-bug.md b/doc/md/git-bug.md index a71d6dfb..5a55485c 100644 --- a/doc/md/git-bug.md +++ b/doc/md/git-bug.md @@ -27,12 +27,23 @@ git-bug [flags] * [git-bug bridge](git-bug_bridge.md) - List bridges to other bug trackers * [git-bug bug](git-bug_bug.md) - List bugs * [git-bug commands](git-bug_commands.md) - Display available commands. -* [git-bug label](git-bug_label.md) - List valid labels -* [git-bug pull](git-bug_pull.md) - Pull updates from a git remote -* [git-bug push](git-bug_push.md) - Push updates to a git remote -* [git-bug termui](git-bug_termui.md) - Launch the terminal UI -* [git-bug user](git-bug_user.md) - List identities -* [git-bug version](git-bug_version.md) - Show git-bug version information -* [git-bug webui](git-bug_webui.md) - Launch the web UI +* [git-bug comment](git-bug_comment.md) - Display or add comments to a bug. +* [git-bug deselect](git-bug_deselect.md) - Clear the implicitly selected bug. +* [git-bug export](git-bug_export.md) - Export bugs as a series of operations. +* [git-bug label](git-bug_label.md) - Display, add or remove labels to/from a bug. +* [git-bug ls](git-bug_ls.md) - List bugs. +* [git-bug ls-id](git-bug_ls-id.md) - List bug identifiers. +* [git-bug ls-label](git-bug_ls-label.md) - List valid labels. +* [git-bug pull](git-bug_pull.md) - Pull bugs update from a git remote. +* [git-bug push](git-bug_push.md) - Push bugs update to a git remote. +* [git-bug rm](git-bug_rm.md) - Remove an existing bug. +* [git-bug select](git-bug_select.md) - Select a bug for implicit use in future commands. +* [git-bug show](git-bug_show.md) - Display the details of a bug. +* [git-bug status](git-bug_status.md) - Display or change a bug status. +* [git-bug termui](git-bug_termui.md) - Launch the terminal UI. +* [git-bug title](git-bug_title.md) - Display or change a title of a bug. +* [git-bug user](git-bug_user.md) - Display or change the user identity. +* [git-bug version](git-bug_version.md) - Show git-bug version information. * [git-bug wipe](git-bug_wipe.md) - Wipe git-bug from the git repository +* [git-bug webui](git-bug_webui.md) - Launch the web UI. diff --git a/doc/md/git-bug_export.md b/doc/md/git-bug_export.md new file mode 100644 index 00000000..df9c9a9b --- /dev/null +++ b/doc/md/git-bug_export.md @@ -0,0 +1,39 @@ +## git-bug export + +Export bugs as a series of operations. + +### Synopsis + +Export bugs as a series of operations. + +You can pass an additional query to filter and order the list. This query can be expressed either with a simple query language, flags, a natural language full text search, or a combination of the aforementioned. + +``` +git-bug export [QUERY] [flags] +``` + +### Examples + +``` +See ls +``` + +### Options + +``` + -s, --status strings Filter by status. Valid values are [open,closed] + -a, --author strings Filter by author + -p, --participant strings Filter by participant + -A, --actor strings Filter by actor + -l, --label strings Filter by label + -t, --title strings Filter by title + -n, --no strings Filter by absence of something. Valid values are [label] + -b, --by string Sort the results by a characteristic. Valid values are [id,creation,edit] (default "creation") + -d, --direction string Select the sorting direction. Valid values are [asc,desc] (default "asc") + -h, --help help for export +``` + +### SEE ALSO + +* [git-bug](git-bug.md) - A bug tracker embedded in Git. + |