UltraSTAR の基本

一般の規則

共通のキーワード

すべてのコマンドは共通のオプションキーワードとして -keywordlist を持つ。このオプションを 指定したときには、コマンドはオプションキーワードのリストを 表示するだけで、ほかの機能は一切しない。
もうひとつの共通オプションは -prm で、 使う.prmファイルをexplicitに指定する働きをする。 ファイル名が "/" で始まる場合は、(UNIX/LINUX OS と同様に)ファイルの絶対パスを指す。そうでない場合は、 環境変数STAR_PRM からの相対パスを指す。

パラメータファイル

オプションキーワードのほとんどすべてを .prm ファイルで指定することができる。.prm ファイルを使うことによってタイピングの手間が省ける。.prm ファイルの一行が相当するオプションひとつに相当する。"#" で始まる行はコメントである。キーワードとその値は "=" で区切られる。キーワードはコマンドラインのオプションキーワードと 同一(ただし先頭の "-" を含まない)である; たとえば、 -n_column に相当するオプションはn_column となる。
.prm ファイルのデフォルトディレクトリは環境変数 STAR_PRM によって与えられる。STAR_PRM が指定されていない場合には カレントディレクトリを検索する。コマンドごとの デフォルトファイル名はマニュアルページを参照。 たいていはコマンド名に拡張子 ".prm" を付加したもの (display コマンドに対しては "display.prm")となる。

文法構造

名称

コマンドの名称とごく簡単な説明。名称は 強調表示 される。

使用法

コマンドラインの簡単な説明。コマンド自身は 強調表示される。コマンド自身のあとには、 コマンドの働きを制御するオプションキーワードが続く。 変数はコマンドに与えられるパラメータである。 括弧 [ ] に入っているキーワード and/or 変数 は省略可能である。 括弧中で縦棒 | に区切られたパラメータは排他的である。 すなわち、それらのうちひとつだけを指定しなければならない。

フィルタ種別

コマンドはデータ入出力によっていくつかの型に分類できる。.scn フローを入力とするものと .sdb フローを入力とするものがある。 出力についても同様である。この章では、コマンドの型を以下のように記述する。

.scn | command | .sdb 

上の .scn および .sdb がファイルを表すのではないことに注意。
フローが括弧に入っている、すなわち

.scn | command (| .sdb ) 

のような場合は、コマンドがフローを出力しないか、 フローの入力を受け付けないことを示す。

フローの出力を伴うコマンドを実行したとき、コマンドウインドウの 表示が乱れることがある。このような場合、Xウインドウを使っているならば、 ctrlキーを押しながらシェルウインドウを中ボタンクリックし、 現れるポップアップメニューから"Do full reset"を選ぶと 正常な状態に戻る。xterm の man ページを参照のこと。

機能

コマンド自体についての詳細情報。

オプション

オプションキーワードについての詳細情報。

パラメータ

.prm ファイルに記述するパラメータが 対応するオプションキーワードと違う振舞いをする場合にのみ記述される。

GUI

いくつかのコマンドには GUI モードが用意されており、 パラメータを作業ウインドウ上で対話的に指定することができる。 作業ウインドウは自動的にあらわれる。この章は表示の意味、 およびウインドウ上のボタンやメニューバーについての説明である。
ほとんどのコマンドには "next", "print", "quit" および "help" の4 つ(あるいはそれ以上)のボタンがある。"next" は次のページあるいはプロセスに進むためのボタンである。"quit" は処理を中断し、以降のプロセスをすべてキャンセルする。

デフォルト

オプションキーワードや .prm ファイルによる指定がないときのデフォルト設定。

環境変数

コマンドの使うシェル環境変数。

参照

関連のあるコマンド and/or ファイル。

バグ

見つかっているバグ。

履歴

コマンドのアップグレードの履歴と最新バージョンに関する情報。

マニュアルのバージョン