lib/libc/gen/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$
  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
  48 The
  49 .Fn fnmatch
  50 function
  51 matches patterns according to the rules used by the shell.
  52 It checks the string specified by the
  53 .Fa string
  54 argument to see if it matches the pattern specified by the
  55 .Fa pattern
  56 argument.
  57 .Pp
  58 The
  59 .Fa flags
  60 argument modifies the interpretation of
  61 .Fa pattern
  62 and
  63 .Fa string .
  64 The value of
  65 .Fa flags
  66 is the bitwise inclusive
  67 .Tn OR
  68 of any of the following
  69 constants, which are defined in the include file
  70 .Pa fnmatch.h .
  71 .Bl -tag -width FNM_PATHNAME
  72 .It Dv FNM_NOESCAPE
  73 Normally, every occurrence of a backslash
  74 .Pq Ql \e
  75 followed by a character in
  76 .Fa pattern
  77 is replaced by that character.
  78 This is done to negate any special meaning for the character.
  79 If the
  80 .Dv FNM_NOESCAPE
  81 flag is set, a backslash character is treated as an ordinary character.
  82 .It Dv FNM_PATHNAME
  83 Slash characters in
  84 .Fa string
  85 must be explicitly matched by slashes in
  86 .Fa pattern .
  87 If this flag is not set, then slashes are treated as regular characters.
  88 .It Dv FNM_PERIOD
  89 Leading periods in
  90 .Fa string
  91 must be explicitly matched by periods in
  92 .Fa pattern .
  93 If this flag is not set, then leading periods are treated as regular
  94 characters.
  95 The definition of
  96 .Dq leading
  97 is related to the specification of
  98 .Dv FNM_PATHNAME .
  99 A period is always
 100 .Dq leading
 101 if it is the first character in
 102 .Ar string .
 103 Additionally, if
 104 .Dv FNM_PATHNAME
 105 is set,
 106 a period is
 107 leading
 108 if it immediately follows a slash.
 109 .It Dv FNM_LEADING_DIR
 110 Ignore
 111 .Nm /*
 112 rest after successful
 113 .Fa pattern
 114 matching.
 115 .It Dv FNM_CASEFOLD
 116 Ignore  case  distinctions in both the
 117 .Fa pattern
 118 and the
 119 .Fa string .
 120 .El
 121 .Sh RETURN VALUES
 122 The
 123 .Fn fnmatch
 124 function returns zero if
 125 .Fa string
 126 matches the pattern specified by
 127 .Fa pattern ,
 128 otherwise, it returns the value
 129 .Dv FNM_NOMATCH .
 130 .Sh SEE ALSO
 131 .Xr sh 1 ,
 132 .Xr glob 3 ,
 133 .Xr regex 3
 134 .Sh STANDARDS
 135 The
 136 .Fn fnmatch
 137 function conforms to
 138 .St -p1003.2 .
 139 .Sh HISTORY
 140 The
 141 .Fn fnmatch
 142 function first appeared in
 143 .Bx 4.4 .
 144 .Sh BUGS
 145 The pattern
 146 .Ql *
 147 matches the empty string, even if
 148 .Dv FNM_PATHNAME
 149 is specified.