From: Michael Orlitzky <michael@orlitzky.com>
Date: Tue, 27 Feb 2018 17:59:14 +0000 (-0500)
Subject: man/apply-default-acl.1: document the way exit codes are SUPPOSED to work.
X-Git-Tag: v0.1.3~8
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=65cf3943a8e511e35d18bd5b4818013f3773d593;p=apply-default-acl.git

man/apply-default-acl.1: document the way exit codes are SUPPOSED to work.
---

diff --git a/doc/man/apply-default-acl.1 b/doc/man/apply-default-acl.1
index d8d6694..6d77ce1 100644
--- a/doc/man/apply-default-acl.1
+++ b/doc/man/apply-default-acl.1
@@ -34,3 +34,20 @@ contents of \fBfoo\fR are processed.
 Apply the default ACL literally; that is, don't use a heuristic to
 decide whether or not to mask the execute bit. This usually results in
 looser-than-necessary execute permissions.
+
+.SH EXIT CODE
+.P
+When given a single path, the following codes correspond directly to
+the action of the program on that path:
+.IP \fB0\ (EXIT_SUCCESS)\fR
+Success
+.IP \fB1\ (EXIT_FAILURE)\fR
+Failure due to a symlink, hardlink, or invalid/inaccessible path
+.IP \fB2\fP
+Other unexpected library error
+.P
+When called on multiple paths, the results from all paths are
+collected and the \(dqworst\(dq result is returned. For example, if
+one path succeeds and another fails, the overall result will be
+failure. If one succeeds, one fails, and one causes an error, then the
+overall result will be an error; and so on.