如何使用 man page:比 Google 搜索更快

Linux 手册页比您想象的更容易使用,并且包含大量信息。
435 位读者喜欢这篇文章。
Why the operating system matters even more in 2017

Internet Archive Book Images。由 Opensource.com 修改。CC BY-SA 4.0

很容易养成习惯,在 Linux 中谷歌搜索任何你想知道的命令或操作,但我认为有更好的东西:一个鲜活的、完整的参考,即 man page,它是 manual pages(手册页)的缩写。

man page 的历史可以追溯到 Linux 之前,一直到 Unix 的早期。 根据维基百科,Dennis Ritchie 和 Ken Thompson 在 1971 年编写了第一个 man page,那时远早于个人电脑时代,大约在当时使用的许多计算器都有烤面包机那么大的时候。Man page 也以简洁而闻名,并且在某种程度上,它们有自己的语言。就像 Unix 和 Linux 一样,man page 不是静态的,它们像内核一样不断地被开发和维护。

Man page 分为数字引用的章节

  1. 通用用户命令
  2. 系统调用
  3. 库函数
  4. 特殊文件和驱动程序
  5. 文件格式
  6. 游戏和屏幕保护程序
  7. 杂项
  8. 系统管理命令和守护进程

即便如此,用户通常不需要知道特定命令所在的章节就可以找到他们需要的东西。

这些文件的格式对于今天的许多用户来说可能看起来很奇怪。最初,它们是用一种称为 troff 的旧标记语言编写的,因为它们被设计为通过 PostScript 打印机打印,因此它们包含了标题和其他布局方面的格式。在 Linux 中,使用 groff 代替。

在我的 Fedora 中,man page 位于 /usr/share/man 中,带有子目录(如 man1 代表第 1 节命令)以及用于 man page 翻译的附加子目录。

如果您查找命令 man 的 man page,您会看到文件 man.1.gz,它是使用 gzip 实用程序压缩的 man page。要访问 man page,请输入如下命令:

man man

例如,显示 man 的 man page。这会解压缩 man page,解释格式化命令,并使用 less 显示结果,因此导航与您使用 less 时相同。

所有 man page 都应具有以下子节:Name(名称)、Synopsis(概要)、Description(描述)、Examples(示例)和 See Also(另请参阅)。许多还有其他章节,如 Options(选项)、Exit Status(退出状态)、Environment(环境)、Bugs(错误)、Files(文件)、Author(作者)、Reporting Bugs(报告错误)、History(历史记录)和 Copyright(版权)。

分解 man page

为了解释如何解读典型的 man page,让我们以 ls 的 man page 为例。在 Name(名称)下,我们看到:

ls - list directory contents

这以最简单的术语告诉我们 ls 的含义。

Synopsis(概要)下,我们开始看到简洁性:

ls [OPTION]... [FILE]…

方括号内的任何元素都是可选的。上面的命令意味着您可以合法地键入 ls,仅此而已。每个元素后的省略号表示您可以包含任意数量的选项(只要它们彼此兼容)和任意数量的文件。您可以指定目录名称,也可以使用 * 作为通配符。例如:

ls Documents/*.txt

Description(描述)下,我们看到了对命令作用的更详细的描述,然后是命令的可用选项列表。ls 的第一个选项是:

-a, --all 
	do not ignore entries starting with .

如果我们想使用此选项,我们可以键入简短形式语法 -a,或长形式 --all。并非所有选项都有两种形式(例如,--author),即使有,它们也并非总是如此明显的关联(例如,-F, --classify)。当您想使用多个选项时,您可以键入带有空格的简短形式,或者使用单个连字符且不带空格键入它们(只要它们不需要进一步的子选项)。因此,

ls -a -d -l

ls -adl

是等效的。

命令 tar 在某种程度上是独特的,大概是由于其悠久的历史,它根本不需要连字符来表示简短形式。因此,

tar -cvf filearchive.tar thisdirectory/

tar cvf filearchive.tar thisdirectory/

都是合法的。

ls man page 上,Description(描述)之后是 Author(作者)、Reporting Bugs(报告错误)、Copyright(版权)和 See Also(另请参阅)。

See Also(另请参阅)部分通常会建议相关的 man page,因此通常值得一看。毕竟,man page 的内容远不止命令。

某些特定于 Bash 而非系统命令的命令,如 aliascd 和许多其他命令,都列在单个 BASH_BUILTINS man page 中。虽然这些文档更加简洁紧凑,但总体而言,它包含类似的信息。

我发现 man page 提供了很多好的、可用的信息,特别是当我需要一个最近没有使用过的命令,并且需要复习一下选项和要求时。在这一点上,man page 备受诟病的简洁性实际上非常有利。

标签
Greg Pittman
Greg 是肯塔基州路易斯维尔的一位退休神经科医生,长期以来对计算机和编程感兴趣,从 20 世纪 60 年代的 Fortran IV 开始。当 Linux 和开源软件出现时,它激发了他学习更多知识并最终做出贡献的承诺。他是 Scribus 团队的成员。

11 条评论

> 最初,它们是用一种称为 troff 的旧标记语言编写的,因为它们被设计为通过 PostScript 打印机打印

啊,不,PostScript 打印机在 troff 发明时也不存在。troff 及其使用的语言最初旨在驱动 Graphic Systems CAT 照相排字机。

Google 搜索带有示例,大多数 man page 没有。

man page 是如何不编写手册的例子。它们是使用 Linux 的最大障碍之一。Linux 需要建设性的帮助页面。

我使用 man page。有些比其他的更好。

我一直安装的一个很棒的项目是 cheat 命令:https://github.com/chrisallenlane/cheat

它的工作方式类似于 man page

$ cheat tar

打印 tar 命令常用用法的示例。

它有很多命令示例,您可以轻松添加更多示例,甚至可以贡献示例。结合 man page,它是一个相当完整的参考集。

写得好的 man page 是一件美妙的事情。如果 man page 有清晰简洁的文字,用户就不需要 Google 搜索示例。如果 man page 特别麻烦,可以包含示例,否则——但是如果你必须查找 Google 脚本小子示例,你就没有真正理解命令的工作方式。

我很惊讶没有人提到 man2html ... 它允许您在 Web 浏览器中浏览 man page。最初需要进行一些设置,但正如之前在此处提到的:MAN page 是如何不编写手册的一个很好的例子。我发现 man2html 非常有用 ... 我经常打开一个 Web 浏览器窗口,以及一个带有各种搜索框的自定义“主页”。在这里,我可以简单地键入命令的名称并按 Enter 键,以看到整个 MAN page 以格式良好且可滚动的文本格式显示 =)

尝试使用尊重您隐私的搜索引擎。

现在很难找到和安装这些东西了,但我最喜欢的 man page 查看器是 xman。是的,athena 小部件有点笨拙而且过时了,但它仍然提供了纯 shell 的简单替代方案。

大多数时候您不需要搜索引擎!
只需 RTFM :) (阅读他妈的手册)

© . All rights reserved.