vreg(1) - f36

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

NAME

6       vreg - Register configuration utility
7

SYNOPSIS

9         vreg --help
10         vreg ...
11

DESCRIPTION

13       Vreg has two major uses.  The first vreg converts a HTML document
14       (saved via Word, Framemaker, LyX, or Latex) to a vreg file.  The second
15       generates standard headers from the .html or from a .vregs file.
16

HTML CONVERSION

18       When the --html switch is used, vreg generates a .vregs file from a
19       .html file.  The file format is described in vregs_spec.doc or
20       vregs_spec.htm.
21
22       When saving HTML, be sure to change both the filename to .htm and the
23       file format to HTML.  If inside Microsoft Word, exit.
24

HEADER CREATION

26       When the --header switch is used, vreg reads a .vregs file and creates
27       definition and class headers in the --output directory.  Vreg can also
28       create LaTex tables based on the register layouts.
29

GENERAL ARGUMENTS

31       --change-diff program
32           With --change-error, use this program to determine if the error
33           should be reported or not.  The program should exit with non-zero
34           status to raise an error.
35
36       --change-error language
37           Report error if file of the given language would change.  Use ALL
38           for all languages.  This option may be given multiple times to
39           specify multiple languages.
40
41       --dry-run
42           Don't write any output files, mearly report which files would
43           change.
44
45       --help
46           Displays this message and program version and exits.
47
48       --headers
49           Creates the header files and other files after the hardware.vregs
50           file has changed.
51
52       --html html_filename
53           Reads the specified filename and creates a .vregs file from the
54           html.
55
56       --if-product product
57           Only include registers in output with a Product column matching
58           that specified.  See the vregs_spec document for more information.
59
60       --library package
61           Specifies a package to be used to resolve subclasses.  The library
62           package will only be read, not changed in any way.
63
64       --nocomments
65           Add minimal comment to the header files, to save disk space and
66           time.  Users of the file will have to then look at the .vregs file
67           to determine what bits represent.
68
69       --output
70           Specifies the directory name to be used for all output files.
71
72       --package
73           Specifies the name of the package; used for creating all filenames.
74
75       --rebuild-comment
76           Specifies a comment to be placed into output files describing to
77           users how to rebuild the file.
78
79       --rm
80           When used with the --html switch, remove a directory named
81           html_name_files.  (This generally contains images written by
82           Microsoft Word that are not needed.)  Also, clean up the HTML file
83           to compress out useless style tags that make the file less humanly
84           readable.
85
86       --rules
87           Specify the name of the rules file.  (See SystemC::Vregs::Rules.)
88           Defaults to the out_directory/package__rules.pl.
89
90       --v2k
91           Use Verilog-2001 constructs, such as localparam.  Identical to the
92           v2k package attribute.
93
94       --version
95           Displays program version and exits.
96
97       --vregs
98           Specify vregs format file to be read or written.  Defaults to be in
99           the directory specified by --output with the filename
100           package.vregs.
101

OUTPUT FILE TYPE ARGUMENTS

103       --asm_h
104           Create an _asm.h file.
105
106       --class_cpp
107           Create a _class.cpp file.
108
109       --class_h
110           Create a _class.h C++ file.
111
112       --defs_h
113           Create a _defs.h file.
114
115       --defs_pm
116           Create a _defs.pl file.
117
118       --defs_v
119           Create a _defs.v file.
120
121       --filename-asm-h filename
122           Specify the output filename for the asm_h file.  By default this is
123           {--output}{package_name}_asm.h.
124
125           Similar options exist for all of the other output files.
126
127       --files
128           Create all files. Equivalent to: --class_h --class_cpp --defs_h
129           --defs_pm --defs_v --info_cpp --hash_pm --params_v --struct_h
130
131       --hash_pm
132           Create a _hash.pm file.
133
134       --info_cpp
135           Create an _info.cpp file.
136
137       --latex
138           Creates latex tables from the vregs definition, suitable for
139           formatting into printable documentation.
140
141       --nofiles
142           Suppresses creating all files. Equivalent to: --noclass_h
143           --noclass_cpp --nodefs_h --nodefs_pm --nodefs_v --noinfo_cpp
144           --nohash_pm --noparams_v --nostruct_h
145
146           You can then use specific enables after the --nofiles to turn on
147           the desired files, for example: --nofiles --class_h --defs_h
148           --hash_pm
149
150       --params_v
151           Create a _defs.pm file.
152
153       --struct_h
154           Create a _struct.h C file.
155

DISTRIBUTION

157       Vregs is part of the <http://www.veripool.org/> free Verilog software
158       tool suite.  The latest version is available from CPAN and from
159       <http://www.veripool.org/vregs>.
160
161       Copyright 2001-2010 by Wilson Snyder.  This package is free software;
162       you can redistribute it and/or modify it under the terms of either the
163       GNU Lesser General Public License Version 3 or the Perl Artistic
164       License Version 2.0.
165

AUTHORS

167       Wilson Snyder <wsnyder@wsnyder.org>
168