xref: /freebsd/lib/libcompat/4.3/re_comp.3 (revision 63f537551380d2dab29fa402ad1269feae17e594)
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.\"
30.Dd June 4, 1993
31.Dt RE_COMP 3
32.Os
33.Sh NAME
34.Nm re_comp ,
35.Nm re_exec
36.Nd regular expression handler
37.Sh LIBRARY
38.Lb libcompat
39.Sh SYNOPSIS
40.In unistd.h
41.Ft char *
42.Fn re_comp "const char *s"
43.Ft int
44.Fn re_exec "const char *s"
45.Sh DESCRIPTION
46.Bf -symbolic
47This interface is made obsolete by
48.Xr regex 3 .
49.Ef
50.Pp
51The
52.Fn re_comp
53function
54compiles a string into an internal form suitable for pattern matching.
55The
56.Fn re_exec
57function
58checks the argument string against the last string passed to
59.Fn re_comp .
60.Pp
61The
62.Fn re_comp
63function
64returns 0 if the string
65.Fa s
66was compiled successfully; otherwise a string containing an
67error message is returned.
68If
69.Fn re_comp
70is passed 0 or a null string, it returns without changing the currently
71compiled regular expression.
72.Pp
73The
74.Fn re_exec
75function
76returns 1 if the string
77.Fa s
78matches the last compiled regular expression, 0 if the string
79.Fa s
80failed to match the last compiled regular expression, and \-1 if the compiled
81regular expression was invalid (indicating an internal error).
82.Pp
83The strings passed to both
84.Fn re_comp
85and
86.Fn re_exec
87may have trailing or embedded newline characters;
88they are terminated by
89.Dv NUL Ns s .
90The regular expressions recognized are described in the manual entry for
91.Xr ed 1 ,
92given the above difference.
93.Sh DIAGNOSTICS
94The
95.Fn re_exec
96function
97returns \-1 for an internal error.
98.Pp
99The
100.Fn re_comp
101function
102returns
103.Dq no previous regular expression
104or one of the strings generated by
105.Xr regerror 3 .
106.Sh SEE ALSO
107.Xr ed 1 ,
108.Xr egrep 1 ,
109.Xr ex 1 ,
110.Xr fgrep 1 ,
111.Xr grep 1 ,
112.Xr regex 3
113.Sh HISTORY
114The
115.Fn re_comp
116and
117.Fn re_exec
118functions appeared in
119.Bx 4.0 .
120