User Commands pathchk(1) NAME pathchk - check path names SYNOPSIS /usr/bin/pathchk /usr/bin/pathchk [ options ] pathname ksh93 pathchk [ options ] pathname DESCRIPTION pathchk checks each pathname to see if it is valid and/or portable. A pathname is valid if it can be used to access or create a file without causing syntax errors. A file is portable, if no truncation will result on any conforming POSIX.1 implementation. By default pathchk checks each component of each pathname based on the underlying file system. A diagnostic is written to standard error for each pathname that: - Is longer than $(getconf PATH_MAX) bytes. - Contains any component longer than $(getconf NAME_MAX) bytes. - Contains any directory component in a directory that is not searchable. - Contains any character in any component that is not valid in its containing directory. - Is empty. OPTIONS The following options is supported: -p, --portability Instead of performing length checks on the underlying file system, write a diagnostic for each pathname operand that: - Is longer than $(getconf _POSIX_PATH_MAX) bytes. - Contains any component longer than $(getconf _POSIX_NAME_MAX) bytes. - Contains any character in any component that is not in the portable filename character set. - Is empty. -P Write a diagnostic for each pathname operand that: - Contains a component whose first character is the character - Is empty OPERANDS The following operand is supported: path A path to be checked. USAGE See largefile(5) for the description of the behavior of pathchk when encountering files greater than or equal to 2 Gbyte ( 2**31 bytes). EXAMPLES Example 1: Using the pathchk command To verify that all paths in an imported data interchange archive are legitimate and unambiguous on the current system: example% pax -f archive | sed -e '/ == .*/s///' | xargs pathchk if (( $? == 0 )) ; then pax -r -f archive else printf "Investigate problems before importing files.\n" exit 1 fi To verify that all files in the current directory hierarchy could be moved to any system conforming to the X/Open specification that also supports the pax(1) command: example% find . -print | xargs pathchk -p if (( $? == 0 )) ; then pax -w -f archive . else printf "Portable archive cannot be created.\n" exit 1 fi To verify that a user-supplied path names a readable file and that the application can create a file extending the given path without truncation and without overwriting any existing file: example% case $- in *C*) reset="";; *) reset="set +C" set -C;; esac test -r "$path" && pathchk "$path.out" && rm "$path.out" > "$path.out" if (( $? != 0 )) ; then printf "%s: %s not found or %s.out fails \ creation checks.\n" "$0" "$path" "$path" $reset # reset the noclobber option in case a trap # on EXIT depends on it exit 1 fi $reset PROCESSING < "$path" > "$path.out" The following assumptions are made in this example: 1. PROCESSING represents the code that will be used by the application to use $path once it is verified that $path.out will work as intended. 2. The state of the noclobber option is unknown when this code is invoked and should be set on exit to the state it was in when this code was invoked. (The reset variable is used in this example to restore the initial state.) 3. Note the usage of: rm "$path.out" > "$path.out" a. The pathchk command has already verified, at this point, that $path.out will not be truncated. b. With the noclobber option set, the shell will verify that $path.out does not already exist before invoking rm. c. If the shell succeeded in creating $path.out, rm will remove it so that the application can create the file again in the PROCESSING step. d. If the PROCESSING step wants the file to exist already when it is invoked, the: rm "$path.out" > "$path.out" should be replaced with: > "$path.out" which will verify that the file did not already exist, but leave $path.out in place for use by PROCESSING. ENVIRONMENT VARIABLES See environ(5) for descriptions of the following environment variables that affect the execution of pathchk: LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, and NLSPATH. EXIT STATUS The following exit values are returned: 0 All path operands passed all of the checks. >0 An error occurred. ATTRIBUTES See attributes(5) for descriptions of the following attributes: ____________________________________________________________ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |_____________________________|_____________________________| | Availability | SUNWcsu | |_____________________________|_____________________________| | CSI | enabled | |_____________________________|_____________________________| | Interface Stability | Commited | |_____________________________|_____________________________| This command conforms to IEEE Std 1003.1-2008. SEE ALSO getconf(1), ksh93(1), pax(1), test(1), creat(2), pathchk(2), attributes(5), environ(5), largefile(5), standards(5), http://www.opengroup.org/onlinepubs/9699919799/utilities/pathchk.html SunOS 5.10 Last change: 1 Feb 1995 4