man/apply-default-acl.1: add a note about the --recursive exit codes.

[apply-default-acl.git] / doc / man / apply-default-acl.1

diff --git a/doc/man/apply-default-acl.1 b/doc/man/apply-default-acl.1
index d8d66948f7acf569ea7cdb4588c94ac5201e1d39..b13d5fd910990ff22520668d8e48df74bd1ef3ab 100644 (file)
--- a/doc/man/apply-default-acl.1
+++ b/doc/man/apply-default-acl.1
@@ -34,3 +34,27 @@ 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.
+.P
+The \fB\-\-recursive\fR flag modifies this behavior. Due to an
+implementation detail, the recursive operation will return
+EXIT_SUCCESS even if it encounters links or inaccessible paths during
+the traversal. Beware; this means that manually supplying all children
+of a directory on the command-line does not act the same as operating
+on that directory recursively.