aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2016-11-25 22:40:37 -0400
committerDavid Bremner <david@tethera.net>2016-11-25 22:44:05 -0400
commit0ca79007275ef6430d7f791b1161e39827139c87 (patch)
tree39e241ab046bbf21c90e9ea7c99262c6c64b9260
parentf5185881f7b01f67b5b64218804749b733f08d44 (diff)
cli/new: document new exit code
It seems important to give the numeric return code for people writing scripts. Hopefully deviations from this convention are rare.
-rw-r--r--doc/man1/notmuch-new.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/man1/notmuch-new.rst b/doc/man1/notmuch-new.rst
index 787ed78f..7f0b2237 100644
--- a/doc/man1/notmuch-new.rst
+++ b/doc/man1/notmuch-new.rst
@@ -43,6 +43,14 @@ Supported options for **new** include
``--quiet``
Do not print progress or results.
+EXIT STATUS
+===========
+
+This command supports the following special exit status code
+
+``75 (EX_TEMPFAIL)``
+ A temporary failure occured; the user is invited to retry.
+
SEE ALSO
========