Conventions: Difference between revisions
(New page: = Conventions = This section describes the use of the manual and the conventions used to denote the parameters and choices associated with each statement. The program accepts input in a f...) |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
This section describes the use of the manual and the conventions used to denote the parameters and choices associated with each statement. The program accepts input in a fashion similar to SUPREM III and PISCES II. The input is made up of a series of statements. It is important to bear in mind that the parser is case sensitive, ''i.e.'' FOO is not the same as foo. Parameter values may be abbreviated, along as the abbreviation uniquely identifies the parameter. | This section describes the use of the manual and the conventions used to denote the parameters and choices associated with each statement. The program accepts input in a fashion similar to SUPREM III and PISCES II. The input is made up of a series of statements. It is important to bear in mind that the parser is case sensitive, ''i.e.'' FOO is not the same as foo. Parameter values may be abbreviated, along as the abbreviation uniquely identifies the parameter. | ||
| Line 11: | Line 9: | ||
The manual describes these parameters in the following form: | The manual describes these parameters in the following form: | ||
; param = <n> | ; param = <n> | ||
: a real valued parameter | : a real valued parameter | ||
| Line 27: | Line 23: | ||
Most commands now accept -help as a parameter. This will output a list of command parameters, defualts, parameter type, and a short help string for each. | Most commands now accept -help as a parameter. This will output a list of command parameters, defualts, parameter type, and a short help string for each. | ||
Latest revision as of 12:52, 11 June 2020
This section describes the use of the manual and the conventions used to denote the parameters and choices associated with each statement. The program accepts input in a fashion similar to SUPREM III and PISCES II. The input is made up of a series of statements. It is important to bear in mind that the parser is case sensitive, i.e. FOO is not the same as foo. Parameter values may be abbreviated, along as the abbreviation uniquely identifies the parameter.
Each statement can have parameters which are of the form:
parameter_name = value
Value is either a real number expression or a character string. There are some parameters that are booleans, which recognize true and false as special strings. If the value is left off a boolean parameter, it is set to true.
The manual describes these parameters in the following form:
- param = <n>
- a real valued parameter
- param = <c>
- a string valued parameter
- !param
- a boolean parameter set false
- param
- a boolean parameter set true
Choices are denoted by putting the parameters in parenthesis and separating them by vertical bars. For example, ( par1 | par2 ) states that either par1 or par2 may be specified but not both. Anything enclosed in brackets [ ] are optional parameters and aren't necessary. Almost everything in the program has some sort of default value, so almost all parameters are optional. In case of doubt, though, never rely on the defaults.
Command Options
Most commands now accept -help as a parameter. This will output a list of command parameters, defualts, parameter type, and a short help string for each.