fnmatch(3) [osf1 man page]

fnmatch(3)						     Library Functions Manual							fnmatch(3)

NAME

       fnmatch - Matches filename patterns

LIBRARY

       Standard C Library (libc.so, libc.a)

SYNOPSIS

       #include <fnmatch.h>

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

STANDARDS

       Interfaces documented on this reference page conform to industry standards as follows:

       fnmatch():  XPG4, XPG4-UNIX

       Refer to the standards(5) reference page for more information about industry standards and associated tags.

PARAMETERS

       Contains  the  pattern  to which the string parameter is to be compared.  Contains the string to be compared against the pattern parameter.
       Contains a bit flag specifying the configurable attributes of the comparison to be performed by the fnmatch function.

       The flags parameter modifies the interpretation of the pattern and string parameters. It is the bitwise inclusive OR (|)  of  0	(zero)	or
       more  of  the  following  flags,  which are defined in the fnmatch.h file.  Slash in the string parameter only matches slash in the pattern
       parameter.  Leading period in the string parameter must be exactly matched by period in the pattern parameter.  Unless FNM_NOESCAPE is set,
       preceding  a  character	in  pattern  with  a   (backslash character) causes fnmatch() to match that character in string.  For example, \
       matches a backslash in string.  If FNM_NOESCAPE is set,  (backslash) is interpreted as an ordinary character.

       If the FNM_PATHNAME flag is set in the flags parameter, a / (slash) in the string parameter is explicitly matched by a  /  in  the  pattern
       parameter.   It	is  not  matched by either the * (asterisk) or ?  (question-mark) special characters, nor by a bracket expression.  If the
       FNM_PATHNAME flag is not set, the / is treated as an ordinary character.

       If FNM_PERIOD is set in the flags parameter, then a leading period in the string parameter only matches a period in the pattern	parameter;
       it  is  not  matched  by either the asterisk or question-mark special characters, nor by a bracket expression. A period is determined to be
       leading according to the setting of the FNM_PATHNAME flag, according to the following rules: If the FNM_PATHNAME flag is set, a	period	is
       leading	only  if  it is the first character in the string parameter or if it immediately follows a slash.  If the FNM_PATHNAME flag is not
       set,  a period is leading only if it is the first character of the string parameter.

       If FNM_PERIOD is not set, no special restrictions are placed on matching a period.

       A  (backslash character) quotes the next character, unless FNM_NOESCAPE is set.  If FNM_NOESCAPE is  set,    (backslash)  is  treated	as
       itself.

DESCRIPTION

       The fnmatch() function checks the string specified by the string parameter to see if it matches the pattern specified by the pattern param-
       eter.  This routine follows the match criteria of the glob() function.

       The fnmatch function is useful when a program needs to perform pattern matching, such as when a directory is to be searched for a  particu-
       lar  string (as is the case with the find command).  A program like the pax command can also use the fnmatch() function to perform its pat-
       tern matching operations.

RETURN VALUES

       If the value in the string parameter matches the pattern specified by the pattern parameter, then the fnmatch() function returns 0  (zero).
       If there is no match, the fnmatch() function returns FNM_NOMATCH, which is defined in the fnmatch.h file. If an error occurs, the fnmatch()
       function returns a nonzero value.

RELATED INFORMATION

       Functions: glob(3), globfree(3), regcomp(3)

       Standards: standards(5) delim off

																	fnmatch(3)

Check Out this Related Man Page

fnmatch(3C)						   Standard C Library Functions 					       fnmatch(3C)

NAME

       fnmatch - match filename or path name

SYNOPSIS

       #include <fnmatch.h>

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

DESCRIPTION

       The fnmatch() function matches patterns as described on the fnmatch(5) manual page.  It checks the string argument to see if it matches the
       pattern argument.

       The flags argument modifies the interpretation of pattern and string. It is the bitwise inclusive OR of zero or more of the following flags
       defined in the header <fnmatch.h>.

       FNM_PATHNAME	 If  set,  a  slash  (/)  character  in string will be explicitly matched by a slash in pattern; it will not be matched by
			 either the asterisk (*) or question-mark (?) special characters, nor by a bracket ([]) expression.

			 If not set, the slash character is treated as an ordinary character.

       FNM_NOESCAPE	 If not set, a backslash character () in pattern followed by any other character will	match  that  second  character	in
			 string. In particular, "\" will match a backslash in string.

			 If set, a backslash character will be treated as an ordinary character.

       FNM_PERIOD	 If  set,  a  leading period in string will match a period in pattern; where the location of "leading" is indicated by the
			 value of FNM_PATHNAME:

			     o	    If FNM_PATHNAME is set, a period is "leading" if it is the first character in string or if it immediately fol-
				    lows a slash.

			     o	    If FNM_PATHNAME is not set, a period is "leading" only if it is the first character of string.

       If not set, no special restrictions are placed on matching a period.

RETURN VALUES

       If string matches the pattern specified by pattern, then fnmatch() returns 0. If there is no match, fnmatch() returns FNM_NOMATCH, which is
       defined in the header <fnmatch.h>. If an error occurs, fnmatch() returns another non-zero value.

USAGE

       The fnmatch() function has two major uses. It could be used by an application or utility that needs to read a directory and apply a pattern
       against	each  entry. The find(1) utility is an example of this. It can also be used by the pax(1) utility to process its pattern operands,
       or by applications that need to match strings in a similar manner.

       The name fnmatch() is intended to imply filename match, rather than pathname match. The default action of this function is to  match  file-
       names,  rather  than  path names, since it gives no special significance to the slash character. With the FNM_PATHNAME flag, fnmatch() does
       match path names, but without tilde expansion, parameter expansion, or special treatment for period at the beginning of a filename.

       The fnmatch() function can be used safely in multithreaded applications, as long as setlocale(3C) is not being called to change the locale.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |CSI			     |Enabled			   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe with exceptions	   |
       +-----------------------------+-----------------------------+

SEE ALSO

       find(1), pax(1), glob(3C), setlocale(3C), wordexp(3C), attributes(5), fnmatch(5), standards(5)

SunOS 5.11							    24 Jul 2002 						       fnmatch(3C)

Linux and UNIX Man Pages

fnmatch(3) [osf1 man page]

Check Out this Related Man Page