luke
/
iverilog
mirror of https://github.com/steveicarus/iverilog.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update man page.

This commit is contained in:
Martin Whitaker 2019-10-21 15:33:39 +01:00
parent 8d3e895593
commit 1c7f7aedbe
1 changed files with 29 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
driver/iverilog.man.in
View File

@ -1,4 +1,4 @@
.TH iverilog 1 "Oct 5th, 2019" "" "Version %M.%n%E" .TH iverilog 1 "Oct 21st, 2019" "" "Version %M.%n%E"
.SH NAME .SH NAME
iverilog - Icarus Verilog compiler iverilog - Icarus Verilog compiler
@ -7,8 +7,9 @@ iverilog - Icarus Verilog compiler
[\-EiSuVv] [\-Bpath] [\-ccmdfile|\-fcmdfile] [\-Dmacro[=defn]] [\-EiSuVv] [\-Bpath] [\-ccmdfile|\-fcmdfile] [\-Dmacro[=defn]]
[\-Pparameter=value] [\-pflag=value] [\-dname] [\-Pparameter=value] [\-pflag=value] [\-dname]
[\-g1995\:|\-g2001\:|\-g2005\:|\-g2005-sv\:|\-g2009\:|\-g2012\:|\-g<feature>] [\-g1995\:|\-g2001\:|\-g2005\:|\-g2005-sv\:|\-g2009\:|\-g2012\:|\-g<feature>]
[\-Iincludedir] [\-mmodule] [\-M[mode=]file] [\-Nfile] [\-ooutputfilename] [\-Iincludedir] [\-Lmoduledir] [\-mmodule] [\-M[mode=]file] [\-Nfile]
[\-stopmodule] [\-ttype] [\-Tmin/typ/max] [\-Wclass] [\-ypath] [\-lfile] [\-ooutputfilename] [\-stopmodule] [\-ttype] [\-Tmin/typ/max] [\-Wclass]
[\-ypath] [\-lfile]
sourcefile sourcefile
.SH DESCRIPTION .SH DESCRIPTION
@ -164,6 +165,12 @@ over that instantiation. It will also stop the compiler returning an
error if there are no top level modules. This allows the compiler to be error if there are no top level modules. This allows the compiler to be
used to check incomplete designs for errors. used to check incomplete designs for errors.
.TP 8 .TP 8
.B -L\fIpath\fP
This flag adds a directory to the path list used to locate VPI
modules. The default path includes only the install directory for the
system.vpi module, but this flag can add other directories. Multiple
paths are allowed, and the paths will be searched in order.
.TP 8
.B -l\fIfile\fP .B -l\fIfile\fP
Add the specified file to the list of source files to be compiled, Add the specified file to the list of source files to be compiled,
but mark it as a library file. All modules contained within that but mark it as a library file. All modules contained within that
@ -191,12 +198,12 @@ prefixed by "I " and other files are prefixed by "M ".
Add this module to the list of VPI modules to be loaded by the Add this module to the list of VPI modules to be loaded by the
simulation. Many modules can be specified, and all will be loaded, in simulation. Many modules can be specified, and all will be loaded, in
the order specified. The system module is implicit and always included the order specified. The system module is implicit and always included
(and loaded last). If a System Function Table file (<module>.sft) (and loaded last).
exists for the module it will be loaded automatically.
If the specified name includes at least one directory character, it is If the specified name includes at least one directory character, it is
assumed to be prefixed by the path to the module, otherwise the module assumed to be prefixed by the path to the module, otherwise the module
is assumed to be located in the \fIiverilog\fP base directory. is searched for in the paths specified by preceding \fB-L\fP options,
and if not found there, in the \fIiverilog\fP base directory.
.TP 8 .TP 8
.B -N\fIpath\fP .B -N\fIpath\fP
This is used for debugging the compiler proper. Dump the final netlist This is used for debugging the compiler proper. Dump the final netlist
@ -406,13 +413,23 @@ sensitivity list. Although this behaviour is prescribed by the IEEE
standard, it is not what might be expected and can have performance standard, it is not what might be expected and can have performance
implications if the array is large. implications if the array is large.
.SH "SYSTEM FUNCTION TABLE FILES" .SH "VPI MODULES"
If the source file name as a \fB.sft\fP suffix, then it is taken to be If the source file name has a \fB.vpi\fP or \fB.vpl\fP suffix, then it
a system function table file. A System function table file is used to is taken to be a VPI module. VPI modules supplied by the user are scanned
describe to the compiler the return types for system functions. This to determine the return types of any system functions they provide. This
is necessary because the compiler needs this information to elaborate is necessary because the compiler needs this information to elaborate
expressions that contain these system functions, but cannot run the expressions that contain these system functions. The module path/name is
sizetf functions since it has no run-time. passed on to the target to allow the VPI module to be automatically loaded
at the start of simulation.
VPI modules may also be supplied using the \fB-L\fP and \fB-m\fP options.
.SH "SYSTEM FUNCTION TABLE FILES [deprecated]"
If the source file name has a \fB.sft\fP suffix, then it is taken to be a
system function table file. A system function table file is the old method
used to describe to the compiler the return types for system functions.
Users are encouraged to switch to the new method of simply supplying the
VPI module.
The format of the table is ASCII, one function per line. Empty lines The format of the table is ASCII, one function per line. Empty lines
are ignored, and lines that start with the '\fI#\fP' character are are ignored, and lines that start with the '\fI#\fP' character are