☰

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

tag-icon • tag-icon command-line man
コマンドの要約を作成する標準がありますか？

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

たとえば、次の形式です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 リファレンス。

答え2

SYNOPSIS実際に、で（驚くべきことに！）を探して答えを見つけることができます。man 7 man-pagesそれは言う:

       SYNOPSIS      A brief summary of the command or function's interface.

                     For commands, this shows the syntax of  the  command  and
                     its  arguments  (including options); boldface is used for
                     as-is text and italics are used to  indicate  replaceable
                     arguments.   Brackets  ([])  surround optional arguments,
                     vertical bars (|) separate choices,  and  ellipses  (...)
                     can  be  repeated.   For functions, it shows any required
                     data declarations or #include directives, followed by the
                     function declaration.

                     Where  a  feature  test macro must be defined in order to
                     obtain the declaration of a function (or a variable) from
                     a header file, then the SYNOPSIS should indicate this, as
                     described in feature_test_macros(7).

関連情報