New version from uunet. Uses mandoc macros.

usr.bin/yacc/yacc.1

@@ -1,110 +1,175 @@
-.\"	$Id: yacc.1,v 1.3 1993/08/02 17:56:53 mycroft Exp $	-*- nroff -*-
-.TH YACC 1 "July\ 15,\ 1990"
-.UC 6
-.SH NAME
-Yacc \- an LALR(1) parser generator
-.SH SYNOPSIS
-.B yacc [ -dlrtv ] [ -b
-.I file_prefix
-.B ] [ -p
-.I symbol_prefix
-.B ]
-.I filename
-.SH DESCRIPTION
-.I Yacc
+.\" Copyright (c) 1989, 1990 The Regents of the University of California.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to Berkeley by
+.\" Robert Paul Corbett.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"	This product includes software developed by the University of
+.\"	California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"	from: @(#)yacc.1	5.7 (Berkeley) 7/30/91
+.\"	$Id: yacc.1,v 1.4 1993/08/06 19:34:17 mycroft Exp $
+.\"
+.Dd July 30, 1991
+.Dt YACC 1
+.Os
+.Sh NAME
+.Nm yacc
+.Nd an
+.Tn LALR(1)
+parser generator
+.Sh SYNOPSIS
+.Nm yacc
+.Op Fl dlrtv
+.Op Fl b Ar prefix
+.Ar filename
+.Sh DESCRIPTION
+.Nm Yacc
 reads the grammar specification in the file
-.I filename
-and generates an LR(1) parser for it.
-The parsers consist of a set of LALR(1) parsing tables and a driver routine
+.Ar filename
+and generates an
+.Tn LR(1)
+parser for it.
+The parsers consist of a set of
+.Tn LALR(1)
+parsing tables and a driver routine
 written in the C programming language.
-.I Yacc
+.Nm Yacc
 normally writes the parse tables and the driver routine to the file
-.IR y.tab.c.
-.PP
+.Pa y.tab.c .
+.Pp
 The following options are available:
-.RS
-.TP
-\fB-b \fIfile_prefix\fR
+.Bl -tag -width Ar
+.It Fl b Ar prefix
 The
-.B -b
+.Fl b
 option changes the prefix prepended to the output file names to
 the string denoted by
-.IR file_prefix.
+.Ar prefix .
 The default prefix is the character
-.IR y.
-.TP
-.B -d
-The \fB-d\fR option causes the header file
-.IR y.tab.h
+.Ar y .
+.It Fl d
+The
+.Fl d
+option causes the header file
+.Pa y.tab.h
 to be written.
-.TP
-.B -l
+.It Fl l
 If the
-.B -l
+.Fl l
 option is not specified,
-.I yacc
+.Nm yacc
 will insert \#line directives in the generated code.
 The \#line directives let the C compiler relate errors in the
 generated code to the user's original code.
-If the \fB-l\fR option is specified,
-.I yacc
+If the
+.Fl l
+option is specified,
+.Nm yacc
 will not insert the \#line directives.
 \&\#line directives specified by the user will be retained.
-.TP
-\fB-p \fIsymbol_prefix\fR
+.It Fl r
 The
-.B -p
-option changes the prefix prepended to yacc-generated symbols to
-the string denoted by
-.IR symbol_prefix.
-The default prefix is the string
-.IR yy.
-.TP
-.B -r
-The
-.B -r
+.Fl r
 option causes
-.I yacc
-to produce separate files for code and tables.  The code file
-is named
-.IR y.code.c,
+.Nm yacc
+to produce separate files for code and tables.
+The code file is named
+.Pa y.code.c ,
 and the tables file is named
-.IR y.tab.c.
-.TP
-.B -t
+.Pa y.tab.c .
+.It Fl t
 The
-.B -t
+.Fl t
 option changes the preprocessor directives generated by
-.I yacc
+.Nm yacc
 so that debugging statements will be incorporated in the compiled code.
-.TP
-.B -v
+.It Fl v
 The
-.B -v
+.Fl v
 option causes a human-readable description of the generated parser to
 be written to the file
-.IR y.output.
-.RE
-.PP
-If the environment variable TMPDIR is set, the string denoted by
-TMPDIR will be used as the name of the directory where the temporary
+.Pa y.output .
+.Pp
+.Sh ENVIRONMENT
+The following environment variable is referenced by
+.Nm yacc :
+.Bl -tag -width TMPDIR
+.It Ev TMPDIR
+If the environment variable
+.Ev TMPDIR
+is set, the string denoted by
+.Ev TMPDIR
+will be used as the name of the directory where the temporary
 files are created.
-.SH FILES
-.IR y.code.c
-.br
-.IR y.tab.c
-.br
-.IR y.tab.h
-.br
-.IR y.output
-.br
-.IR /tmp/yacc.aXXXXXX
-.br
-.IR /tmp/yacc.tXXXXXX
-.br
-.IR /tmp/yacc.uXXXXXX
-.SH DIAGNOSTICS
+.El
+.Sh TABLES
+The names of the tables generated by this version of
+.Nm yacc
+are
+.Dq yylhs ,
+.Dq yylen ,
+.Dq yydefred ,
+.Dq yydgoto ,
+.Dq yysindex ,
+.Dq yyrindex ,
+.Dq yygindex ,
+.Dq yytable ,
+and
+.Dq yycheck .
+Two additional tables,
+.Dq yyname
+and
+.Dq yyrule ,
+are created if
+.Dv YYDEBUG
+is defined and non-zero.
+.Sh FILES
+.Bl -tag -width /tmp/yacc.uXXXXXXXX -compact
+.It Pa y.code.c
+.It Pa y.tab.c
+.It Pa y.tab.h
+.It Pa y.output
+.It Pa /tmp/yacc.aXXXXXX
+.It Pa /tmp/yacc.tXXXXXX
+.It Pa /tmp/yacc.uXXXXXX
+.El
+.Sh DIAGNOSTICS
 If there are rules that are never reduced, the number of such rules is
-reported on standard error.
-If there are any LALR(1) conflicts, the number of conflicts is reported
-on standard error.
+written to the standard error.
+If there are any
+.Tn LALR(1)
+conflicts, the number of conflicts is also written
+to the standard error.
+.Sh SEE ALSO
+.Xr yyfix 1
+.Sh STANDARDS
+The
+.Nm yacc
+utility conforms to
+.St -p1003.2 .