diff options
| author | Paul Buetow (lxpbuetowlap.united.domain) <paul.buetow@1und1.de> | 2014-03-16 14:45:29 +0100 |
|---|---|---|
| committer | Paul Buetow (lxpbuetowlap.united.domain) <paul.buetow@1und1.de> | 2014-03-16 14:45:29 +0100 |
| commit | eb2bdba0d89c81c25b728f6aecbb4a423b60494b (patch) | |
| tree | 48eeb2035feb29e3d4aea4cb3156f057a3164121 /docs | |
| parent | 50b05a273f6989b19d40971b79061883b0e7eced (diff) | |
some more documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/japi.1 | 6 | ||||
| -rw-r--r-- | docs/japi.pod | 6 | ||||
| -rw-r--r-- | docs/japi.txt | 10 |
3 files changed, 22 insertions, 0 deletions
diff --git a/docs/japi.1 b/docs/japi.1 index c7d4a7a..bd29ae0 100644 --- a/docs/japi.1 +++ b/docs/japi.1 @@ -131,6 +131,12 @@ .nh .SH "NAME" japi \- A Humble Jira API Tool +.PP +This is a small and simple command line tool to be used manually or via cron to fetch the newest unresolved and unclosed tickets from a Jira project. +.PP +It might be usefull to write the results every hour to a local file and do a "cat ~/.issues" every time you open a new shell. +.PP +CAUTION: You may also need to install the "JIRA::REST" module from CPAN manually. It's not included in standard Debian GNU/Linux Wheezy yet. .SH "SYNOPSIS" .IX Header "SYNOPSIS" Synopsis: japi diff --git a/docs/japi.pod b/docs/japi.pod index b38fd45..41a0a05 100644 --- a/docs/japi.pod +++ b/docs/japi.pod @@ -2,6 +2,12 @@ japi - A Humble Jira API Tool +This is a small and simple command line tool to be used manually or via cron to fetch the newest unresolved and unclosed tickets from a Jira project. + +It might be usefull to write the results every hour to a local file and do a C<cat ~/.issues> every time you open a new shell. + +CAUTION: You may also need to install the C<JIRA::REST> module from CPAN manually. It's not included in standard Debian GNU/Linux Wheezy yet. + =head1 SYNOPSIS Synopsis: japi diff --git a/docs/japi.txt b/docs/japi.txt index 9096b46..2f4225d 100644 --- a/docs/japi.txt +++ b/docs/japi.txt @@ -1,6 +1,16 @@ NAME japi - A Humble Jira API Tool + This is a small and simple command line tool to be used manually or via + cron to fetch the newest unresolved and unclosed tickets from a Jira + project. + + It might be usefull to write the results every hour to a local file and + do a "cat ~/.issues" every time you open a new shell. + + CAUTION: You may also need to install the "JIRA::REST" module from CPAN + manually. It's not included in standard Debian GNU/Linux Wheezy yet. + SYNOPSIS Synopsis: japi [--debug] [--help] [--version] [--passfile] [--jira_apiversion <STRING>] [--jira_query <STRING>] [--jira_uribase |