git.gag.com Git - debian/sudo/blob - fnmatch.3

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