[解決済み】コマンドライン/シェルヘルプのテキストに「標準」フォーマットはありますか？

質問

ない場合、デファクトスタンダードはあるのでしょうか？基本的に私は、コマンドラインのヘルプテキストをこのように書いています。

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
• man ページがある場合はそのように示し、そうでない場合は、より詳細なヘルプを見つけることができる場所を簡単に示します。

さらに、以下の両方の形式を受け入れるのが良い方法であることに注意してください。 -h と --help をクリックすると、このメッセージが表示されます。 と ユーザがコマンドラインの構文を間違えた場合、例えば必須の引数を省略した場合などにこのメッセージを表示する必要があることを示します。