lib/libcompat/4.3/re_comp.3

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