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
|
.. program:: ghdl
.. _REF:Command:
Additional Command Reference
############################
.. HINT:: The most common commands and options are shown in section :ref:`USING:Invoking`. Here the advanced and experimental features are described.
Environment variables
=====================
.. envvar:: GHDL_PREFIX
Misc commands
=============
There are a few GHDL commands which are seldom useful.
.. index:: cmd help
Help [``-h``]
-----------------
.. option:: --help, -h
Display (on the standard output) a short description of the all the commands
available. If the help switch is followed by a command switch, then options
for that second command are displayed::
ghdl --help
ghdl -h
ghdl -h command
.. index:: cmd display configuration
Display config [``--disp-config``]
--------------------------------------
.. option:: --disp-config <[options]>
Display the program paths and options used by GHDL. This may be useful to track installation errors.
.. index:: cmd display standard
.. index:: display ``std.standard``
Display standard [``--disp-standard``]
------------------------------------------
.. option:: --disp-standard <[options]>
Display the ``std.standard`` package.
.. index:: cmd version
Version [``--version``]
---------------------------
.. option:: --version, -v
Display the GHDL version.
File commands
=============
The following commands act on one or several files. These are not analyzed, therefore, they work even if a file has semantic errors.
.. index:: cmd file pretty printing
.. index:: vhdl to html
Pretty print [``--pp-html``]
--------------------------------
.. option:: --pp-html <[options] file...>
The files are just scanned and an html file with syntax highlighting is generated on standard output. Since the files
are not even parsed, erroneous files or incomplete designs can be pretty printed. The style of the html file can be
modified with the :option:`--format` option.
.. index:: cmd file find
Find [``-f``]
-----------------
.. option:: -f <file...>
The files are scanned, parsed and the names of design units are displayed. Design units marked with two stars are candidates to be at the apex of a design hierarchy.
.. index:: cmd file chop
Chop [``--chop``]
---------------------
.. option:: --chop <files...>
The provided files are read, and a file is written in the current directory for every design unit. Each filename is built according to the type:
* For an entity declaration, a package declaration, or a configuration the file name is :file:`NAME.vhdl`, where `NAME` is the name of the design unit.
* For a package body, the filename is :file:`NAME-body.vhdl`.
* Finally, for an architecture `ARCH` of an entity `ENTITY`, the filename is :file:`ENTITY-ARCH.vhdl`.
Since the input files are parsed, this command aborts in case of syntax error. The command aborts too if a file to be written already exists.
Comments between design units are stored into the most adequate files.
This command may be useful to split big files, if your computer doesn't have enough memory to compile such files. The size of the executable is reduced too.
.. index:: cmd file lines
Lines [``--lines``]
-----------------------
.. option:: --lines <files...>
Display on the standard output lines of files preceded by line number.
.. _gccllvm-only-programs:
GCC/LLVM only commands
======================
.. index:: cmd GCC/LLVM binding
Bind [``--bind``]
---------------------
.. option:: --bind <[options] primary_unit [secondary_unit]>
Performs only the first stage of the elaboration command; the list of object files is created but the executable is not built. This command should be used only when the main entry point is not GHDL.
.. HINT::
Currently, the objects generated by :option:`--bind` are created in the working directory. This behaviour is different from other object files generated with :option:`-a`, which are always placed in the same directory as the `WORK` library. It is possible to provide an output path with ``ghdl --bind -o path/primary_unit primary_unit``. However, ``ghdl --list-link`` will only search in the current path.
.. index:: cmd GCC/LLVM linking
Link [``--link``]
---------------------
.. option:: --link <[options] primary_unit [secondary_unit]>
Performs only the second stage of the elaboration command: the executable is created by linking the files of the object files list. This command is available only for completeness. The elaboration command is equivalent to the bind command followed by the link command.
.. index:: cmd GCC/LLVM list link
List link [``--list-link``]
---------------------------
.. option:: --list-link <primary_unit [secondary_unit]>
This command may be used only after a bind command. GHDL displays all the files which will be linked to create an executable and additional arguments for the linker. This command is intended to add object files in a link of a foreign program. This command should be used only after ``ghdl --bind``, as some files generated by it are looked for in the current path.
.. HINT::
One of the arguments returned by ``--list-link`` is ``-Wl,--version-script=PREFIX/lib/ghdl/grt.ver``, where `PREFIX` is the installation path of GHDL. This will hide most of the symbols when the target executable binary is built. In some contexts, where the binary is to be loaded dynamically, the user might want additional symbols to be accessible. There are two possible approaches to have it done:
* Filter the output of ``--list-link`` with e.g. ``sed``.
* Provide an additional non-anonymous version script: ``-Wl,-Wl,--version-script=file.ver``.
.. index:: cmd XML generation
XML tree generation [``--file-to-xml``]
---------------------------------------
.. option:: --file-to-xml
Outputs an XML representation of the decorated syntax tree for the input file and its dependencies. It can be used for VHDL tooling using semantic information, like style checkers, documentation extraction, complexity estimation, etc.
.. WARNING::
* The AST slightly changes from time to time (particularly when new nodes are added for new language features), so be liberal in what is allowed by your tool. Also, the XML can be quite large so consider it only during prototyping.
* Note that at this time there is no XML dump of the elaborated design.
Options
=======
.. option:: --GHDL1<=COMMAND>
Use ``COMMAND`` as the command name for the compiler. If ``COMMAND`` is not a path, then it is searched in the path.
.. option:: --AS<=COMMAND>
Use ``COMMAND`` as the command name for the assembler. If ``COMMAND`` is not a path, then it is searched in the path. The default is ``as``.
.. option:: --LINK<=COMMAND>
Use ``COMMAND`` as the linker driver. If ``COMMAND`` is not a path, then it is searched in the path. The default is ``gcc``.
.. _passing-options-to-other-programs:
Passing options to other programs
=================================
.. WARNING:: These options are only available with GCC/LLVM.
For many commands, GHDL acts as a driver: it invokes programs to perform the command. You can pass arbitrary options to these programs.
Both the compiler and the linker are in fact GCC programs. See the GCC manual for details on GCC options.
.. option:: -Wc,<OPTION>
Pass `OPTION` as an option to the compiler.
.. option:: -Wa,<OPTION>
Pass `OPTION` as an option to the assembler.
.. option:: -Wl,<OPTION>
Pass `OPTION` as an option to the linker.
|
