運用コマンドの概要
運用コマンドの入力方法および記述形式について説明します。
入力方法
TP1/Message Queueの運用コマンドの入力方法には,シェルから入力する方法と,アプリケーションの中に組み込んで実行する方法があります。
TP1/Message Queueの運用コマンドは,すべてアプリケーションから実行できます。アプリケーションから実行するには,OpenTP1の提供するdc_adm_call_command関数を使用して実行します。したがって,コマンドがあるディレクトリを,OpenTP1のユーザサービス定義のputenv PATHであらかじめ定義しておいてください。コマンドの実行結果は,アプリケーションに返されます。返される内容は,標準出力または標準エラー出力に出力される値です。
記述形式
運用コマンドの記述形式を次に示します。
コマンド名 オプション コマンド引数
コマンド名
コマンド名は,実行するコマンドのファイル名称です。
OpenTP1の運用コマンドは$DCDIR/bin/にありますので,PATHに$DCDIR/binを加えてください。
オプション
次に示す説明中に使用する「$」はシェルのプロンプト,「cmd」はコマンド名称です。
-
オプションはマイナス記号(-)で始まる文字列で,フラグ引数を取らないか,または1個のフラグ引数を取ります。
オプションの記述形式を次に示します。
-オプションフラグ または -オプションフラグ フラグ引数
オプションフラグは,1文字の英数字(英大文字と英小文字は区別されます)です。
フラグ引数は,オプションフラグに対する引数です。
-
フラグ引数を取らないオプションフラグは,一つのマイナス記号(-)の後ろにまとめて指定できます。
(例)次に示す二つは同じ意味です。
$ cmd -a -b -c $ cmd -abc
-
フラグ引数を必要とするオプションフラグのフラグ引数は,省略できません。
-
フラグ引数中に空白を含める場合で,シェルから入力するときには,前後を引用符(")で囲まなければなりません。
(例)1 2を引数に持つオプションfは,次に示すとおり記述します。
$ cmd -f "1 2"
-
同じオプションフラグを2回以上指定すると,最後に指定したものが有効になります。
(例)
$ cmd -a 1 -a 2 無効 有効
-
オプションは,コマンド引数より前に指定しなければなりません。
(例)
オプションフラグaが,フラグ引数を取らない場合,次に示すとおり入力すると,fileと-bは,コマンド引数とみなされます。
$ cmd -a file -b
-
二つのマイナス記号(-)は,オプションの終わりを示します。
(例)
次に示すとおり入力すると,-bはコマンド引数とみなされます。
$ cmd -a -- -b
-
マイナス記号(-)だけのオプションは入力できません。
(例)
次に示すとおり入力すると,-はコマンド引数とみなされます。
$ cmd -
コマンド引数
コマンド引数は,コマンド操作の対象になるものを指定します。