1.\" Copyright (c) 1989, 1991 The Regents of the University of California. 2.\" 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 5.4 (Berkeley) 6/28/92 35.\" 36.Dd June 28, 1992 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 strings match periods in patterns. 89The definition of ``leading'' is related to the specification of 90.Dv FNM_PATHNAME. 91A period is always ``leading'' if it is the first character in 92.Ar string . 93Additionally, if 94.Dv FNM_PATHNAME 95is set, 96a period is ``leading'' if it immediately follows a slash. 97.Em "This flag is not currently implemented." 98.El 99.Sh RETURN VALUES 100The 101.Fn fnmatch 102function returns zero if 103.Fa string 104matches the pattern specified by 105.Fa pattern , 106otherwise, it returns the value 107.Dv FNM_NOMATCH . 108.Sh SEE ALSO 109.Xr sh 1 , 110.Xr glob 3 , 111.Xr wordexp 3 , 112.Xr regexp 3 113.Sh HISTORY 114The 115.Fn fnmatch 116function is 117.Ud . 118.Sh BUGS 119Quotes and slashes in range patterns are not handled correctly by 120this implementation. 121.Pp 122The 123.Dv FNM_PERIOD 124flag is not implemented. 125.Pp 126The pattern 127.Ql * 128matches the empty string, even if 129.Dv FNM_PATHNAME 130is specified. 131