vhier(1) - f37

1VHIER(1)              User Contributed Perl Documentation             VHIER(1)
2
3
4

NAME

6       vhier - Return all files in a verilog hierarchy using Verilog::Netlist
7

SYNOPSIS

9         vhier --help
10         vhier [verilog_options] [-o filename] [verilog_files.v...]
11

DESCRIPTION

13       Vhier reads the Verilog files passed on the command line and outputs a
14       tree of all of the filenames, modules, and cells referenced by that
15       file.
16

VERILOG ARGUMENTS

18       The following arguments are compatible with GCC, VCS and most Verilog
19       programs.
20
21       +define+var+value =item -Dvar=value
22           Defines the given preprocessor symbol.
23
24       -F file
25           Read the specified file, and act as if all text inside it was
26           specified as command line parameters.  Any relative paths are
27           relative to the directory containing the specified file.
28
29       -f file
30           Read the specified file, and act as if all text inside it was
31           specified as command line parameters.  Any relative paths are
32           relative to the current directory.
33
34       +incdir+dir =item -Idir
35           Add the directory to the list of directories that should be
36           searched for include directories or libraries.
37
38       +libext+ext+ext...
39           Specify the extensions that should be used for finding modules.  If
40           for example module x is referenced, look in x.ext.
41
42       -sv Specifies SystemVerilog language features should be enabled;
43           equivalent to "--language 1800-2017".  This option is selected by
44           default, it exists for compatibility with other simulators.
45
46       -y dir
47           Add the directory to the list of directories that should be
48           searched for include directories or libraries.
49

VHIER ARGUMENTS

51       --help
52           Displays this message and program version and exits.
53
54       --o file
55           Use the given filename for output instead of stdout.
56
57       --cells
58           Show the module name of all cells in top-down order.
59
60       --forest
61           Show "ASCII-art" hierarchy tree of all cells (like ps --forest)
62
63       --input-files
64           Show all input filenames.  Copying all of these files should result
65           in only those files needed to represent the entire design.
66
67       --includes
68           Show each source filename that includes another filename.  The
69           included filename will be as specified in the original source
70           filename, so it may be necessary to resolve it into an absolute
71           path for further processing.
72
73       --instance
74           With --cells or --forest, show module instance names.
75
76       --language
77       <1364-1995|1364-2001|1364-2005|1800-2005|1800-2009|1800-2012|1800-2017>
78           Set the language standard for the files.  This determines which
79           tokens are signals versus keywords, such as the ever-common "do"
80           (data-out signal, versus a do-while loop keyword).
81
82       --resolve-files
83           Show resolved filenames passed on the command line.  This will
84           convert raw module and filenames without paths to include the
85           library search path directory.  Output filenames will be in the
86           same order as passed on the command line.  Unlike --input-files or
87           --module-files, hierarchy is not traversed.
88
89       --module-files
90           Show all module filenames in top-down order.  Child modules will
91           always appear as low as possible, so that reversing the list will
92           allow bottom-up processing of modules.  Unlike input-files, header
93           files are not included.
94
95       --modules
96           Show all module names.
97
98       --no-missing
99           Do not complain about references to missing modules.
100
101       --missing-modules
102           With --nomissing, show all modules that are not found.
103
104       --skiplist file
105           Given file contains a list of regular expressions, one per line. If
106           a module name in the design hierarchy matches one of these
107           expressions, skip showing that module and any sub-hierarchy.
108
109       --synthesis
110           Define SYNTHESIS, and ignore text between "ambit", "pragma",
111           "synopsys" or "synthesis" translate_off and translate_on meta
112           comments.  Note using metacomments is discouraged as they have led
113           to silicon bugs (versus ifdef SYNTHESIS); see
114           <https://www.veripool.org/papers/TenIPEdits_SNUGBos07_paper.pdf>.
115
116       --top-module module
117           Start the report at the specified module name, ignoring all modules
118           that are not the one specified with --top-module or below, and
119           report an error if the --top-module specified does not exist.
120           Without this option vhier will report all modules, starting at the
121           module(s) that have no children below them.
122
123           Note this option will not change the result of the --input-files
124           list, as the files needed to parse any design are independent of
125           which modules are used.
126
127       --version
128           Displays program version and exits.
129
130       --xml
131           Create output in XML format.
132

DISTRIBUTION

134       Verilog-Perl is part of the <https://www.veripool.org/> free Verilog
135       EDA software tool suite.  The latest version is available from CPAN and
136       from <https://www.veripool.org/verilog-perl>.
137
138       Copyright 2005-2022 by Wilson Snyder.  This package is free software;
139       you can redistribute it and/or modify it under the terms of either the
140       GNU Lesser General Public License Version 3 or the Perl Artistic
141       License Version 2.0.
142

AUTHORS

144       Wilson Snyder <wsnyder@wsnyder.org>
145