source: vendor/FreeBSD-yacc/current/yacc.1@ 3790

Last change on this file since 3790 was 2464, checked in by bird, 20 years ago

FreeBSD CVS 2005-07-07

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