summaryrefslogtreecommitdiff
path: root/README.txt
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 /README.txt
parent8b32e35c3ed772e19f310d1b7c6979857c33c7a8 (diff)
fix the documentation0.1.1
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt14
1 files changed, 7 insertions, 7 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.