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
|
Description: Extend ghdl.1 manpage
Add the Debian specific ghdl wrapper information to the manpage.
Author: Andreas Bombe <aeb@debian.org>
Forwarded: not-needed
Last-Update: 2023-07-09
---
This patch header follows DEP-3: http://dep.debian.net/deps/dep3/
--- a/doc/ghdl.1
+++ b/doc/ghdl.1
@@ -14,13 +14,22 @@
.\" .br insert line break
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
-.TH "GHDL" "1" "Jun 24, 2006" "" ""
+.TH "GHDL" "1" "Jan 14, 2018" "" ""
.SH "NAME"
ghdl \- VHDL compiler/simulator
.SH "SYNOPSIS"
.B ghdl
.RI [ command ] " " [ options ] " files" ...
.br
+.B ghdl-gcc
+.RI [ command ] " " [ options ] " files" ...
+.br
+.B ghdl-llvm
+.RI [ command ] " " [ options ] " files" ...
+.br
+.B ghdl-mcode
+.RI [ command ] " " [ options ] " files" ...
+.br
.SH "DESCRIPTION"
This manual page documents briefly the
.B ghdl
@@ -29,6 +38,17 @@
reference documentation.
.PP
Instead, users should read the GHDL texinfo manual
+.PP
+The Debian package supports installing multiple GHDL backends at the same time.
+The GHDL executable \fBghdl\fR is actually a wrapper that will execute the first
+installed backend it finds in the order mcode, gcc, llvm.
+If you want to run GHDL with a specific backend you can directly run their
+executable, named \fBghdl-mcode\fR, \fBghdl-gcc\fR and \fBghdl-llvm\fR
+respectively.
+Alternatively, you can run \fBghdl\fR with the \fIGHDL_BACKEND\fR environment
+variable set to \fBmcode\fR, \fBgcc\fR or \fBllvm\fR to select a backend.
+If the backend in \fIGHDL_BACKEND\fR is not installed or invalid, the wrapper
+will silently revert to selecting the first installed backend it finds.
.SH "OPTIONS"
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`\-').
|
