From: Jim Meyering <jim@meyering.net>
Date: Tue, 6 Jul 2004 16:15:45 +0000 (+0000)
Subject: (readlink invocation): Document new
X-Git-Tag: v5.3.0~1149
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=159c3f467ee295500142361f574dd331543e6fac;p=thirdparty%2Fcoreutils.git

(readlink invocation): Document new
"readlink -f" behaviour and new canonicalize options, -e and -m.
---

diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index 1423b4c446..007c8b45e8 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -7762,9 +7762,7 @@ of a symbolic link, it produces no output and exits with a nonzero exit code.
 
 @command{readlink} outputs the absolute name of the given file which contains
 no @file{.}, @file{..} components nor any repeated separators
-(@file{/}) nor symbolic links.
-If the file is missing or unavailable,
-it produces no output and exits with a nonzero exit code.
+(@file{/}) or symbolic links.
 
 @end table
 
@@ -7783,6 +7781,24 @@ The program accepts the following options.  Also see @ref{Common options}.
 @opindex -f
 @opindex --canonicalize
 Activate canonicalize mode.
+If any path component except the last one is missing or unavailable,
+@command{readlink} produces no output and exits with a nonzero exit code.
+
+@item -e
+@itemx --canonicalize-existing
+@opindex -e
+@opindex --canonicalize-existing
+Activate canonicalize mode.
+If any path component is missing or unavailable, @command{readlink} produces
+no output and exits with a nonzero exit code.
+
+@item -m
+@itemx --canonicalize-missing
+@opindex -m
+@opindex --canonicalize-missing
+Activate canonicalize mode.
+If any path component is missing or unavailable, @command{readlink} treats it
+as a directory.
 
 @item -n
 @itemx --no-newline