Getting Help from an Installed App - 2024.1 English

Vivado Design Suite User Guide: Using Tcl Scripting (UG894)

Document ID
Release Date
2024.1 English

After an app has been installed, additional Help is available on each proc. The detailed Help for a proc can be accessed in three different ways. You can select the hyperlinked proc name to open a dialog box that shows the detailed Help. You can also right-click the proc name to open a context window with a Help menu item. Selecting Help opens the embedded Help information for the selected proc. Finally, the detailed Help can also be accessed from the Tcl Console using the full namespace for the proc name along with the -help command line option.

The following figure shows the detailed Help for xilinx::designutils::write_template.

Figure 1. write_template Help

The same Help text can be printed from the Tcl Console with:

vivado% xilinx::designutils::write_template -help
Note: The full name qualifier for this proc is xilinx::designutils::write_template and not just write_template.