?? v2html.man.html
字號:
<HTML><HEAD><TITLE>v2html - Verilog to HTML converter</TITLE><LINK REV="made" HREF="mailto:bhcompile@daffy.perf.redhat.com"></HEAD><BODY><A NAME="__index__"></A><!-- INDEX BEGIN --><UL> <LI><A HREF="#name">NAME</A></LI> <LI><A HREF="#synopsis">SYNOPSIS</A></LI> <LI><A HREF="#description">DESCRIPTION</A></LI> <LI><A HREF="#author">AUTHOR</A></LI> <LI><A HREF="#examples">EXAMPLES</A></LI> <LI><A HREF="#diagnostics">DIAGNOSTICS</A></LI></UL><!-- INDEX END --><HR><P><H1><A NAME="name">NAME</A></H1><P>v2html - Verilog to HTML converter</P><P><HR><H1><A NAME="synopsis">SYNOPSIS</A></H1><P><STRONG>v2html</STRONG> [options] file1 [file2] ...</P><P><STRONG>v2html</STRONG> is a perl 5 script that converts a bunch of verilog files tohtml, linking various things to their definitions. At the momentit handles:</P><DL><DT><STRONG><A NAME="item_%2D_modules">- modules</A></STRONG><BR><DD><DT><STRONG><A NAME="item_%2D_tasks">- tasks</A></STRONG><BR><DD><DT><STRONG><A NAME="item_%2D_functions">- functions</A></STRONG><BR><DD><DT><STRONG><A NAME="item_%2D_includes">- includes</A></STRONG><BR><DD><DT><STRONG><A NAME="item_%2D_defines">- defines</A></STRONG><BR><DD><DT><STRONG><A NAME="item_%2D_parameters">- parameters</A></STRONG><BR><DD><DT><STRONG><A NAME="item_%2D_inputs%2Coutputs%2Cinouts">- inputs,outputs,inouts</A></STRONG><BR><DD><DT><STRONG><A NAME="item_%2D_signals%3A_wire%2C_reg_etc%2E">- signals: wire, reg etc.</A></STRONG><BR><DD><DT><STRONG><A NAME="item_%2D_mail_addresses_in_comments">- mail addresses in comments</A></STRONG><BR><DD><DT><STRONG><A NAME="item_URLS">- http URLS (http://....) in comments</A></STRONG><BR><DD></DL><P>It also generates a page containing all the modules it found arrangedhierarchically and separate index pages for all of the files, modules,signals, tasks and functions.</P><P>Once you have the html files they can be installed on a web-server, orsimply viewed using ``Open File...'' in your web browser.</P><P>Details on navigating around the converted files, and many examplescan be found at <A HREF="http://www.burbleland.com/v2html/v2html.html">http://www.burbleland.com/v2html/v2html.html</A> .</P><P>Note that as of version 5.0 <STRONG>v2html</STRONG> uses <EM>cascading style sheets</EM>to colour the display. This means that pages viewed with old browsersthat do not support <EM>cascading style sheets</EM> (for instance Netscape3) will not be coloured.</P><P><HR><H1><A NAME="description">DESCRIPTION</A></H1><P>In addition to the switches detailed below <STRONG>v2html</STRONG> also accepts andignores most VCS/VerilogXL options and all other options starting with aplus. This means that you should be able to run it with the samecommand file you use for running simulations.</P><P>Switches:</P><DL><DT><STRONG><A NAME="item_%2Dq"><STRONG>-q</STRONG></A></STRONG><BR><DD>Be quiet - so don't print all those informative messages about whatit is doing.<P></P><DT><STRONG><A NAME="item_%2Bdefine%2BNAME%5B%3DVALUE%5D"><STRONG>+define+NAME[=VALUE]</STRONG></A></STRONG><BR><DD>Pre-define a value. This is just the same as putting:<PRE> 'define NAME [VALUE]</PRE><P>at the top of each of your input files. The rather strange syntax is thesame as VerilogXL's. This option is useful for controlling which ifdefs appeartrue to <STRONG>v2html</STRONG>.</P><P></P><DT><STRONG><A NAME="item_%2Bincdir%2BDIR"><STRONG>+incdir+DIR</STRONG></A></STRONG><BR><DD>Specify a directory to search for include files (just like VerilogXL).<P></P><DT><STRONG><A NAME="item_%2Dy_DIR"><STRONG>-y</STRONG> DIR</A></STRONG><BR><DD>Specify a directory to search for modules (just like VerilogXL). Note that<STRONG>v2html</STRONG> doesn't do any fancy search orders like VerilogXL - it just searchesthe directories in the order that you specify them on the command line.<P></P><DT><STRONG><A NAME="item_%2Blibext%2BEXT"><STRONG>+libext+EXT</STRONG></A></STRONG><BR><DD>Specify an extension use when searching for modules (just likeVerilogXL). You can specify multiple extensions using<STRONG>+libext+EXT1+EXT2+EXT2</STRONG> or by specifying multiple <STRONG>+libext+EXT</STRONG>options.<P></P><DT><STRONG><A NAME="item_%2Dv_LIBFILE"><STRONG>-v</STRONG> LIBFILE</A></STRONG><BR><DD>Specify a library file to use (just like VerilogXL).<P></P><DT><STRONG><A NAME="item_%2Df_command_lines_options_file"><STRONG>-f</STRONG> command_lines_options_file</A></STRONG><BR><DD>Specify a file to get more command line options from. For instance youcould put a list of all your files in src_files and then use <STRONG>-f</STRONG>src_file. You can also put in just about anything that you can puton the command line. Comments can be included using # or // at thestart of the line. Wildcards are not allowed in the file names. Usesingle or double quotes to quote arguments that have spaces in themfor example:<PRE> # v2html -f file - turn on gzip compression -z -ze .gz -zc 'gzip -f'</PRE><PRE>You can have as many -f options as you want and you can probably put-f options in the file too.</PRE><P></P><DT><STRONG><A NAME="item_%2Dm_mail_addr"><STRONG>-m</STRONG> mail_addr</A></STRONG><BR><DD>A mail address of the site maintainer. This is placed in a field atthe bottom of each file like this:<PRE> This page: Maintained by: Joe_Bloggs@barking.com Created: Thu Nov 6 08:53:37 1997 From: test2.v</PRE><P></P><DT><STRONG><A NAME="item_%2Di"><STRONG>-i</STRONG></A></STRONG><BR><DD>Incremental mode. At the moment this isn't very incremental! <STRONG>v2html</STRONG>checks the dates on all of the files that it read last time it ran andall of the output files it generated. If any of the input files arenewer than the output files, or if the command line options havechanged it <STRONG>deletes</STRONG> all of the files it made last time and rebuildseverything. The delete is done to stop old files accumulating in theoutput directory.<P><STRONG>v2html</STRONG> keeps track of all the information it needs to do this ina file called .v2html_incr .</P><P></P><DT><STRONG><A NAME="item_%2Do_output_dir"><STRONG>-o</STRONG> output_dir</A></STRONG><BR><DD>Set the output directory for the html files. The default is the currentdirectory.<P></P><DT><STRONG><A NAME="item_%2Dcss_cascading_style_sheet"><STRONG>-css</STRONG> cascading_style_sheet</A></STRONG><BR><DD>The appearance of all the different elements of the html page can be alteredusing a <EM>cascading style sheet</EM>. By default <STRONG>v2html</STRONG> uses a file called<EM>v2html.css</EM> in the same directory as the html files. You can customize theappearance of the html files by editing this file (<STRONG>v2html</STRONG> will create oneif it does not exist, but will not overwrite an existing one).<P>If you have many different html directories which you want to use theone central cascading style sheet then you can use the <STRONG>-css</STRONG> optionto specify one. For example:</P><PRE> -css <A HREF="http://www.barking.com/joes_style.css">http://www.barking.com/joes_style.css</A></PRE><P></P><DT><STRONG><A NAME="item_%2Dh_hier_file"><STRONG>-h</STRONG> hier_file</A></STRONG><BR><DD>Set the name of the file that the hierarchy is written to. The defaultis hierarchy.html. This is also used as a base for the index filenames. These file names are formed put appending <CODE>-f</CODE>, <CODE>-m</CODE>,<A HREF="#item_%2Ds"><CODE>-s</CODE></A>, <CODE>-t</CODE> and <CODE>-fn</CODE> to the part of the hierarchy file namebefore the first dot (so hier.htm will put the files index inhier-f.htm).<P></P><DT><STRONG><A NAME="item_%2Dht_top_module"><STRONG>-ht</STRONG> top_module</A></STRONG><BR><DD>Set the name of a top module you want in the hierarchy. You can specifymultiple <STRONG>-ht</STRONG> options to specify multiple top modules.<P>If you don't specify any <STRONG>-ht</STRONG> options then <STRONG>v2html</STRONG> will inspectthe hierarchy and find all the top modules in the verilog files andprint these out. The 'top modules' are modules that are notinstantiated but instantiate other modules that <STRONG>v2html</STRONG> has foundthe definition of.</P><P></P><DT><STRONG><A NAME="item_%2Dhc_hierarchy_comment"><STRONG>-hc</STRONG> hierarchy_comment</A></STRONG><BR><DD>Specifies some text to put at the top of the hierarchy. For instance:<PRE> v2html -hc "This is our ASIC" *.v</PRE><P></P><DT><STRONG><A NAME="item_%2Dhtf"><STRONG>-htf</STRONG></A></STRONG><BR><DD>Turns on printing of tasks and functions in the hierarchy. By default theyare not printed.<P></P><DT><STRONG><A NAME="item_%2Dlines_max_lines_per_file"><STRONG>-lines</STRONG> max_lines_per_file</A></STRONG><BR><DD>In order to speed up viewing <STRONG>v2html</STRONG> splits large verilog files across multiplehtml pages. This option lets you specify how many lines you want on a page. The default is 1000.<P></P><DT><STRONG><A NAME="item_%2Dnnm"><STRONG>-nnm</STRONG></A></STRONG><BR><DD>No ``No modules''. By default the hierarchy contains three sections, thehierarchies of the top modules, a list of files containing no modulesand a list of unconnected modules (modules that are not instantiatedbut also do not qualify as top modules). The <STRONG>-nnm</STRONG> makes<STRONG>v2html</STRONG> skip printing the list of files containing no modules.See <STRONG>-nu</STRONG>.<P></P><DT><STRONG><A NAME="item_%2Dnu"><STRONG>-nu</STRONG></A></STRONG><BR>?? 快捷鍵說明
復(fù)制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -