xref: /freebsd/lib/libc/gen/fnmatch.3 (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
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.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)fnmatch.3	8.3 (Berkeley) 4/28/95
35.\"
36.Dd April 28, 1995
37.Dt FNMATCH 3
38.Os
39.Sh NAME
40.Nm fnmatch
41.Nd match filename or pathname
42.Sh SYNOPSIS
43.Fd #include <fnmatch.h>
44.Ft int
45.Fn fnmatch "const char *pattern" "const char *string" "int flags"
46.Sh DESCRIPTION
47The
48.Fn fnmatch
49function
50matches patterns according to the rules used by the shell.
51It checks the string specified by the
52.Fa string
53argument to see if it matches the pattern specified by the
54.Fa pattern
55argument.
56.Pp
57The
58.Fa flags
59argument modifies the interpretation of
60.Fa pattern
61and
62.Fa string .
63The value of
64.Fa flags
65is the bitwise inclusive
66.Tn OR
67of any of the following
68constants, which are defined in the include file
69.Pa fnmatch.h .
70.Bl -tag -width FNM_PATHNAME
71.It Dv FNM_NOESCAPE
72Normally, every occurrence of a backslash
73.Pq Ql \e
74followed by a character in
75.Fa pattern
76is replaced by that character.
77This is done to negate any special meaning for the character.
78If the
79.Dv FNM_NOESCAPE
80flag is set, a backslash character is treated as an ordinary character.
81.It Dv FNM_PATHNAME
82Slash characters in
83.Fa string
84must be explicitly matched by slashes in
85.Fa pattern .
86If this flag is not set, then slashes are treated as regular characters.
87.It Dv FNM_PERIOD
88Leading periods in
89.Fa string
90must be explicitly matched by periods in
91.Fa pattern .
92If this flag is not set, then leading periods are treated as regular
93characters.
94The definition of ``leading'' is related to the specification of
95.Dv FNM_PATHNAME.
96A period is always ``leading'' if it is the first character in
97.Ar string .
98Additionally, if
99.Dv FNM_PATHNAME
100is set,
101a period is ``leading'' if it immediately follows a slash.
102.It Dv FNM_LEADING_DIR
103Ignore
104.Nm /*
105rest after successful
106.Fa pattern
107matching.
108.It Dv FNM_CASEFOLD
109Ignore  case  distinctions in both the
110.Fa pattern
111and the
112.Fa string .
113.El
114.Sh RETURN VALUES
115The
116.Fn fnmatch
117function returns zero if
118.Fa string
119matches the pattern specified by
120.Fa pattern ,
121otherwise, it returns the value
122.Dv FNM_NOMATCH .
123.Sh SEE ALSO
124.Xr sh 1 ,
125.Xr glob 3 ,
126.Xr regex 3
127.Sh STANDARDS
128The
129.Fn fnmatch
130function conforms to
131.St -p1003.2 .
132.Sh HISTORY
133The
134.Fn fnmatch
135function first appeared in
136.Bx 4.4 .
137.Sh BUGS
138The pattern
139.Ql *
140matches the empty string, even if
141.Dv FNM_PATHNAME
142is specified.
143