[apple/file_cmds.git] / pathchk / pathchk.1

.\" 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: src/usr.bin/pathchk/pathchk.1,v 1.3 2002/12/12 17:26:01 ru Exp $
.\"
.Dd May 21, 2002
.Dt PATHCHK 1
.Os
.Sh NAME
.Nm pathchk
.Nd check pathnames
.Sh SYNOPSIS
.Nm
.Op Fl p
.Ar pathname ...
.Sh DESCRIPTION
The
.Nm
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.
(The value of
.Dv NAME_MAX
depends on the underlying file system.)
.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
.Ql _ ) .
No component may start with the hyphen
.Pq Ql \&-
character.
.El
.El
.Sh EXAMPLES
Check whether the names of files in the current directory are portable to
other
.Tn POSIX
systems:
.Pp
.Dl "find . -print | xargs pathchk -p"
.Sh DIAGNOSTICS
.Ex -std
.Sh SEE ALSO
.Xr getconf 1 ,
.Xr pathconf 2 ,
.Xr stat 2
.Sh STANDARDS
The
.Nm
utility conforms to
.St -p1003.1-2001 .
.Sh HISTORY
A
.Nm
utility appeared in
.Fx 5.0 .
Commit	Line	Data
c59d3020 A	1	.\" Copyright (c) 2001, 2002 Chuck Rouillard
	2	.\" All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\" 3. The name of the author may not be used to endorse or promote
	13	.\" products derived from this software without specific prior written
	14	.\" permission.
	15	.\"
	16	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
	17	.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
	18	.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	19	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
	20	.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	21	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	22	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	23	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	24	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	25	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	26	.\" SUCH DAMAGE.
	27	.\"
	28	.\" $FreeBSD: src/usr.bin/pathchk/pathchk.1,v 1.3 2002/12/12 17:26:01 ru Exp $
	29	.\"
	30	.Dd May 21, 2002
	31	.Dt PATHCHK 1
	32	.Os
	33	.Sh NAME
	34	.Nm pathchk
	35	.Nd check pathnames
	36	.Sh SYNOPSIS
	37	.Nm
	38	.Op Fl p
	39	.Ar pathname ...
	40	.Sh DESCRIPTION
	41	The
	42	.Nm
	43	utility checks whether each of the specified
	44	.Ar pathname
	45	arguments is valid or portable.
	46	.Pp
	47	A diagnostic message is written for each argument that:
	48	.Bl -bullet
	49	.It
	50	Is longer than
	51	.Dv PATH_MAX
	52	bytes.
	53	.It
	54	Contains any component longer than
	55	.Dv NAME_MAX
	56	bytes.
	57	(The value of
	58	.Dv NAME_MAX
	59	depends on the underlying file system.)
	60	.It
	61	Contains a directory component that is not searchable.
	62	.El
	63	.Pp
	64	It is not considered an error if a
65	.Ar pathname
66	argument contains a nonexistent component as long as a component by that
67	name could be created.
68	.Pp
69	The options are as follows:
70	.Bl -tag -width indent
71	.It Fl p
72	Perform portability checks on the specified
73	.Ar pathname
74	arguments.
75	Diagnostic messages will be written for each argument that:
76	.Bl -bullet
77	.It
78	Is longer than
79	.Dv _POSIX_PATH_MAX
80	.Pq 255
81	bytes.
82	.It
83	Contains a component longer than
84	.Dv _POSIX_NAME_MAX
85	.Pq 14
86	bytes.
87	.It
88	Contains any character not in the portable filename character set (that is,
89	alphanumeric characters,
90	.Ql \&. ,
91	.Ql \&-
92	and
93	.Ql _ ) .
94	No component may start with the hyphen
95	.Pq Ql \&-
96	character.
97	.El
98	.El
99	.Sh EXAMPLES
100	Check whether the names of files in the current directory are portable to
101	other
102	.Tn POSIX
103	systems:
104	.Pp
105	.Dl "find . -print \| xargs pathchk -p"
106	.Sh DIAGNOSTICS
107	.Ex -std
108	.Sh SEE ALSO
109	.Xr getconf 1 ,
110	.Xr pathconf 2 ,
111	.Xr stat 2
112	.Sh STANDARDS
113	The
114	.Nm
115	utility conforms to
116	.St -p1003.1-2001 .
117	.Sh HISTORY
118	A
119	.Nm
120	utility appeared in
121	.Fx 5.0 .