Visible to Intel only — GUID: mwh1410471015343
Ixiasoft
1.1. Benefits of Command-Line Executables
1.2. Introductory Example
1.3. Command-Line Scripting Help
1.4. Project Settings with Command-Line Options
1.5. Compilation with quartus_sh --flow
1.6. Text-Based Report Files
1.7. Using Command-Line Executables in Scripts
1.8. Common Scripting Examples
1.9. The QFlow Script
1.10. Document Revision History
1.8.1. Create a Project and Apply Constraints
1.8.2. Check Design File Syntax
1.8.3. Create a Project and Synthesize a Netlist Using Netlist Optimizations
1.8.4. Archive and Restore Projects
1.8.5. Perform I/O Assignment Analysis
1.8.6. Update Memory Contents Without Recompiling
1.8.7. Create a Compressed Configuration File
1.8.8. Fit a Design as Quickly as Possible
1.8.9. Fit a Design Using Multiple Seeds
2.1. Tool Command Language
2.2. Intel® Quartus® Prime Tcl Packages
2.3. Intel® Quartus® Prime Tcl API Help
2.4. End-to-End Design Flows
2.5. Creating Projects and Making Assignments
2.6. Compiling Designs
2.7. Reporting
2.8. Timing Analysis
2.9. Automating Script Execution
2.10. Other Scripting Features
2.11. The Intel® Quartus® Prime Tcl Shell in Interactive Mode Example
2.12. The tclsh Shell
2.13. Tcl Scripting Basics
2.14. Tcl Scripting Revision History
Visible to Intel only — GUID: mwh1410471015343
Ixiasoft
2.3. 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:tcl> help ------------------------------------------------------------------------- ---------------------------------- Available Intel® Quartus® Prime Tcl Packages: ---------------------------------- Loaded Not Loaded ------------------ ---------------------------------- ::quartus::device ::quartus::external_memif_toolkit ::quartus::misc ::quartus::iptclgen ::quartus::project ::quartus::design ::quartus::rtm ::quartus::partial_reconfiguration ::quartus::report ::quartus::names ::quartus::incremental_compilation ::quartus::flow * Type "help -tcl" to get an overview on Intel® Quartus® Prime Tcl usages. * Type "help <package name>" to view a list of Tcl commands available for the specified Intel® Quartus® Prime Tcl package.
The Tcl console provides help options that display specific information:
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.
help -pkg ::quartus::project help -pkg project help -pkg project -version 1.0 |
<command_name> -hor <command_name> -help |
Displays the short help of a Intel® Quartus® Prime Tcl command in a loaded package. Examples:project_open -h project_open -help |
package require ::quartus::<package name>[<version>] |
Loads a specific version of an Intel® Quartus® Prime Tcl package. If you do not specify -version, the Intel® Quartus® Prime software loads the latest version of the package. Example: package require ::quartus::project 1.0 This command is similar to the load_package command |
load_package <package name> [-version <version number>] |
Allows you to alternate between different versions of the same package. Example: load_package ::quartus::project -version 1.0 |
help -cmd <command_name> -[-version <version>] or <command_name> -long_help |
Displays the complete help text for an Intel® Quartus® Prime Tcl command. If you do not specify -version, the Intel® Quartus® Prime software loads the latest version of the package. Examples: project_open -long_help help -cmd project_open help -cmd project_open -version 1.0 |
help -examples |
Displays examples of Intel® Quartus® Prime Tcl usage. |
help -quartus |
To view help on the predefined global Tcl array that contains project information and information about the Intel® Quartus® Prime executable that is currently running. |
quartus_sh --qhelp |
Launches the Tk viewer for Intel® Quartus® Prime command-line help and display help for the command-line executables and Tcl API packages. |
help -timequestinfo |
To view help on the predefined global "TimeQuestInfo"Tcl array that contains delay model information and speed grade information of a Timing Analyzer design that is currently running. |
The Tcl API help is also available in Intel® Quartus® Prime online help. Search for the command or package name to find details about that command or package.