diff options
Diffstat (limited to 'doc/man/git-bug-bridge-configure.1')
| -rw-r--r-- | doc/man/git-bug-bridge-configure.1 | 38 |
1 files changed, 21 insertions, 17 deletions
diff --git a/doc/man/git-bug-bridge-configure.1 b/doc/man/git-bug-bridge-configure.1 index d1dc9f7d..cc66487f 100644 --- a/doc/man/git-bug-bridge-configure.1 +++ b/doc/man/git-bug-bridge-configure.1 @@ -1,7 +1,6 @@ -.TH "GIT-BUG" "1" "Apr 2019" "Generated from git-bug's source code" "" .nh -.ad l - +.TH GIT\-BUG(1)Apr 2019 +Generated from git\-bug's source code .SH NAME .PP @@ -19,8 +18,6 @@ git\-bug\-bridge\-configure \- Configure a new bridge. .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. -Repository configuration can be made by passing either the \-\-url flag or the \-\-project and \-\-owner flags. If the three flags are provided git\-bug will use \-\-project and \-\-owner flags. -Token configuration can be directly passed with the \-\-token flag or in the terminal prompt. If you don't already have one you can use the interactive procedure to generate one. .fi .RE @@ -29,43 +26,47 @@ Token configuration can be directly passed with the \-\-token flag or in the ter .SH OPTIONS .PP \fB\-n\fP, \fB\-\-name\fP="" - A distinctive name to identify the bridge + A distinctive name to identify the bridge .PP \fB\-t\fP, \fB\-\-target\fP="" - The target of the bridge. Valid values are [github,gitlab,launchpad\-preview] + The target of the bridge. Valid values are [github,gitlab,jira,launchpad\-preview] .PP \fB\-u\fP, \fB\-\-url\fP="" - The URL of the target repository + The URL of the remote repository .PP \fB\-b\fP, \fB\-\-base\-url\fP="" - The base URL of your issue tracker service + The base URL of your remote issue tracker .PP -\fB\-o\fP, \fB\-\-owner\fP="" - The owner of the target repository +\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 the API (see "git\-bug bridge auth") + 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 API + A raw authentication token for the remote issue tracker .PP \fB\-\-token\-stdin\fP[=false] - Will read the token from stdin and ignore \-\-token + 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 target repository + The name of the remote repository .PP \fB\-h\fP, \fB\-\-help\fP[=false] - help for configure + help for configure .SH EXAMPLE @@ -75,7 +76,10 @@ Token configuration can be directly passed with the \-\-token flag or in the ter .nf # Interactive example [1]: github -[2]: launchpad\-preview +[2]: gitlab +[3]: jira +[4]: launchpad\-preview + target: 1 name [default]: default |