summaryrefslogtreecommitdiffstats
path: root/newlib/libc/posix/fnmatch.3
blob: aec25ea26b9631f95149ce99fe37adede51d8f94 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
FNMATCH(3)                         BSD Library Functions Manual                        FNMATCH(3)

NAME
     fnmatch -- match filename or pathname

LIBRARY
     Standard C Library (libc, -lc)

SYNOPSIS
     #include <fnmatch.h>

     int
     fnmatch(const char *pattern, const char *string, int flags);

DESCRIPTION
     The fnmatch() function matches patterns according to the rules used by the shell.  It checks
     the string specified by the string argument to see if it matches the pattern specified by
     the pattern argument.

     The flags argument modifies the interpretation of pattern and string.  The value of flags is
     the bitwise inclusive OR of any of the following constants, which are defined in the include
     file fnmatch.h.

     FNM_NOESCAPE  Normally, every occurrence of a backslash ('\') followed by a character in
                   pattern is replaced by that character.  This is done to negate any special
                   meaning for the character.  If the FNM_NOESCAPE flag is set, a backslash char-
                   acter is treated as an ordinary character.

     FNM_PATHNAME  Slash characters in string must be explicitly matched by slashes in pattern.
                   If this flag is not set, then slashes are treated as regular characters.

     FNM_PERIOD    Leading periods in string must be explicitly matched by periods in pattern.
                   If this flag is not set, then leading periods are treated as regular charac-
                   ters.  The definition of "leading" is related to the specification of
                   FNM_PATHNAME.  A period is always "leading" if it is the first character in
                   string.  Additionally, if FNM_PATHNAME is set, a period is leading if it imme-
                   diately follows a slash.

     FNM_LEADING_DIR
                   Ignore /* rest after successful pattern matching.

     FNM_CASEFOLD  Ignore  case  distinctions in both the pattern and the string.

RETURN VALUES
     The fnmatch() function returns zero if string matches the pattern specified by pattern, oth-
     erwise, it returns the value FNM_NOMATCH.

SEE ALSO
     sh(1), glob(3), regex(3)

STANDARDS
     The fnmatch() function conforms to IEEE Std 1003.2 ("POSIX.2").

HISTORY
     The fnmatch() function first appeared in 4.4BSD.

BUGS
     The pattern '*' matches the empty string, even if FNM_PATHNAME is specified.

BSD                                       April 28, 1995                                      BSD