GEOS SDK TechDocs
|
| 
5 Commands
| 
5.2 Built-in Commands
The descriptions of the Tcl commands will follow the following notational conventions:
command (alternative1|alternative2|...|alternativeN)
()
The parentheses enclose a set of alternatives separated by a vertical line. For example, the expression
quit (cont|leave)
means that either
quit cont
or
quit leave
can be used.
command [optional_argument]
[]
The brackets enclose optional arguments to the command. For example, the command
alias [<word[<command>]>]
could have zero, one, or two arguments because the <command> and <word> arguments are optional. Another example would be the command
objwalk [<addr>]
, which may take zero arguments if it is meant to use the default address, and one argument if the user gives it a particular address to look at.
command <type_of_argument>
< >
The angled brackets enclose the type of an argument rather than the actual string to be typed. For example,
<addr>
indicates an address expression and
<argument>
indicates some sort of argument, but
(addr|type)
means either the string
addr
or the string
type
.
* +
An asterisk following any of the previous constructs indicates zero or more repetitions of the construct may be typed. An addition sign indicates one or more repetitions of the construct may be used. For example,
unalias
word
* can be the
unalias
command by itself, or it can be followed by a list of words to be unaliased.GEOS SDK TechDocs
|
| 5 Commands
| 5.2 Built-in Commands