From acc9a6f3a6df2961c3ae44352216d915cb9b5315 Mon Sep 17 00:00:00 2001 From: Michael Muré Date: Sat, 10 Sep 2022 11:09:19 +0200 Subject: commands: reorg into different packages --- doc/man/git-bug-add.1 | 43 ------------ doc/man/git-bug-bridge-auth-rm.1 | 6 +- doc/man/git-bug-bridge-auth-show.1 | 4 +- doc/man/git-bug-bridge-auth.1 | 4 +- doc/man/git-bug-bridge-configure.1 | 140 ------------------------------------- doc/man/git-bug-bridge-new.1 | 140 +++++++++++++++++++++++++++++++++++++ doc/man/git-bug-bridge-pull.1 | 4 +- doc/man/git-bug-bridge-push.1 | 4 +- doc/man/git-bug-bridge-rm.1 | 4 +- doc/man/git-bug-bridge.1 | 6 +- doc/man/git-bug-bug-comment-edit.1 | 39 +++++++++++ doc/man/git-bug-bug-comment-new.1 | 39 +++++++++++ doc/man/git-bug-bug-comment.1 | 27 +++++++ doc/man/git-bug-bug-deselect.1 | 42 +++++++++++ doc/man/git-bug-bug-label-new.1 | 27 +++++++ doc/man/git-bug-bug-label-rm.1 | 27 +++++++ doc/man/git-bug-bug-label.1 | 27 +++++++ doc/man/git-bug-bug-new.1 | 43 ++++++++++++ doc/man/git-bug-bug-rm.1 | 27 +++++++ doc/man/git-bug-bug-select.1 | 50 +++++++++++++ doc/man/git-bug-bug-show.1 | 35 ++++++++++ doc/man/git-bug-bug-status-close.1 | 27 +++++++ doc/man/git-bug-bug-status-open.1 | 27 +++++++ doc/man/git-bug-bug-status.1 | 27 +++++++ doc/man/git-bug-bug-title-edit.1 | 35 ++++++++++ doc/man/git-bug-bug-title.1 | 27 +++++++ doc/man/git-bug-bug.1 | 96 +++++++++++++++++++++++++ doc/man/git-bug-comment-add.1 | 39 ----------- doc/man/git-bug-comment-edit.1 | 39 ----------- doc/man/git-bug-comment.1 | 27 ------- doc/man/git-bug-deselect.1 | 42 ----------- doc/man/git-bug-label-add.1 | 27 ------- doc/man/git-bug-label-ls.1 | 30 -------- doc/man/git-bug-label-rm.1 | 27 ------- doc/man/git-bug-label.1 | 11 +-- doc/man/git-bug-ls.1 | 96 ------------------------- doc/man/git-bug-pull.1 | 4 +- doc/man/git-bug-push.1 | 4 +- doc/man/git-bug-rm.1 | 27 ------- doc/man/git-bug-select.1 | 50 ------------- doc/man/git-bug-show.1 | 35 ---------- doc/man/git-bug-status-close.1 | 27 ------- doc/man/git-bug-status-open.1 | 27 ------- doc/man/git-bug-status.1 | 27 ------- doc/man/git-bug-termui.1 | 4 +- doc/man/git-bug-title-edit.1 | 35 ---------- doc/man/git-bug-title.1 | 27 ------- doc/man/git-bug-user-adopt.1 | 6 +- doc/man/git-bug-user-create.1 | 43 ------------ doc/man/git-bug-user-ls.1 | 31 -------- doc/man/git-bug-user-new.1 | 43 ++++++++++++ doc/man/git-bug-user-user.1 | 31 ++++++++ doc/man/git-bug-user.1 | 12 ++-- doc/man/git-bug-version.1 | 4 +- doc/man/git-bug-webui.1 | 2 +- doc/man/git-bug.1 | 4 +- 56 files changed, 879 insertions(+), 879 deletions(-) delete mode 100644 doc/man/git-bug-add.1 delete mode 100644 doc/man/git-bug-bridge-configure.1 create mode 100644 doc/man/git-bug-bridge-new.1 create mode 100644 doc/man/git-bug-bug-comment-edit.1 create mode 100644 doc/man/git-bug-bug-comment-new.1 create mode 100644 doc/man/git-bug-bug-comment.1 create mode 100644 doc/man/git-bug-bug-deselect.1 create mode 100644 doc/man/git-bug-bug-label-new.1 create mode 100644 doc/man/git-bug-bug-label-rm.1 create mode 100644 doc/man/git-bug-bug-label.1 create mode 100644 doc/man/git-bug-bug-new.1 create mode 100644 doc/man/git-bug-bug-rm.1 create mode 100644 doc/man/git-bug-bug-select.1 create mode 100644 doc/man/git-bug-bug-show.1 create mode 100644 doc/man/git-bug-bug-status-close.1 create mode 100644 doc/man/git-bug-bug-status-open.1 create mode 100644 doc/man/git-bug-bug-status.1 create mode 100644 doc/man/git-bug-bug-title-edit.1 create mode 100644 doc/man/git-bug-bug-title.1 create mode 100644 doc/man/git-bug-bug.1 delete mode 100644 doc/man/git-bug-comment-add.1 delete mode 100644 doc/man/git-bug-comment-edit.1 delete mode 100644 doc/man/git-bug-comment.1 delete mode 100644 doc/man/git-bug-deselect.1 delete mode 100644 doc/man/git-bug-label-add.1 delete mode 100644 doc/man/git-bug-label-ls.1 delete mode 100644 doc/man/git-bug-label-rm.1 delete mode 100644 doc/man/git-bug-ls.1 delete mode 100644 doc/man/git-bug-rm.1 delete mode 100644 doc/man/git-bug-select.1 delete mode 100644 doc/man/git-bug-show.1 delete mode 100644 doc/man/git-bug-status-close.1 delete mode 100644 doc/man/git-bug-status-open.1 delete mode 100644 doc/man/git-bug-status.1 delete mode 100644 doc/man/git-bug-title-edit.1 delete mode 100644 doc/man/git-bug-title.1 delete mode 100644 doc/man/git-bug-user-create.1 delete mode 100644 doc/man/git-bug-user-ls.1 create mode 100644 doc/man/git-bug-user-new.1 create mode 100644 doc/man/git-bug-user-user.1 (limited to 'doc/man') diff --git a/doc/man/git-bug-add.1 b/doc/man/git-bug-add.1 deleted file mode 100644 index 39c8fce4..00000000 --- a/doc/man/git-bug-add.1 +++ /dev/null @@ -1,43 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-add - Create a new bug. - - -.SH SYNOPSIS -.PP -\fBgit-bug add [flags]\fP - - -.SH DESCRIPTION -.PP -Create a new bug. - - -.SH OPTIONS -.PP -\fB-t\fP, \fB--title\fP="" - Provide a title to describe the issue - -.PP -\fB-m\fP, \fB--message\fP="" - Provide a message to describe the issue - -.PP -\fB-F\fP, \fB--file\fP="" - Take the message from the given file. Use - to read the message from the standard input - -.PP -\fB--non-interactive\fP[=false] - Do not ask for user input - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for add - - -.SH SEE ALSO -.PP -\fBgit-bug(1)\fP diff --git a/doc/man/git-bug-bridge-auth-rm.1 b/doc/man/git-bug-bridge-auth-rm.1 index a22da320..4ce7672c 100644 --- a/doc/man/git-bug-bridge-auth-rm.1 +++ b/doc/man/git-bug-bridge-auth-rm.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-bridge-auth-rm - Remove a credential. +git-bug-bridge-auth-rm - Remove a credential .SH SYNOPSIS .PP -\fBgit-bug bridge auth rm ID [flags]\fP +\fBgit-bug bridge auth rm BRIDGE_ID [flags]\fP .SH DESCRIPTION .PP -Remove a credential. +Remove a credential .SH OPTIONS diff --git a/doc/man/git-bug-bridge-auth-show.1 b/doc/man/git-bug-bridge-auth-show.1 index 19ac9d37..1c4385ff 100644 --- a/doc/man/git-bug-bridge-auth-show.1 +++ b/doc/man/git-bug-bridge-auth-show.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge-auth-show - Display an authentication credential. +git-bug-bridge-auth-show - Display an authentication credential .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge-auth-show - Display an authentication credential. .SH DESCRIPTION .PP -Display an authentication credential. +Display an authentication credential .SH OPTIONS diff --git a/doc/man/git-bug-bridge-auth.1 b/doc/man/git-bug-bridge-auth.1 index 1fd94f5b..f6f36623 100644 --- a/doc/man/git-bug-bridge-auth.1 +++ b/doc/man/git-bug-bridge-auth.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge-auth - List all known bridge authentication credentials. +git-bug-bridge-auth - List all known bridge authentication credentials .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge-auth - List all known bridge authentication credentials. .SH DESCRIPTION .PP -List all known bridge authentication credentials. +List all known bridge authentication credentials .SH OPTIONS diff --git a/doc/man/git-bug-bridge-configure.1 b/doc/man/git-bug-bridge-configure.1 deleted file mode 100644 index 002d8202..00000000 --- a/doc/man/git-bug-bridge-configure.1 +++ /dev/null @@ -1,140 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-bridge-configure - Configure a new bridge. - - -.SH SYNOPSIS -.PP -\fBgit-bug bridge configure [flags]\fP - - -.SH DESCRIPTION -.PP -.RS - -.nf -Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge. - -.fi -.RE - - -.SH OPTIONS -.PP -\fB-n\fP, \fB--name\fP="" - A distinctive name to identify the bridge - -.PP -\fB-t\fP, \fB--target\fP="" - The target of the bridge. Valid values are [github,gitlab,jira,launchpad-preview] - -.PP -\fB-u\fP, \fB--url\fP="" - The URL of the remote repository - -.PP -\fB-b\fP, \fB--base-url\fP="" - The base URL of your remote issue tracker - -.PP -\fB-l\fP, \fB--login\fP="" - The login on your remote issue tracker - -.PP -\fB-c\fP, \fB--credential\fP="" - The identifier or prefix of an already known credential for your remote issue tracker (see "git-bug bridge auth") - -.PP -\fB--token\fP="" - A raw authentication token for the remote issue tracker - -.PP -\fB--token-stdin\fP[=false] - Will read the token from stdin and ignore --token - -.PP -\fB-o\fP, \fB--owner\fP="" - The owner of the remote repository - -.PP -\fB-p\fP, \fB--project\fP="" - The name of the remote repository - -.PP -\fB--non-interactive\fP[=false] - Do not ask for user input - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for configure - - -.SH EXAMPLE -.PP -.RS - -.nf -# Interactive example -[1]: github -[2]: gitlab -[3]: jira -[4]: launchpad-preview - -target: 1 -name [default]: default - -Detected projects: -[1]: github.com/a-hilaly/git-bug -[2]: github.com/MichaelMure/git-bug - -[0]: Another project - -Select option: 1 - -[1]: user provided token -[2]: interactive token creation -Select option: 1 - -You can generate a new token by visiting https://github.com/settings/tokens. -Choose 'Generate new token' and set the necessary access scope for your repository. - -The access scope depend on the type of repository. -Public: - - 'public_repo': to be able to read public repositories -Private: - - 'repo' : to be able to read private repositories - -Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700 -Successfully configured bridge: default - -# For GitHub -git bug bridge configure \\ - --name=default \\ - --target=github \\ - --owner=$(OWNER) \\ - --project=$(PROJECT) \\ - --token=$(TOKEN) - -# For Launchpad -git bug bridge configure \\ - --name=default \\ - --target=launchpad-preview \\ - --url=https://bugs.launchpad.net/ubuntu/ - -# For Gitlab -git bug bridge configure \\ - --name=default \\ - --target=github \\ - --url=https://github.com/michaelmure/git-bug \\ - --token=$(TOKEN) - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBgit-bug-bridge(1)\fP diff --git a/doc/man/git-bug-bridge-new.1 b/doc/man/git-bug-bridge-new.1 new file mode 100644 index 00000000..1b0b2f38 --- /dev/null +++ b/doc/man/git-bug-bridge-new.1 @@ -0,0 +1,140 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bridge-new - Configure a new bridge + + +.SH SYNOPSIS +.PP +\fBgit-bug bridge new [flags]\fP + + +.SH DESCRIPTION +.PP +.RS + +.nf +Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge. + +.fi +.RE + + +.SH OPTIONS +.PP +\fB-n\fP, \fB--name\fP="" + A distinctive name to identify the bridge + +.PP +\fB-t\fP, \fB--target\fP="" + The target of the bridge. Valid values are [github,gitlab,jira,launchpad-preview] + +.PP +\fB-u\fP, \fB--url\fP="" + The URL of the remote repository + +.PP +\fB-b\fP, \fB--base-url\fP="" + The base URL of your remote issue tracker + +.PP +\fB-l\fP, \fB--login\fP="" + The login on your remote issue tracker + +.PP +\fB-c\fP, \fB--credential\fP="" + The identifier or prefix of an already known credential for your remote issue tracker (see "git-bug bridge auth") + +.PP +\fB--token\fP="" + A raw authentication token for the remote issue tracker + +.PP +\fB--token-stdin\fP[=false] + Will read the token from stdin and ignore --token + +.PP +\fB-o\fP, \fB--owner\fP="" + The owner of the remote repository + +.PP +\fB-p\fP, \fB--project\fP="" + The name of the remote repository + +.PP +\fB--non-interactive\fP[=false] + Do not ask for user input + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for new + + +.SH EXAMPLE +.PP +.RS + +.nf +# Interactive example +[1]: github +[2]: gitlab +[3]: jira +[4]: launchpad-preview + +target: 1 +name [default]: default + +Detected projects: +[1]: github.com/a-hilaly/git-bug +[2]: github.com/MichaelMure/git-bug + +[0]: Another project + +Select option: 1 + +[1]: user provided token +[2]: interactive token creation +Select option: 1 + +You can generate a new token by visiting https://github.com/settings/tokens. +Choose 'Generate new token' and set the necessary access scope for your repository. + +The access scope depend on the type of repository. +Public: + - 'public_repo': to be able to read public repositories +Private: + - 'repo' : to be able to read private repositories + +Enter token: 87cf5c03b64029f18ea5f9ca5679daa08ccbd700 +Successfully configured bridge: default + +# For GitHub +git bug bridge new \\ + --name=default \\ + --target=github \\ + --owner=$(OWNER) \\ + --project=$(PROJECT) \\ + --token=$(TOKEN) + +# For Launchpad +git bug bridge new \\ + --name=default \\ + --target=launchpad-preview \\ + --url=https://bugs.launchpad.net/ubuntu/ + +# For Gitlab +git bug bridge new \\ + --name=default \\ + --target=github \\ + --url=https://github.com/michaelmure/git-bug \\ + --token=$(TOKEN) + +.fi +.RE + + +.SH SEE ALSO +.PP +\fBgit-bug-bridge(1)\fP diff --git a/doc/man/git-bug-bridge-pull.1 b/doc/man/git-bug-bridge-pull.1 index 0ff1f860..4d39b0d7 100644 --- a/doc/man/git-bug-bridge-pull.1 +++ b/doc/man/git-bug-bridge-pull.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge-pull - Pull updates. +git-bug-bridge-pull - Pull updates from a remote bug tracker .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge-pull - Pull updates. .SH DESCRIPTION .PP -Pull updates. +Pull updates from a remote bug tracker .SH OPTIONS diff --git a/doc/man/git-bug-bridge-push.1 b/doc/man/git-bug-bridge-push.1 index fa882cf0..9541c527 100644 --- a/doc/man/git-bug-bridge-push.1 +++ b/doc/man/git-bug-bridge-push.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge-push - Push updates. +git-bug-bridge-push - Push updates to remote bug tracker .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge-push - Push updates. .SH DESCRIPTION .PP -Push updates. +Push updates to remote bug tracker .SH OPTIONS diff --git a/doc/man/git-bug-bridge-rm.1 b/doc/man/git-bug-bridge-rm.1 index 2445e6d8..6010eca8 100644 --- a/doc/man/git-bug-bridge-rm.1 +++ b/doc/man/git-bug-bridge-rm.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge-rm - Delete a configured bridge. +git-bug-bridge-rm - Delete a configured bridge .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge-rm - Delete a configured bridge. .SH DESCRIPTION .PP -Delete a configured bridge. +Delete a configured bridge .SH OPTIONS diff --git a/doc/man/git-bug-bridge.1 b/doc/man/git-bug-bridge.1 index 30e5f3ed..7fbce2c1 100644 --- a/doc/man/git-bug-bridge.1 +++ b/doc/man/git-bug-bridge.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-bridge - Configure and use bridges to other bug trackers. +git-bug-bridge - List bridges to other bug trackers .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-bridge - Configure and use bridges to other bug trackers. .SH DESCRIPTION .PP -Configure and use bridges to other bug trackers. +List bridges to other bug trackers .SH OPTIONS @@ -24,4 +24,4 @@ Configure and use bridges to other bug trackers. .SH SEE ALSO .PP -\fBgit-bug(1)\fP, \fBgit-bug-bridge-auth(1)\fP, \fBgit-bug-bridge-configure(1)\fP, \fBgit-bug-bridge-pull(1)\fP, \fBgit-bug-bridge-push(1)\fP, \fBgit-bug-bridge-rm(1)\fP +\fBgit-bug(1)\fP, \fBgit-bug-bridge-auth(1)\fP, \fBgit-bug-bridge-new(1)\fP, \fBgit-bug-bridge-pull(1)\fP, \fBgit-bug-bridge-push(1)\fP, \fBgit-bug-bridge-rm(1)\fP diff --git a/doc/man/git-bug-bug-comment-edit.1 b/doc/man/git-bug-bug-comment-edit.1 new file mode 100644 index 00000000..5a3d3506 --- /dev/null +++ b/doc/man/git-bug-bug-comment-edit.1 @@ -0,0 +1,39 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-comment-edit - Edit an existing comment on a bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug comment edit [COMMENT_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Edit an existing comment on a bug + + +.SH OPTIONS +.PP +\fB-F\fP, \fB--file\fP="" + Take the message from the given file. Use - to read the message from the standard input + +.PP +\fB-m\fP, \fB--message\fP="" + Provide the new message from the command line + +.PP +\fB--non-interactive\fP[=false] + Do not ask for user input + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for edit + + +.SH SEE ALSO +.PP +\fBgit-bug-bug-comment(1)\fP diff --git a/doc/man/git-bug-bug-comment-new.1 b/doc/man/git-bug-bug-comment-new.1 new file mode 100644 index 00000000..f2afc933 --- /dev/null +++ b/doc/man/git-bug-bug-comment-new.1 @@ -0,0 +1,39 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-comment-new - Add a new comment to a bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug comment new [BUG_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Add a new comment to a bug + + +.SH OPTIONS +.PP +\fB-F\fP, \fB--file\fP="" + Take the message from the given file. Use - to read the message from the standard input + +.PP +\fB-m\fP, \fB--message\fP="" + Provide the new message from the command line + +.PP +\fB--non-interactive\fP[=false] + Do not ask for user input + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for new + + +.SH SEE ALSO +.PP +\fBgit-bug-bug-comment(1)\fP diff --git a/doc/man/git-bug-bug-comment.1 b/doc/man/git-bug-bug-comment.1 new file mode 100644 index 00000000..162c4182 --- /dev/null +++ b/doc/man/git-bug-bug-comment.1 @@ -0,0 +1,27 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-comment - List a bug's comments + + +.SH SYNOPSIS +.PP +\fBgit-bug bug comment [BUG_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +List a bug's comments + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for comment + + +.SH SEE ALSO +.PP +\fBgit-bug-bug(1)\fP, \fBgit-bug-bug-comment-edit(1)\fP, \fBgit-bug-bug-comment-new(1)\fP diff --git a/doc/man/git-bug-bug-deselect.1 b/doc/man/git-bug-bug-deselect.1 new file mode 100644 index 00000000..fd342245 --- /dev/null +++ b/doc/man/git-bug-bug-deselect.1 @@ -0,0 +1,42 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-deselect - Clear the implicitly selected bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug deselect [flags]\fP + + +.SH DESCRIPTION +.PP +Clear the implicitly selected bug + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for deselect + + +.SH EXAMPLE +.PP +.RS + +.nf +git bug select 2f15 +git bug comment +git bug status +git bug deselect + + +.fi +.RE + + +.SH SEE ALSO +.PP +\fBgit-bug-bug(1)\fP diff --git a/doc/man/git-bug-bug-label-new.1 b/doc/man/git-bug-bug-label-new.1 new file mode 100644 index 00000000..aa2b0c65 --- /dev/null +++ b/doc/man/git-bug-bug-label-new.1 @@ -0,0 +1,27 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-label-new - Add a label to a bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug label new [BUG_ID] LABEL... [flags]\fP + + +.SH DESCRIPTION +.PP +Add a label to a bug + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for new + + +.SH SEE ALSO +.PP +\fBgit-bug-bug-label(1)\fP diff --git a/doc/man/git-bug-bug-label-rm.1 b/doc/man/git-bug-bug-label-rm.1 new file mode 100644 index 00000000..b204d61f --- /dev/null +++ b/doc/man/git-bug-bug-label-rm.1 @@ -0,0 +1,27 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-label-rm - Remove a label from a bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug label rm [BUG_ID] LABEL... [flags]\fP + + +.SH DESCRIPTION +.PP +Remove a label from a bug + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for rm + + +.SH SEE ALSO +.PP +\fBgit-bug-bug-label(1)\fP diff --git a/doc/man/git-bug-bug-label.1 b/doc/man/git-bug-bug-label.1 new file mode 100644 index 00000000..a98c2285 --- /dev/null +++ b/doc/man/git-bug-bug-label.1 @@ -0,0 +1,27 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-label - Display labels of a bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug label [BUG_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Display labels of a bug + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for label + + +.SH SEE ALSO +.PP +\fBgit-bug-bug(1)\fP, \fBgit-bug-bug-label-new(1)\fP, \fBgit-bug-bug-label-rm(1)\fP diff --git a/doc/man/git-bug-bug-new.1 b/doc/man/git-bug-bug-new.1 new file mode 100644 index 00000000..91de2dcc --- /dev/null +++ b/doc/man/git-bug-bug-new.1 @@ -0,0 +1,43 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-new - Create a new bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug new [flags]\fP + + +.SH DESCRIPTION +.PP +Create a new bug + + +.SH OPTIONS +.PP +\fB-t\fP, \fB--title\fP="" + Provide a title to describe the issue + +.PP +\fB-m\fP, \fB--message\fP="" + Provide a message to describe the issue + +.PP +\fB-F\fP, \fB--file\fP="" + Take the message from the given file. Use - to read the message from the standard input + +.PP +\fB--non-interactive\fP[=false] + Do not ask for user input + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for new + + +.SH SEE ALSO +.PP +\fBgit-bug-bug(1)\fP diff --git a/doc/man/git-bug-bug-rm.1 b/doc/man/git-bug-bug-rm.1 new file mode 100644 index 00000000..ee7ea185 --- /dev/null +++ b/doc/man/git-bug-bug-rm.1 @@ -0,0 +1,27 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-rm - Remove an existing bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug rm BUG_ID [flags]\fP + + +.SH DESCRIPTION +.PP +Remove an existing bug in the local repository. Note removing bugs that were imported from bridges will not remove the bug on the remote, and will only remove the local copy of the bug. + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for rm + + +.SH SEE ALSO +.PP +\fBgit-bug-bug(1)\fP diff --git a/doc/man/git-bug-bug-select.1 b/doc/man/git-bug-bug-select.1 new file mode 100644 index 00000000..d73cd606 --- /dev/null +++ b/doc/man/git-bug-bug-select.1 @@ -0,0 +1,50 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-select - Select a bug for implicit use in future commands + + +.SH SYNOPSIS +.PP +\fBgit-bug bug select BUG_ID [flags]\fP + + +.SH DESCRIPTION +.PP +Select a bug for implicit use in future commands. + +.PP +This command allows you to omit any bug ID argument, for example: + git bug show +instead of + git bug show 2f153ca + +.PP +The complementary command is "git bug deselect" performing the opposite operation. + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for select + + +.SH EXAMPLE +.PP +.RS + +.nf +git bug select 2f15 +git bug comment +git bug status + + +.fi +.RE + + +.SH SEE ALSO +.PP +\fBgit-bug-bug(1)\fP diff --git a/doc/man/git-bug-bug-show.1 b/doc/man/git-bug-bug-show.1 new file mode 100644 index 00000000..aec83fa3 --- /dev/null +++ b/doc/man/git-bug-bug-show.1 @@ -0,0 +1,35 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-show - Display the details of a bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug show [BUG_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Display the details of a bug + + +.SH OPTIONS +.PP +\fB--field\fP="" + Select field to display. Valid values are [author,authorEmail,createTime,lastEdit,humanId,id,labels,shortId,status,title,actors,participants] + +.PP +\fB-f\fP, \fB--format\fP="default" + Select the output formatting style. Valid values are [default,json,org-mode] + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for show + + +.SH SEE ALSO +.PP +\fBgit-bug-bug(1)\fP diff --git a/doc/man/git-bug-bug-status-close.1 b/doc/man/git-bug-bug-status-close.1 new file mode 100644 index 00000000..edd9f666 --- /dev/null +++ b/doc/man/git-bug-bug-status-close.1 @@ -0,0 +1,27 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-status-close - Mark a bug as closed + + +.SH SYNOPSIS +.PP +\fBgit-bug bug status close [BUG_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Mark a bug as closed + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for close + + +.SH SEE ALSO +.PP +\fBgit-bug-bug-status(1)\fP diff --git a/doc/man/git-bug-bug-status-open.1 b/doc/man/git-bug-bug-status-open.1 new file mode 100644 index 00000000..4c001ada --- /dev/null +++ b/doc/man/git-bug-bug-status-open.1 @@ -0,0 +1,27 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-status-open - Mark a bug as open + + +.SH SYNOPSIS +.PP +\fBgit-bug bug status open [BUG_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Mark a bug as open + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for open + + +.SH SEE ALSO +.PP +\fBgit-bug-bug-status(1)\fP diff --git a/doc/man/git-bug-bug-status.1 b/doc/man/git-bug-bug-status.1 new file mode 100644 index 00000000..7abcd1a5 --- /dev/null +++ b/doc/man/git-bug-bug-status.1 @@ -0,0 +1,27 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-status - Display the status of a bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug status [BUG_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Display the status of a bug + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for status + + +.SH SEE ALSO +.PP +\fBgit-bug-bug(1)\fP, \fBgit-bug-bug-status-close(1)\fP, \fBgit-bug-bug-status-open(1)\fP diff --git a/doc/man/git-bug-bug-title-edit.1 b/doc/man/git-bug-bug-title-edit.1 new file mode 100644 index 00000000..c5e33c7a --- /dev/null +++ b/doc/man/git-bug-bug-title-edit.1 @@ -0,0 +1,35 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-title-edit - Edit a title of a bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug title edit [BUG_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Edit a title of a bug + + +.SH OPTIONS +.PP +\fB-t\fP, \fB--title\fP="" + Provide a title to describe the issue + +.PP +\fB--non-interactive\fP[=false] + Do not ask for user input + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for edit + + +.SH SEE ALSO +.PP +\fBgit-bug-bug-title(1)\fP diff --git a/doc/man/git-bug-bug-title.1 b/doc/man/git-bug-bug-title.1 new file mode 100644 index 00000000..94568035 --- /dev/null +++ b/doc/man/git-bug-bug-title.1 @@ -0,0 +1,27 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug-title - Display the title of a bug + + +.SH SYNOPSIS +.PP +\fBgit-bug bug title [BUG_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Display the title of a bug + + +.SH OPTIONS +.PP +\fB-h\fP, \fB--help\fP[=false] + help for title + + +.SH SEE ALSO +.PP +\fBgit-bug-bug(1)\fP, \fBgit-bug-bug-title-edit(1)\fP diff --git a/doc/man/git-bug-bug.1 b/doc/man/git-bug-bug.1 new file mode 100644 index 00000000..6ee62303 --- /dev/null +++ b/doc/man/git-bug-bug.1 @@ -0,0 +1,96 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-bug - List bugs + + +.SH SYNOPSIS +.PP +\fBgit-bug bug [QUERY] [flags]\fP + + +.SH DESCRIPTION +.PP +Display a summary of each bugs. + +.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-m\fP, \fB--metadata\fP=[] + Filter by metadata. Example: github-url=URL + +.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-f\fP, \fB--format\fP="default" + Select the output formatting style. Valid values are [default,plain,compact,id,json,org-mode] + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for bug + + +.SH EXAMPLE +.PP +.RS + +.nf +List open bugs sorted by last edition with a query: +git bug status:open sort:edit-desc + +List closed bugs sorted by creation with flags: +git bug --status closed --by creation + +Do a full text search of all bugs: +git bug "foo bar" baz + +Use queries, flags, and full text search: +git bug status:open --by creation "foo bar" baz + + +.fi +.RE + + +.SH SEE ALSO +.PP +\fBgit-bug(1)\fP, \fBgit-bug-bug-comment(1)\fP, \fBgit-bug-bug-deselect(1)\fP, \fBgit-bug-bug-label(1)\fP, \fBgit-bug-bug-new(1)\fP, \fBgit-bug-bug-rm(1)\fP, \fBgit-bug-bug-select(1)\fP, \fBgit-bug-bug-show(1)\fP, \fBgit-bug-bug-status(1)\fP, \fBgit-bug-bug-title(1)\fP diff --git a/doc/man/git-bug-comment-add.1 b/doc/man/git-bug-comment-add.1 deleted file mode 100644 index 41aec9bb..00000000 --- a/doc/man/git-bug-comment-add.1 +++ /dev/null @@ -1,39 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-comment-add - Add a new comment to a bug. - - -.SH SYNOPSIS -.PP -\fBgit-bug comment add [ID] [flags]\fP - - -.SH DESCRIPTION -.PP -Add a new comment to a bug. - - -.SH OPTIONS -.PP -\fB-F\fP, \fB--file\fP="" - Take the message from the given file. Use - to read the message from the standard input - -.PP -\fB-m\fP, \fB--message\fP="" - Provide the new message from the command line - -.PP -\fB--non-interactive\fP[=false] - Do not ask for user input - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for add - - -.SH SEE ALSO -.PP -\fBgit-bug-comment(1)\fP diff --git a/doc/man/git-bug-comment-edit.1 b/doc/man/git-bug-comment-edit.1 deleted file mode 100644 index 03e6c1cd..00000000 --- a/doc/man/git-bug-comment-edit.1 +++ /dev/null @@ -1,39 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-comment-edit - Edit an existing comment on a bug. - - -.SH SYNOPSIS -.PP -\fBgit-bug comment edit [COMMENT_ID] [flags]\fP - - -.SH DESCRIPTION -.PP -Edit an existing comment on a bug. - - -.SH OPTIONS -.PP -\fB-F\fP, \fB--file\fP="" - Take the message from the given file. Use - to read the message from the standard input - -.PP -\fB-m\fP, \fB--message\fP="" - Provide the new message from the command line - -.PP -\fB--non-interactive\fP[=false] - Do not ask for user input - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for edit - - -.SH SEE ALSO -.PP -\fBgit-bug-comment(1)\fP diff --git a/doc/man/git-bug-comment.1 b/doc/man/git-bug-comment.1 deleted file mode 100644 index 2939b641..00000000 --- a/doc/man/git-bug-comment.1 +++ /dev/null @@ -1,27 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-comment - Display or add comments to a bug. - - -.SH SYNOPSIS -.PP -\fBgit-bug comment [ID] [flags]\fP - - -.SH DESCRIPTION -.PP -Display or add comments to a bug. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for comment - - -.SH SEE ALSO -.PP -\fBgit-bug(1)\fP, \fBgit-bug-comment-add(1)\fP, \fBgit-bug-comment-edit(1)\fP diff --git a/doc/man/git-bug-deselect.1 b/doc/man/git-bug-deselect.1 deleted file mode 100644 index 9b630357..00000000 --- a/doc/man/git-bug-deselect.1 +++ /dev/null @@ -1,42 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-deselect - Clear the implicitly selected bug. - - -.SH SYNOPSIS -.PP -\fBgit-bug deselect [flags]\fP - - -.SH DESCRIPTION -.PP -Clear the implicitly selected bug. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for deselect - - -.SH EXAMPLE -.PP -.RS - -.nf -git bug select 2f15 -git bug comment -git bug status -git bug deselect - - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBgit-bug(1)\fP diff --git a/doc/man/git-bug-label-add.1 b/doc/man/git-bug-label-add.1 deleted file mode 100644 index a8ef3375..00000000 --- a/doc/man/git-bug-label-add.1 +++ /dev/null @@ -1,27 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-label-add - Add a label to a bug. - - -.SH SYNOPSIS -.PP -\fBgit-bug label add [ID] LABEL... [flags]\fP - - -.SH DESCRIPTION -.PP -Add a label to a bug. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for add - - -.SH SEE ALSO -.PP -\fBgit-bug-label(1)\fP diff --git a/doc/man/git-bug-label-ls.1 b/doc/man/git-bug-label-ls.1 deleted file mode 100644 index 67ee7dd1..00000000 --- a/doc/man/git-bug-label-ls.1 +++ /dev/null @@ -1,30 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-label-ls - List valid labels. - - -.SH SYNOPSIS -.PP -\fBgit-bug label ls [flags]\fP - - -.SH DESCRIPTION -.PP -List valid labels. - -.PP -Note: in the future, a proper label policy could be implemented where valid labels are defined in a configuration file. Until that, the default behavior is to return the list of labels already used. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for ls - - -.SH SEE ALSO -.PP -\fBgit-bug-label(1)\fP diff --git a/doc/man/git-bug-label-rm.1 b/doc/man/git-bug-label-rm.1 deleted file mode 100644 index 6b98196b..00000000 --- a/doc/man/git-bug-label-rm.1 +++ /dev/null @@ -1,27 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-label-rm - Remove a label from a bug. - - -.SH SYNOPSIS -.PP -\fBgit-bug label rm [ID] LABEL... [flags]\fP - - -.SH DESCRIPTION -.PP -Remove a label from a bug. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for rm - - -.SH SEE ALSO -.PP -\fBgit-bug-label(1)\fP diff --git a/doc/man/git-bug-label.1 b/doc/man/git-bug-label.1 index 69a5c217..9de7d2c0 100644 --- a/doc/man/git-bug-label.1 +++ b/doc/man/git-bug-label.1 @@ -3,17 +3,20 @@ .SH NAME .PP -git-bug-label - Display, add or remove labels to/from a bug. +git-bug-label - List valid labels .SH SYNOPSIS .PP -\fBgit-bug label [ID] [flags]\fP +\fBgit-bug label [flags]\fP .SH DESCRIPTION .PP -Display, add or remove labels to/from a bug. +List valid labels. + +.PP +Note: in the future, a proper label policy could be implemented where valid labels are defined in a configuration file. Until that, the default behavior is to return the list of labels already used. .SH OPTIONS @@ -24,4 +27,4 @@ Display, add or remove labels to/from a bug. .SH SEE ALSO .PP -\fBgit-bug(1)\fP, \fBgit-bug-label-add(1)\fP, \fBgit-bug-label-ls(1)\fP, \fBgit-bug-label-rm(1)\fP +\fBgit-bug(1)\fP diff --git a/doc/man/git-bug-ls.1 b/doc/man/git-bug-ls.1 deleted file mode 100644 index e58177de..00000000 --- a/doc/man/git-bug-ls.1 +++ /dev/null @@ -1,96 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-ls - List bugs. - - -.SH SYNOPSIS -.PP -\fBgit-bug ls [QUERY] [flags]\fP - - -.SH DESCRIPTION -.PP -Display a summary of each bugs. - -.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-m\fP, \fB--metadata\fP=[] - Filter by metadata. Example: github-url=URL - -.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-f\fP, \fB--format\fP="default" - Select the output formatting style. Valid values are [default,plain,compact,id,json,org-mode] - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for ls - - -.SH EXAMPLE -.PP -.RS - -.nf -List open bugs sorted by last edition with a query: -git bug ls status:open sort:edit-desc - -List closed bugs sorted by creation with flags: -git bug ls --status closed --by creation - -Do a full text search of all bugs: -git bug ls "foo bar" baz - -Use queries, flags, and full text search: -git bug ls status:open --by creation "foo bar" baz - - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBgit-bug(1)\fP diff --git a/doc/man/git-bug-pull.1 b/doc/man/git-bug-pull.1 index f2536b30..62485429 100644 --- a/doc/man/git-bug-pull.1 +++ b/doc/man/git-bug-pull.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-pull - Pull bugs update from a git remote. +git-bug-pull - Pull updates from a git remote .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-pull - Pull bugs update from a git remote. .SH DESCRIPTION .PP -Pull bugs update from a git remote. +Pull updates from a git remote .SH OPTIONS diff --git a/doc/man/git-bug-push.1 b/doc/man/git-bug-push.1 index 2be8d6e2..2f15aacb 100644 --- a/doc/man/git-bug-push.1 +++ b/doc/man/git-bug-push.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-push - Push bugs update to a git remote. +git-bug-push - Push updates to a git remote .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-push - Push bugs update to a git remote. .SH DESCRIPTION .PP -Push bugs update to a git remote. +Push updates to a git remote .SH OPTIONS diff --git a/doc/man/git-bug-rm.1 b/doc/man/git-bug-rm.1 deleted file mode 100644 index 78156f37..00000000 --- a/doc/man/git-bug-rm.1 +++ /dev/null @@ -1,27 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-rm - Remove an existing bug. - - -.SH SYNOPSIS -.PP -\fBgit-bug rm ID [flags]\fP - - -.SH DESCRIPTION -.PP -Remove an existing bug in the local repository. Note removing bugs that were imported from bridges will not remove the bug on the remote, and will only remove the local copy of the bug. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for rm - - -.SH SEE ALSO -.PP -\fBgit-bug(1)\fP diff --git a/doc/man/git-bug-select.1 b/doc/man/git-bug-select.1 deleted file mode 100644 index e94d80b1..00000000 --- a/doc/man/git-bug-select.1 +++ /dev/null @@ -1,50 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-select - Select a bug for implicit use in future commands. - - -.SH SYNOPSIS -.PP -\fBgit-bug select ID [flags]\fP - - -.SH DESCRIPTION -.PP -Select a bug for implicit use in future commands. - -.PP -This command allows you to omit any bug ID argument, for example: - git bug show -instead of - git bug show 2f153ca - -.PP -The complementary command is "git bug deselect" performing the opposite operation. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for select - - -.SH EXAMPLE -.PP -.RS - -.nf -git bug select 2f15 -git bug comment -git bug status - - -.fi -.RE - - -.SH SEE ALSO -.PP -\fBgit-bug(1)\fP diff --git a/doc/man/git-bug-show.1 b/doc/man/git-bug-show.1 deleted file mode 100644 index 6abf1b6f..00000000 --- a/doc/man/git-bug-show.1 +++ /dev/null @@ -1,35 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-show - Display the details of a bug. - - -.SH SYNOPSIS -.PP -\fBgit-bug show [ID] [flags]\fP - - -.SH DESCRIPTION -.PP -Display the details of a bug. - - -.SH OPTIONS -.PP -\fB--field\fP="" - Select field to display. Valid values are [author,authorEmail,createTime,lastEdit,humanId,id,labels,shortId,status,title,actors,participants] - -.PP -\fB-f\fP, \fB--format\fP="default" - Select the output formatting style. Valid values are [default,json,org-mode] - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for show - - -.SH SEE ALSO -.PP -\fBgit-bug(1)\fP diff --git a/doc/man/git-bug-status-close.1 b/doc/man/git-bug-status-close.1 deleted file mode 100644 index 3fcbdc35..00000000 --- a/doc/man/git-bug-status-close.1 +++ /dev/null @@ -1,27 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-status-close - Mark a bug as closed. - - -.SH SYNOPSIS -.PP -\fBgit-bug status close [ID] [flags]\fP - - -.SH DESCRIPTION -.PP -Mark a bug as closed. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for close - - -.SH SEE ALSO -.PP -\fBgit-bug-status(1)\fP diff --git a/doc/man/git-bug-status-open.1 b/doc/man/git-bug-status-open.1 deleted file mode 100644 index e13f11a3..00000000 --- a/doc/man/git-bug-status-open.1 +++ /dev/null @@ -1,27 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-status-open - Mark a bug as open. - - -.SH SYNOPSIS -.PP -\fBgit-bug status open [ID] [flags]\fP - - -.SH DESCRIPTION -.PP -Mark a bug as open. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for open - - -.SH SEE ALSO -.PP -\fBgit-bug-status(1)\fP diff --git a/doc/man/git-bug-status.1 b/doc/man/git-bug-status.1 deleted file mode 100644 index e810b673..00000000 --- a/doc/man/git-bug-status.1 +++ /dev/null @@ -1,27 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-status - Display or change a bug status. - - -.SH SYNOPSIS -.PP -\fBgit-bug status [ID] [flags]\fP - - -.SH DESCRIPTION -.PP -Display or change a bug status. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for status - - -.SH SEE ALSO -.PP -\fBgit-bug(1)\fP, \fBgit-bug-status-close(1)\fP, \fBgit-bug-status-open(1)\fP diff --git a/doc/man/git-bug-termui.1 b/doc/man/git-bug-termui.1 index ac09d2ed..7409c963 100644 --- a/doc/man/git-bug-termui.1 +++ b/doc/man/git-bug-termui.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-termui - Launch the terminal UI. +git-bug-termui - Launch the terminal UI .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-termui - Launch the terminal UI. .SH DESCRIPTION .PP -Launch the terminal UI. +Launch the terminal UI .SH OPTIONS diff --git a/doc/man/git-bug-title-edit.1 b/doc/man/git-bug-title-edit.1 deleted file mode 100644 index 5e0fa139..00000000 --- a/doc/man/git-bug-title-edit.1 +++ /dev/null @@ -1,35 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-title-edit - Edit a title of a bug. - - -.SH SYNOPSIS -.PP -\fBgit-bug title edit [ID] [flags]\fP - - -.SH DESCRIPTION -.PP -Edit a title of a bug. - - -.SH OPTIONS -.PP -\fB-t\fP, \fB--title\fP="" - Provide a title to describe the issue - -.PP -\fB--non-interactive\fP[=false] - Do not ask for user input - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for edit - - -.SH SEE ALSO -.PP -\fBgit-bug-title(1)\fP diff --git a/doc/man/git-bug-title.1 b/doc/man/git-bug-title.1 deleted file mode 100644 index 164c0257..00000000 --- a/doc/man/git-bug-title.1 +++ /dev/null @@ -1,27 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-title - Display or change a title of a bug. - - -.SH SYNOPSIS -.PP -\fBgit-bug title [ID] [flags]\fP - - -.SH DESCRIPTION -.PP -Display or change a title of a bug. - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for title - - -.SH SEE ALSO -.PP -\fBgit-bug(1)\fP, \fBgit-bug-title-edit(1)\fP diff --git a/doc/man/git-bug-user-adopt.1 b/doc/man/git-bug-user-adopt.1 index ce4e9fe1..f7f2c895 100644 --- a/doc/man/git-bug-user-adopt.1 +++ b/doc/man/git-bug-user-adopt.1 @@ -3,17 +3,17 @@ .SH NAME .PP -git-bug-user-adopt - Adopt an existing identity as your own. +git-bug-user-adopt - Adopt an existing identity as your own .SH SYNOPSIS .PP -\fBgit-bug user adopt USER-ID [flags]\fP +\fBgit-bug user adopt USER_ID [flags]\fP .SH DESCRIPTION .PP -Adopt an existing identity as your own. +Adopt an existing identity as your own .SH OPTIONS diff --git a/doc/man/git-bug-user-create.1 b/doc/man/git-bug-user-create.1 deleted file mode 100644 index 66c7db58..00000000 --- a/doc/man/git-bug-user-create.1 +++ /dev/null @@ -1,43 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-user-create - Create a new identity. - - -.SH SYNOPSIS -.PP -\fBgit-bug user create [flags]\fP - - -.SH DESCRIPTION -.PP -Create a new identity. - - -.SH OPTIONS -.PP -\fB-a\fP, \fB--avatar\fP="" - Avatar URL - -.PP -\fB-e\fP, \fB--email\fP="" - Email of the user - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for create - -.PP -\fB-n\fP, \fB--name\fP="" - Name to identify the user - -.PP -\fB--non-interactive\fP[=false] - Do not ask for user input - - -.SH SEE ALSO -.PP -\fBgit-bug-user(1)\fP diff --git a/doc/man/git-bug-user-ls.1 b/doc/man/git-bug-user-ls.1 deleted file mode 100644 index aff46335..00000000 --- a/doc/man/git-bug-user-ls.1 +++ /dev/null @@ -1,31 +0,0 @@ -.nh -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" - -.SH NAME -.PP -git-bug-user-ls - List identities. - - -.SH SYNOPSIS -.PP -\fBgit-bug user ls [flags]\fP - - -.SH DESCRIPTION -.PP -List identities. - - -.SH OPTIONS -.PP -\fB-f\fP, \fB--format\fP="default" - Select the output formatting style. Valid values are [default,json] - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for ls - - -.SH SEE ALSO -.PP -\fBgit-bug-user(1)\fP diff --git a/doc/man/git-bug-user-new.1 b/doc/man/git-bug-user-new.1 new file mode 100644 index 00000000..cdb6f91f --- /dev/null +++ b/doc/man/git-bug-user-new.1 @@ -0,0 +1,43 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-user-new - Create a new identity + + +.SH SYNOPSIS +.PP +\fBgit-bug user new [flags]\fP + + +.SH DESCRIPTION +.PP +Create a new identity + + +.SH OPTIONS +.PP +\fB-a\fP, \fB--avatar\fP="" + Avatar URL + +.PP +\fB-e\fP, \fB--email\fP="" + Email of the user + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for new + +.PP +\fB-n\fP, \fB--name\fP="" + Name to identify the user + +.PP +\fB--non-interactive\fP[=false] + Do not ask for user input + + +.SH SEE ALSO +.PP +\fBgit-bug-user(1)\fP diff --git a/doc/man/git-bug-user-user.1 b/doc/man/git-bug-user-user.1 new file mode 100644 index 00000000..f4bf83d8 --- /dev/null +++ b/doc/man/git-bug-user-user.1 @@ -0,0 +1,31 @@ +.nh +.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" + +.SH NAME +.PP +git-bug-user-user - Display a user identity + + +.SH SYNOPSIS +.PP +\fBgit-bug user user show [USER_ID] [flags]\fP + + +.SH DESCRIPTION +.PP +Display a user identity + + +.SH OPTIONS +.PP +\fB-f\fP, \fB--field\fP="" + Select field to display. Valid values are [email,humanId,id,lastModification,lastModificationLamports,login,metadata,name] + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for user + + +.SH SEE ALSO +.PP +\fBgit-bug-user(1)\fP diff --git a/doc/man/git-bug-user.1 b/doc/man/git-bug-user.1 index 2a613ae2..276d0e43 100644 --- a/doc/man/git-bug-user.1 +++ b/doc/man/git-bug-user.1 @@ -3,23 +3,23 @@ .SH NAME .PP -git-bug-user - Display or change the user identity. +git-bug-user - List identities .SH SYNOPSIS .PP -\fBgit-bug user [USER-ID] [flags]\fP +\fBgit-bug user [flags]\fP .SH DESCRIPTION .PP -Display or change the user identity. +List identities .SH OPTIONS .PP -\fB-f\fP, \fB--field\fP="" - Select field to display. Valid values are [email,humanId,id,lastModification,lastModificationLamports,login,metadata,name] +\fB-f\fP, \fB--format\fP="default" + Select the output formatting style. Valid values are [default,json] .PP \fB-h\fP, \fB--help\fP[=false] @@ -28,4 +28,4 @@ Display or change the user identity. .SH SEE ALSO .PP -\fBgit-bug(1)\fP, \fBgit-bug-user-adopt(1)\fP, \fBgit-bug-user-create(1)\fP, \fBgit-bug-user-ls(1)\fP +\fBgit-bug(1)\fP, \fBgit-bug-user-adopt(1)\fP, \fBgit-bug-user-new(1)\fP, \fBgit-bug-user-user(1)\fP diff --git a/doc/man/git-bug-version.1 b/doc/man/git-bug-version.1 index 311f1d2a..6b688221 100644 --- a/doc/man/git-bug-version.1 +++ b/doc/man/git-bug-version.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-version - Show git-bug version information. +git-bug-version - Show git-bug version information .SH SYNOPSIS @@ -13,7 +13,7 @@ git-bug-version - Show git-bug version information. .SH DESCRIPTION .PP -Show git-bug version information. +Show git-bug version information .SH OPTIONS diff --git a/doc/man/git-bug-webui.1 b/doc/man/git-bug-webui.1 index 0fcfeac2..f6cdcfde 100644 --- a/doc/man/git-bug-webui.1 +++ b/doc/man/git-bug-webui.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug-webui - Launch the web UI. +git-bug-webui - Launch the web UI .SH SYNOPSIS diff --git a/doc/man/git-bug.1 b/doc/man/git-bug.1 index b982c7f4..8b66d312 100644 --- a/doc/man/git-bug.1 +++ b/doc/man/git-bug.1 @@ -3,7 +3,7 @@ .SH NAME .PP -git-bug - A bug tracker embedded in Git. +git-bug - A bug tracker embedded in Git .SH SYNOPSIS @@ -29,4 +29,4 @@ the same git remote you are already using to collaborate with other people. .SH SEE ALSO .PP -\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-label(1)\fP, \fBgit-bug-ls(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-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 -- cgit