perl-Verilog-Perl/vppreproc(1)

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

NAME

6       vppreproc - Preprocess Verilog code using verilog-perl
7

SYNOPSIS

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

DESCRIPTION

13       Vppreproc reads the Verilog files passed on the command line and
14       outputs preprocessed output to standard out or the filename passed with
15       -p.
16
17       Note vppreproc was named vppp until release 3.100, so if you're looking
18       for vppp, this is the right replacement.  The vppp name conflicted with
19       another non-Verilog related tool.
20

VERILOG ARGUMENTS

22       The following arguments are compatible with GCC, VCS and most Verilog
23       programs.
24
25       +define+var+value =item -Dvar=value
26           Defines the given preprocessor symbol.
27
28       -f file
29           Read the specified file, and act as if all text inside it was
30           specified as command line parameters.
31
32       +incdir+dir =item -Idir
33           Add the directory to the list of directories that should be
34           searched for include directories or libraries.
35
36       +libext+ext+ext...
37           Specify the extensions that should be used for finding modules.  If
38           for example module x is referenced, look in x.ext.
39
40       -y dir
41           Add the directory to the list of directories that should be
42           searched for include directories or libraries.
43

VPPREPROC ARGUMENTS

45       --help
46           Displays this message and program version and exits.
47
48       --o file
49           Use the given filename for output instead of stdout.
50
51       --dump-defines
52           Suppress normal output, and instead print a list of all defines
53           existing at the end of processing the input file.
54
55       --noblank
56           Removes empty lines from the output.  Should be used with --noline,
57           as if correct line numbers are needed, blank lines must be
58           preserved for proper accounting by the program reading the output
59           of vppreproc.
60
61       --nocomment
62           Remove comments.
63
64       --noline
65           Remove `line directives.
66
67       --pedantic
68           Rigorously obey the Verilog spec.  This disables the `error
69           feature, and may disable other features that are not specified in
70           the approved language reference manual. Defaults false.
71
72       --simple
73           Requests simple output, an alias for --noline, --nocomment and
74           --noblank.
75
76       --version
77           Displays program version and exits.
78

LANGUAGE EXTENSIONS

80       Vppreproc supports the preprocessing constructs defined in the Verilog
81       2001 and SystemVerilog 2005 standards.
82
83       The following additional constructs may be added to your Verilog code.
84
85       `__FILE__
86           The __FILE__ define expands to the current filename as a string,
87           like C++'s __FILE__.  This was incorporated into to the 1800-2009
88           standard (but supported by Verilog-Perl since 2004!)
89
90       `__LINE__
91           The __LINE__ define expands to the current filename as a string,
92           like C++'s __LINE__.  This was incorporated into to the 1800-2009
93           standard (but supported by Verilog-Perl since 2004!)
94
95       `error string
96           This will report an error when encountered, like C++'s #error.
97

DISTRIBUTION

99       Verilog-Perl is part of the <http://www.veripool.org/> free Verilog EDA
100       software tool suite.  The latest version is available from CPAN and
101       from http://www.veripool.org/verilog-perl
102       <http://www.veripool.org/verilog-perl>.
103
104       Copyright 2000-2010 by Wilson Snyder.  This package is free software;
105       you can redistribute it and/or modify it under the terms of either the
106       GNU Lesser General Public License Version 3 or the Perl Artistic
107       License Version 2.0.
108

AUTHORS

110       Wilson Snyder <wsnyder@wsnyder.org>
111