diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/japi.1 | 9 | ||||
| -rw-r--r-- | docs/japi.txt | 7 |
2 files changed, 13 insertions, 3 deletions
diff --git a/docs/japi.1 b/docs/japi.1 index f54856e..b17b2be 100644 --- a/docs/japi.1 +++ b/docs/japi.1 @@ -124,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "JAPI 1" -.TH JAPI 1 "2014-03-16" "japi 0.1.2" "User Commands" +.TH JAPI 1 "2014-03-16" "japi 0.2.0" "User Commands" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -143,6 +143,7 @@ Synopsis: japi [\-\-debug] [\-\-help] [\-\-version] + [\-\-nocolor] [\-\-passfile] [\-\-jira_apiversion \s-1STRING\s0] [\-\-jira_query \s-1STRING\s0] @@ -159,6 +160,9 @@ Prints out the help. .IP "\-\-version" 4 .IX Item "--version" Prints out the version. +.IP "\-\-nocolor" 4 +.IX Item "--nocolor" +By default the output uses colored text output. This switch disables it. .IP "\-\-passfile \s-1STRING\s0" 4 .IX Item "--passfile STRING" Specifies the path to an optional file which includes the Jira \s-1API\s0 password but Base64 encoded. The default value is \f(CW\*(C`~/.japipass\*(C'\fR. @@ -182,8 +186,9 @@ Almost all options have to be passed the Japi tool via command line. One excepti .PP It can be created like this: .PP -.Vb 1 +.Vb 2 \& bash \-c \*(Aqread \-s PASSWORD; tr \-d "\en" <<< "$PASSWORD" | base64\*(Aq | tee ~/.japipass +\& chmod 0600 ~/.japipass .Ve .SH "AUTHOR" .IX Header "AUTHOR" diff --git a/docs/japi.txt b/docs/japi.txt index f85e339..c84b5fc 100644 --- a/docs/japi.txt +++ b/docs/japi.txt @@ -12,7 +12,7 @@ NAME manually. It's not included in standard Debian GNU/Linux Wheezy yet. SYNOPSIS - Synopsis: japi [--debug] [--help] [--version] [--passfile] + Synopsis: japi [--debug] [--help] [--version] [--nocolor] [--passfile] [--jira_apiversion STRING] [--jira_query STRING] [--jira_uribase STRING] [--jira_user STRING] @@ -26,6 +26,10 @@ SYNOPSIS --version Prints out the version. + --nocolor + By default the output uses colored text output. This switch disables + it. + --passfile STRING Specifies the path to an optional file which includes the Jira API password but Base64 encoded. The default value is "~/.japipass". @@ -57,6 +61,7 @@ CONFIG It can be created like this: bash -c 'read -s PASSWORD; tr -d "\n" <<< "$PASSWORD" | base64' | tee ~/.japipass + chmod 0600 ~/.japipass AUTHOR Paul C. Buetow - <paul@buetow.org> |