1VRENAME(1) User Contributed Perl Documentation VRENAME(1)
2
6 vrename - change signal names across many Verilog files
7
9 vrename <filename_or_directory>...
10
12 Vrename will allow a signal to be changed across all levels of the
13 design hierarchy, or to create a cross reference of signal names. (It
14 actually includes module names, macros, and other definitions, so those
15 can be changed too.)
16 Vpm uses a three step process. First, use
18 vrename --list [<file.v>...] [<directory>....]
20 This reads the specified files, or all files below the specified
22 directory, and creates a signals.vrename file.
23 Now, edit the signals.vrename file manually to specify the new signal
25 names. Then, use
26 vrename --change [<file.v>...] [<directory>....]
28
30 vrename takes the following arguments:
31 --help
33 Displays this message and program version and exits.
34 --version
36 Displays program version and exits.
37 --change
39 Take the signals file signals.vrename in the current directory and
40 change the signals in the design as specified by the signals file.
41 Either --list or --change must be specified.
42 --changefile {file}
44 Use the given filename instead of "signals.vrename".
45 --crypt
47 With --list, randomize the signal renames. With --change, compress
48 spaces and comments and apply those renames listed in the file
49 (presumably created with vrename --list --crypt).
50 The comment /*ENCRYPT_ME*/ must be included in all files that need
52 to be encrypted, or use the --cryptall flag. If a signal should
53 not be encrypted, it can simply be set in the signals.vrename list
54 to be changed to itself. After encrypting, you may want to save
55 the signals.vrename file so you have a key for decoding, and also
56 so that it may be used for the next encryption run. When used in
57 this way for the next encryption run, only new signals will get new
58 encryptions, all other encryptions will be encrypted the same.
59 --cryptall
61 As with --crypt, but put cryptic names into signals.vrename even if
62 the file does not include ENCRYPT_ME. Generally you will then need
63 to edit the signals.vrename file manually to exclude any top level
64 signals that should be preserved.
65 --keywords
67 Include keywords in the renaming list. Default is to ignore
68 keywords, as changing a keyword will probably result in unrunnable
69 code, however, occasionally it may be necessary to rename signals
70 which happen to match the name of keywords recently added to the
71 language (such as 'bit').
72 --list
74 Create a list of signals in the design and write to
75 signals.vrename. Either --list or --change must be specified.
76 --nowrite
78 Don't write the actual changes, just report the files that would be
79 changed.
80 --o {dir}
82 Use the given directory for output instead of the current
83 directory.
84 --read
86 Read the changes list, allows --list to append to the changes
87 already read.
88 --xref
90 Include a cross reference of where the signals are used. --list
91 must also be specified.
92
94 Verilog-Perl is part of the <http://www.veripool.org/> free Verilog EDA
95 software tool suite. The latest version is available from CPAN and
96 from http://www.veripool.org/verilog-perl
97 <http://www.veripool.org/verilog-perl>.
98 Copyright 2000-2009 by Wilson Snyder. This package is free software;
100 you can redistribute it and/or modify it under the terms of either the
101 GNU Lesser General Public License Version 3 or the Perl Artistic
102 License Version 2.0.
103
105 Wilson Snyder <wsnyder@wsnyder.org>
106
108 Verilog-Perl, Verilog::Parser
109perl v5.12.0 2009-07-20 VRENAME(1)