了解联机帮助页中的概要

Question

我无法理解命令手册页中的 SYNOPSIS 部分。例如，让我们看看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. SYNOPSIS 部分是否描述了命令的语法？
2. 这些[...]和[...]里面[...] 是什么意思？他们的意思是可选的吗？
3. 是否|意味着OR？
4. 是什么,意思[-m system[,...]]？
5. 概要部分是否遵循用于正则表达式的规则？

Answer 1

1. 概要部分通常会提供一些示例用例。有时子命令有不同的选项，因此可能会显示几个示例。
2. 括号[]总是表示可选的开关、参数、选项等。
3. 是的，管道|表示或，特别是在括号或圆括号内时。
4. 括号中的括号仅表示第二部分依赖于第一部分，并且本身也是可选的。您可以单独使用某些开关或为其添加值。括号开头的逗号表示可以有多个逗号分隔的值。
5. 它们依赖于 Regex 概念，但旨在让人类可读，因此不要遵循所有转义规则等。

Answer 2

从man手册页：

以下约定适用于 SYNOPSIS 部分，并可用作其他部分的指南。

确切的渲染可能因输出设备而异。例如，在终端中运行时， man 通常无法呈现斜体，并且通常会使用带下划线或彩色的文本来代替。

命令或函数说明是一种应该匹配所有可能调用的模式。在某些情况下，建议说明几个独占调用，如本手册页的 SYNOPSIS 部分所示。