summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul Eggert <eggert@cs.ucla.edu>2004-10-18 06:29:51 +0000
committerPaul Eggert <eggert@cs.ucla.edu>2004-10-18 06:29:51 +0000
commit91b17c0c82f315d1e0095d6289e5917ff5154bce (patch)
treeeda01308383fa19196999f09852ef5c9c004708e /doc
parent586910ff61f1df89c07fad099ca1a8e206b585a3 (diff)
downloadcoreutils-91b17c0c82f315d1e0095d6289e5917ff5154bce.tar.xz
(pathchk invocation): Overall lengths are
OS limits, not file system limits. Component length checks apply to all components, not merely to existing ones. Say that nonexistent names are not errors. For -p, omit all checks based on the underlying file system, not merely length checks. Explain what the portabile file name character set is.
Diffstat (limited to 'doc')
-rw-r--r--doc/coreutils.texi25
1 files changed, 15 insertions, 10 deletions
diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index d81a12c0c..810104b5a 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -10161,19 +10161,22 @@ pathchk [@var{option}]@dots{} @var{name}@dots{}
For each @var{name}, @command{pathchk} prints a message if any of
these conditions is true:
+
@enumerate
@item
-one of the existing directories in @var{name} does not have search
+One of the existing directories in @var{name} does not have search
(execute) permission,
@item
-the length of @var{name} is larger than its file system's maximum
-file name length,
+The length of @var{name} is larger than the maximum supported by the
+operating system.
@item
-the length of one component of @var{name}, corresponding to an
-existing directory name, is larger than its file system's maximum
-length for a file name component.
+The length of one component of @var{name} is longer than
+its file system's maximum.
@end enumerate
+A nonexistent @var{name} is not an error, so long a file with that
+name could be created under the above conditions.
+
The program accepts the following option. Also see @ref{Common options}.
@table @samp
@@ -10182,10 +10185,12 @@ The program accepts the following option. Also see @ref{Common options}.
@itemx --portability
@opindex -p
@opindex --portability
-Instead of performing length checks on the underlying file system,
-test the length of each file name and its components against the
+Do not perform checks based on the underlying file system. Instead,
+check the length of each file name and its components against the
@acronym{POSIX} minimum limits for portability. Also check that the file
-name contains no characters not in the portable file name character set.
+name contains only characters that are in the portable file name
+character set, namely, the ASCII letters and digits, @samp{-},
+@samp{.}, @samp{/}, and @samp{_}.
@end table
@@ -10193,7 +10198,7 @@ name contains no characters not in the portable file name character set.
Exit status:
@display
-0 if all specified file names passed all of the tests,
+0 if all specified file names passed all checks,
1 otherwise.
@end display