Specador Documentation Generator User Guide
Rev. 21.1.50, 23 November 2021

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

-lang e|vlog|vhdl
   Mandatory. Enable support for the specified language(eLanguage, Verilog/SystemVerilog or VHDL).
-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.
-preferences <XML file>
   Optional. Use preferences specified in the XML file.
-gen_preferences_xml
   Optional. Generate an XML file with all supported preferences. 
-ignore_compile_errors
   Optional. Ignore compile errors.
-menu <XML file>
   Optional. Use menu specified in the XML file. It has precedence over the html menu specified by preferences.
-title <title>
   Optional. Use specified title. It has precedence over the title specified by preferences.
-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.
-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.
-version
   Print version and exit.

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