summaryrefslogtreecommitdiff
path: root/web/yacco2/bin/man/man1/yacco2.man
blob: c1905e8dc80d97cfc991c22c482b596eee3fe1d4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
./#=========
.TH yacco2 1 "" "1.0"
./#=========
.SH NAME
yacco2 \(em multi-threaded lr1(1) translation system.

./"========
.SH DESCRIPTION
.B yacco2
is a complete translation system to create compilers/translators.
It is written using "Literate programming" genre that generates
c++ code and companion pdf documents (see CWEB reference below).
Grammars are written in a dialect of a deterministc grammar with  ``literate programming'' directives.
Thus providing the generation duality of c++ code  and its pdf document.
Also the emitted lr(1) parsing tables per grammar have their own lookahead sets documented as a pdf.

.PP
.SH " 4 parts of yacco2 system"
1) 
.I yacco2 
.RS
.nf 
API parse library that your compiler/translator links to
Found in /usr/local/yacco2/library/lib/Release/
.fi
.RE

2) 
.I o2
.RS
.nf 
compiler/compiler program to compile your grammars or to generate their c++/documentation
Found in /usr/local/yacco2/bin
.fi
.RE

 3)
.I o2linker
.RS
.nf 
grammars linker to create ``thread bit'' map, and a grammars summary document
Found in /usr/local/yacco2/bin
.fi
.RE

4) document generator
.RS
.nf
``Literate grammar'' documents (see CWEB reference below)
.fi
.RE

./"========
.SH "SEE ALSO by man"
.BR o2(1), 
.BR o2linker(1), 
.BR TeX(1),
.BR CWEB(1),
.BR cweave(1),
.BR ctangle(1),
.BR mpost(1)
.PP
In 
.B /usr/local/yacco2/docs/ 
.RS
.nf
wlibrary.pdf \(em yacco2's library documented ``literate program'' 
o2.pdf \(em compiler/compiler documented ``literate program'' 
o2linker.pdf \(em documented ``literate program'' 
yacco2's grammars's pdfes
o2linker_doc.pdf \(em example of o2/o2linker's grammars cross reference produced by o2linker 
o2book.pdf \(em reference manual 
.fi
.RE

In 
.B /usr/local/yacco2/
.RS
.nf
READMEvx.y.pdf \(em installation guide. A must read where v: version number, y: minor adjustment number.
.fi
.RE

./"=========
.SH "OTHER LINKS"
.TP
.B www.tug.org
\(em website to download the 
.B CWEB 
``Literate programming'' system, 
.I mpost
Metapost graphics program, and
.B TeX
typesetting system if not already on your system. These are open source. Please consider joining
.B
Tug. 


./"=========
.SH AUTHOR
Dave Bone