Paramters for the command stored in .prm file
BASICS
Optional paramters for commands are stored in a ".prm file"
with the extension ".prm".
Most parameter entry of the file corresponds to the option
keyword in the command line step by step.
If you use the same set of option keywords for commands,
the .prm file reduces your key typing.
The command line option keywords override them.
So you can custumize the STAR/ULTRA commands by yourself.
Default location of .prm files are assigned by the envilonment
parameter STAR_PRM.
The default file name for each command is shown in corresponding
man page; most of them are the same as the command name attached
with ".prm" extension.
For example,
The "display.prm" is for display command.
The option "-prm" is not supported, which means the prm file
is not called recarsively. Therefore you can use the same
prm file to apply several different commands.
The .prm file consists parameter entries and comments.
PARAMTER ENTRY
The most lines of the .prm file are "parameter entries".
The line contains at least one field.
Each field is divided by the character "=".
If the parameter name is not supported by the command, it is neglected.
- Keyword field
- The first field is for keyword.
The keyword is the same as the corresponding option keyword
but without first "-" character.
The option "-prm" is not supported, which means the prm file
is not called recarsively.
- Value field
- If the keyword requires its value, you must put the proper
value in the value field.
In the option keyword in a command line if you want to input
blank characters, you must use backslash or quartations to escape
OS shell processing. But in a prm file you do not use such kind of
escape; you can give blanks as it is directly.
COMMENT ENTRY
Free comments can be written in the .prm file.
The first character of the sdb comment must be "#".
ENVIRONMENT
- STAR_PRM
- Default directory where .prm files are.
SEE ALSO
All STAR/ULTRA commands which accept option keywords.
BUGS
HISTORY
- ver.1
- 1997/11/18 T.Handa
MANUAL VERSION
1998/5/23 T.Handa