From 8b32e35c3ed772e19f310d1b7c6979857c33c7a8 Mon Sep 17 00:00:00 2001 From: "Paul Buetow (lxpbuetowlap.united.domain)" Date: Sun, 16 Mar 2014 14:52:03 +0100 Subject: New release --- docs/japi.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/japi.1 b/docs/japi.1 index bd29ae0..9cf23b5 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.0.0" "User Commands" +.TH JAPI 1 "2014-03-16" "japi 0.1.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 -- cgit v1.2.3 From ccc4fbd28b04dd50bd274c8f722ea44eb6e0dda9 Mon Sep 17 00:00:00 2001 From: "Paul Buetow (mars.fritz.box)" Date: Sun, 16 Mar 2014 15:23:44 +0100 Subject: fix the documentation --- docs/japi.1 | 28 ++++++++++++++-------------- docs/japi.pod | 18 +++++++++--------- docs/japi.txt | 14 +++++++------- 3 files changed, 30 insertions(+), 30 deletions(-) (limited to 'docs') diff --git a/docs/japi.1 b/docs/japi.1 index 9cf23b5..5980d66 100644 --- a/docs/japi.1 +++ b/docs/japi.1 @@ -144,10 +144,10 @@ Synopsis: japi [\-\-help] [\-\-version] [\-\-passfile] - [\-\-jira_apiversion <\s-1STRING\s0>] - [\-\-jira_query <\s-1STRING\s0>] - [\-\-jira_uribase <\s-1STRING\s0>] - [\-\-jira_user <\s-1STRING\s0>] + [\-\-jira_apiversion \s-1STRING\s0] + [\-\-jira_query \s-1STRING\s0] + [\-\-jira_uribase \s-1STRING\s0] + [\-\-jira_user \s-1STRING\s0] .SS "Options:" .IX Subsection "Options:" .IP "\-\-debug" 4 @@ -159,22 +159,22 @@ Prints out the help. .IP "\-\-version" 4 .IX Item "--version" Prints out the version. -.IP "\-\-passfile <\s-1STRING\s0>" 4 -.IX Item "--passfile " +.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. .Sp If the file is not present, Japi will prompt for the password. -.IP "\-\-jira_apiversion <\s-1STRING\s0>" 4 -.IX Item "--jira_apiversion " +.IP "\-\-jira_apiversion \s-1STRING\s0" 4 +.IX Item "--jira_apiversion STRING" Specifies the Jira \s-1API\s0 version to use. The default value is \f(CW\*(C`rest/api/2\*(C'\fR. -.IP "\-\-jira_query <\s-1STRING\s0>" 4 -.IX Item "--jira_query " +.IP "\-\-jira_query \s-1STRING\s0" 4 +.IX Item "--jira_query STRING" Specifies the Jira search string (e.q. a \s-1JQL\s0 string). The default value is \f(CW\*(C`search?jql=project=MT and status not in (Resolved,Closed)\*(Aq\*(C'\fR. -.IP "\-\-jira_uribase <\s-1STRING\s0>" 4 -.IX Item "--jira_uribase " +.IP "\-\-jira_uribase \s-1STRING\s0" 4 +.IX Item "--jira_uribase STRING" Specifies the Jira \s-1URI\s0 base. The default value is \f(CW\*(C`https://your\-jira.example.com\*(C'\fR. This has to be changed. -.IP "\-\-jira_user <\s-1STRING\s0>" 4 -.IX Item "--jira_user " +.IP "\-\-jira_user \s-1STRING\s0" 4 +.IX Item "--jira_user STRING" Specifies the Jira user. The default value is your current Linux/UNIX user. .SH "CONFIG" .IX Header "CONFIG" diff --git a/docs/japi.pod b/docs/japi.pod index 41a0a05..80a46eb 100644 --- a/docs/japi.pod +++ b/docs/japi.pod @@ -15,10 +15,10 @@ Synopsis: japi [--help] [--version] [--passfile] - [--jira_apiversion ] - [--jira_query ] - [--jira_uribase ] - [--jira_user ] + [--jira_apiversion STRING] + [--jira_query STRING] + [--jira_uribase STRING] + [--jira_user STRING] =head2 Options: @@ -36,25 +36,25 @@ Prints out the help. Prints out the version. -=item --passfile +=item --passfile STRING Specifies the path to an optional file which includes the Jira API password but Base64 encoded. The default value is C<~/.japipass>. If the file is not present, Japi will prompt for the password. -=item --jira_apiversion +=item --jira_apiversion STRING Specifies the Jira API version to use. The default value is C. -=item --jira_query +=item --jira_query STRING Specifies the Jira search string (e.q. a JQL string). The default value is C. -=item --jira_uribase +=item --jira_uribase STRING Specifies the Jira URI base. The default value is C. This has to be changed. -=item --jira_user +=item --jira_user STRING Specifies the Jira user. The default value is your current Linux/UNIX user. diff --git a/docs/japi.txt b/docs/japi.txt index 2f4225d..5e59be1 100644 --- a/docs/japi.txt +++ b/docs/japi.txt @@ -13,8 +13,8 @@ NAME SYNOPSIS Synopsis: japi [--debug] [--help] [--version] [--passfile] - [--jira_apiversion ] [--jira_query ] [--jira_uribase - ] [--jira_user ] + [--jira_apiversion STRING] [--jira_query STRING] [--jira_uribase STRING] + [--jira_user STRING] Options: --debug @@ -26,26 +26,26 @@ SYNOPSIS --version Prints out the version. - --passfile + --passfile STRING Specifies the path to an optional file which includes the Jira API password but Base64 encoded. The default value is "~/.japipass". If the file is not present, Japi will prompt for the password. - --jira_apiversion + --jira_apiversion STRING Specifies the Jira API version to use. The default value is "rest/api/2". - --jira_query + --jira_query STRING Specifies the Jira search string (e.q. a JQL string). The default value is "search?jql=project=MT and status not in (Resolved,Closed)'". - --jira_uribase + --jira_uribase STRING Specifies the Jira URI base. The default value is "https://your-jira.example.com". This has to be changed. - --jira_user + --jira_user STRING Specifies the Jira user. The default value is your current Linux/UNIX user. -- cgit v1.2.3 From 07a45c2a1fd34e4267c95bc8cb33145789d467db Mon Sep 17 00:00:00 2001 From: "Paul Buetow (mars.fritz.box)" Date: Sun, 16 Mar 2014 15:24:14 +0100 Subject: New release --- docs/japi.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/japi.1 b/docs/japi.1 index 5980d66..08ce86b 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.0" "User Commands" +.TH JAPI 1 "2014-03-16" "japi 0.1.1" "User Commands" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l -- cgit v1.2.3 From 8d8f42654a358e6eed05b8b9c6c6241f2a63114d Mon Sep 17 00:00:00 2001 From: "Paul Buetow (mars.fritz.box)" Date: Sun, 16 Mar 2014 15:33:49 +0100 Subject: fix default value in doc --- docs/japi.pod | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/japi.pod b/docs/japi.pod index 80a46eb..70cc710 100644 --- a/docs/japi.pod +++ b/docs/japi.pod @@ -48,7 +48,7 @@ Specifies the Jira API version to use. The default value is C. =item --jira_query STRING -Specifies the Jira search string (e.q. a JQL string). The default value is C. +Specifies the Jira search string (e.q. a JQL string). The default value is C. =item --jira_uribase STRING -- cgit v1.2.3 From 569b4dc0bf7d77f6556212137bbe2a5985bd5379 Mon Sep 17 00:00:00 2001 From: "Paul Buetow (mars.fritz.box)" Date: Sun, 16 Mar 2014 15:34:21 +0100 Subject: New release --- docs/japi.1 | 4 ++-- docs/japi.txt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/japi.1 b/docs/japi.1 index 08ce86b..f54856e 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.1" "User Commands" +.TH JAPI 1 "2014-03-16" "japi 0.1.2" "User Commands" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -169,7 +169,7 @@ If the file is not present, Japi will prompt for the password. Specifies the Jira \s-1API\s0 version to use. The default value is \f(CW\*(C`rest/api/2\*(C'\fR. .IP "\-\-jira_query \s-1STRING\s0" 4 .IX Item "--jira_query STRING" -Specifies the Jira search string (e.q. a \s-1JQL\s0 string). The default value is \f(CW\*(C`search?jql=project=MT and status not in (Resolved,Closed)\*(Aq\*(C'\fR. +Specifies the Jira search string (e.q. a \s-1JQL\s0 string). The default value is \f(CW\*(C`search?jql=project=MT and status not in (Resolved,Closed)\*(C'\fR. .IP "\-\-jira_uribase \s-1STRING\s0" 4 .IX Item "--jira_uribase STRING" Specifies the Jira \s-1URI\s0 base. The default value is \f(CW\*(C`https://your\-jira.example.com\*(C'\fR. This has to be changed. diff --git a/docs/japi.txt b/docs/japi.txt index 5e59be1..f85e339 100644 --- a/docs/japi.txt +++ b/docs/japi.txt @@ -39,7 +39,7 @@ SYNOPSIS --jira_query STRING Specifies the Jira search string (e.q. a JQL string). The default value is "search?jql=project=MT and status not in - (Resolved,Closed)'". + (Resolved,Closed)". --jira_uribase STRING Specifies the Jira URI base. The default value is -- cgit v1.2.3