コマンドライン/シェルのヘルプテキストの「標準」形式はありますか？

そうでない場合、事実上の標準はありますか？基本的に私はコマンドラインのヘルプテキストを次のように書いています：

usage: app_name [options] required_input required_input2
  options:
    -a, --argument     Does something
    -b required     Does something with "required"
    -c, --command required     Something else
    -d [optlistitem1 optlistitem 2 ... ]     Something with list

基本的にはさまざまなツールのヘルプテキストを読んだだけですが、ガイドラインのリストなどはありますか？たとえば、角括弧または括弧を使用しますか？間隔の使い方は？引数がリストの場合はどうなりますか？ありがとう！

通常、ヘルプ出力には以下が含まれます。

• アプリの機能の説明
• 使用構文：
  • [options]オプションの場所を示すために使用します
  • arg_name 必須の単数引数
  • [arg_name] オプションの単数引数
  • arg_name... 必要な引数が多数ある場合がある（これはまれです）
  • [arg_name...] 任意の数を指定できる引数の場合
  • arg_name小文字のヘビの場合、わかりやすい短い名前である必要があることに注意してください
• うまくフォーマットされたオプションのリスト、それぞれ：
  • 短い説明がある
  • デフォルト値がある場合は表示する
  • 該当する場合、可能な値を表示
  • オプションが短い形式（例：）-lまたは長い形式（例：）を受け入れることができる場合、--listそれらの説明は同じであるため、同じ行に一緒に含めてください。
• コマンドライン引数のソースとなる可能性のある設定ファイルまたは環境変数の場所の簡単なインジケーター、例えば GREP_OPTS
• マニュアルページがある場合はそれを示し、そうでない場合は、より詳細なヘルプがどこにあるかを示す簡単なインジケーター

それは両方を受け入れることをいい形だと、さらに注意-hして--help、このメッセージをトリガすると、コマンドライン構文アップユーザー台無し場合は、このメッセージを表示する必要があること、などを省いaが引数を必要としていました。

docoptを見てください。これは、コマンドライン引数を文書化（および自動的に解析）するための正式な標準です。

例えば...

Usage:
  my_program command --option <argument>
  my_program [<optional-argument>]
  my_program --another-option=<with-argument>
  my_program (--either-that-option | <or-this-argument>)
  my_program <repeating-argument> <repeating-argument>...

コマンドラインの使用法には標準的な構文はないと思いますが、ほとんどはこの規則を使用しています

Microsoft コマンドライン構文、IBMには同様のコマンドライン構文があります。

• Text without brackets or braces

  次のように入力する必要がある項目
  
  

• <Text inside angle brackets>

  値を指定する必要があるプレースホルダー
  
  

• [Text inside square brackets]

  オプション品
  
  

• {Text inside braces}

  必要なアイテムのセット。一つ選ぶ
  
  

• 縦棒 {a|b}

  相互に排他的なアイテムのセパレータ。一つ選ぶ
  
  

• 省略 <file> …

  繰り返すことができるアイテム
  
  

私たちは、ほとんどがPOSIX準拠のOSであるLinuxを実行しています。POSIX標準は次のとおりです。ユーティリティ引数構文。

• オプションでは、このような単一の英数字が続くハイフン、次のとおりです-o。
• オプションには引数が必要な場合があります（引数はオプションの直後に指定する必要があります）。たとえば、-o argumentまたは -oargument。
• 引数を必要としないオプションはハイフンの後にグループ化できるため、たとえば-lstと同等-t -l -sです。
• オプションは任意の順序で表示できます。したがって、-lstと同等-tlsです。
• オプションは複数回表示できます。
• オプションは他の非オプション引数に先行します：-lst非オプション。
• --引数には、オプションを終了します。
• この-オプションは通常、標準入力ストリームの1つを表すために使用されます。

Microsoftには独自のコマンドライン標準仕様があります。

このドキュメントは、コマンドラインユーティリティの開発者を対象としています。まとめると、私たちの目標は、一貫性のある構成可能なコマンドラインのユーザーエクスペリエンスを提供することです。これにより、ユーザーはコアコンセプトのセット（構文、命名、動作など）を学習し、その知識を多数のコマンドセットでの作業に変換できます。これらのコマンドは、標準化されたデータストリームを標準化された形式で出力でき、出力テキストのストリームを解析する負担なしに簡単に構成できるようにする必要があります。このドキュメントは、シェル、ユーティリティのセット、またはコマンド作成テクノロジの特定の実装に依存しないように作成されています。ただし、付録J-Windows PowerShellを使用したMicrosoftコマンドライン標準の実装では、Windows PowerShellを使用してこれらのガイドラインの多くを無料で実装する方法を示しています。

GNU Coding Standardは、このようなものの良いリファレンスです。このセクションでは、の出力を扱います--help。この場合、それほど具体的ではありません。短いオプションと長いオプション、および簡潔な説明を示す表を印刷することで、おそらく間違いはありません。読みやすくするために、すべての引数の間隔を正しく設定してください。ツールのmanページ（および場合によってはinfoマニュアル）を提供して、より詳細な説明を提供することをお勧めします。

はい、あなたは正しい軌道に乗っています。

はい、角括弧はオプション項目の通常のインジケーターです。

通常、スケッチしたように、上部にコマンドラインの概要があり、その後に詳細が続き、理想的には各オプションのサンプルがあります。（例では、各オプションの説明の間に行が表示されていますが、これは編集の問題であり、実際のプログラムは空白行のないインデントされたオプションのリストを出力することを想定しています。これはどの場合でも従うべき標準です。）

新しい傾向（これに対処するPOSIX仕様があるかもしれませんか？）は、ドキュメントのマンページシステムが削除され、マンページに含まれるすべての情報がprogram --help出力の一部として含まれるようになりました。この補足には、より長い説明、概念の説明、使用例、既知の制限とバグ、バグの報告方法、および関連コマンドの「参照」セクションが含まれます。

これがお役に立てば幸いです。

私は例としてタールのような公式プロジェクトに従います。私の意見では、メッセージを助けます。できるだけシンプルでわかりやすいものにする必要があります。使用例も良いです。「標準的なヘルプ」は実際には必要ありません。