xref: /netbsd-src/share/man/man9/pmatch.9 (revision 6d07b400dc878478f544ef48ff61b3295c40c6bb)
1.\" $NetBSD: pmatch.9,v 1.3 2009/10/19 18:41:09 bouyer Exp $
2.\"
3.\" Copyright (c) 2003 Manuel Bouyer.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24.\"
25.\"
26.Dd October 12, 2003
27.Dt PMATCH 9
28.Os
29.Sh NAME
30.Nm pmatch
31.Nd performs pattern matching on strings
32.Sh SYNOPSIS
33.In sys/systm.h
34.Ft int
35.Fn pmatch "const char *string" "const char *pattern" "const char **estr"
36.Sh DESCRIPTION
37Extract substring matching
38.Fa pattern
39from
40.Fa string .
41If not
42.Dv NULL ,
43.Fa estr
44points to the end of the longest exact or substring match.
45.Pp
46.Fn pmatch
47uses the following metacharacters:
48.Bl -tag -width Ds
49.It Li \&?
50match any single character.
51.It Li *
52match any character 0 or more times.
53.It Li \&[
54define a range of characters that will match.
55The range is defined by 2 characters separated by a
56.Sq Li \&- .
57The range definition has to end with a
58.Sq Li \&] .
59A
60.Sq Li ^
61following the
62.Sq Li \&[
63will negate the range.
64.El
65.Sh RETURN VALUES
66.Fn pmatch
67will return 2 for an exact match, 1 for a substring match, 0 for no match and
68\-1 if an error occurs.
69