contrib/flex/doc/flex.1

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