external/bsd/flex/dist/doc/flex.1

   1 .\"     $NetBSD$
   2 .\"
   3 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
   4 .TH FLEX "1" "February 2008" "flex 2.5.35" "User Commands"
   5 .SH NAME
   6 flex \- the fast lexical analyser generator
   7 .SH SYNOPSIS
   8 .B flex
   9 [\fIOPTIONS\fR] [\fIFILE\fR]...
  10 .SH DESCRIPTION
  11 Generates programs that perform pattern\-matching on text.
  12 .SS "Table Compression:"
  13 .TP
  14 \fB\-Ca\fR, \fB\-\-align\fR
  15 trade off larger tables for better memory alignment
  16 .TP
  17 \fB\-Ce\fR, \fB\-\-ecs\fR
  18 construct equivalence classes
  19 .TP
  20 \fB\-Cf\fR
  21 do not compress tables; use \fB\-f\fR representation
  22 .TP
  23 \fB\-CF\fR
  24 do not compress tables; use \fB\-F\fR representation
  25 .TP
  26 \fB\-Cm\fR, \fB\-\-meta\-ecs\fR
  27 construct meta\-equivalence classes
  28 .TP
  29 \fB\-Cr\fR, \fB\-\-read\fR
  30 use read() instead of stdio for scanner input
  31 .TP
  32 \fB\-f\fR, \fB\-\-full\fR
  33 generate fast, large scanner. Same as \fB\-Cfr\fR
  34 .TP
  35 \fB\-F\fR, \fB\-\-fast\fR
  36 use alternate table representation. Same as \fB\-CFr\fR
  37 .TP
  38 \fB\-Cem\fR
  39 default compression (same as \fB\-\-ecs\fR \fB\-\-meta\-ecs\fR)
  40 .SS "Debugging:"
  41 .TP
  42 \fB\-d\fR, \fB\-\-debug\fR
  43 enable debug mode in scanner
  44 .TP
  45 \fB\-b\fR, \fB\-\-backup\fR
  46 write backing\-up information to lex.backup
  47 .TP
  48 \fB\-p\fR, \fB\-\-perf\-report\fR
  49 write performance report to stderr
  50 .TP
  51 \fB\-s\fR, \fB\-\-nodefault\fR
  52 suppress default rule to ECHO unmatched text
  53 .TP
  54 \fB\-T\fR, \fB\-\-trace\fR
  55 flex should run in trace mode
  56 .TP
  57 \fB\-w\fR, \fB\-\-nowarn\fR
  58 do not generate warnings
  59 .TP
  60 \fB\-v\fR, \fB\-\-verbose\fR
  61 write summary of scanner statistics to stdout
  62 .SS "Files:"
  63 .TP
  64 \fB\-o\fR, \fB\-\-outfile\fR=\fIFILE\fR
  65 specify output filename
  66 .TP
  67 \fB\-S\fR, \fB\-\-skel\fR=\fIFILE\fR
  68 specify skeleton file
  69 .TP
  70 \fB\-t\fR, \fB\-\-stdout\fR
  71 write scanner on stdout instead of lex.yy.c
  72 .TP
  73 \fB\-\-yyclass\fR=\fINAME\fR
  74 name of C++ class
  75 .TP
  76 \fB\-\-header\-file\fR=\fIFILE\fR
  77 create a C header file in addition to the scanner
  78 .HP
  79 \fB\-\-tables\-file\fR[=\fIFILE\fR] write tables to FILE
  80 .SS "Scanner behavior:"
  81 .TP
  82 \fB\-7\fR, \fB\-\-7bit\fR
  83 generate 7\-bit scanner
  84 .TP
  85 \fB\-8\fR, \fB\-\-8bit\fR
  86 generate 8\-bit scanner
  87 .TP
  88 \fB\-B\fR, \fB\-\-batch\fR
  89 generate batch scanner (opposite of \fB\-I\fR)
  90 .TP
  91 \fB\-i\fR, \fB\-\-case\-insensitive\fR
  92 ignore case in patterns
  93 .TP
  94 \fB\-l\fR, \fB\-\-lex\-compat\fR
  95 maximal compatibility with original lex
  96 .TP
  97 \fB\-X\fR, \fB\-\-posix\-compat\fR
  98 maximal compatibility with POSIX lex
  99 .TP
 100 \fB\-I\fR, \fB\-\-interactive\fR
 101 generate interactive scanner (opposite of \fB\-B\fR)
 102 .TP
 103 \fB\-\-yylineno\fR
 104 track line count in yylineno
 105 .SS "Generated code:"
 106 .TP
 107 \-+,  \fB\-\-c\fR++
 108 generate C++ scanner class
 109 .TP
 110 \fB\-Dmacro\fR[=\fIdefn\fR]
 111 #define macro defn  (default defn is '1')
 112 .TP
 113 \fB\-L\fR,  \fB\-\-noline\fR
 114 suppress #line directives in scanner
 115 .TP
 116 \fB\-P\fR,  \fB\-\-prefix\fR=\fISTRING\fR
 117 use STRING as prefix instead of "yy"
 118 .TP
 119 \fB\-R\fR,  \fB\-\-reentrant\fR
 120 generate a reentrant C scanner
 121 .TP
 122 \fB\-\-bison\-bridge\fR
 123 scanner for bison pure parser.
 124 .TP
 125 \fB\-\-bison\-locations\fR
 126 include yylloc support.
 127 .TP
 128 \fB\-\-stdinit\fR
 129 initialize yyin/yyout to stdin/stdout
 130 .HP
 131 \fB\-\-noansi\-definitions\fR old\-style function definitions
 132 .TP
 133 \fB\-\-noansi\-prototypes\fR
 134 empty parameter list in prototypes
 135 .TP
 136 \fB\-\-nounistd\fR
 137 do not include <unistd.h>
 138 .TP
 139 \fB\-\-noFUNCTION\fR
 140 do not generate a particular FUNCTION
 141 .SS "Miscellaneous:"
 142 .TP
 143 \fB\-c\fR
 144 do\-nothing POSIX option
 145 .TP
 146 \fB\-n\fR
 147 do\-nothing POSIX option
 148 .HP
 149 \-?
 150 .TP
 151 \fB\-h\fR, \fB\-\-help\fR
 152 produce this help message
 153 .TP
 154 \fB\-V\fR, \fB\-\-version\fR
 155 report flex version
 156 .SH "SEE ALSO"
 157 The full documentation for
 158 .B flex
 159 is maintained as a Texinfo manual.  If the
 160 .B info
 161 and
 162 .B flex
 163 programs are properly installed at your site, the command
 164 .IP
 165 .B info flex
 166 .PP
 167 should give you access to the complete manual.