aproposSyntax

aproposSyntax — gives a command's syntax description.

Synopsis

       
(aproposSyntax [pattern])
	

Parameters

pattern

A string containing a pattern to be matched against command names, supporting * and ? wildcard characters. When this parameter is not specified, the default is *, to include all command names.

Returns

A list showing the syntax of the first command that matches the pattern, formatted as:

(aproposSyntax (command [parameter ...]))

on success, otherwise (error).

Description

This command gives the syntax description string (if any) associated with the first command matching the pattern.

Example

Hist> (aproposSyntax f*)
(aproposSyntax (filebase point directory basename extension [digits]))