common::help - 2020.2 English

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
UG1400
Release Date
2020-12-15
Version
2020.2 English

Description

Display help for one or more topics.

Syntax

help [-category <arg>] [-args] [-syntax] [-long] [-prop <arg>] [-class <arg>] [-message <arg>] [-quiet] [-verbose] [<pattern_or_object>] 

Returns

Nothing.

Usage

Name Description
[-category] Search for topics in the specified category
[-args] Display arguments description
[-syntax] Display syntax description
[-long] Display long help description
[-prop] Display property help for matching property names Default: *
[-class] Display object type help
[-message] Display information about the message with the given message. Every message delivered by the tool has a unique global message ID that consists of an application sub-system code and a message identifier. Example: -message {Common 17-8}.
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<pattern_or_object>] Display help for topics that match the specified pattern Default: *

Categories

Project