help - 2024.1 English

Vitis High-Level Synthesis User Guide (UG1399)

Document ID
UG1399
Release Date
2024-05-30
Version
2024.1 English

Description

  • When specified without a command name, the help command lists all Vitis HLS Tcl commands.
  • When used with a Vitis HLS Tcl command as an argument, the help command returns details of the specified command.
Tip: For recognized Vitis HLS commands, auto-completion using the tab key is available when entering the command name.

Syntax

help <cmd>
  • <cmd> specifies a command name to return the help for. If no command is specified, a list of all Vitis HLS commands will be returned.

Options

cmd <string>
Command name
-ini [=true|false]
Show help for command ini
-list [=true|false]
List matching help entries instead of showing full help
-width <int:120>
Set width of output

Examples

Displays help for all commands and directives:
help
Displays help for the add_files command:
help add_files