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$ 36.\" 37.Dd April 28, 1995 38.Dt FNMATCH 3 39.Os 40.Sh NAME 41.Nm fnmatch 42.Nd match filename or pathname 43.Sh SYNOPSIS 44.Fd #include <fnmatch.h> 45.Ft int 46.Fn fnmatch "const char *pattern" "const char *string" "int flags" 47.Sh DESCRIPTION 48The 49.Fn fnmatch 50function 51matches patterns according to the rules used by the shell. 52It checks the string specified by the 53.Fa string 54argument to see if it matches the pattern specified by the 55.Fa pattern 56argument. 57.Pp 58The 59.Fa flags 60argument modifies the interpretation of 61.Fa pattern 62and 63.Fa string . 64The value of 65.Fa flags 66is the bitwise inclusive 67.Tn OR 68of any of the following 69constants, which are defined in the include file 70.Pa fnmatch.h . 71.Bl -tag -width FNM_PATHNAME 72.It Dv FNM_NOESCAPE 73Normally, every occurrence of a backslash 74.Pq Ql \e 75followed by a character in 76.Fa pattern 77is replaced by that character. 78This is done to negate any special meaning for the character. 79If the 80.Dv FNM_NOESCAPE 81flag is set, a backslash character is treated as an ordinary character. 82.It Dv FNM_PATHNAME 83Slash characters in 84.Fa string 85must be explicitly matched by slashes in 86.Fa pattern . 87If this flag is not set, then slashes are treated as regular characters. 88.It Dv FNM_PERIOD 89Leading periods in 90.Fa string 91must be explicitly matched by periods in 92.Fa pattern . 93If this flag is not set, then leading periods are treated as regular 94characters. 95The definition of ``leading'' is related to the specification of 96.Dv FNM_PATHNAME. 97A period is always ``leading'' if it is the first character in 98.Ar string . 99Additionally, if 100.Dv FNM_PATHNAME 101is set, 102a period is ``leading'' if it immediately follows a slash. 103.It Dv FNM_LEADING_DIR 104Ignore 105.Nm /* 106rest after successful 107.Fa pattern 108matching. 109.It Dv FNM_CASEFOLD 110Ignore case distinctions in both the 111.Fa pattern 112and the 113.Fa string . 114.El 115.Sh RETURN VALUES 116The 117.Fn fnmatch 118function returns zero if 119.Fa string 120matches the pattern specified by 121.Fa pattern , 122otherwise, it returns the value 123.Dv FNM_NOMATCH . 124.Sh SEE ALSO 125.Xr sh 1 , 126.Xr glob 3 , 127.Xr regex 3 128.Sh STANDARDS 129The 130.Fn fnmatch 131function conforms to 132.St -p1003.2 . 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