summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPádraig Brady <P@draigBrady.com>2009-01-04 01:06:10 +0000
committerPádraig Brady <P@draigBrady.com>2009-01-05 00:01:21 +0000
commit972967903de659ed0aa367913f131855f8f72835 (patch)
tree39e18262ec9c0df873724450eead37ad9c8910c1 /doc
parente0035fa4eba4a1c7fa49b27e704c177f1dfcd534 (diff)
downloadcoreutils-972967903de659ed0aa367913f131855f8f72835.tar.xz
doc: pathchk description enhancements
* doc/coreutils.texi (pathchk invocation): Mention pathchk checks validity (for current system) as well as portability. Say messages go to stderr, and reorder description of checks done for the -p option, to match what's done in code. * src/pathchk.c (usage): Mention pathchk checks name validity. Suggested clarifications were from Dan Jacobson.
Diffstat (limited to 'doc')
-rw-r--r--doc/coreutils.texi26
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/coreutils.texi b/doc/coreutils.texi
index e3e99b647..51145de19 100644
--- a/doc/coreutils.texi
+++ b/doc/coreutils.texi
@@ -376,7 +376,7 @@ File name manipulation
* basename invocation:: Strip directory and suffix from a file name
* dirname invocation:: Strip non-directory suffix from a file name
-* pathchk invocation:: Check file name portability
+* pathchk invocation:: Check file name validity and portability
Working context
@@ -11572,7 +11572,7 @@ This section describes commands that manipulate file names.
@menu
* basename invocation:: Strip directory and suffix from a file name.
* dirname invocation:: Strip non-directory suffix from a file name.
-* pathchk invocation:: Check file name portability.
+* pathchk invocation:: Check file name validity and portability.
@end menu
@@ -11672,20 +11672,20 @@ dirname stdio.h
@node pathchk invocation
-@section @command{pathchk}: Check file name portability
+@section @command{pathchk}: Check file name validity and portability
@pindex pathchk
@cindex file names, checking validity and portability
@cindex valid file names, checking for
@cindex portable file names, checking for
-@command{pathchk} checks portability of file names. Synopsis:
+@command{pathchk} checks validity and portability of file names. Synopsis:
@example
pathchk [@var{option}]@dots{} @var{name}@dots{}
@end example
-For each @var{name}, @command{pathchk} prints a message if any of
+For each @var{name}, @command{pathchk} prints an error message if any of
these conditions is true:
@enumerate
@@ -11711,30 +11711,30 @@ Options must precede operands.
@item -p
@opindex -p
Instead of performing checks based on the underlying file system,
-print a message if any of these conditions is true:
+print an error message if any of these conditions is true:
@enumerate
@item
A file name is empty.
@item
-The length of a file name or one of its components exceeds the
-@acronym{POSIX} minimum limits for portability.
+A file name contains a character outside the @acronym{POSIX} portable file
+name character set, namely, the ASCII letters and digits, @samp{.},
+@samp{_}, @samp{-}, and @samp{/}.
@item
-A file name contains a character outside the portable file name
-character set, namely, the ASCII letters and digits, @samp{-},
-@samp{.}, @samp{/}, and @samp{_}.
+The length of a file name or one of its components exceeds the
+@acronym{POSIX} minimum limits for portability.
@end enumerate
@item -P
@opindex -P
-Print a message if a file name is empty, or if it contains a component
+Print an error message if a file name is empty, or if it contains a component
that begins with @samp{-}.
@item --portability
@opindex --portability
-Print a message if a file name is not portable to all @acronym{POSIX}
+Print an error message if a file name is not portable to all @acronym{POSIX}
hosts. This option is equivalent to @samp{-p -P}.
@end table