【Linux导论】查找Linux文档(Finding Linux Documentation)

原文

LFS101x.2 Introduction to Linux (Linux Foundation)

Chapter 06: Finding Linux Documentation

- Section 1: Documentation Sources

- Section 2: The man page

- Section 3: GNU info
- Section 4: Help Command

- Section 5: Other Documentation Sources

1.文档来源 - (Documentation Sources)

无论你是新手还是老手，你不可能记得所有Linux程序和工具的使用方法，或者该在命令行输入什么。你需要定期查看帮助文档。基于Linux的系统由大量的代码造就而成，并且存在很多文档以及获取帮助的途径。发行者会合并这些材料，并以一种综合易用的方式提供给用户使用。

重要的Linux文档来源包括：

man pages(手册页面(manual pages)的缩写)
GNU info
help命令以及--help选项
其他文档来源，例如https://www.gentoo.org/doc/en/

2.man页面 - (The man page)

1.)man页面 - (The man page)

man pages是最常使用的Linux文档。它提供了许多文档，深入叙述了许多程序以及工具，同时也包括配置文件，系统调用，库函数以及内核的介绍。输入man和一个话题名作为参数，可以在该话题下的man pages中检索信息。有些Linux发行版需要每一个安装的程序都有一个对应的man page，可见它的覆盖之深(Note:man实际上是manual的缩写)。在19世纪70年代，在早期的UNIX版本中，最先引入man
pages结构。

man pages通常转换成：

网页
出版的书籍
图形化帮助
其他格式

2.)man命令 - (man)

man程序搜寻、格式化并且显示man pages中包含的信息。因为许多主题有很多信息，输出会通过terminal pager程序进行管道操作，例如less可以使得一次显示一页；同时，信息会被格式化成为一个良好的视觉显示。

当没有给定选项时，默认情况下只能见到一个关于此话题的专门页面。你可以使用
-f 选项，来显示所有包含话题字符串的man pages。你可以使用
-k 选项，来显示所有包含特定主题(尽管这个特定的主题不一定出现在话题字符中)的man pages。

man -f 与whatis 效果一样；

man -k 与apropos
效果一样。

3.)手册章节 - (Manual Chapter)

man pages被分成九个章节(1到9)。有时，一个字母会附加到章节数字后面，用以识别一个特定的话题。例如，部分描述X Window API的页面对应于章节3X。

章节数可以用来指定man来显示特定话题的页面；同一个名字具有多个页面多个章节是很正常的事情，特别是库函数或者系统调用的名字。

使用 -a 选项，man可以显示给定名称的所有页面和所有章节，一个接着一个。

$ man 3 printf

$ man -a printf

3.GNU info - (GNU info)

1.)GNU info系统 - (GNU Info System)

下一个Linux文档来源是GNU Info System。这个是GNU项目的标准文档格式(info)，可以选择它来代替man。info系统拥有更加自由的格式，并且支持链接的子部分。从功能上说，GNU Info System和man有很多相似之处。然而，话题通过链接连接在一起(这个设计早于万维网)。信息可以通过命令行接口查看，或者通过图形化帮助工具、打印版本或者在线浏览。

2.)命令行info浏览器 - (Command Line Info Browser)

在命令行中输入info可以查看所有可用话题的索引。你可以使用常规的移动按键：arrows，Page Up或者Page Down在这些话题中浏览。你可以通过输入
info <topic name> 查看特定话题的帮助信息。然后系统会在所有可用的info文件中搜索这个话题。

有些有用的按键：q代表退出，h代表帮助，Enter表示选择一个菜单单元。

3.)info页面结构 - (info Page Structure)

你所要看的info页面上的话题成为一个节点(node)。节点与书写文档的章节和子章节相似。你可以在节点之间移动，并且按顺序查看每个节点。每个节点可能包含菜单(menus)和链接的子话题，或者名目(items)。

名目(items)可以比较成互联网的超链接。它们通过名目前面的星号(*)得以区分。被命名的名目(在菜单以外的)通过双冒号(::)得以区分。名目可以指向文件内的其他节点或者其他文件。下表列出了用于在节点之间移动的击键。

4.帮助命令 - (Help Command)

1.)帮助选项简介 - (Introduction to the help Option)

第三个Linux文档的来源是使用help选项。大多数命令都有一个短小的表达，在命令或者应用中，使用
--help 或者
-h 选项。例如，想要了解更多的man命令，你可以运行以下命令：

$ man -- help

--help 选项可以作为一个快速引用的工具，并且它比起man或者info页面，能够更快地显示信息。

2.)关于help命令 - (About the help Command)

当在bash命令shell中运行时，一些常用的命令(例如echo)会运行它们自己内建版本的系统程序和工具，因为这样做更有效率（我们将在下一章详细讨论命令shell）。为了查看这些内建命令的概要，你可以简单的输入help。对于这些内置的命令，help命令可以完成和
-h 或者 --help 参数同样的基础功能。

5.其他文档来源 - (Other Documentation Sources)

1.)其他文档来源 - (Other Documentation Sources)

除了man pages，GNU Info System，以及help命令，还有几种其他的Linux文档来源，下图举了一些例子。

2.)桌面帮助系统 - (Desktop Help Systems)

所有的Linux桌面系统都有一个图形化的帮助应用程序。这个程序通常显示为一个问好的图标，或者一个船舶救生用具的图片。这些程序通常包含了桌面和程序的自定义帮助，并且具有info或者man pages的图像化显示。

你可以使用以下命令，在图形化终端中启动图形帮助系统：

GNOME：gnome-help

KDE：khelpcenter

3.)软件包文档 - (Package Documentation)

软件包管理系统中也有Linux文档。通常，这些文档直接从上游源代码中获得，但它包含着组织发行版和安装软件的信息。这些信息被放置在 /usr/share/doc
目录下，并且以软件包的名称命名子文件夹，可能也会在名称中包含版本号。

4.)在线资源 - (Online Resources)

有很多地方可以获取在线的Linux文档，即使一点点搜索也可以获得很多结果。以下的网站受到该课程的其他用户好评，并且含有免费的、可通过Creative Commons License下载的命令行纲要。

LinuxCommand.org：http://linuxcommand.org/tlcl.php

你也可以对每种发行版找到非常有用的文档。每种发行版都有用户为它而建的论坛和wiki部分。以下是部分资源：

Ubuntu：https://help.ubuntu.com/

CentOS：https://www.centos.org/docs/

OpenSUSE：http://en.opensuse.org/Portal:Documentation

GENTOO：http://www.gentoo.org/doc/en

另外，你可以通过在线搜索引擎在整个互联网搜索有用的资源，包括博客，论坛，邮件列表，新闻文章，等等。



Translated by Timely~

如对上述翻译有疑问，可以联系我一起讨论。