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