share/man/man3c/fnmatch.3c

   1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited All Rights Reserved  Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH FNMATCH 3C "Jun 11, 2015"
  11 .SH NAME
  12 fnmatch \- match filename or path name
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <fnmatch.h>
  17
  18 \fBint\fR \fBfnmatch\fR(\fBconst char *\fR\fIpattern\fR, \fBconst char *\fR\fIstring\fR, \fBint\fR \fIflags\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .LP
  23 The \fBfnmatch()\fR function matches patterns as described on the
  24 \fBfnmatch\fR(5) manual page.  It checks the \fIstring\fR argument to see if it
  25 matches the \fIpattern\fR argument.
  26 .sp
  27 .LP
  28 The \fIflags\fR argument modifies the interpretation of \fIpattern\fR and
  29 \fIstring\fR. It is the bitwise inclusive \fBOR\fR of zero or more of the
  30 following flags defined in the header <\fBfnmatch.h\fR>.
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fBFNM_PATHNAME\fR  \fR
  35 .ad
  36 .RS 18n
  37 If set, a slash (\fB/\fR) character in \fIstring\fR will be explicitly matched
  38 by a slash in \fIpattern\fR; it will not be matched by either the asterisk
  39 (\fB*\fR) or question-mark (\fB?\fR) special characters, nor by a bracket
  40 (\fB[\|]\fR) expression.
  41 .sp
  42 If not set, the slash character is treated as an ordinary character.
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBFNM_IGNORECASE\fR\fR
  49 .ad
  50 .RS 18n
  51 If set, the \fIstring\fR will be transliterated to lower case before doing the
  52 actual match. This transliteration is done using \fBtowlower_l\fR(3C), using
  53 the locale of the current thread. If no locale is set, then the global locale
  54 is used instead.
  55 .sp
  56 If not set, the match will use \fIstring\fR with no changes, making the match
  57 case-sensitive.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBFNM_NOESCAPE\fR\fR
  64 .ad
  65 .RS 18n
  66 If not set, a backslash character (\fB\e\fR) in \fIpattern\fR followed by any
  67 other character will match that second character in \fIstring\fR. In
  68 particular, "\fB\e\e\fR" will match a backslash in \fIstring\fR.
  69 .sp
  70 If set, a backslash character will be treated as an ordinary character.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBFNM_PERIOD\fR\fR
  77 .ad
  78 .RS 18n
  79 If set, a leading period in \fIstring\fR will match a period in \fIpattern\fR;
  80 where the location of "leading" is indicated by the value of
  81 \fBFNM_PATHNAME\fR:
  82 .RS +4
  83 .TP
  84 .ie t \(bu
  85 .el o
  86 If \fBFNM_PATHNAME\fR is set, a period is "leading" if it is the first
  87 character in \fIstring\fR or if it immediately follows a slash.
  88 .RE
  89 .RS +4
  90 .TP
  91 .ie t \(bu
  92 .el o
  93 If \fBFNM_PATHNAME\fR is not set, a period is "leading" only if it is the first
  94 character of \fIstring\fR.
  95 .RE
  96 .RE
  97
  98 .sp
  99 .RS 18n
 100 If not set, no special restrictions are placed on matching a period.
 101 .SH RETURN VALUES
 102 .LP
 103 If \fIstring\fR matches the pattern specified by \fIpattern\fR, then
 104 \fBfnmatch()\fR returns \fB0\fR. If there is no match, \fBfnmatch()\fR returns
 105 \fBFNM_NOMATCH\fR, which is defined in the header <\fBfnmatch.h\fR>. If an
 106 error occurs, \fBfnmatch()\fR returns another non-zero value.
 107 .SH USAGE
 108 .LP
 109 The \fBfnmatch()\fR function has two major uses. It could be used by an
 110 application or utility that needs to read a directory and apply a pattern
 111 against each entry. The \fBfind\fR(1) utility is an example of this. It can
 112 also be used by the \fBpax\fR(1) utility to process its \fIpattern\fR operands,
 113 or by applications that need to match strings in a similar manner.
 114 .sp
 115 .LP
 116 The name \fBfnmatch()\fR is intended to imply \fIfilename\fR match, rather than
 117 \fIpathname\fR match. The default action of this function is to match
 118 filenames, rather than path names, since it gives no special significance to
 119 the slash character. With the \fBFNM_PATHNAME\fR flag, \fBfnmatch()\fR does
 120 match path names, but without tilde expansion, parameter expansion, or special
 121 treatment for period at the beginning of a filename.
 122 .sp
 123 .LP
 124 The \fBfnmatch()\fR function can be used safely in multithreaded applications,
 125 as long as \fBsetlocale\fR(3C) is not being called to change the locale.
 126 .SH ATTRIBUTES
 127 .LP
 128 See \fBattributes\fR(5) for descriptions of the following attributes:
 129 .sp
 130
 131 .sp
 132 .TS
 133 box;
 134 c | c
 135 l | l .
 136 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 137 _
 138 CSI     Enabled
 139 _
 140 Interface Stability     Standard
 141 _
 142 MT-Level        MT-Safe with exceptions
 143 .TE
 144
 145 .SH SEE ALSO
 146 .LP
 147 \fBfind\fR(1), \fBpax\fR(1), \fBglob\fR(3C), \fBsetlocale\fR(3C),
 148 \fBwordexp\fR(3C), \fBattributes\fR(5), \fBfnmatch\fR(5), \fBstandards\fR(5)