14.3 コマンドの説明形式
この章では、パラメタファイルを使用できるコマンドについては、パラメタファイルの使用を前提に説明します。パラメタファイルとコマンドの引数のどちらでも指定できる項目は、パラメタファイル中で指定する項目として説明します。なお、同じ内容をコマンドの引数を使って指定する場合については、各コマンドの「パラメタファイルを使用しない場合のコマンド形式」を参照してください。
パラメタファイルには、コマンド実行時に必要なパラメタを内容別のタグで分けて記述します。パラメタファイルを作成するには、まず設定するパラメタに対応するタグをパラメタファイルの指定内容の表で確認したあと、そのタグの指定方法を「14.19.3 タグの指定方法」で調べてください。タグの種類やパラメタファイルの形式については、「14.19 パラメタファイルの作成」を参照してください。
パラメタファイルとコマンドの引数の両方を指定した場合は、コマンドの引数で指定した内容が有効となり、パラメタファイルでの指定は無視されます。ただし、dcmpkgetコマンドの場合は、一部パラメタファイルの定義が有効になる場合があります。dcmpkgetコマンドの詳細は、「14.10 dcmpkget.exe（パッケージのバックアップの取得）」を参照してください。
各コマンドで説明する内容を、次に示します。
- 機能
-
コマンドの機能を示します。
- 形式
-
コマンドを指定するときの文法を示します。［ ］で囲まれている引数は省略できます。パラメタファイルを使用できるコマンドについては、パラメタファイルの使用を前提に示しています。
- 形式の例
dcmXXXX.exe [/A] [/B] /i パラメタファイル1 [パラメタファイル2]
上記の形式では、「/i パラメタファイル1」以外の引数は省略できます。また、パラメタファイルは2つまで指定できます。
- 引数
-
「形式」で示した各引数について説明します。ここで説明する引数は、パラメタファイルでは指定できない引数です。
- パラメタファイルの指定内容とコマンド引数との対応
-
コマンドで使用するパラメタファイルの指定内容を表で示します。また、パラメタファイルの内容をコマンドの引数を使っても指定できる場合は、各パラメタとコマンド引数の対応も示します。
パラメタファイルに指定する内容の詳細、および省略時のデフォルト値については、「14.19 パラメタファイルの作成」を参照してください。パラメタファイルとコマンドの引数の両方を指定した場合は、コマンドの引数で指定した内容が有効となり、パラメタファイルでの指定は無視されます。
パラメタファイルの内容が引数で指定できないコマンドでは、見出しは「パラメタファイルの指定内容」です。
- パラメタファイルを使用しない場合のコマンド形式
-
パラメタファイルを使用しないで、コマンド引数だけを使用して指定する場合のコマンド形式を示します。|（ストローク）で区切られた項目は、そのうちのどれか1つを指定することを示します。
- 形式の例
dcmXXXX.exe [/A|/B] /j ジョブ名称 [/l ジョブ格納フォルダパス]
上記の形式では、「/j ジョブ名称」以外の引数は省略できます。また、「/A」または「/B」を指定できます。
パラメタファイルの内容を引数で指定できないコマンド、およびパラメタファイルを使用できないコマンドについては、この項目はありません。
- リターンコード
-
コマンド実行時のリターンコードを示します。
- 注意事項
-
コマンドの注意事項がある場合に説明します。
- 実行例
-
コマンドの実行方法を、実際の例を挙げて説明します。