perl-Verilog/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       --noblank
52           Removes empty lines from the output.  Should be used with --noline,
53           as if correct line numbers are needed, blank lines must be
54           preserved for proper accounting by the program reading the output
55           of vppreproc.
56
57       --nocomment
58           Remove comments.
59
60       --noline
61           Remove `line directives.
62
63       --pedantic
64           Rigorously obey the Verilog spec.  This disables the `__FILE__ and
65           `__LINE__ features, and may disable other features that are not
66           specified in the approved language reference manual. Defaults
67           false.
68
69       --simple
70           Requests simple output, an alias for --noline, --nocomment and
71           --noblank.
72
73       --version
74           Displays program version and exits.
75

LANGUAGE EXTENSIONS

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

DISTRIBUTION

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

AUTHORS

107       Wilson Snyder <wsnyder@wsnyder.org>
108