aproposSyntax

aproposSyntax — gives command usage.

Synopsis

       
(aproposSyntax pattern)
	

Parameters

pattern

A string containing a pattern to be matched against command names, although only the first matching name is used. Supports * and ? wildcard characters.

Returns

If the usage string is available for that command, then it is returned formated as:

(aproposSyntax usage_string)

If the command is found, but no usage is available, then a generic usage string is returned:

(aproposSyntax "(cmd_name...)")

If no command matching the pattern is found, then the parameter is simply echoed back as:

(aproposSyntax "pattern")

Otherwise (error) is returned.

Description

This command provides the usage syntax for a specified command, if available.