コマンドの要約を作成する標準がありますか?

コマンドの要約を作成する標準がありますか?

私の考えでは、誰もが記事を書く方法について自分の考えを持っています。要約説明するコマンドの使い方エンドユーザー用。

たとえば、次の形式ですman grep

grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]

今、別のマンページに表示されるいくつかの構文があります。 []オプションとみなされ、...同じ入力の倍数でのみ意味があります。

しかし、人々はORの代わりに|orを使用し、他の人は意味を逆に使用します。それともどこに行くべきかは何も指示しませんでした。 /[][OPTIONS]

私が書いている記事の標準に従いたいのですが、私が見ているサイトごとに異なる内容があります。

本当のものがありますか?基準シノプシスを使う方法ですか、それとも慣習は人々が長い間やってきた方法ですか?

ベストアンサー1

古典的な標準はPOSIXから来ました。ユーティリティパラメータの構文(更新されたリンクを提供してくれた@illuminÉに感謝します)。マニュアルページで使用される構文を説明します。

utility_name[-a][-b][-c option_argument]
    [-d|-e][-f[option_argument]][operand...]

伝統的に単一文字オプションを使用することをお勧めし、-Wベンダーにお勧めします。これはマルチ文字オプションが適用される方法です(例を参照)。gcc オプションの概要)。

GNUソフトウェアは--help2man リファレンス

おすすめ記事