[apple/libc.git] / gen / FreeBSD / fnmatch.3

.\" Copyright (c) 1989, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Guido van Rossum.
.\" 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.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.
.\"
.\"     @(#)fnmatch.3	8.3 (Berkeley) 4/28/95
.\" $FreeBSD: src/lib/libc/gen/fnmatch.3,v 1.19 2007/01/09 00:27:53 imp Exp $
.\"
.Dd July 18, 2004
.Dt FNMATCH 3
.Os
.Sh NAME
.Nm fnmatch
.Nd test whether a filename or pathname matches a shell-style pattern
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In fnmatch.h
.Ft int
.Fn fnmatch "const char *pattern" "const char *string" "int flags"
.Sh DESCRIPTION
The
.Fn fnmatch
function
matches patterns according to the rules used by the shell.
It checks the string specified by the
.Fa string
argument to see if it matches the pattern specified by the
.Fa pattern
argument.
.Pp
The
.Fa flags
argument modifies the interpretation of
.Fa pattern
and
.Fa string .
The value of
.Fa flags
is the bitwise inclusive
.Tn OR
of any of the following
constants, which are defined in the include file
.In fnmatch.h .
.Bl -tag -width FNM_PATHNAME
.It Dv FNM_NOESCAPE
Normally, every occurrence of a backslash
.Pq Ql \e
followed by a character in
.Fa pattern
is replaced by that character.
This is done to negate any special meaning for the character.
If the
.Dv FNM_NOESCAPE
flag is set, a backslash character is treated as an ordinary character.
.It Dv FNM_PATHNAME
Slash characters in
.Fa string
must be explicitly matched by slashes in
.Fa pattern .
If this flag is not set, then slashes are treated as regular characters.
.It Dv FNM_PERIOD
Leading periods in
.Fa string
must be explicitly matched by periods in
.Fa pattern .
If this flag is not set, then leading periods are treated as regular
characters.
The definition of
.Dq leading
is related to the specification of
.Dv FNM_PATHNAME .
A period is always
.Dq leading
if it is the first character in
.Fa string .
Additionally, if
.Dv FNM_PATHNAME
is set,
a period is
leading
if it immediately follows a slash.
.It Dv FNM_LEADING_DIR
Ignore
.Dq Li /*
rest after successful
.Fa pattern
matching.
.It Dv FNM_CASEFOLD
Ignore case distinctions in both the
.Fa pattern
and the
.Fa string .
.El
.Sh RETURN VALUES
The
.Fn fnmatch
function returns zero if
.Fa string
matches the pattern specified by
.Fa pattern ,
otherwise, it returns the value
.Dv FNM_NOMATCH .
.Sh SEE ALSO
.Xr sh 1 ,
.Xr glob 3 ,
.Xr regex 3
.Sh STANDARDS
The current implementation of the
.Fn fnmatch
function
.Em does not
conform to
.St -p1003.2 .
Collating symbol expressions, equivalence class expressions and
character class expressions are not supported.
.Sh HISTORY
The
.Fn fnmatch
function first appeared in
.Bx 4.4 .
.Sh BUGS
The pattern
.Ql *
matches the empty string, even if
.Dv FNM_PATHNAME
is specified.
Commit	Line	Data
5b2abdfb A	1	.\" Copyright (c) 1989, 1991, 1993
	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" Guido van Rossum.
	6	.\" Redistribution and use in source and binary forms, with or without
	7	.\" modification, are permitted provided that the following conditions
	8	.\" are met:
	9	.\" 1. Redistributions of source code must retain the above copyright
	10	.\" notice, this list of conditions and the following disclaimer.
	11	.\" 2. Redistributions in binary form must reproduce the above copyright
	12	.\" notice, this list of conditions and the following disclaimer in the
	13	.\" documentation and/or other materials provided with the distribution.
5b2abdfb A	14	.\" 4. Neither the name of the University nor the names of its contributors
	15	.\" may be used to endorse or promote products derived from this software
	16	.\" without specific prior written permission.
	17	.\"
	18	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	19	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	20	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	21	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	22	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	23	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	24	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	25	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	26	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	27	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	28	.\" SUCH DAMAGE.
	29	.\"
	30	.\" @(#)fnmatch.3 8.3 (Berkeley) 4/28/95
1f2f436a	31	.\" $FreeBSD: src/lib/libc/gen/fnmatch.3,v 1.19 2007/01/09 00:27:53 imp Exp $
5b2abdfb	32	.\"
3d9156a7	33	.Dd July 18, 2004
5b2abdfb A	34	.Dt FNMATCH 3
	35	.Os
	36	.Sh NAME
	37	.Nm fnmatch
3d9156a7	38	.Nd test whether a filename or pathname matches a shell-style pattern
5b2abdfb A	39	.Sh LIBRARY
	40	.Lb libc
	41	.Sh SYNOPSIS
	42	.In fnmatch.h
	43	.Ft int
	44	.Fn fnmatch "const char pattern" "const char string" "int flags"
	45	.Sh DESCRIPTION
	46	The
	47	.Fn fnmatch
	48	function
	49	matches patterns according to the rules used by the shell.
	50	It checks the string specified by the
	51	.Fa string
	52	argument to see if it matches the pattern specified by the
	53	.Fa pattern
	54	argument.
	55	.Pp
	56	The
	57	.Fa flags
	58	argument modifies the interpretation of
	59	.Fa pattern
	60	and
	61	.Fa string .
	62	The value of
	63	.Fa flags
	64	is the bitwise inclusive
	65	.Tn OR
	66	of any of the following
	67	constants, which are defined in the include file
3d9156a7	68	.In fnmatch.h .
5b2abdfb A	69	.Bl -tag -width FNM_PATHNAME
	70	.It Dv FNM_NOESCAPE
	71	Normally, every occurrence of a backslash
	72	.Pq Ql \e
	73	followed by a character in
	74	.Fa pattern
	75	is replaced by that character.
	76	This is done to negate any special meaning for the character.
	77	If the
	78	.Dv FNM_NOESCAPE
	79	flag is set, a backslash character is treated as an ordinary character.
	80	.It Dv FNM_PATHNAME
	81	Slash characters in
	82	.Fa string
	83	must be explicitly matched by slashes in
	84	.Fa pattern .
	85	If this flag is not set, then slashes are treated as regular characters.
	86	.It Dv FNM_PERIOD
	87	Leading periods in
	88	.Fa string
	89	must be explicitly matched by periods in
	90	.Fa pattern .
	91	If this flag is not set, then leading periods are treated as regular
	92	characters.
	93	The definition of
	94	.Dq leading
	95	is related to the specification of
	96	.Dv FNM_PATHNAME .
	97	A period is always
	98	.Dq leading
	99	if it is the first character in
9385eb3d	100	.Fa string .
5b2abdfb A	101	Additionally, if
	102	.Dv FNM_PATHNAME
	103	is set,
	104	a period is
	105	leading
	106	if it immediately follows a slash.
	107	.It Dv FNM_LEADING_DIR
	108	Ignore
9385eb3d	109	.Dq Li /*
5b2abdfb A	110	rest after successful
	111	.Fa pattern
	112	matching.
	113	.It Dv FNM_CASEFOLD
3d9156a7	114	Ignore case distinctions in both the
5b2abdfb A	115	.Fa pattern
	116	and the
	117	.Fa string .
	118	.El
	119	.Sh RETURN VALUES
	120	The
	121	.Fn fnmatch
	122	function returns zero if
	123	.Fa string
	124	matches the pattern specified by
	125	.Fa pattern ,
	126	otherwise, it returns the value
	127	.Dv FNM_NOMATCH .
	128	.Sh SEE ALSO
	129	.Xr sh 1 ,
	130	.Xr glob 3 ,
	131	.Xr regex 3
	132	.Sh STANDARDS
3d9156a7	133	The current implementation of the
5b2abdfb	134	.Fn fnmatch
3d9156a7 A	135	function
	136	.Em does not
	137	conform to
5b2abdfb	138	.St -p1003.2 .
3d9156a7 A	139	Collating symbol expressions, equivalence class expressions and
3d9156a7 A	140	character class expressions are not supported.
5b2abdfb A	141	.Sh HISTORY
	142	The
	143	.Fn fnmatch
	144	function first appeared in
	145	.Bx 4.4 .
	146	.Sh BUGS
	147	The pattern
	148	.Ql *
	149	matches the empty string, even if
	150	.Dv FNM_PATHNAME
	151	is specified.