summaryrefslogtreecommitdiffstats
path: root/man3/fnmatch.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:40:15 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:40:15 +0000
commit399644e47874bff147afb19c89228901ac39340e (patch)
tree1c4c0b733f4c16b5783b41bebb19194a9ef62ad1 /man3/fnmatch.3
parentInitial commit. (diff)
downloadmanpages-399644e47874bff147afb19c89228901ac39340e.tar.xz
manpages-399644e47874bff147afb19c89228901ac39340e.zip
Adding upstream version 6.05.01.upstream/6.05.01
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man3/fnmatch.3')
-rw-r--r--man3/fnmatch.3142
1 files changed, 142 insertions, 0 deletions
diff --git a/man3/fnmatch.3 b/man3/fnmatch.3
new file mode 100644
index 0000000..3de8117
--- /dev/null
+++ b/man3/fnmatch.3
@@ -0,0 +1,142 @@
+'\" t
+.\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.\" Modified Sat Jul 24 19:35:54 1993 by Rik Faith (faith@cs.unc.edu)
+.\" Modified Mon Oct 16 00:16:29 2000 following Joseph S. Myers
+.\"
+.TH fnmatch 3 2023-07-20 "Linux man-pages 6.05.01"
+.SH NAME
+fnmatch \- match filename or pathname
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
+.SH SYNOPSIS
+.nf
+.B #include <fnmatch.h>
+.PP
+.BI "int fnmatch(const char *" "pattern" ", const char *" string ", int " flags );
+.fi
+.SH DESCRIPTION
+The
+.BR fnmatch ()
+function checks whether the
+.I string
+argument matches the
+.I pattern
+argument, which is a shell wildcard pattern (see
+.BR glob (7)).
+.PP
+The
+.I flags
+argument modifies the behavior; it is the bitwise OR of zero or more
+of the following flags:
+.TP
+.B FNM_NOESCAPE
+If this flag is set, treat backslash as an ordinary character,
+instead of an escape character.
+.TP
+.B FNM_PATHNAME
+If this flag is set, match a slash in
+.I string
+only with a slash in
+.I pattern
+and not by an asterisk (*) or a question mark (?) metacharacter,
+nor by a bracket expression ([]) containing a slash.
+.TP
+.B FNM_PERIOD
+If this flag is set, a leading period in
+.I string
+has to be matched exactly by a period in
+.IR pattern .
+A period is considered to be leading if it is the first character in
+.IR string ,
+or if both
+.B FNM_PATHNAME
+is set and the period immediately follows a slash.
+.TP
+.B FNM_FILE_NAME
+This is a GNU synonym for
+.BR FNM_PATHNAME .
+.TP
+.B FNM_LEADING_DIR
+If this flag (a GNU extension) is set, the pattern is considered to be
+matched if it matches an initial segment of
+.I string
+which is followed by a slash.
+This flag is mainly for the internal
+use of glibc and is implemented only in certain cases.
+.TP
+.B FNM_CASEFOLD
+If this flag (a GNU extension) is set, the pattern is matched
+case-insensitively.
+.TP
+.B FNM_EXTMATCH
+If this flag (a GNU extension) is set, extended patterns are
+supported, as introduced by \&'ksh' and now supported by other shells.
+The extended format is as follows, with \fIpattern\-list\fR
+being a \&'|' separated list of patterns.
+.TP
+\&'?(\fIpattern\-list\fR)'
+The pattern matches if zero or one occurrences of any of the
+patterns in the \fIpattern\-list\fR match the input \fIstring\fR.
+.TP
+\&'*(\fIpattern\-list\fR)'
+The pattern matches if zero or more occurrences of any of the
+patterns in the \fIpattern\-list\fR match the input \fIstring\fR.
+.TP
+\&'+(\fIpattern\-list\fR)'
+The pattern matches if one or more occurrences of any of the
+patterns in the \fIpattern\-list\fR match the input \fIstring\fR.
+.TP
+\&'@(\fIpattern\-list\fR)'
+The pattern matches if exactly one occurrence of any of the
+patterns in the \fIpattern\-list\fR match the input \fIstring\fR.
+.TP
+\&'!(\fIpattern\-list\fR)'
+The pattern matches if the input \fIstring\fR cannot be matched with
+any of the patterns in the \fIpattern\-list\fR.
+.SH RETURN VALUE
+Zero if
+.I string
+matches
+.IR pattern ,
+.B FNM_NOMATCH
+if there is no match or another nonzero value if there is an error.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface Attribute Value
+T{
+.na
+.nh
+.BR fnmatch ()
+T} Thread safety MT-Safe env locale
+.TE
+.sp 1
+.SH STANDARDS
+.TP
+.BR fnmatch ()
+POSIX.1-2008.
+.TP
+.B FNM_FILE_NAME
+.TQ
+.B FNM_LEADING_DIR
+.TQ
+.B FNM_CASEFOLD
+GNU.
+.SH HISTORY
+.TP
+.BR fnmatch ()
+POSIX.1-2001, POSIX.2.
+.SH SEE ALSO
+.BR sh (1),
+.BR glob (3),
+.BR scandir (3),
+.BR wordexp (3),
+.BR glob (7)