了解联机帮助中的概要


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

Answers:


25
  1. 提要部分通常会提供一些用例示例。有时子命令具有不同的选项,因此可能会显示几个示例。
  2. 方括号[]始终表示可选的开关,参数,选项等。
  3. 是的,管道的|意思是,特别是在括号或括号内时。
  4. 括号中的括号仅表示第二部分取决于第一部分,它本身也是可选的。您可以单独使用某些开关,也可以为其添加值。方括号开头的逗号表示可能存在多个逗号分隔的值。
  5. 它们基于正则表达式的概念,但旨在使人可读,因此请不要遵循所有转义规则等。

谢谢!是否有一些参考说明语法简介?
蒂姆(Tim)

@Tim:那是我见过的最疯狂的人之一,我想如果您再读几本书,就会发现它的窍门。这只是约定,不是魔术。
卡莱布


3

man手册页:


以下约定适用于“概要”部分,并且可以在其他部分中用作指南。 人物简介

确切的渲染可能因输出设备而异。例如,在终端中运行时,人通常将无法渲染斜体,而通常会使用带下划线或彩色的文本。

命令或功能说明是一种应与所有可能的调用匹配的模式。在某些情况下,建议如本手册的“摘要”部分所示,说明几种互斥调用。


3

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

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.