コマンドの詳細
ここでは,コマンドの説明形式と説明順序について説明します。
コマンドの説明形式
各コマンドで説明する項目は次のとおりです。ただし,コマンドによっては説明しない項目もあります。
- 機能
- コマンドの機能およびコマンドの実行に必要なユーザの権限について説明しています。
- 形式
- コマンドの形式を説明しています。
- コマンドを実行できるサーバ
- コマンドを実行できるサーバについて説明しています。
- 格納先フォルダまたはディレクトリ
- コマンドの格納場所について説明しています。
- 引数
- コマンドの引数について説明しています。なお,スペースを含むパスを指定する場合は,「"」で囲んで指定してください。
- 注意事項
- 注意事項を説明しています。
- 戻り値
- コマンドの戻り値について説明しています。
なお,コマンド実行時に表示されるメッセージについては「14.3 メッセージ一覧」を参照してください。
コマンドの説明順序
コマンドは,コマンド名のアルファベット順で説明しています。