xref: /freebsd/lib/libcompat/4.3/re_comp.3 (revision ea825d02749f382c3f7e17f28247f20a48733eab)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)re_comp.3	8.1 (Berkeley) 6/4/93
29.\" $FreeBSD$
30.\"
31.Dd June 4, 1993
32.Dt RE_COMP 3
33.Os
34.Sh NAME
35.Nm re_comp ,
36.Nm re_exec
37.Nd regular expression handler
38.Sh LIBRARY
39.Lb libcompat
40.Sh SYNOPSIS
41.In unistd.h
42.Ft char *
43.Fn re_comp "const char *s"
44.Ft int
45.Fn re_exec "const char *s"
46.Sh DESCRIPTION
47.Bf -symbolic
48This interface is made obsolete by
49.Xr regex 3 .
50.Ef
51.Pp
52The
53.Fn re_comp
54function
55compiles a string into an internal form suitable for pattern matching.
56The
57.Fn re_exec
58function
59checks the argument string against the last string passed to
60.Fn re_comp .
61.Pp
62The
63.Fn re_comp
64function
65returns 0 if the string
66.Fa s
67was compiled successfully; otherwise a string containing an
68error message is returned.
69If
70.Fn re_comp
71is passed 0 or a null string, it returns without changing the currently
72compiled regular expression.
73.Pp
74The
75.Fn re_exec
76function
77returns 1 if the string
78.Fa s
79matches the last compiled regular expression, 0 if the string
80.Fa s
81failed to match the last compiled regular expression, and \-1 if the compiled
82regular expression was invalid (indicating an internal error).
83.Pp
84The strings passed to both
85.Fn re_comp
86and
87.Fn re_exec
88may have trailing or embedded newline characters;
89they are terminated by
90.Dv NUL Ns s .
91The regular expressions recognized are described in the manual entry for
92.Xr ed 1 ,
93given the above difference.
94.Sh DIAGNOSTICS
95The
96.Fn re_exec
97function
98returns \-1 for an internal error.
99.Pp
100The
101.Fn re_comp
102function
103returns
104.Dq no previous regular expression
105or one of the strings generated by
106.Xr regerror 3 .
107.Sh SEE ALSO
108.Xr ed 1 ,
109.Xr egrep 1 ,
110.Xr ex 1 ,
111.Xr fgrep 1 ,
112.Xr grep 1 ,
113.Xr regex 3
114.Sh HISTORY
115The
116.Fn re_comp
117and
118.Fn re_exec
119functions appeared in
120.Bx 4.0 .
121