/
listCommands

listCommands

Description

Prints all the commands to the log window sorted by category.

Use listCommands when you need to check for the presence of a command inside your version of Shogun Post. You can then use help to get more detailed information on a specific command.

Functional area

System

Command syntax

Syntax

listCommands [-category string] [-reverse] [-syntax] [-native] [-menu] [-commands] [-categories]

Arguments

None

Flags

NameFlag argumentsArgument typeExclusive toComments
category1stringcommandsDisplays the commands for the given category. Use -categories to see what are the valid names to use for this flag argument.
reverse0Prints the commands in reverse order
syntax0Also display the commands syntax
native0menuOnly display the native commands
menu0nativeOnly display menu or GUI commands
commands0categoryDo not sort the commands by category
categories0Display the list of categories
xmlDump1stringGenerates XML files for each nativeShogun command

Return value

void

Examples

// Lists all commands, including syntax descriptions for each one.
listCommands -syntax;

Additional information

Related commands



© Copyright Vicon Motion Systems. All rights reserved.

Vicon trademarks