General basics of UltraSTAR

GENERAL RULES

common keywords

All commands have the common option keyword for command line; which is -keywordlist. This option totaly changes the function of the command. The command with the option prints only the list of option keywords and does not work any other functions.
Another common option is -prm which explicitly gives the .prm file which should be used. If the given file name is started by the character "/", it means the abslute pass name like UNIX/LINUX OS. If it is not, it means the relative pass name, but in the directory assigned by the envilonment parameter STAR_PRM at first.

parameter file

Almost all option keywords can be assigned in the .prm file. You can reduce your keytyping using the .prm file. One line in the .prm file corresponds to one option. The line with the character "#" in the first column means comment. The keyword and its value in a line are devided by "=". The keyword is the same as the option keyword but no "-" character as the first; for example -n_column corresponds n_column.
The default directory for the .prm files are assigned by the envilonment parameter STAR_PRM. If it is not set, search the current directory. The default file name for the proper command is given in a manual page; most of them are the command name attached with the extension ".prm" like "display.prm" for the display command.

GRAMATICAL STRUCTURE

NAME

The name of the command and its shortest destription. The name is typed in emphasysed like this.

SYNOPSIS

Short destription of the command line. The command itself is typed in emphasysed. The command is followed by optional keywords which give optional function for the command. The valuables are parameters attaching to the command. If the keyword and/or valuable is in blanket [ ], it is not required. Several parameters devided by bar (|) in a blanket are exclusive. You should assign only one of them.

FILTER TYPE

The command is categolized into several types depending on the data I/O. Some are .scn flow as an input, others are .sdb flow as an input. Similar for output. In this section the type is shown as

.scn | command | .sdb 

Be care that .scn and .sdb are not for the files in the above expression.
If the flow key is in parens, like

.scn | command (| .sdb ) 

then the command does not make outflow or not accept inflow.

If you execute some command with outflow, the command window may show strange characters. In this case and you are in xterm, push the middle button on your mouse with cntl key on the shell window. The popup menu appears and choose "Do full reset". Then the window is recovered. See manual page of the command xterm on your system.

DESCRIPTION

In this section detail explanations for the command are given.

OPTIONS

Detail explanations for the option keywords are given in this section.

PARAMETERS

This section will be described only if parameters in the .prm file is out of the general rules corresponding option keywords.

GUI

Some commands can be used in the GUI mode in which you can assign and chage parameters interactively through a working window. The working window automatically appears. This section shows the meaning of the display and instructions for buttons on a menu bar at the top of the window.
Most commands show more than 4 buttons on the menu bar, which are "next", "print", "quit" and "help". The next button is to proceed the next page of process. The quit button is to stop and cancel all processes after this command step.

DEFAULTS

This section gives system defaults if no option keywords nor the .prm file is attached.

ENVIRONMENT

This section gives the shell environment parameters which uses in the command.

SEE ALSO

Related commands and/or files are given in this section.

BUGS

Found bugs are given in this section. Undescoverd bugs are not given.

HISTORY

The upgrade history and the latest version of the command.

MANUAL VERSION