Linux 学习之帮助手册(man/info/doc)
jinhucheung opened this issue · comments
1. Man Page
man手册页（manual pages，“手册”），是类UNIX系统最重要的手册工具。多数类UNIX都预装了它。使用man手册页的命令是：man。
所有Man Page的文件默认放在/usr/share/man目录下.
1.1 使用Man手册
通过执行以下命令打开相应手册页
$ man 手册名(可以是命令名也可以是文件名)
man手册页通过命令名和所属分类标识ID来划分的,有些不同分类的man手册页名字可能相同，比如 man(1) 和 man(7)，这时需要额外指明分类以访问需要的手册。例如：
$ man 5 passwd
会显示有关文件/etc/passwd，而非命令 passwd的内容。
man手册页分类标识及含义说明如下表
| 分类标识ID | 含义说明 |
|---|---|
| 1 | 用户在shell环境中可以操作的命令或可执行文件 |
| 2 | 系统内核可调用的函数与工具等 |
| 3 | 一些常用的函数与函数库,大部分为C的函数库(libc) |
| 4 | 设备文件的说明,通常在/dev下的文件 |
| 5 | 配置文件或者是某些文件的格式 |
| 6 | 游戏 |
| 7 | 惯例与协议等,例如Linux文件系统,网络协议,ASCII code等说明 |
| 8 | 系统管理员可用的管理命令(通常需要root权限)和守护进程 |
| 9 | 跟内核有关的文件 |
1.2 Man手册页格式
所有man手册页都按照以下标准格式组织：
- NAME - 手册叙述对象名称，及简要描述。
- SYNOPSIS - 命令参数格式，或者函数调用格式等。
- DESCRIPTION - 对叙述对象更加详细的描述。
- EXAMPLES - 由浅入深的使用示例。
- OPTIONS - 命令行或者函数调用参数的意义。
- EXIT STATUS - 不同返回（退出）代码的含义。
- FILES - 与叙述对象相关的文件。
- BUGS - 已知的bug。
- SEE ALSO - 相关内容列表。
- AUTHOR, HISTORY, COPYRIGHT, LICENSE, WARRANTY - 历史、版权、编者信息。
1.3 搜索手册页
如果用户压根儿不知道要查阅的手册的名称，该怎么办呢？没事，通过 -k 参数就可以按给定关键词搜索相关手册。
关键词搜索特性是从一个专用的缓存生成的。默认情况下你没有这个缓存，所以无论你搜什么，都会提示你nothing appropriate。你可以通过下面的命令来生成这个缓存：
# mandb
每当你安装新的manpage之后都需要运行这个命令，缓存才会更新。
现在你可以开始搜索了。 例如，要查阅手册说明有关"password"的手册页：
$ man -k password(如果你想全文搜索的话，你可以用-K选项)
通过whatis或-f命令，可以只显示需要的man手册页的简要信息。如果只是想获取对命令 ls 的简要说明，使用以下命令：
$ whatis ls
或
$ man -f ls
然后会得到输出：“list directory contents.”（“列目录内容”）。
2. Info Page
所有UNIX LIKE系统当中,都可以利用man来查询相关手册页,但Linux额外提供了一种帮助手册,这就是Info.
Info page其实就是命令行模式下的网页数据,其将文件数据拆成一个个段落,每个段落用自己页面撰写,页面与页面间用"超链接"跳转,故每个页面也称为节点.
所有Info Page的文件默认放在/usr/share/info目录下.
2.1 使用Info手册
通过执行以下命令打开相应的手册
$ info 手册名
2.2 Info手册页格式
Info手册页一般格式:
- File:当前页面由哪个文件提供
- Node:当前页面所属节点
- Next:当前页面的下一个节点
- Up:回到上一层的节点总揽界面
- Prev:前一个节点
- Info:当前页面的详细描述
- Menu:下级节点的菜单