使用方法の説明文

使用方法の説明文は、少なくとも 1 つの無効なフラグがコマンド行で指定された場合に、コマンドによって生成されます。フラグに関連付けられたデータがない場合または不正な場合は、使用方法の説明文は使用してはなりません。そのような場合は、その問題に固有のエラー・メッセージが使用されます。

• 使用方法の説明文にはコマンド形式を示します。たとえば、del コマンドの使用方法の説明文の例は次のとおりです。

     Usage: del {File ...|-}

• コマンドの目的を定義する節は削除してください。

• File、Directory、String、Number などの語 (パラメータ) の最初の文字は、使用方法の説明文で使用するときだけ大文字にします。

• コマンド行でパラメータを省略形にしないでください。経験のあるユーザにとっては Num が Number であることは明らかですが、それでも確実に正しく翻訳されるように略さず書いてください。

• 使用方法の説明文では、区切り文字は次のものだけを使用します。

  区切り	文字説明
  []	パラメータはオプションです。
  { }	パラメータの選択肢が 2 つ以上ありますが、そのうちの 1 つが必要です (下のテキストを参照)。
  |	パラメータを 1 つだけ選択してください。[a|b] は、a か b のいずれかを選択するか、a も b もどちらも選択しなくて良いという意味です。{a|b} は、a と b のいずれかを選択しなければならないと言う意味です。
  ..	そのコマンド行でパラメータを繰り返せます (この記号の前にスペースが 1 つ入ることに注意)。
  -	標準入力です。

• 使用方法の説明文パラメータは、角括弧や中括弧を必要としません。もし必要で、それが唯一の選択肢の場合は、下記のようになります。

     banner String

• 使用方法の説明文では、コマンド行中で分けられなければならないフラグの間にスペースを 1 つ入れます。次に例を示します。

     unget [-n] [-rSID] [-s] {File|-}

• 区切りスペースなしで複数のフラグを一緒に使用できる場合は、フラグをコマンド行でスペースによって分けないでください。次に例を示します。

     wc [-cwl] {File ...|-}

• コマンド行でのフラグの順序に特に意味がない場合は、フラグをアルファベット順に並べます。大文字と小文字が混在する場合は、小文字を先にします。

     get -aAijlmM

• 使用方法の説明文が長くて改行する場合があります。使用方法の説明文をどこで終わらせるかはよく考えて決めてください。次の例は、get コマンドの古い形式の使用方法の説明文です。

     Usage: get [-e|-k] [-cCutoff] [-iList] [-rSID] [-wString] [xList] ¥
             [-b] [-gmnpst] [-l[p]] File ...
  Retrieves a specified version of a Source Code Control System (SCCS) file.