v2html.1

v2html - verilog to html converter 主要为FPGA和ASIC工作人员

.\" Automatically generated by Pod::Man version 1.15
.\" Sun Sep 22 21:31:40 2002
.\"
.\" Standard preamble:
.\" ======================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R

.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
.\" index entries marked with X<> in POD.  Of course, you'll have to process
.\" the output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it
.\" makes way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.bd B 3
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ======================================================================
.\"
.IX Title "V2HTML 1"
.TH V2HTML 1 "v2html 7.30" "September 2002" "v2html"
.UC
.SH "NAME"
v2html \- Verilog to \s-1HTML\s0 converter
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBv2html\fR [options] file1 [file2] ...
.PP
\&\fBv2html\fR is a perl 5 script that converts a bunch of verilog files to
html, linking various things to their definitions. At the moment
it handles:
.Ip "\- modules" 5
.IX Item "- modules"
.PD 0
.Ip "\- tasks" 5
.IX Item "- tasks"
.Ip "\- functions" 5
.IX Item "- functions"
.Ip "\- includes" 5
.IX Item "- includes"
.Ip "\- defines" 5
.IX Item "- defines"
.Ip "\- parameters" 5
.IX Item "- parameters"
.Ip "\- inputs,outputs,inouts" 5
.IX Item "- inputs,outputs,inouts"
.Ip "\- signals: wire, reg etc." 5
.IX Item "- signals: wire, reg etc."
.Ip "\- mail addresses in comments" 5
.IX Item "- mail addresses in comments"
.Ip "\- http \s-1URLS\s0 (http://....) in comments" 5
.IX Item "- http URLS (http://....) in comments"
.PD
.PP
It also generates a page containing all the modules it found arranged
hierarchically and separate index pages for all of the files, modules,
signals, tasks and functions.
.PP
Once you have the html files they can be installed on a web-server, or
simply viewed using \*(L"Open File...\*(R" in your web browser.
.PP
Details on navigating around the converted files, and many examples
can be found at http://www.burbleland.com/v2html/v2html.html .
.PP
Note that as of version 5.0 \fBv2html\fR uses \fIcascading style sheets\fR
to colour the display. This means that pages viewed with old browsers
that do not support \fIcascading style sheets\fR (for instance Netscape
3) will not be coloured.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
In addition to the switches detailed below \fBv2html\fR also accepts and
ignores most VCS/VerilogXL options and all other options starting with a
plus. This means that you should be able to run it with the same
command file you use for running simulations.
.PP
Switches:
.Ip "\fB\-q\fR" 5
.IX Item "-q"
Be quiet \- so don't print all those informative messages about what
it is doing.
.Ip "\fB+define+NAME[=VALUE]\fR" 5
.IX Item "+define+NAME[=VALUE]"
Pre-define a value. This is just the same as putting:
.Sp
.Vb 1
\&        'define NAME [VALUE]
.Ve
at the top of each of your input files. The rather strange syntax is the
same as VerilogXL's. This option is useful for controlling which ifdefs appear
true to \fBv2html\fR.
.Ip "\fB+incdir+DIR\fR" 5
.IX Item "+incdir+DIR"
Specify a directory to search for include files (just like VerilogXL).
.Ip "\fB\-y\fR\ \s-1DIR\s0" 5
.IX Item "-yDIR"
Specify a directory to search for modules (just like VerilogXL). Note that
\&\fBv2html\fR doesn't do any fancy search orders like VerilogXL \- it just searches
the directories in the order that you specify them on the command line.
.Ip "\fB+libext+EXT\fR" 5
.IX Item "+libext+EXT"
Specify an extension use when searching for modules (just like
VerilogXL). You can specify multiple extensions using
\&\fB+libext+EXT1+EXT2+EXT2\fR or by specifying multiple \fB+libext+EXT\fR
options.
.Ip "\fB\-v\fR\ \s-1LIBFILE\s0" 5
.IX Item "-vLIBFILE"
Specify a library file to use (just like VerilogXL).
.Ip "\fB\-f\fR\ command_lines_options_file" 5
.IX Item "-fcommand_lines_options_file"
Specify a file to get more command line options from. For instance you
could put a list of all your files in src_files and then use \fB\-f\fR\ src_file.  You can also put in just about anything that you can put
on the command line.  Comments can be included using # or // at the
start of the line. Wildcards are not allowed in the file names. Use
single or double quotes to quote arguments that have spaces in them
for example:
.Sp
.Vb 3
\&          # v2html -f file - turn on gzip compression
\&          -z -ze .gz
\&          -zc 'gzip  -f'
.Ve
You can have as many \-f options as you want and you can probably put
\&\-f options in the file too.
.Ip "\fB\-m\fR\ mail_addr" 5
.IX Item "-mmail_addr"
A mail address of the site maintainer. This is placed in a field at
the bottom of each file like this:
.Sp
.Vb 4
\& This page:
\&         Maintained by:         [e-mail]
\&         Created:               Thu Nov 6 08:53:37 1997
\&         From:                  test2.v
.Ve
.Ip "\fB\-i\fR" 5
.IX Item "-i"
Incremental mode. At the moment this isn't very incremental! \fBv2html\fR
checks the dates on all of the files that it read last time it ran and
all of the output files it generated.  If any of the input files are
newer than the output files, or if the command line options have
changed it \fBdeletes\fR all of the files it made last time and rebuilds
everything. The delete is done to stop old files accumulating in the
output directory.
.Sp
\&\fBv2html\fR keeps track of all the information it needs to do this in
a file called .v2html_incr .
.Ip "\fB\-o\fR\ output_dir" 5
.IX Item "-ooutput_dir"
Set the output directory for the html files. The default is the current
directory.
.Ip "\fB\-css\fR\ cascading_style_sheet" 5
.IX Item "-csscascading_style_sheet"
The appearance of all the different elements of the html page can be altered
using a \fIcascading style sheet\fR. By default \fBv2html\fR uses a file called
\&\fIv2html.css\fR in the same directory as the html files. You can customize the
appearance of the html files by editing this file (\fBv2html\fR will create one