]> git.saurik.com Git - bison.git/blobdiff - doc/bison.1
Use git-version-gen for version names between releases.
[bison.git] / doc / bison.1
diff --git a/doc/bison.1 b/doc/bison.1
deleted file mode 100644 (file)
index 2d13b4c..0000000
+++ /dev/null
@@ -1,199 +0,0 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
-.TH BISON "1" "July 2008" "bison 2.3b+" "User Commands"
-.SH NAME
-bison \- GNU Project parser generator (yacc replacement)
-.SH SYNOPSIS
-.B bison
-[\fIOPTION\fR]... \fIFILE\fR
-.SH DESCRIPTION
-.I Bison
-is a parser generator in the style of
-.IR yacc (1).
-It should be upwardly compatible with input files designed
-for
-.IR yacc .
-.PP
-Input files should follow the
-.I yacc
-convention of ending in
-.BR .y .
-Unlike
-.IR yacc ,
-the generated files do not have fixed names, but instead use the prefix
-of the input file.
-Moreover, if you need to put
-.I C++
-code in the input file, you can end his name by a C++-like extension
-(.ypp or .y++), then bison will follow your extension to name the
-output file (.cpp or .c++).
-For instance, a grammar description file named
-.B parse.yxx
-would produce the generated parser in a file named
-.BR parse.tab.cxx ,
-instead of
-.IR yacc 's
-.B y.tab.c
-or old
-.I Bison
-version's
-.BR parse.tab.c .
-.PP
-This description of the options that can be given to
-.I bison
-is adapted from the node
-.B Invocation
-in the
-.B bison.texinfo
-manual, which should be taken as authoritative.
-.PP
-.I Bison
-supports both traditional single-letter options and mnemonic long
-option names.  Long option names are indicated with
-.B \-\-
-instead of
-.BR \- .
-Abbreviations for option names are allowed as long as they
-are unique.  When a long option takes an argument, like
-.BR \-\-file-prefix ,
-connect the option name and the argument with
-.BR = .
-.PP
-Generate LALR(1) and GLR parsers.
-.PP
-Mandatory arguments to long options are mandatory for short options too.
-The same is true for optional arguments.
-.SS "Operation modes:"
-.TP
-\fB\-h\fR, \fB\-\-help\fR
-display this help and exit
-.TP
-\fB\-V\fR, \fB\-\-version\fR
-output version information and exit
-.TP
-\fB\-\-print\-localedir\fR
-output directory containing locale\-dependent data
-.TP
-\fB\-\-print\-datadir\fR
-output directory containing skeletons and XSLT
-.TP
-\fB\-y\fR, \fB\-\-yacc\fR
-emulate POSIX Yacc
-.TP
-\fB\-W\fR, \fB\-\-warnings\fR=\fI[CATEGORY]\fR
-report the warnings falling in CATEGORY
-.SS "Parser:"
-.TP
-\fB\-L\fR, \fB\-\-language\fR=\fILANGUAGE\fR
-specify the output programming language
-.TP
-\fB\-S\fR, \fB\-\-skeleton\fR=\fIFILE\fR
-specify the skeleton to use
-.TP
-\fB\-t\fR, \fB\-\-debug\fR
-instrument the parser for debugging
-.TP
-\fB\-\-locations\fR
-enable locations computation
-.TP
-\fB\-p\fR, \fB\-\-name\-prefix\fR=\fIPREFIX\fR
-prepend PREFIX to the external symbols
-.TP
-\fB\-l\fR, \fB\-\-no\-lines\fR
-don't generate `#line' directives
-.TP
-\fB\-k\fR, \fB\-\-token\-table\fR
-include a table of token names
-.SS "Output:"
-.TP
-\fB\-\-defines\fR[=\fIFILE\fR]
-also produce a header file
-.TP
-\fB\-d\fR
-likewise but cannot specify FILE (for POSIX Yacc)
-.TP
-\fB\-r\fR, \fB\-\-report\fR=\fITHINGS\fR
-also produce details on the automaton
-.TP
-\fB\-\-report\-file\fR=\fIFILE\fR
-write report to FILE
-.TP
-\fB\-v\fR, \fB\-\-verbose\fR
-same as `\-\-report=state'
-.TP
-\fB\-b\fR, \fB\-\-file\-prefix\fR=\fIPREFIX\fR
-specify a PREFIX for output files
-.TP
-\fB\-o\fR, \fB\-\-output\fR=\fIFILE\fR
-leave output to FILE
-.TP
-\fB\-g\fR, \fB\-\-graph\fR[=\fIFILE\fR]
-also output a graph of the automaton
-.TP
-\fB\-x\fR, \fB\-\-xml\fR[=\fIFILE\fR]
-also output an XML report of the automaton
-(the XML schema is experimental)
-.SS "Warning categories include:"
-.TP
-`midrule\-values'
-unset or unused midrule values
-.TP
-`yacc'
-incompatibilities with POSIX YACC
-.TP
-`all'
-all the warnings
-.TP
-`no\-CATEGORY'
-turn off warnings in CATEGORY
-.TP
-`none'
-turn off all the warnings
-.TP
-`error'
-treat warnings as errors
-.SS "THINGS is a list of comma separated words that can include:"
-.TP
-`state'
-describe the states
-.TP
-`itemset'
-complete the core item sets with their closure
-.TP
-`lookahead'
-explicitly associate lookahead tokens to items
-.TP
-`solved'
-describe shift/reduce conflicts solving
-.TP
-`all'
-include all the above information
-.TP
-`none'
-disable the report
-.SH AUTHOR
-Written by Robert Corbett and Richard Stallman.
-.SH "REPORTING BUGS"
-Report bugs to <bug\-bison@gnu.org>.
-.PP
-Id
-.SH COPYRIGHT
-Copyright \(co 2008 Free Software Foundation, Inc.
-.br
-This is free software; see the source for copying conditions.  There is NO
-warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-.SH "SEE ALSO"
-.BR lex (1),
-.BR flex (1),
-.BR yacc (1).
-.PP
-The full documentation for
-.B bison
-is maintained as a Texinfo manual.  If the
-.B info
-and
-.B bison
-programs are properly installed at your site, the command
-.IP
-.B info bison
-.PP
-should give you access to the complete manual.