Next: , Previous: Library commands, Up: Invoking GHDL


3.7 Cross-reference command

To easily navigate through your sources, you may generate cross-references.

     $ ghdl --xref-html [options] file...

This command generates an html file for each file given in the command line, with syntax highlighting and full cross-reference: every identifier is a link to its declaration. Besides, an index of the files is created too.

The set of file are analyzed, and then, if the analysis is successful, html files are generated in the directory specified by the -o dir option, or html/ directory by default.

If the --format=html2 is specified, then the generated html files follow the HTML 2.0 standard, and colours are specified with ‘<FONT>’ tags. However, colours are hard-coded.

If the --format=css is specified, then the generated html files follow the HTML 4.0 standard, and use the CSS-1 file ghdl.css to specify colours. This file is generated only if it does not already exist (it is never overwritten) and can be customized by the user to change colours or appearance. Refer to a generated file and its comments for more information.