summaryrefslogtreecommitdiff
path: root/doc/flex.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/flex.1')
-rw-r--r--doc/flex.1163
1 files changed, 163 insertions, 0 deletions
diff --git a/doc/flex.1 b/doc/flex.1
new file mode 100644
index 0000000..a1cd269
--- /dev/null
+++ b/doc/flex.1
@@ -0,0 +1,163 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
+.TH FLEX "1" "May 2017" "The Flex Project" "Programming"
+.SH NAME
+flex \- the fast lexical analyser generator
+.SH SYNOPSIS
+.B flex
+[\fI\,OPTIONS\/\fR] [\fI\,FILE\/\fR]...
+.SH DESCRIPTION
+Generates programs that perform pattern\-matching on text.
+.SS "Table Compression:"
+.TP
+\fB\-Ca\fR, \fB\-\-align\fR
+trade off larger tables for better memory alignment
+.TP
+\fB\-Ce\fR, \fB\-\-ecs\fR
+construct equivalence classes
+.TP
+\fB\-Cf\fR
+do not compress tables; use \fB\-f\fR representation
+.TP
+\fB\-CF\fR
+do not compress tables; use \fB\-F\fR representation
+.TP
+\fB\-Cm\fR, \fB\-\-meta\-ecs\fR
+construct meta\-equivalence classes
+.TP
+\fB\-Cr\fR, \fB\-\-read\fR
+use read() instead of stdio for scanner input
+.TP
+\fB\-f\fR, \fB\-\-full\fR
+generate fast, large scanner. Same as \fB\-Cfr\fR
+.TP
+\fB\-F\fR, \fB\-\-fast\fR
+use alternate table representation. Same as \fB\-CFr\fR
+.TP
+\fB\-Cem\fR
+default compression (same as \fB\-\-ecs\fR \fB\-\-meta\-ecs\fR)
+.SS "Debugging:"
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+enable debug mode in scanner
+.TP
+\fB\-b\fR, \fB\-\-backup\fR
+write backing\-up information to lex.backup
+.TP
+\fB\-p\fR, \fB\-\-perf\-report\fR
+write performance report to stderr
+.TP
+\fB\-s\fR, \fB\-\-nodefault\fR
+suppress default rule to ECHO unmatched text
+.TP
+\fB\-T\fR, \fB\-\-trace\fR
+flex should run in trace mode
+.TP
+\fB\-w\fR, \fB\-\-nowarn\fR
+do not generate warnings
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+write summary of scanner statistics to stdout
+.TP
+\fB\-\-hex\fR
+use hexadecimal numbers instead of octal in debug outputs
+.SH FILES
+.TP
+\fB\-o\fR, \fB\-\-outfile\fR=\fI\,FILE\/\fR
+specify output filename
+.TP
+\fB\-S\fR, \fB\-\-skel\fR=\fI\,FILE\/\fR
+specify skeleton file
+.TP
+\fB\-t\fR, \fB\-\-stdout\fR
+write scanner on stdout instead of lex.yy.c
+.TP
+\fB\-\-yyclass\fR=\fI\,NAME\/\fR
+name of C++ class
+.TP
+\fB\-\-header\-file\fR=\fI\,FILE\/\fR
+create a C header file in addition to the scanner
+.HP
+\fB\-\-tables\-file\fR[=\fI\,FILE\/\fR] write tables to FILE
+.SS "Scanner behavior:"
+.TP
+\fB\-7\fR, \fB\-\-7bit\fR
+generate 7\-bit scanner
+.TP
+\fB\-8\fR, \fB\-\-8bit\fR
+generate 8\-bit scanner
+.TP
+\fB\-B\fR, \fB\-\-batch\fR
+generate batch scanner (opposite of \fB\-I\fR)
+.TP
+\fB\-i\fR, \fB\-\-case\-insensitive\fR
+ignore case in patterns
+.TP
+\fB\-l\fR, \fB\-\-lex\-compat\fR
+maximal compatibility with original lex
+.TP
+\fB\-X\fR, \fB\-\-posix\-compat\fR
+maximal compatibility with POSIX lex
+.TP
+\fB\-I\fR, \fB\-\-interactive\fR
+generate interactive scanner (opposite of \fB\-B\fR)
+.TP
+\fB\-\-yylineno\fR
+track line count in yylineno
+.SS "Generated code:"
+.TP
+\-+, \fB\-\-c\fR++
+generate C++ scanner class
+.TP
+\fB\-Dmacro\fR[=\fI\,defn\/\fR]
+#define macro defn (default defn is '1')
+.TP
+\fB\-L\fR, \fB\-\-noline\fR
+suppress #line directives in scanner
+.TP
+\fB\-P\fR, \fB\-\-prefix\fR=\fI\,STRING\/\fR
+use STRING as prefix instead of "yy"
+.TP
+\fB\-R\fR, \fB\-\-reentrant\fR
+generate a reentrant C scanner
+.TP
+\fB\-\-bison\-bridge\fR
+scanner for bison pure parser.
+.TP
+\fB\-\-bison\-locations\fR
+include yylloc support.
+.TP
+\fB\-\-stdinit\fR
+initialize yyin/yyout to stdin/stdout
+.TP
+\fB\-\-nounistd\fR
+do not include <unistd.h>
+.TP
+\fB\-\-noFUNCTION\fR
+do not generate a particular FUNCTION
+.SS "Miscellaneous:"
+.TP
+\fB\-c\fR
+do\-nothing POSIX option
+.TP
+\fB\-n\fR
+do\-nothing POSIX option
+.HP
+\-?
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+produce this help message
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+report flex version
+.SH "SEE ALSO"
+The full documentation for
+.B flex
+is maintained as a Texinfo manual. If the
+.B info
+and
+.B flex
+programs are properly installed at your site, the command
+.IP
+.B info flex
+.PP
+should give you access to the complete manual.