NAME

vreg - Register configuration utility

SYNOPSIS

  vreg --help
  vreg ...

DESCRIPTION

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

HTML CONVERSION

When the --html switch is used, vreg generates a .vregs file from a .html file. The file format is described in vregs_spec.doc or vregs_spec.htm.

When saving HTML, be sure to change both the filename to .htm and the file format to HTML. If inside Microsoft Word, exit.

HEADER CREATION

When the --header switch is used, vreg reads a .vregs file and creates definition and class headers in the --output directory.

ARGUMENTS

--help

Displays this message and program version and exits.

--headers

Creates the header files and other files after the hardware.vregs file has changed.

--html html_filename

Reads the specified filename and creates a .vregs file from the html.

--library package

Specifies a package to be used to resolve subclasses. The library package will only be read, not changed in any way.

--nocomments

Add minimal comment to the header files, to save disk space and time. Users of the file will have to then look at the .vregs file to determine what bits represent.

--noclass_cpp

Suppresses creating the _class.cpp file.

--noclass_h

Suppresses creating the _class.h file.

--nodefs_h

Suppresses creating the _defs.h file.

--nodefs_pm

Suppresses creating the _defs.pl file.

--nodefs_v

Suppresses creating the _defs.v file.

--noinfo_cpp

Suppresses creating the _info.cpp file.

--noparams_v

Suppresses creating the _defs.pm file.

--nofiles

Suppresses creating all files. Equivalent to: --noclass_h --noclass_cpp --nodefs_h --nodefs_pm --nodefs_v --noinfo_cpp --nohash_pm --noparams_v

You can then use specific enables after the --nofiles to turn on the desired files, for example: --nofiles --class_h --defs_h --hash_pm

--output

Specifies the directory name to be used for all output files.

--package

Specifies the name of the package; used for creating all filenames.

--rebuild-comment

Specifies a comment to be placed into output files describing to users how to rebuild the file.

--rm

When used with the --html switch, remove a directory named html_name_files. (This generally contains images written by Microsoft Word that are not needed.) Also, clean up the HTML file to compress out useless style tags that make the file less humanly readable.

--rules

Specify the name of the rules file. (See SystemC::Vregs::Rules.) Defaults to the out_directory/package__rules.pl.

-v2k

Use Verilog-2001 constructs, such as localparam. Identical to the v2k package attribute.

DISTRIBUTION

The latest version is available from CPAN and from http://www.veripool.com/.

Copyright 2001-2005 by Wilson Snyder. This package is free software; you can redistribute it and/or modify it under the terms of either the GNU Lesser General Public License or the Perl Artistic License.

AUTHORS

Wilson Snyder <wsnyder@wsnyder.org>

SEE ALSO

SystemC::Vregs, SystemC::Vregs::Rules

vregs_spec.htm from the SystemC::Vregs distribution.