summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow (mars.fritz.box) <paul@buetow.org>2014-03-16 15:23:44 +0100
committerPaul Buetow (mars.fritz.box) <paul@buetow.org>2014-03-16 15:23:44 +0100
commitccc4fbd28b04dd50bd274c8f722ea44eb6e0dda9 (patch)
tree9e8a898df7cd0e53e78be25500b5f8dc5d628f50
parent8b32e35c3ed772e19f310d1b7c6979857c33c7a8 (diff)
fix the documentation0.1.1
-rw-r--r--README.txt14
-rw-r--r--docs/japi.128
-rw-r--r--docs/japi.pod18
-rw-r--r--docs/japi.txt14
4 files changed, 37 insertions, 37 deletions
diff --git a/README.txt b/README.txt
index 2f4225d..5e59be1 100644
--- a/README.txt
+++ b/README.txt
@@ -13,8 +13,8 @@ NAME
SYNOPSIS
Synopsis: japi [--debug] [--help] [--version] [--passfile]
- [--jira_apiversion <STRING>] [--jira_query <STRING>] [--jira_uribase
- <STRING>] [--jira_user <STRING>]
+ [--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 <STRING>
+ --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 <STRING>
+ --jira_apiversion STRING
Specifies the Jira API version to use. The default value is
"rest/api/2".
- --jira_query <STRING>
+ --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 <STRING>
+ --jira_uribase STRING
Specifies the Jira URI base. The default value is
"https://your-jira.example.com". This has to be changed.
- --jira_user <STRING>
+ --jira_user STRING
Specifies the Jira user. The default value is your current
Linux/UNIX user.
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 <STRING>"
+.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 <STRING>"
+.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 <STRING>"
+.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 <STRING>"
+.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 <STRING>"
+.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 <STRING>]
- [--jira_query <STRING>]
- [--jira_uribase <STRING>]
- [--jira_user <STRING>]
+ [--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 <STRING>
+=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 <STRING>
+=item --jira_apiversion STRING
Specifies the Jira API version to use. The default value is C<rest/api/2>.
-=item --jira_query <STRING>
+=item --jira_query STRING
Specifies the Jira search string (e.q. a JQL string). The default value is C<search?jql=project=MT and status not in (Resolved,Closed)'>.
-=item --jira_uribase <STRING>
+=item --jira_uribase STRING
Specifies the Jira URI base. The default value is C<https://your-jira.example.com>. This has to be changed.
-=item --jira_user <STRING>
+=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 <STRING>] [--jira_query <STRING>] [--jira_uribase
- <STRING>] [--jira_user <STRING>]
+ [--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 <STRING>
+ --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 <STRING>
+ --jira_apiversion STRING
Specifies the Jira API version to use. The default value is
"rest/api/2".
- --jira_query <STRING>
+ --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 <STRING>
+ --jira_uribase STRING
Specifies the Jira URI base. The default value is
"https://your-jira.example.com". This has to be changed.
- --jira_user <STRING>
+ --jira_user STRING
Specifies the Jira user. The default value is your current
Linux/UNIX user.