コマンドの記述形式について説明します。
各コマンドで説明する項目は次のとおりです。ただし,コマンドによっては説明しない項目もあります。
- 機能
- コマンドの機能について説明しています。
- 形式
- コマンドの指定形式を次の形式で説明しています。
- コマンド名[[/オプション[値]]…]
- /オプションと値の組み合わせを「オプション」と呼びます。各コマンドのオプションをまとめて「引数」と呼びます。
- 引数
- コマンドの引数について説明しています。
- 格納先
- コマンドの格納場所について説明しています。
- 実行権限
- コマンドの実行に必要なユーザーの権限について説明しています。
- 注意事項
- コマンド使用時の注意事項を説明しています。
- 戻り値
- コマンドの戻り値について説明しています。
- なお,コマンド実行時に表示されるメッセージについては,マニュアル「JP1/AO メッセージ」を参照してください。
- コマンドによっては監査ログを出力します。監査ログを出力するコマンド,監査の対象となる操作,および出力されるメッセージIDについては,マニュアル「JP1/AO 運用ガイド」の「監査ログに出力される事象の種別」のトピックを参照してください。
- 使用例
- コマンドの使用例について説明しています。