Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/13/2021
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

2.3.2. Intel® Quartus® Prime Tcl API Help

Intel® Quartus® Prime Tcl help allows easy access to information about the Intel® Quartus® Prime Tcl commands.
  • This command opens the Intel® Quartus® Prime Command-Line and Tcl API help browser, which documents all commands and options in the Intel® Quartus® Prime Tcl API. At a system command prompt, access the Intel® Quartus® Prime Tcl API Help by typing:
    quartus_sh --qhelp
  • The Tcl API Help can be accessed from the Tcl console as well. At a Tcl prompt, type
    help
    to access the help information. The output is:
The Tcl console provides help options that display specific information:
Table 7.  Help Options Available in the Intel® Quartus® Prime Tcl Environment
Help Command Description
help
Displays complete list of available Intel® Quartus® Prime Tcl packages.
help -tcl
Explains how to load Tcl packages and access command-line help.
help -pkg <package_name -[-version <version number>]
Displays help commands of the Intel® Quartus® Prime package that you specify, including the list of available Tcl commands.
  • If you do not specify -version, the Intel® Quartus® Prime software loads the latest version of the package.
  • If the package is not loaded, the Intel® Quartus® Prime software displays the help for the latest version of the package.
Examples:
help -pkg ::quartus::project
help -pkg project
help -pkg project -version 1.0
<command_name> -h
or