pathchk(1) [osx man page]

PATHCHK(1)						    BSD General Commands Manual 						PATHCHK(1)

NAME

     pathchk -- check pathnames

SYNOPSIS

     pathchk [-p] pathname ...

DESCRIPTION

     The pathchk utility checks whether each of the specified pathname arguments is valid or portable.

     A diagnostic message is written for each argument that:

     o	 Is longer than PATH_MAX bytes.

     o	 Contains any component longer than NAME_MAX bytes.  (The value of NAME_MAX depends on the underlying file system.)

     o	 Contains a directory component that is not searchable.

     It is not considered an error if a pathname argument contains a nonexistent component as long as a component by that name could be created.

     The options are as follows:

     -p      Perform portability checks on the specified pathname arguments.  Diagnostic messages will be written for each argument that:

	     o	 Is longer than _POSIX_PATH_MAX (255) bytes.

	     o	 Contains a component longer than _POSIX_NAME_MAX (14) bytes.

	     o	 Contains any character not in the portable filename character set (that is, alphanumeric characters, '.', '-' and '_').  No com-
		 ponent may start with the hyphen ('-') character.

EXAMPLES

     Check whether the names of files in the current directory are portable to other POSIX systems:

	   find . -print | xargs pathchk -p

DIAGNOSTICS

     The pathchk utility exits 0 on success, and >0 if an error occurs.

SEE ALSO

     getconf(1), pathconf(2), stat(2)

STANDARDS

     The pathchk utility conforms to IEEE Std 1003.1-2001 (``POSIX.1'').

HISTORY

     A pathchk utility appeared in FreeBSD 5.0.

BSD
								   May 21, 2002 							       BSD

pathchk(1)						      General Commands Manual							pathchk(1)

NAME

       pathchk - Checks path names

SYNOPSIS

       pathchk [-p] pathname...

STANDARDS

       Interfaces documented on this reference page conform to industry standards as follows:

       pathchk:  XCU5.0

       Refer to the standards(5) reference page for more information about industry standards and associated tags.

OPTIONS

       Performs  path name checks based on POSIX portability standards.  An error message is sent if any of the following conditions are true: The
       byte length of the full path name is longer than allowed by POSIX standards ({_POSIX_PATH_MAX}).  The byte length of a component is  longer
       than allowed by POSIX standards ({_POSIX_NAME_MAX}).  A character in any component is not in the portable file name character set.

OPERANDS

       The path name to be checked.

DESCRIPTION

       The pathchk command checks that one or more path names are valid (that is, they can be used to access or create a file without causing syn-
       tax errors) and portable (that is, no file name truncation will result).

       By default, the pathchk command checks each component of each path name specified by the pathname argument based  on  the  underlying  file
       system.	 If the -p option is not specified, pathchk sends an error message if any of the following conditions are true: The byte length of
       the full path name is longer than allowed by the system ({PATH_MAX} bytes).  The byte length of a component is longer than allowed  by  the
       system  ({NAME_MAX} bytes).  Search permission is not allowed for a component.  A character in any component is not valid in its containing
       directory.

       It is not considered an error if one or more components of a path name do not exist, as long as a file matching the path name specified	by
       the pathname argument could be created without violating any of the preceding criteria.

EXAMPLES

       To  check  the  validity and portability of the /u/bob/work/tempfiles path name, enter: pathchk /u/bob/work/tempfiles To check the validity
       and portability of the /u/bob/temp path name for POSIX standards, enter: pathchk -p /u/bob/temp

ENVIRONMENT VARIABLES

       The following environment variables affect the execution of pathchk: Provides a default value for the internationalization  variables  that
       are  unset  or null. If LANG is unset or null, the corresponding value from the default locale is used.	If any of the internationalization
       variables contain an invalid setting, the utility behaves as if none of the variables had been defined.	 If  set  to  a  non-empty  string
       value,  overrides the values of all the other internationalization variables.  Determines the locale for the interpretation of sequences of
       bytes of text data as characters (for example, single-byte as opposed to multibyte characters in arguments).  Determines the locale for the
       format  and contents of diagnostic messages written to standard error.  Determines the location of message catalogues for the processing of
       LC_MESSAGES.

FILES

       System maximum values

EXIT STATUS

       The pathchk command returns the following exit values: All path name operands passed the checks.  An error occurred.

SEE ALSO

       Commands:  test(1)

       Files:  limits(4)

       Standards:  standards(5)

																	pathchk(1)