BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / gen / fnmatch.3

diff --git a/usr/src/lib/libc/gen/fnmatch.3 b/usr/src/lib/libc/gen/fnmatch.3
index 43de144..0b733d2 100644 (file)
--- a/usr/src/lib/libc/gen/fnmatch.3
+++ b/usr/src/lib/libc/gen/fnmatch.3
@@ -1,72 +1,113 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
+.\" Copyright (c) 1989, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" Guido van Rossum.
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" Guido van Rossum.

+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\" %sccs.include.redist.man%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.\"    @(#)fnmatch.3   5.2 (Berkeley) %G%
+.\"     @(#)fnmatch.3  5.3 (Berkeley) 4/19/91

 .\"
 .\"

-.TH FNMATCH 3 ""
-.UC 7
-.SH NAME
-fnmatch \- match filename or pathname
-.SH SYNOPSIS
-.nf
-#include <unistd.h>
-
-int fnmatch(const char *pattern, const char *string, int flags);
-.fi
-.SH DESCRIPTION
-.I Fnmatch
+.Dd April 19, 1991
+.Dt FNMATCH 3
+.Os
+.Sh NAME
+.Nm fnmatch
+.Nd match filename or pathname
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Ft int
+.Fn fnmatch "const char *pattern" "const char *string" "int flags"
+.Sh DESCRIPTION
+The
+.Fn fnmatch
+function

 matches patterns according to the rules used by the shell.
 It checks the string specified by the
 matches patterns according to the rules used by the shell.
 It checks the string specified by the

-.I string
+.Fa string

 argument to see if it matches the pattern specified by the
 argument to see if it matches the pattern specified by the

-.I pattern
+.Fa pattern

 argument.
 argument.

-.PP
+.Pp

 The
 The

-.I flags
+.Fa flags

 argument modifies the interpretation of
 argument modifies the interpretation of

-.I pattern
+.Fa pattern

 and
 and

-.I string.
+.Fa string .

 The value of
 The value of

-.I flags
-is the bitwise inclusive OR of any of the following
+.Fa flags
+is the bitwise inclusive
+.Tn OR
+of any of the following

 constants, which are defined in the include file
 constants, which are defined in the include file

-.IR unistd.h .
-.TP
-FNM_PATHNAME
+.Pa unistd.h .
+.Bl -tag -width FNM_PATHNAME
+.It Dv FNM_PATHNAME

 Slash characters in
 Slash characters in

-.I string
+.Fa string

 must be explicitly matched by slashes in
 must be explicitly matched by slashes in

-.IR pattern .
+.Fa pattern .

 If this flag is not set, then slashes are treated as regular characters.
 If this flag is not set, then slashes are treated as regular characters.

-.TP
-FNM_QUOTE
-Every occurrence of a backslash (``\e'') followed by a character in
-.I pattern
+.It Dv FNM_QUOTE
+Every occurrence of a backslash
+.Pq Ql \e
+followed by a character in
+.Fa pattern

 is replaced by that character.
 This is done to negate any special meaning for the character.
 is replaced by that character.
 This is done to negate any special meaning for the character.

-.SH RETURNS
+.El
+.Sh RETURN VALUES

 If
 If

-.I string
+.Fa string

 matches the pattern specified by
 matches the pattern specified by

-.IR pattern ,
+.Fa pattern ,

 then
 then

-.I fnmatch
+.Fn fnmatch

 returns zero.
 Otherwise,
 returns zero.
 Otherwise,

-.I fnmatch
+.Fn fnmatch

 returns nonzero.
 returns nonzero.

-.SH SEE ALSO
-sh(1), glob(3), wordexp(3), regexp(3)
-.SH BUGS
+.Sh SEE ALSO
+.Xr sh 1 ,
+.Xr glob 3 ,
+.Xr wordexp 3 ,
+.Xr regexp 3
+.Sh HISTORY
+The
+.Fn fnmatch
+function is
+.Ud .
+.Sh BUGS

 Quotes and slashes in range patterns are not handled correctly.
 Quotes and slashes in range patterns are not handled correctly.

-.PP
-The pattern ``*'' matches the empty string, even if
-.I FNM_PATHNAME
+.Pp
+The pattern
+.Ql *
+matches the empty string, even if
+.Dv FNM_PATHNAME

 is specified.
 is specified.