doc/ghdl.1

   1 .\" Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .\" Please adjust this date whenever revising the manpage.
   6 .\"
   7 .\" Some roff macros, for reference:
   8 .\" .nh        disable hyphenation
   9 .\" .hy        enable hyphenation
  10 .\" .ad l      left justify
  11 .\" .ad b      justify to both left and right margins
  12 .\" .nf        disable filling
  13 .\" .fi        enable filling
  14 .\" .br        insert line break
  15 .\" .sp <n>    insert n+1 empty lines
  16 .\" for manpage-specific macros, see man(7)
  17 .TH "GHDL" "1" "Jun 24, 2006" "" ""
  18 .SH "NAME"
  19 ghdl \- VHDL compiler/simulator
  20 .SH "SYNOPSIS"
  21 .B ghdl
  22 .RI [ command ] " " [ options ] " files" ...
  23 .br
  24 .SH "DESCRIPTION"
  25 This manual page documents briefly the
  26 .B ghdl
  27 command.
  28 This manual page was written for user of man, but is not as complete as the
  29 reference documentation.
  30 .PP
  31 Instead, users should read the GHDL texinfo manual
  32 .SH "OPTIONS"
  33 This program follows the usual GNU command line syntax, with long
  34 options starting with two dashes (`\-').
  35 A summary of the main modes and options is included below.
  36 For a complete description, refer to the GHDL texinfo manual.
  37 .PP
  38 Basic commands:
  39 .TP
  40 .B \-a
  41 Analysis, i.e. \fIghdl \-a file.vhdl\fP
  42 .TP
  43 .B \-e
  44 Elabortation, i.e. \fIghdl \-e unit_name\fP
  45 .TP
  46 .B \-r
  47 Run: run the simulation, i.e. \fIghdl \-r unit_name\fP
  48 .TP
  49 .B \-s
  50 Syntax\-check, i.e. \fIghdl \-s file.vhdl\fP
  51 .TP
  52 .B \-\-clean
  53 Clean: remove generated files, i.e. \fIghdl \-\-clean\fP
  54 .TP
  55 .B \-h, \-\-help
  56 Help, i.e. \fIghdl \-\-help\fP
  57 .TP
  58 .B \-\-version
  59 Version, i.e. \fIghdl \-\-version\fP
  60 .PP
  61 Basic options:
  62 .TP
  63 .B \-\-work=NAME
  64 Name of the WORK library, i.e. \fI ghdl \-a \-\-work=foo foo.vhdl\fP
  65 .TP
  66 .B \-\-std=STD
  67 Which VHDL standard (87|93|93c|00|02), i.e. \fIghdl \-a \-\-std=87 old.vhdl\fP
  68 .TP
  69 .B \-\-ieee=VER
  70 Which IEEE library (none|standard|synopsys|mentor), i.e. \fIghdl \-a \-\-ieee=synopsys broken.vhdl\fP
  71 .TP
  72 .B \-\-no\-vital\-checks
  73 Disable VITAL restriction checking, i.e. \fIghdl \-a \-\-no\-vital\-checks unsupported_vital.vhdl\fP
  74 .PP
  75 There are many more modes and options;
  76 please consult the documentation.
  77 .PP
  78 Executables created by GHDL have addition simulation options. The
  79 most important ones are listed below:
  80 .TP
  81 .B \-\-help
  82 Show options for simulation and execution.
  83 .TP
  84 .B \-\-assert\-level=LEVEL
  85 Assert level at which to stop simulation (none|note|warning|error|failure), i.e. \fI./touchy_design \-\-assert\-level=note\fB
  86 .TP
  87 .B \-\-stop\-time=TIME
  88 Stop simuation after TIME, i.e. \fI./design \-\-stop\-time=50ns
  89 .TP
  90 .B \-\-vcd=FILENAME
  91 Dump VCD to FILENAME (a waveform dump, viewable with\-\-for instance\-\-\fBgtkwave\fP), i.e. \fI./design \-\-vcd=design.vcd
  92 .TP
  93 .B \-\-sdf=[TYPE=]PATH=FILENAME
  94 Back annotate SDF onto design using TYPE (min|typ|max), instance PATH, and SDF file FILENAME, i.e. \fI./sdf_design \-\-sdf=typ=top/inst=inst.sdf\fP
  95
  96 .SH "SEE ALSO"
  97 .BR gtkwave (1)
  98 .PP
  99 The texinfo manual fully documents GHDL. You may also browse it at
 100 \fB<https://ghdl.github.io/ghdl/>\fP.
 101 .SH "AUTHOR"
 102 This manual page was written by Wesley J. Landaker
 103 <wjl@icecavern.net>, for the Debian project (but may be used by
 104 others). It is released under the same terms as GHDL, i.e. the GNU
 105 General Public License. It was modified by Tristan Gingold to include
 106 it in the GHDL sources.