]> gitweb.michael.orlitzky.com - apply-default-acl.git/commitdiff
man/apply-default-acl.1: document the way exit codes are SUPPOSED to work.
authorMichael Orlitzky <michael@orlitzky.com>
Tue, 27 Feb 2018 17:59:14 +0000 (12:59 -0500)
committerMichael Orlitzky <michael@orlitzky.com>
Tue, 27 Feb 2018 17:59:14 +0000 (12:59 -0500)
doc/man/apply-default-acl.1

index d8d66948f7acf569ea7cdb4588c94ac5201e1d39..6d77ce1ef4f25b006d7a8382e2ea9ec22ff9ff3a 100644 (file)
@@ -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.