cli/new: document new exit code
authorDavid Bremner <david@tethera.net>
Sat, 26 Nov 2016 02:40:37 +0000 (22:40 -0400)
committerDavid Bremner <david@tethera.net>
Sat, 26 Nov 2016 02:44:05 +0000 (22:44 -0400)
It seems important to give the numeric return code for people writing
scripts. Hopefully deviations from this convention are rare.

doc/man1/notmuch-new.rst

index 787ed78f30833559a4fd8f876e0ac7a63d5b2e28..7f0b2237acad24e66afd6b0843312723c3dbfdc6 100644 (file)
@@ -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
 ========