Linux系统编程三：使用man查看帮助文档

Posted 2021-08-13 何事误红尘

目录

• 一、概述
• 二、使用方法
• 三、手册分页
• 四、总结

一、概述

在前两篇延时时间和LED控制中，都用到了系统函数。随着学习深入，用到的函数越来越多，如何记住每个函数的原型和头文件？一些常用的函数随着印象加深自然能够记下来，其余函数在用到的时候查一下就可以了。本篇主要是记录查询指令man的使用方法？

二、使用方法

man+想要查询的内容即可。如查询close函数，在终端输入指令man close即可看到如下结果：

搜索结果大致可分为以下几个部分：

1. 名称 (NAME) 部分包含命令的名字以及对这个命令的简短说明。
2. 概要 (SYNOPSYS) 部分给出了命令的用法说明，包括命令格式、参数和选项列表。选项指的是一个短线后面紧跟着一个或多个英文字母，如 -a 、 -Bc，命令的选项影响该命令所进行的操作。
3. 描述 (DESCRIPTION) 部分是关于命令功能的详细阐述，根据命令和平台的不同，描述的内容也不同，有的简洁、精确，有的包含了大量的例子。不管怎么样，它描述了命令的所有功能，而且是这个命令的权威性解释。
4. 选项 (OPTIONS) 部分给出了命令行中每一个选项的说明。早期的 Unix 命令的功能都很简单，每个命令只有一两个选项，但随着时间的推移，命令的功能越来越多，基本上每个选项用来实现一个功能，所以选项也越来越多，像 who 命令就有很多选项。
5. 参阅 (SEE ALSO) 部分包含与这个命令相关的其他主题。有些帮助还有 BUG 部分。

三、手册分页

在上图close函数的搜索结果中，可以得知close函数的原型和所需头文件。在下面有状态栏，有展示结果和退出提示，按q即可退出。在界面的右上方，有一个close(2)，这个2即是close在man书册的哪一个分页。

如果我们明确知道自己相差的函数是在哪一个分页，则可以通过man +分页 + 要查询的内容。如查询C库函数中的sleep函数，在终端输入指令man 3 sleep可看到如下结果：

传入参数是睡眠的秒数。往下查看，在SEE ALSO中，可以看到sleep(1)，也就是说在手册分页1中，也有一个sleep函数。

使用man 1 sleep查看手册，结果如下：

这时查询的sleep是一个命令，而非C 库函数了。所以当查询结果与期望不相符时，不妨看看相关内容。

四、总结

这一篇内容非常简单，只是觉得一份完整的笔记，这里有man的痕迹。以后对man有了其他体会，再丰富这篇内容。