The e93 Command Reference is a command dictionary that describes each of the built-in commands and many of the procs available for use with e93.
For each entry, the reference begins with a heading line that includes the command name and a label indicating whether the command is a proc, or built-in command.
For each command, the reference provides the following information:
Section Title Description SYNOPSIS a concise listing of the syntax for invoking the command DESCRIPTION an explanation of the command's function INPUT information on the command's input, if any OUTPUT information on the command's output, if any STATUS a list of possible status codes and their meanings PARAMETERS a description of each of the command's parameters OPTIONS a description of each of the command's options For some commands, the reference also includes these sections:
Section Title Description EXAMPLES examples of how to use the command LIMITATIONS a list of limitations, special cases, or warnings SEE ALSO references to related commands or information LOCATION the .tcl file that contains the proc
This section lists the complete syntax for the command, in the general form
Command ?parameter...? ?option...?
where
Command
is the name of the proc, or built-in command; parameter... is a list of one or more parameters; and option... is a list of one or more options.
e93 syntax conventions
? ?
Question marks indicate optional elements; other elements must be specified. ... Ellipses (...) indicate the preceding item can be repeated one or more times in a list separated by spaces or tabs. italics Italics indicate a parameter that you must replace with anything that matches the parameter's definition. |
A vertical bar ( |
) indicates an either/or choice.literal
Courier text indicates a word that must appear exactly as shown. off
Bold elements indicate the default setting of the command or option. -
A hyphen ( -
) always precedes an option and is a required part of the option.
This section takes a task-oriented approach to describing the function of the proc, or built-in command. In general, the section describes the default behavior and then discusses notable options that modify the default behavior. These options often appear in a bulleted list of alternative or additional ways to use the command that allow you to customize its function to fit your needs.
Currently no e93 commands accept input from stdin.
This section describes the output of the command. Output can include none (no output), one or more files, or standard output.
This section lists the status codes that the command returns and their meanings. Note that these status codes are returned in the errorInfo variable and can be retrieved by using the command line
puts $errorInfo
A value of 0 indicates that no errors occurred; anything else indicates an error.
Typical values are:
0
no errors
1
syntax error
2
execution error
In general, .
This section describes all the parameters that can be used with a particular proc, or built-in command. Parameters are position dependent, they appear in the order in which they must appear on the command line.
Be careful not to confuse a parameter type with a specific instance of that parameter. A parameter such as file1 ?file2?..., which indicates that you can specify more than one file, is considered to be a single parameter type; myFile and yourFile are specific instances of that parameter.
This section describes all the command line options that can be used with a particular proc, or built-in command. You use them to tailor a command to your needs.
You can distinguish options to the commands from parameters (which are most frequently filenames) by the hyphen (-) that immediately precedes an option. This hyphen is part of the option and must always be included.
Options can have their own parameters, which are also described in this section. In general, if you specify an option that has parameters, you must also specify at least one of its parameters.
Using one or more examples, this section illustrates the uses of a proc, or built-in command, either alone or within enclosing procs. Examples proceed from relatively easy tasks (often the default behavior) to more complicated ones (using multiple options) that are custom designed for a specific purpose.
This section is included for some commands to point out certain limitations, warnings, or special cases of which you should be aware.
This section provides references to other relevant information.
This section, in the case of Tcl procedures (procs), list the name of the .tcl file that contains the proc.