了解联机帮助页中的概要

了解联机帮助页中的概要

我无法理解命令手册页中的概要部分。例如,让我们看看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. 概要部分是否遵循正则表达式使用的规则?

答案1

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

答案2

man手册页:


以下约定适用于概要部分,并且可以用作其他部分的指南。 男人的剧情简介· · · · · ·

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

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

答案3

理解命令行实用程序参数语法含义的另一个来源是实用程序参数语法约定,记录在第12章和正则表达式记录在第9章POSIX.1-2008(2013 版)标准。

相关内容