usr.bin/yacc/yacc.1

   1 .\" Copyright (c) 1989, 1990 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Robert Paul Corbett.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 4. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)yacc.1      5.8 (Berkeley) 5/24/93
  32 .\" $FreeBSD$
  33 .\"     $OpenBSD: yacc.1,v 1.14 2001/05/01 17:58:05 aaron Exp $
  34 .\"
  35 .Dd May 24, 1993
  36 .Dt YACC 1
  37 .Os
  38 .Sh NAME
  39 .Nm yacc
  40 .Nd an LALR(1) parser generator
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl dlrtvy
  44 .Op Fl b Ar file_prefix
  45 .Op Fl o Ar output_filename
  46 .Op Fl p Ar symbol_prefix
  47 .Ar filename
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility reads the grammar specification in the file
  52 .Ar filename
  53 and generates an LR(1) parser for it.
  54 The parsers consist of a set of LALR(1) parsing tables and a driver routine
  55 written in the C programming language.
  56 The
  57 .Nm
  58 utility normally writes the parse tables and the driver routine to the file
  59 .Pa y.tab.c .
  60 .Pp
  61 The following options are available:
  62 .Bl -tag -width indent
  63 .It Fl b Ar file_prefix
  64 Change the prefix prepended to the output file names to
  65 the string denoted by
  66 .Ar file_prefix .
  67 The default prefix is the character
  68 .Pa y .
  69 .It Fl d
  70 Cause the header file
  71 .Pa y.tab.h
  72 to be written.
  73 .It Fl l
  74 If the
  75 .Fl l
  76 option is not specified,
  77 .Nm
  78 will insert #line directives in the generated code.
  79 The #line directives let the C compiler relate errors in the
  80 generated code to the user's original code.
  81 If the
  82 .Fl l
  83 option is specified,
  84 .Nm
  85 will not insert the #line directives.
  86 Any #line directives specified by the user will be retained.
  87 .It Fl o Ar output_filename
  88 Cause
  89 .Nm
  90 to write the generated code to
  91 .Ar output_filename
  92 instead of the default file,
  93 .Pa y.tab.c .
  94 .It Fl p Ar symbol_prefix
  95 Change the prefix prepended to yacc-generated symbols to
  96 the string denoted by
  97 .Ar symbol_prefix .
  98 The default prefix is the string
  99 .Pa yy .
 100 .It Fl r
 101 Cause
 102 .Nm
 103 to produce separate files for code and tables.
 104 The code file
 105 is named
 106 .Pa y.code.c ,
 107 and the tables file is named
 108 .Pa y.tab.c .
 109 .It Fl t
 110 Change the preprocessor directives generated by
 111 .Nm
 112 so that debugging statements will be incorporated in the compiled code.
 113 .It Fl v
 114 Cause a human-readable description of the generated parser to
 115 be written to the file
 116 .Pa y.output .
 117 .It Fl y
 118 NOOP for bison compatibility.
 119 .Nm
 120 is already designed to be POSIX yacc compatible.
 121 .El
 122 .Sh ENVIRONMENT
 123 .Bl -tag -width ".Ev TMPDIR"
 124 .It Ev TMPDIR
 125 Name of directory where temporary files are to be created.
 126 .El
 127 .Sh TABLES
 128 The names of the tables generated by this version of
 129 .Nm
 130 are
 131 .Va yylhs , yylen , yydefred , yydgoto , yysindex ,
 132 .Va yyrindex , yygindex , yytable ,
 133 and
 134 .Va yycheck .
 135 Two additional tables,
 136 .Va yyname
 137 and
 138 .Va yyrule ,
 139 are created if
 140 .Dv YYDEBUG
 141 is defined and non-zero.
 142 .Sh FILES
 143 .Bl -tag -width "Pa /tmp/yacc.aXXXXXXXXXX" -compact
 144 .It Pa y.code.c
 145 .It Pa y.tab.c
 146 .It Pa y.tab.h
 147 .It Pa y.output
 148 .It Pa /tmp/yacc.aXXXXXXXXXX
 149 .It Pa /tmp/yacc.tXXXXXXXXXX
 150 .It Pa /tmp/yacc.uXXXXXXXXXX
 151 .El
 152 .Sh DIAGNOSTICS
 153 If there are rules that are never reduced,
 154 the number of such rules is reported on standard error.
 155 If there are any
 156 .Tn LALR(1)
 157 conflicts,
 158 the number of conflicts is reported on standard error.
 159 .Sh SEE ALSO
 160 .Xr yyfix 1
 161 .Sh STANDARDS
 162 The
 163 .Nm
 164 utility conforms to
 165 .St -p1003.2 .
 166 .Sh HISTORY
 167 A
 168 .Nm
 169 command appeared in PWB UNIX.