使用方法メッセージ

コンピュータ プログラミングにおいて、使用方法メッセージまたはヘルプ メッセージは、実行にコマンド ライン インターフェイスを使用するプログラムによって表示される短いメッセージです。このメッセージは通常、プログラムの正しいコマンド ライン使用方法で構成され、そのプログラムで許容される正しいコマンド ライン引数またはオプションのリストが含まれます。

使用方法メッセージは、プログラムがユーザーに適切なコマンド構文を通知するための簡単な方法として利用されるものであり、適切なエラー メッセージやマニュアル ページなどの詳細なドキュメントの代わりにはなりません。

Unix 系プラットフォームでは、使用方法メッセージは通常、同じ共通パターンに従います。

• 多くの場合、コマンドである「使用方法:」で始まり、その後に引数のリストが続きます。
• オプションの引数を示すために、角括弧が一般的に使用され、一緒に指定する必要があるパラメータをグループ化するためにも使用できます。
• 必須の引数を示すには、角括弧と同じグループ化規則に従って、山括弧が一般的に使用されます。
• 排他的なパラメータは、グループ内で縦棒で区切ることで示されます。

以下はNetBSDソースコード スタイル ガイド に基づいた例です。

使用法: プログラム [-aDde] [-f | -g] [-n 番号] [-b b_arg | -c c_arg] req1 req2 [opt1 [opt2]]

これは、「プログラム」を次のように呼び出す必要があることを示します。

• オペランドのないオプション: a、D、d、e (いずれも省略可能)。この場合、一部のパラメータは大文字と小文字が区別されることに注意してください。
• 排他オプション: f、g (縦棒で示される)
• オペランド付きオプション: n
• 排他的オプション（オペランド：b、c）
• 必須引数: req1、req2
• オプション引数 opt1 は、opt2 の有無にかかわらず使用できます (グループ内では別の角括弧を使用してオプションとしてマークされています)
• オプション引数opt2（opt1が必要）

シェル スクリプトで使用方法のステートメントを出力するには、次のように記述します。

ケース「$ arg 」  
...
h ) printf '使用法: %s パラメータ1 パラメータ2 ...\n' " $( basename " $0 " ) " exit 0 ;;    
    
   
...
エサック

使用方法の説明はエラーメッセージではないため、通常はユーザーが明示的に要求した場合にのみ印刷されます ( --help、 、-h、-?または同様のフラグや引数を使用)。 使用方法の説明は標準出力に書き込まれます。^{[1] [2]}ユーザーが間違ったコマンドを入力した場合、プログラムは理想的には、使用方法の説明を印刷してユーザーに間違いの原因を突き止めさせるのではなく、ユーザーが犯した正確なエラーを説明する簡潔なエラーメッセージで応答する必要があります。 たとえば、ユーザーが正しい数の引数を渡さなかった場合、一般的な使用方法を示す数ページの出力よりも、引数が不足していることを示す 1 行の方がはるかに役立ちます。

• コマンドラインインターフェース