help

Jump to Description or Examples; explanation of how commands are documented.

Purpose

The help command prints information in table form about the commands available in the Discover program.

Syntax

help ?command? ?path? ?keyword? ?*?

Description

Jump to Syntax or Examples

The help command can be used to print out information about a command or a single parameter of a command.

For a main parameter (keyword), the information concerns the parameter path, the parameter aliases, the parameter type, and its current default value. A list of parameters (for a command) or subparameters (for a main parameter) is printed if they exist.

Extra information about a particular command or parameter may also be printed. If the last argument to help is an asterisk (*), information about all parameters that branch off the specified parameter path is printed.

If the first argument to help is not a BTCL command name, help tries to give information as to the type of object the argument is, for example, if it is a known variable or procedure name.

Example 1

Jump to Syntax or Description

help

The command help with no arguments produces a list of all the BTCL commands defined in the Discover 95.0 program.

Example 2

help *

This example of the help command prints information about all the BTCL commands and their parameters.

Example 3

help minimize final_convergence

This example of the help command prints information concerning the minimize final_convergence parameter.

Example 4

help minimize newton *

This example of the help command prints information concerning the minimize newton parameter node and all its subparameters (method, convergence, and line_search_precision).

Main access page

Advanced-Use access.

List of BTCL commands geometry command history command