マンページの概要を理解する


27

コマンドのマンページの「概要」セクションを理解できませんでした。たとえば、manそれ自体のマンページを見てみましょう。によってman man

SYNOPSIS
       man  [-C  file]  [-d]  [-D]  [--warnings[=warnings]]  [-R encoding] [-L
       locale] [-m system[,...]] [-M path] [-S list]  [-e  extension]  [-i|-I]
       [--regex|--wildcard]   [--names-only]  [-a]  [-u]  [--no-subpages]  [-P
       pager] [-r prompt] [-7] [-E encoding] [--no-hyphenation] [--no-justifi‐
       cation]  [-p  string]  [-t]  [-T[device]]  [-H[browser]] [-X[dpi]] [-Z]
       [[section] page ...] ...
       man -k [apropos options] regexp ...
       man -K [-w|-W] [-S list] [-i|-I] [--regex] [section] term ...
       man -f [whatis options] page ...
       man -l [-C file] [-d] [-D] [--warnings[=warnings]]  [-R  encoding]  [-L
       locale]  [-P  pager]  [-r  prompt]  [-7] [-E encoding] [-p string] [-t]
       [-T[device]] [-H[browser]] [-X[dpi]] [-Z] file ...
       man -w|-W [-C file] [-d] [-D] page ...
       man -c [-C file] [-d] [-D] page ...
       man [-hV]
  1. 概要セクションでは、コマンドの構文について説明していますか?
  2. それら[...][...]内部は[...] どういう意味ですか?それらはオプションのものを意味しますか?
  3. |OR はどういう意味ですか?
  4. どういう,意味[-m system[,...]]ですか?
  5. 概要セクションは、正規表現に使用される規則に従っていますか?

関連:POSIX標準の「ユーティリティの表記法」:pubs.opengroup.org/onlinepubs/9699919799/basedefs/...
Kusalananda

回答:


25
  1. 概要セクションでは、通常、いくつかの使用例を示します。サブコマンドには異なるオプションがある場合があるため、いくつかの例を示します。
  2. 括弧は[]常にオプションのスイッチ、引数、オプションなどを示します。
  3. はい、パイプ|は、または特に括弧または括弧内の場合を意味します。
  4. 括弧内の括弧は、2番目の部分が最初の部分に依存し、それ自体がオプションであることを意味します。一部のスイッチは、単独で使用することも、値を追加することもできます。括弧の先頭のカンマは、複数のコンマ区切り値が存在する可能性があることを示します。
  5. 彼らは正規表現の概念に頼っていますが、人間が読めるように意図されているので、すべてのエスケープ規則などに従ってはいけません。

ありがとう!概要の構文を説明する参考文献はありますか?
ティム

@ティム:それは私が見た中で最もクレイジーなものの1つです。もう少し読むと、それを理解できると思います。これは単なる慣習であり、魔法ではありません。
カレブ

9

参照が必要な場合、それらは大まかにEBNFに基づいています。


3

manmanページから:


次の規則は、「概要」セクションに適用され、他のセクションのガイドとして使用できます。 男のあらすじの説明

正確なレンダリングは、出力デバイスによって異なる場合があります。たとえば、通常、端末で実行している場合、人間は斜体をレンダリングできません。通常、代わりに下線付きまたは色付きのテキストを使用します。

コマンドまたは関数の図は、考えられるすべての呼び出しに一致するパターンです。場合によっては、このマニュアルページの「概要」セクションに示されているように、いくつかの排他的な呼び出しを説明することをお勧めします。


3

コマンドラインユーティリティ引数構文の意味を理解するための別のソースは、POSIX.1-2008(2013 Edition)標準の第12章に記載されているユーティリティ引数構文規則と第9章に記載されている正規表現です。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.