The general form of a vzDoc invocation is:
% vzdoc [options] <filename> [<filename2> ...]
The vzDoc command-line options are:
--help: Displays a simple help message, and exits.
--verbose: Displays extra what's-going-on messages
as vzDoc runs. For even more chit-chat,
VZDOC_DEBUG environment variable.
--auto-pre-doc-comments: Use the formatting
(line-breaks, etc.) of the doc-comments' text, i.e. as if <PRE>
and </PRE> tags were automagically put around each comment.
--alt-css-file=<filename>: Uses the file
specified as the CSS (Cascading Style Sheets) file, instead of the
default one that is normally generated.
Supplies several doc-comment `tags' that are
not to be displayed; comma-separated.
(For doc-comment tags that are supported, please see Section 3.3, “Supported tags in doc-comments”.)
vzDoc uses/consults environment variables as follows:
IMPORTANT! The relevant environment variable
provides the path (list of directories) on which
vzDoc will search for any source (input)
Setting this environment variable wrongly will make a big mess.
By default, vzDoc searches only the directory in which the file specified on the command line is found.
Sample usage might be (assuming a Bash shell):
% export SPECMAN_PATH=".:./testbench:../library/models:/proj/reuse/specman/lib" % vzdoc test.e
PATH: Unsurprisingly, this is used to find
external programs, such as Vera.
LOGNAME: The relevant
value is written into the HTML output.
Other environment variables mentioned in Specman/e
import statements: they get substituted in.
(Wow, this is ugly.)
VZDOC_VERA_PP (experimental -- likely to change):
Instead of looking for
vera -pp, use the value
of the environment variable to invoke the program (or equivalent).
VZDOC_DEBUG: Setting it provokes extra debugging
messages. Different `bits' control different debugging messages
(which may change at any time); setting it to
-- lots of bits set... -- is likely to tell you everything there is
VZDOC_FORCE_PARSER_OUTPUT_FILE: For Verilab
internal testing (and profoundly uninteresting).