]> git.saurik.com Git - apple/libc.git/blob - gen/FreeBSD/fnmatch.3
Libc-594.1.4.tar.gz
[apple/libc.git] / gen / FreeBSD / fnmatch.3
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 .\" $FreeBSD: src/lib/libc/gen/fnmatch.3,v 1.18 2004/07/18 06:56:40 tjr Exp $
36 .\"
37 .Dd July 18, 2004
38 .Dt FNMATCH 3
39 .Os
40 .Sh NAME
41 .Nm fnmatch
42 .Nd test whether a filename or pathname matches a shell-style pattern
43 .Sh LIBRARY
44 .Lb libc
45 .Sh SYNOPSIS
46 .In fnmatch.h
47 .Ft int
48 .Fn fnmatch "const char *pattern" "const char *string" "int flags"
49 .Sh DESCRIPTION
50 The
51 .Fn fnmatch
52 function
53 matches patterns according to the rules used by the shell.
54 It checks the string specified by the
55 .Fa string
56 argument to see if it matches the pattern specified by the
57 .Fa pattern
58 argument.
59 .Pp
60 The
61 .Fa flags
62 argument modifies the interpretation of
63 .Fa pattern
64 and
65 .Fa string .
66 The value of
67 .Fa flags
68 is the bitwise inclusive
69 .Tn OR
70 of any of the following
71 constants, which are defined in the include file
72 .In fnmatch.h .
73 .Bl -tag -width FNM_PATHNAME
74 .It Dv FNM_NOESCAPE
75 Normally, every occurrence of a backslash
76 .Pq Ql \e
77 followed by a character in
78 .Fa pattern
79 is replaced by that character.
80 This is done to negate any special meaning for the character.
81 If the
82 .Dv FNM_NOESCAPE
83 flag is set, a backslash character is treated as an ordinary character.
84 .It Dv FNM_PATHNAME
85 Slash characters in
86 .Fa string
87 must be explicitly matched by slashes in
88 .Fa pattern .
89 If this flag is not set, then slashes are treated as regular characters.
90 .It Dv FNM_PERIOD
91 Leading periods in
92 .Fa string
93 must be explicitly matched by periods in
94 .Fa pattern .
95 If this flag is not set, then leading periods are treated as regular
96 characters.
97 The definition of
98 .Dq leading
99 is related to the specification of
100 .Dv FNM_PATHNAME .
101 A period is always
102 .Dq leading
103 if it is the first character in
104 .Fa string .
105 Additionally, if
106 .Dv FNM_PATHNAME
107 is set,
108 a period is
109 leading
110 if it immediately follows a slash.
111 .It Dv FNM_LEADING_DIR
112 Ignore
113 .Dq Li /*
114 rest after successful
115 .Fa pattern
116 matching.
117 .It Dv FNM_CASEFOLD
118 Ignore case distinctions in both the
119 .Fa pattern
120 and the
121 .Fa string .
122 .El
123 .Sh RETURN VALUES
124 The
125 .Fn fnmatch
126 function returns zero if
127 .Fa string
128 matches the pattern specified by
129 .Fa pattern ,
130 otherwise, it returns the value
131 .Dv FNM_NOMATCH .
132 .Sh SEE ALSO
133 .Xr sh 1 ,
134 .Xr glob 3 ,
135 .Xr regex 3
136 .Sh STANDARDS
137 The current implementation of the
138 .Fn fnmatch
139 function
140 .Em does not
141 conform to
142 .St -p1003.2 .
143 Collating symbol expressions, equivalence class expressions and
144 character class expressions are not supported.
145 .Sh HISTORY
146 The
147 .Fn fnmatch
148 function first appeared in
149 .Bx 4.4 .
150 .Sh BUGS
151 The pattern
152 .Ql *
153 matches the empty string, even if
154 .Dv FNM_PATHNAME
155 is specified.