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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- vi:set ts=4: -->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY binary "fauhdlc">
]>
<!--
$Id$
Copyright (C) 2009-2010 FAUmachine Team <info@faumachine.org>.
This program is free software, GPL-2 (or any later version). See COPYING.
-->
<refentry>
<refentryinfo>
<address>
<email><info@faumachine.org></email>
</address>
<corpauthor>FAUmachine Team</corpauthor>
<copyright>
<year>2009-2010</year>
<holder>
FAUmachine Team.
Developed at Friedrich Alexander University
Erlangen-Nuremberg.
</holder>
</copyright>
<legalnotice>
<para>
FAUhdlc comes with ABSOLUTELY NO WARRANTY.
FAUhdlc is free software; you can redistribute
it and/or modify it under the terms of the GNU
General Public License as published by the
Free Software Foundation; either version 2 of
the License, or (at your option) any later
version. See COPYING for details.
</para>
</legalnotice>
</refentryinfo>
<refmeta>
<refentrytitle>FAUHDLC</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>&binary;</refname>
<refpurpose>
Compile VHDL files to intermediate code.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&binary;</command>
<arg>
<option>flags</option>
</arg>
<arg>
<option>
--output
<replaceable>filename</replaceable>
</option>
</arg>
<arg>
<option>
--c-output
<replaceable>filename</replaceable>
</option>
</arg>
<arg rep="repeat">
<option>
--lib
<replaceable>library</replaceable>
</option>
<arg>
<option>
<replaceable>vhdl-file</replaceable>
</option>
</arg>
</arg>
<arg choice="req" rep="repeat">
<option>
<replaceable>vhdl-file</replaceable>
</option>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
<command>&binary;</command> is a VHDL compiler, that
will output intermediate code or C-code.
It supports a subset of the VHDL 2000 standard.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>
These programs follow the usual GNU command line
syntax, with long options starting with two dashes
(`-'). A summary of options is included below.
</para>
<variablelist>
<varlistentry>
<term>
<option>-h</option>,
<option>--help</option>
</term>
<listitem>
<para>Show summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-o</option>,
<option>--output</option>
<replaceable>output-file</replaceable>
</term>
<listitem>
<para>
Output intermediate code into
<replaceable>output-file</replaceable>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-l</option>,
<option>--lib</option>
<replaceable>library-name</replaceable>
</term>
<listitem>
<para>
Put the following VHDL-files into the library
with name <replaceable>library-name</replaceable>.
If no <option>--lib</option> is present, all files
will be put into the library "work".
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-f</option>,
<option>--freestanding</option>
</term>
<listitem>
<para>
Do not preload any library except std.vhdl.
By default, <command>&binary;</command> will preload
common libraries (currently only std_logic_1164) in
the appropriate library namespace.
The <option>--freestanding</option> prevents this
behaviour, for example if you want to override
the implementation of such a library.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-Werror</option>
</term>
<listitem>
<para>
Treat warnings as errors.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-p</option>,
<option>--parse-only</option>
</term>
<listitem>
<para>
Stop with compilation after
parsing the source file(s).
Mainly useful for debugging
the compiler.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-d</option>,
<option>--dot-parse</option>
<replaceable>dot-file</replaceable>
</term>
<listitem>
<para>
Output the raw syntax tree into
<replaceable>dot-file</replaceable>,
which can be used with the GraphViz tools.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-c</option>,
<option>--dot-const</option>
<replaceable>dot-file</replaceable>
</term>
<listitem>
<para>
Output the syntax tree that exists after performing
constant folding into
<replaceable>dot-file</replaceable>,
which can be used with the GraphViz tools.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-C</option>,
<option>--c-output</option>
<replaceable>c-file</replaceable>
</term>
<listitem>
<para>
Generate output as a C file
<replaceable>c-file</replaceable>,
that can be compiled
with a C-compiler, e.g. <command>gcc</command>.
This option is yet experimental.
</para>
<!-- FIXME: Example of compile options for gcc -->
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>fauhdli</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
<refsect1>
<title>CONTACT</title>
<para>
Please report all bugs to FAUmachine Team
<email>info@faumachine.org</email>.
<ulink url="http://www.faumachine.org">FAUmachine/fauhdlc Homepage
</ulink>.
</para>
</refsect1>
</refentry>
|
