aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2022-05-11 00:02:05 +0200
committerTeddy Wing2022-05-11 00:02:05 +0200
commit754002c3b502d6f2beb15e979b1cb22af3b11a14 (patch)
tree1b43e0370b016f49b2efe22835593d06da92d5d1
parent3328e1a5c0359b02a198d121543a5ce07c0a30f2 (diff)
downloadwajir-754002c3b502d6f2beb15e979b1cb22af3b11a14.tar.bz2
doc/wajir.1.txt: Add program description
-rw-r--r--doc/wajir.1.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/wajir.1.txt b/doc/wajir.1.txt
index 5441238..6cc6f88 100644
--- a/doc/wajir.1.txt
+++ b/doc/wajir.1.txt
@@ -14,6 +14,20 @@ SYNOPSIS
DESCRIPTION
-----------
+Automatically watch Jira issues. Given a JQL query, the currently authenticated
+user will be added as a watcher on all resulting issues.
+
+For example, this JQL query finds all issues in the project "FAKE" that are not
+watched by the current user:
+
+ project = "FAKE" AND watcher != currentUser() ORDER BY created ASC
+
+Passing the above JQL to Wajir will cause the current user to watch all
+unwatched issues in the "FAKE" project.
+
+If the *--sendmail* and *--email-to* options are provided, an email containing
+the issue summary, description, and a few other metadata fields will be sent
+using the program given in *--sendmail* to the *--email-to* address.
OPTIONS
-------