Linux Lexicon — 手册页剖析

页面通常分为一系列部分，详细说明名称和描述，以及用法和注意事项。 手册页可能难以阅读，但它们是可以在紧要关头利用的宝贵资源，甚至不需要互联网。

姓名
首先是名称标题，这就是总结。 此部分包括实用程序的名称以及简要说明。

概要
从手册页到手册页有不同程度的可读性，但有一件事是肯定的，最难的部分通常是破译一个毛茸茸的概要。 有几种约定可以指示任何给定命令所需的信息片段。 这些约定由不同的括号和括号以及其他形式的符号组成。 所有这些不同的约定对于初学者来说可能会非常混乱，对于经验丰富但不精通手册艺术的人来说仍然令人生畏。 下面我们将把这些乱七八糟的东西分解成易于理解的规则。

这些规则相当简单，但当它们用于长函数定义时，尤其是嵌套时，它们变得更加困难，甚至令人生畏。 所以，我们将看看下面的一些嵌套，以建立我们已经分解的内容。

焦油{A|c|d|r|t|u|x}[GnSkUWOmpsMBiajJzZhPlRvwo] [ ARG …]

tar命令有很多选项。 我们看到 tar 命令的名称以粗体显示，因为它应该按所示输入。 然后我们看到括号以管道分隔的选项打开，这表明我们仅限于这些选项，并且必须只选择一个。 接下来是可选标志，我们可以使用任何数字，但是，它们可能不会一起工作，进一步阅读手册页将阐明任何潜在的选项冲突。 最后，我们有可重复的参数，在 tar 的情况下，您正在操作的文件。

su [选项] [-] [用户[参数...]]

同样，我们看到su粗体，因为它是命令的名称。 其次，我们看到实际上没有指定任何标志，只是它们是可选的。 第三，指定了一个标志，但它也是可选的。 最后，我们看到一个可选参数在可选参数中是可重复的。 现在，过去看起来很神秘的东西变得更有意义了。

whois [{-h|–host } HOST ] [{-p|–port} PORT ] [-abBcdGHKlLmMrRx] [-g SOURCE:FIRST-LAST ] [-i ATTR [, ATTR ]…] [-s SOURCE [, SOURCE ]…] [-T TYPE [, TYPE ]…] [–verbose]对象

这是一个特别密集的。 将其复制到您最喜欢的文本编辑器中，并在其中添加一些额外的空格，如果它有助于您阅读它。 扫描完后，您应该开始看到几个模式。 主机和端口部分对选项的短格式和长格式使用相同的格式，后跟该选项的参数，而两者本身都是可选的。 然后我们看到可选标志的字符串。 关于从头到尾的源代码的下一点是 whois 预期的语法，稍后将在手册页中解释。 现在我们看到这三组可选标志，它们要么采用单个参数，要么采用可选的重复参数，这是一种最初很难完全掌握的约定的复合。 最后是详细选项和对象（主机/域）。

这就是阅读手册页概要的方法。 还有一些其他的约定，但是它们太晦涩了，无法在本文中介绍。

描述
这通常是概述程序或实用程序的预期用途的地方。 在这个标题下，一些手册会比其他手册详细得多。

选项
还记得所有那些可能是可选的或强制的标志和不同的参数吗？ 这就是他们都得到解释的地方。 这里通常有很好的信息，并且您通常会在其中找到 <argument> 约定，表明给定标志需要相应的参数。 有时您会发现选项位于描述部分，因为没有硬性规则定义手册页，只有约定和遵守标准的意愿。

例子
这是最方便的部分之一，遗憾的是未包含在所有手册中。 您还会发现信息量和示例数量差异很大，并且并非所有示例实际上都有助于使用该命令。

此外，您会定期找到作者、版权信息、错误报告等部分，另请参阅 (apropos)。

除此之外，还有正式定义的手册页部分，定义如下。

许多命令在多个部分中没有手册，但对于那些有手册的，或者对于一些可能命名不明确的命令，您可以像下面的示例一样指定该部分。

从可用部分可以看出，命令并不是唯一具有手册的东西。 系统调用、配置文件和特殊设备也可能有相应的手册页。 手册页中关于典型 Linux 安装的信息量是惊人的，这同样适用于其他开源的类 UNIX 操作系统。

如果您发现手册页不够用并且您仍然不了解某个命令，请务必在线查看，因为许多人对某些工具提供了更全面的解释，而且许多发行版都有自己的手册页，用于不同的软件包。 一旦您发现自己对某个软件感到满意，但仍然觉得缺少手册，您可以随时通过编写自己的软件并提交给相应的项目来做出贡献。 文档往往是软件项目中最容易被忽视的部分，因此即使不会编写代码，也可以编写手册、Wiki 文章和教程来帮助他人。

既然您了解了手册页的结构，那么您就没有任何借口了，只能使用 RTFM（这是为 18 岁以下的人阅读的免费手册）；）

另请阅读： Linux 词典：使用 Watch 命令每 X 秒运行一次命令