Seth Woolley's Man Viewer

bison(1) - bison, bison - GNU Project parser generator (yacc replacement) - man 1 bison

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

BISON(1)                                                              BISON(1)



NAME
       bison - GNU Project parser generator (yacc replacement)

SYNOPSIS
       bison  [  -b  file-prefix  ]  [  --file-prefix=file-prefix  ]  [ -d ] [
       --defines=defines-file ] [ -g  ]  [  --graph=graph-file  ]  [  -k  ]  [
       --token-table  ] [ -l ] [ --no-lines ] [ -n ] [ --no-parser ] [ -o out-
       file(1,n) ] [ --output-file=outfile ] [ -p prefix ] [ --name-prefix=prefix ]
       [  -t  ] [ --debug ] [ -v ] [ --verbose ] [ -V ] [ --version ] [ -y ] [
       --yacc ] [ -h ] [ --help ] [ --fixed-output-files ] file(1,n)
       yacc [ similar options and operands ]

DESCRIPTION
       Bison is a parser generator in(1,8) the style  of  yacc(1).   It  should  be
       upwardly compatible with input files designed for yacc.

       Input  files should follow the yacc convention of ending in(1,8) .y.  Unlike
       yacc, the generated files do not have fixed names, but instead use  the
       prefix of the input file.  Moreover, if(3,n) you need to put C++ code in(1,8) the
       input file(1,n), you can end his name  by  a  C++-like  extension  (.ypp  or
       .y++),  then  bison  will follow your extension to name the output file(1,n)
       (.cpp or  .c++).   For  instance,  a  grammar  description  file(1,n)  named(5,8)
       parse.yxx   would   produce  the  generated  parser  in(1,8)  a  file(1,n)  named(5,8)
       parse.tab.cxx,  instead  of  yacc's  y.tab.c  or  old  Bison  version(1,3,5)'s
       parse.tab.c.

       This  description  of the options that can be given to bison is adapted
       from the node Invocation in(1,8) the bison.texinfo manual, which  should  be
       taken as authoritative.

       Bison supports both traditional single-letter options and mnemonic long
       option names.  Long option names are indicated with --  instead  of  -.
       Abbreviations  for option names are allowed as long as they are unique.
       When a long option takes an argument, like --file-prefix,  connect  the
       option name and the argument with =.

   OPTIONS
       -b file-prefix
       --file-prefix=file-prefix
              Specify  a  prefix  to use for all bison output file(1,n) names.  The
              names are chosen as if(3,n) the input file(1,n) were named(5,8)  file-prefix.c.

       -d
              Write  an extra output file(1,n) containing macro definitions for the
              token type names defined in(1,8) the grammar and the  semantic  value
              type YYSTYPE, as well as a few extern variable declarations.

              If  the  parser  output  file(1,n)  is named(5,8) name.c then this file(1,n) is
              named(5,8) name.h.

              This output file(1,n) is essential if(3,n) you wish to put the  definition
              of  yylex  in(1,8)  a separate source file(1,n), because yylex needs to be
              able to refer to token type codes and the variable yylval.

       --defines=defines-file
              The behavior of --defines is the same than -d option.  The  only
              difference is that it has an optional argument which is the name
              of the output filename.

       -g
              Output a VCG definition of the LALR(1)  grammar  automaton  com-
              puted  by  Bison.  If the grammar file(1,n) is foo.y , the VCG output
              file(1,n) will be foo.vcg.

       --graph=graph-file
              The behavior of --graph is the same than -g  option.   The  only
              difference is that it has an optional argument which is the name
              of the output graph filename.

       -k
       --token-table
              This switch(1,n) causes the name.tab.c output to include  a  list  of
              token  names in(1,8) order by their token numbers; this is defined in(1,8)
              the array yytname.  Also generated are #defines  for  YYNTOKENS,
              YYNNTS, YYNRULES, and YYNSTATES.

       -l
       --no-lines
              Don't  put  any  #line preprocessor commands in(1,8) the parser file.
              Ordinarily bison puts(3,n) them in(1,8) the parser file(1,n) so that the C com-
              piler and debuggers will associate errors with your source file(1,n),
              the grammar file.  This option causes them to  associate  errors
              with  the parser file(1,n), treating it an independent source file(1,n) in(1,8)
              its own right.

       -n
       --no-parser
              Do not generate the parser code into the output;  generate  only
              declarations.  The generated name.tab.c file(1,n) will have only con-
              stant declarations.  In addition, a name.act file(1,n)  is  generated
              containing a switch(1,n) statement body containing all the translated
              actions.

       -o outfile
       --output-file=outfile
              Specify the name outfile for the parser file.

              The other output files' names are constructed  from  outfile  as
              described under the -v and -d switches.

       -p prefix
       --name-prefix=prefix
              Rename  the  external  symbols  used  in(1,8) the parser so that they
              start with prefix instead of yy.  The precise  list  of  symbols
              renamed is yyparse, yylex, yyerror, yylval, yychar, and yydebug.

              For example, if(3,n) you use -p c, the names become cparse, clex, and
              so on.

       -t
       --debug
              In  the  parser file(1,n), define the macro YYDEBUG to 1 if(3,n) it is not
              already defined, so that the debugging facilities are  compiled.

       -v
       --verbose
              Write  an  extra  output file(1,n) containing verbose descriptions of
              the parser states and what is done for each type  of  look-ahead
              token in(1,8) that state.

              This  file(1,n) also describes all the conflicts, both those resolved
              by operator precedence and the unresolved ones.

              The file(1,n)'s name is made by removing .tab.c or .c from the parser
              output file(1,n) name, and adding .output instead.

              Therefore,  if(3,n)  the input file(1,n) is foo.y, then the parser file(1,n) is
              called foo.tab.c by default.  As a consequence, the verbose out-
              put file(1,n) is called foo.output.

       -V
       --version
              Print the version(1,3,5) number of bison and exit.

       -h
       --help Print a summary of the options to bison and exit.

       -y
       --yacc
       --fixed-output-files
              Equivalent  to  -o  y.tab.c;  the  parser  output file(1,n) is called
              y.tab.c, and the other outputs are called y.output and  y.tab.h.
              The purpose of this switch(1,n) is to imitate yacc's output file(1,n) name
              conventions.  Thus, the following shell  script  can  substitute
              for yacc and is often installed as yacc:

              bison -y "$@"


SEE ALSO
       yacc(1)
       The  Bison  Reference Manual, included as the file(1,n) bison.texinfo in(1,8) the
       bison source distribution.

DIAGNOSTICS
       Self explanatory.



                                     local                            BISON(1)

References for this manual (incoming links)