Specador Documentation Generator User Guide
Rev. 24.1.4, 28 February 2024

Chapter 2. How to Run

Specador can be invoked in batch mode by running:

$DVT_HOME/bin/specador.sh ...

Examples:

$> specador.sh -lang vlog -cmd /path/to/simulation.f -title "MY CHIP"

$> specador.sh -lang vhdl -cmd /path/to/file_list.f -preferences /path/to/specador_preferences.xml

$> specador.sh -lang e -ignore_compile_errors -cmd irun.args -title "USB 3.0 uVC"

Arguments

-attach <attach>
   Optional. Provide additional file locations to be copied to the output location.
-cmd <command file>
   Optional. Compile using the specified compilation arguments file.
   If not specified, compilation arguments are automatically detected by scanning the current working directory for source files.
-compile_waivers <XML file>
   Optional. Waive compilation errors using the waivers specified in the XML file.
-diagram_generation_timeout <seconds>
   Optional. Increase the timeout when generating a diagram (default: 30 seconds).
-diagram_layout_attempts <attempts>
   Optional. Increase the layout attempts when generating a diagram (default: 3 attempts).
-gen_preferences_xml
   Optional. Generate an XML file with all supported preferences.
-heap_size <size>
   Optional. Set the Java heap size (syntax is <N>[g|G|m|M|k|K]). Default is 3072m.
-help
   Print help and exit.
-ignore_build_config_errors
   Optional. Ignore build configuration errors.
-ignore_compile_errors
   Optional. Ignore compile errors.
-index <index>
   Optional. Provide an index.rst file to generate a customized Table of Contents.
-lang e|vhdl|vlog
   Mandatory. Enable support for the specified language (e, vlog, vhdl).
-license_queue_timeout <timeout>
   Optional. Maximum time in seconds to wait in queue for a license when one is not available.
-log <log file>
   Optional. Log to specified file.
-menu <XML file>
   Deprecated. Optional. Use menu specified in the XML file. It has precedence over the html menu specified by preferences.
-pdf
   Optional. Generate PDF documentation.
-preferences <XML file>
   Optional. Use preferences specified in the XML file.
-print_all_compile_problems
   Optional. Print all compile problems. Include waived problems if used with "-print_compile_waivers_info".
-print_compile_waivers_info
   Optional. Prints how many problems each compile waiver has matched.
-silent
   Optional. Turn on minimal output.
-stack_size <size>
   Optional. Set the Java thread stack size (syntax is <N>[g|G|m|M|k|K]). Default is 4m.
-title <title>
   Optional. Use specified title. It has precedence over the title specified by preferences.
-v23
   Optional. Use the deprecated 2023 HTML engine.
-version
   Print version and exit.

NOTE: When generating documentation in PDF format, latexmk, texlive-luatex and texlive-formats-extra packages are required as dependencies.

NOTE: When generating documentation in GUI mode, a specador_preferences.xml settings file is saved in the project's .dvt directory.