d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
d031bd192e
freebsd-dev/usr.bin/pathchk/pathchk.1

132 lines
3.2 KiB
Groff
Raw Normal View History

Add the pathchk utility, which checks pathnames for validity or portability between POSIX systems. Submitted by: Chuck Rouillard (manpage, initial implementation)
2002-05-22 10:30:16 +00:00
.\" Copyright (c) 2001, 2002 Chuck Rouillard
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote
.\" products derived from this software without specific prior written
.\" permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
pathchk: Add the new POSIX -P option. This option checks for empty pathnames and components starting with '-'. Our -p option also checks for the latter, which remains the case. MFC after: 1 week
2010-05-01 22:00:28 +00:00
.Dd May 1, 2010
Add the pathchk utility, which checks pathnames for validity or portability between POSIX systems. Submitted by: Chuck Rouillard (manpage, initial implementation)
2002-05-22 10:30:16 +00:00
.Dt PATHCHK 1
.Os
.Sh NAME
.Nm pathchk
.Nd check pathnames
.Sh SYNOPSIS
mdoc(7) police: tidy up the markup.
2002-05-30 14:02:23 +00:00
.Nm
pathchk: Add the new POSIX -P option. This option checks for empty pathnames and components starting with '-'. Our -p option also checks for the latter, which remains the case. MFC after: 1 week
2010-05-01 22:00:28 +00:00
.Op Fl pP
mdoc(7) police: tidy up the markup.
2002-05-30 14:02:23 +00:00
.Ar pathname ...
Add the pathchk utility, which checks pathnames for validity or portability between POSIX systems. Submitted by: Chuck Rouillard (manpage, initial implementation)
2002-05-22 10:30:16 +00:00
.Sh DESCRIPTION
The
mdoc(7) police: tidy up the markup.
2002-05-30 14:02:23 +00:00
.Nm
Add the pathchk utility, which checks pathnames for validity or portability between POSIX systems. Submitted by: Chuck Rouillard (manpage, initial implementation)
2002-05-22 10:30:16 +00:00
utility checks whether each of the specified
.Ar pathname
arguments is valid or portable.
.Pp
A diagnostic message is written for each argument that:
.Bl -bullet
.It
Is longer than
.Dv PATH_MAX
bytes.
.It
Contains any component longer than
.Dv NAME_MAX
bytes.
mdoc(7) police: tidy up the markup.
2002-05-30 14:02:23 +00:00
(The value of
Add the pathchk utility, which checks pathnames for validity or portability between POSIX systems. Submitted by: Chuck Rouillard (manpage, initial implementation)
2002-05-22 10:30:16 +00:00
.Dv NAME_MAX
Uniformly refer to a file system as "file system". Approved by: re
2002-12-12 17:26:04 +00:00
depends on the underlying file system.)
Add the pathchk utility, which checks pathnames for validity or portability between POSIX systems. Submitted by: Chuck Rouillard (manpage, initial implementation)
2002-05-22 10:30:16 +00:00
.It
Contains a directory component that is not searchable.
.El
.Pp
It is not considered an error if a
.Ar pathname
argument contains a nonexistent component as long as a component by that
name could be created.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl p
Perform portability checks on the specified
.Ar pathname
arguments.
Diagnostic messages will be written for each argument that:
.Bl -bullet
.It
Is longer than
.Dv _POSIX_PATH_MAX
.Pq 255
bytes.
.It
Contains a component longer than
.Dv _POSIX_NAME_MAX
.Pq 14
bytes.
.It
Contains any character not in the portable filename character set (that is,
alphanumeric characters,
.Ql \&. ,
.Ql \&-
and
mdoc(7) police: tidy up the markup.
2002-05-30 14:02:23 +00:00
.Ql _ ) .
Add the pathchk utility, which checks pathnames for validity or portability between POSIX systems. Submitted by: Chuck Rouillard (manpage, initial implementation)
2002-05-22 10:30:16 +00:00
No component may start with the hyphen
.Pq Ql \&-
character.
.El
pathchk: Add the new POSIX -P option. This option checks for empty pathnames and components starting with '-'. Our -p option also checks for the latter, which remains the case. MFC after: 1 week
2010-05-01 22:00:28 +00:00
.It Fl P
In addition to the default or
.Fl p
checks, write a diagnostic for each argument that:
.Bl -bullet
.It
Is empty.
.It
Contains a component that starts with a hyphen.
.El
Add the pathchk utility, which checks pathnames for validity or portability between POSIX systems. Submitted by: Chuck Rouillard (manpage, initial implementation)
2002-05-22 10:30:16 +00:00
.El
Sort sections.
2005-01-18 13:43:56 +00:00
.Sh EXIT STATUS
.Ex -std
Add the pathchk utility, which checks pathnames for validity or portability between POSIX systems. Submitted by: Chuck Rouillard (manpage, initial implementation)
2002-05-22 10:30:16 +00:00
.Sh EXAMPLES
Check whether the names of files in the current directory are portable to
other
.Tn POSIX
systems:
mdoc(7) police: tidy up the markup.
2002-05-30 14:02:23 +00:00
.Pp
pathchk(1): Fix the example so it allows arbitrary pathnames. Spaces and various other characters in pathnames are not passed through literally by xargs in its default mode. Instead, use find . -exec ... {} + Although the -- argument is not strictly required here, add it anyway to avoid surprises when modifying the code to find -f -somedir ... MFC after: 1 week
2010-05-01 22:10:45 +00:00
.Dl "find . -exec pathchk -p -- {} +"
Add the pathchk utility, which checks pathnames for validity or portability between POSIX systems. Submitted by: Chuck Rouillard (manpage, initial implementation)
2002-05-22 10:30:16 +00:00
.Sh SEE ALSO
.Xr getconf 1 ,
.Xr pathconf 2 ,
.Xr stat 2
.Sh STANDARDS
The
mdoc(7) police: tidy up the markup.
2002-05-30 14:02:23 +00:00
.Nm
Add the pathchk utility, which checks pathnames for validity or portability between POSIX systems. Submitted by: Chuck Rouillard (manpage, initial implementation)
2002-05-22 10:30:16 +00:00
utility conforms to
.St -p1003.1-2001 .
.Sh HISTORY
A
.Nm
utility appeared in
.Fx 5.0 .
Reference in New Issue Copy Permalink