usr/src/man/man1/regcmp.1

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH REGCMP 1 "Dec 20, 1996"
   7 .SH NAME
   8 regcmp \- regular expression compile
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBregcmp\fR [\fB-\fR] \fIfilename\fR...
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBregcmp\fR command performs a function similar to \fBregcmp\fR and, in
  19 most cases, precludes the need for calling \fBregcmp\fR from C programs.
  20 Bypassing \fBregcmp\fR saves on both execution time and program size. The
  21 command \fBregcmp\fR compiles the regular expressions in \fIfilename\fR and
  22 places the output in \fIfilename\fR\fB\&.i\fR.
  23 .SH OPTIONS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fB\(mi\fR \fR
  28 .ad
  29 .RS 9n
  30 If the \fB\(mi\fR option is used, the output is placed in
  31 \fIfilename\fR\fB\&.c\fR. The format of entries in \fIfilename\fR is a name (C
  32 variable) followed by one or more blanks followed by one or more regular
  33 expressions enclosed in double quotes. The output of \fBregcmp\fR is C source
  34 code. Compiled regular expressions are represented as \fBextern char\fR
  35 vectors. \fIfilename\fR\fB\&.i\fR files may thus be \fB#include\fRd in C
  36 programs, or \fIfilename\fR\fB\&.c\fR files may be compiled and later loaded.
  37 In the C program that uses the \fBregcmp\fR output, \fBregex(abc,line)\fR
  38 applies the regular expression named \fBabc\fR to \fBline\fR. Diagnostics are
  39 self-explanatory.
  40 .RE
  41
  42 .SH EXAMPLES
  43 .LP
  44 \fBExample 1 \fRExamples of the \fBregcmp\fR command.
  45 .sp
  46 .ne 2
  47 .na
  48 \fBname \fR
  49 .ad
  50 .RS 9n
  51 \fB"([A\(miZa\(miz][A\(miZa\(miz0\(mi9_]*)$0"\fR
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fBtelno\fR
  58 .ad
  59 .RS 9n
  60 \fB"\|\e({0,1}([2\(mi9][01][1\(mi9])$0\e){0,1} *"\fR
  61 .sp
  62 \fB"([2\(mi9][0\(mi9]{2})$1[ \(mi]{0,1}"\fR
  63 .sp
  64 \fB"([0\(mi9]{4})$2"\fR
  65 .RE
  66
  67 .sp
  68 .LP
  69 The three arguments to \fBtelno\fR shown above must all be entered on one line.
  70
  71 .sp
  72 .LP
  73 In the C program that uses the \fBregcmp\fR output,
  74
  75 .sp
  76 .in +2
  77 .nf
  78      regex(telno, line, area, exch, rest)
  79 .fi
  80 .in -2
  81 .sp
  82
  83 .sp
  84 .LP
  85 applies the regular expression named \fBtelno\fR to \fBline\fR.
  86
  87 .SH ENVIRONMENT VARIABLES
  88 .sp
  89 .LP
  90 A general description of the usage of the \fBLC_*\fR environmental variables
  91 can be found in \fBenviron\fR(5).
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBLC_CTYPE\fR \fR
  96 .ad
  97 .RS 16n
  98 Determines how \fBregcmp\fR handles characters. When \fBLC_CTYPE\fR is set to a
  99 valid value, \fBregcmp\fR can display and handle text and filenames containing
 100 valid characters for that locale.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBLC_MESSAGES\fR \fR
 107 .ad
 108 .RS 16n
 109 Determines how diagnostic and informative messages are presented. This includes
 110 the language and style of the messages, and the correct form of affirmative and
 111 negative responses.  In the "C" locale, the messages are presented in the
 112 default form found in the program itself (in most cases, U.S. English).
 113 .RE
 114
 115 .SH ATTRIBUTES
 116 .sp
 117 .LP
 118 See \fBattributes\fR(5) for descriptions of the following attributes:
 119 .sp
 120
 121 .sp
 122 .TS
 123 box;
 124 c | c
 125 l | l .
 126 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 127 CSI     Enabled
 128 .TE
 129
 130 .SH SEE ALSO
 131 .sp
 132 .LP
 133 \fBregcmp\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5)