linux中如何快速获取帮助信息

红太狼 2022-04-11 10:51 194阅读 0赞

## 前言 ##

对于一些新的或者不常用的命令和函数，我们常常需要查询使用方法或者参数详情，在linux下我们不需要去网上查询，完全可以利用linux自带的手册查看帮助信息。这就是我们今天要介绍的man命令。

## 基本介绍 ##

实际上man命令并非仅仅能查看命令或者函数的介绍，在linux中，有丰富的帮助手册信息，并且每一个手册都有一个编号。编号和对应内容如下：

<table> 
 <thead> 
  <tr> 
   <th>编号</th> 
   <th>代表内容</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>可执行程序或shell命令，如ls</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>系统调用，如chdir</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>库函数，如printf</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>设备或特殊文件，如tty</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>配置文件格式或约定</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td>游戏</td> 
  </tr> 
  <tr> 
   <td>7</td> 
   <td>杂项</td> 
  </tr> 
  <tr> 
   <td>8</td> 
   <td>管理命令，通常只有root用户可以使用</td> 
  </tr> 
  <tr> 
   <td>9</td> 
   <td>内核例程</td> 
  </tr> 
  <tr> 
   <td>n</td> 
   <td>内置命令，如cd</td> 
  </tr> 
 </tbody> 
</table>

对于内置命令，还可以使用help命令查看帮助手册，例如：

help cd

判断命令是什么类型可使用type命令，例如：

type cd 
    cd is a shell builtin

## 手册内容 ##

多数手册包含以下几部分内容：

*  NAME 功能的简单描述
 *  SYNOPSIS 语法格式
 *  DESCRIPTION 描述
 *  OPTIONS 选项
 *  ERRORS 描述出错场景，**这在排查错误时很有帮助**
 *  NOTES 注意事项
 *  FILES 相关文件，例如对于man命令的FILES部分内容显示了它的配置文件位置等信息
 *  EXAMPLES 使用示例，会提供一些简单的示例
 *  BUGS 存在的bug，**当遇到奇怪的问题时，不妨看看当前命令是否有已知的bug**

## 基本查看 ##

手册的查看和less查看文本类似，可以参考[Linux常用命令--文本查看篇][Linux_--]或查看less命令的使用，这里介绍基本操作：

*  空格 向下翻页
 *  Home 回到第一页
 *  End 跳到最后一页
 *  /string 向前搜索string字符串
 *  ?string 向后搜索string字符串
 *  n 下一个匹配字符
 *  N 上一个匹配字符
 *  q 退出

## 工作流程简述 ##

man命令所展示的帮助信息都是存在于linux系统中的，流程是怎样的呢？

1.搜索$PATH环境变量指定路径。

2.搜索/etc/manpath.config文件中MANPATH中指定的路径。

3.使用指定的解压工具进行解压处理。

4.使用文本查看命令显示手册内容。

配置文件的位置可通过查看FILES部分内容找到：

man man
    FILES
           /etc/manpath.config
                  man-db configuration file.
    
           /usr/share/man
                  A global manual page hierarchy.
    
           /usr/share/man/index.(bt|db|dir|pag)
                  A traditional global index database cache.
    
           /var/cache/man/index.(bt|db|dir|pag)
                  An FHS compliant global index database cache.

这里简单说明一下manpath.config中的SECTION，它指定了优先输出的手册顺序。例如：

SECTION 1 n l 8 3 2 3posix 3pm 3perl 5 4 9 6 7

这里它最先显示的是1，即shell命令的帮助手册，其次是n，即内置命令的帮助手册。以此类推。当然，前提是这些手册都有。

我们也可以通过manpath命令查看man手册所在路径：

manpath
    /usr/local/man:/usr/local/share/man:/usr/share/man:/usr/lib/jvm/java-8-oracle/man

## 实例 ##

查找指定章节手册

一般的命令或者库函数的帮助手册都很好查看，但是如果你想查看write函数的帮助手册，使用下面的命令是看不到的：

man write

因为它既是一个用户命令也是一个系统调用名称，按照前面所设置的顺序，它会优先显示用户命令的帮助手册。因此，如果我们想直接查看作为系统调用（参考：[系统调用和库函数的区别][Link 1]）的write的帮助手册，直接使用下面的方式即可：

man 2 write  #2表明从系统调用手册中查找

查找手册所在位置

如果仅仅是想查看手册在什么位置，可使用-w参数，例如：

man -w ls
    /usr/share/man/man1/ls.1.gz

查找包含关键字的手册

有时候我们需要查看包含某些关键字的手册，但是又不知道具体是那个手册，这个时候可以使用下面的方式：

man -k touch  #查找包含touch关键字的手册（模糊匹配）
    git-merge-tree (1)   - Show three-way merge without touching index
    synaptics (4)        - touchpad input driver
    syndaemon (1)        - a program that monitors keyboard activity and disables...
    touch (1)            - change file timestamps

查看简短描述信息

如果只想简单知道该命令的作用，可使用-f参数，例如：

man -f ls
    ls (1)               - list directory contents

查看所有手册

使用-a参数即可，它会展示所有相关手册

man -a open

## 总结 ##

man命令是你最该学会使用的一个命令。借助man命令，可以帮助我们快速的学会使用其他命令或函数的使用。

推荐阅读：

[Linux中的文件查找技巧][Linux]

[你可能不知道的printf][printf]

[什么是函数重载？][Link 2]

[C语言入坑指南-被遗忘的初始化][C_-]

[一个命令帮你对文本排序][Link 3]

[Linux常用命令-解压缩篇][Linux_-]

![640_wx_fmt_jpeg][]

关注公众号【编程珠玑】，第一时间获取更多原创技术文章

[Linux_--]: http://mp.weixin.qq.com/s?__biz=MzI2OTA3NTk3Ng==&mid=2649283920&idx=1&sn=ae8879b8982b8e81fccceeb48aeba317&chksm=f2f9ae37c58e2721899c81f1c92c35b05cc9e8396922aea492c8fb02a35fdbc3617907a7ca56&scene=21#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzI2OTA3NTk3Ng==&mid=2649283685&idx=1&sn=ab37663964086fc9f2de675aab814005&chksm=f2f9af02c58e261468e6221c52a9b6790dff7b4d83ee5aedf47fe2d2d60e990e4d428710b364&scene=21#wechat_redirect
[Linux]: http://mp.weixin.qq.com/s?__biz=MzI2OTA3NTk3Ng==&mid=2649284125&idx=1&sn=3a057bc7e23cc2db226068751f503bf3&chksm=f2f9ad7ac58e246cfc3de5e6b508aa24111d9184cdd8cadb790f4c98a3fef6d0e1ee3877221a&scene=21#wechat_redirect
[printf]: http://mp.weixin.qq.com/s?__biz=MzI2OTA3NTk3Ng==&mid=2649284148&idx=1&sn=0393607182390eec18801a1374d8c2b2&chksm=f2f9ad53c58e24459d58417f7ede4e43b29ff51b6944ff4415f33471b6df27c86c8a303cab53&scene=21#wechat_redirect
[Link 2]: http://mp.weixin.qq.com/s?__biz=MzI2OTA3NTk3Ng==&mid=2649284131&idx=1&sn=2d046d02b62263f99132a952a5098487&chksm=f2f9ad44c58e2452a06414cc0dc170cee1f2d074b45a77a37a299c9824a80769444cb4252751&scene=21#wechat_redirect
[C_-]: http://mp.weixin.qq.com/s?__biz=MzI2OTA3NTk3Ng==&mid=2649284087&idx=1&sn=79f48f41712b19f806e79bce1084f0ec&chksm=f2f9ae90c58e27867220b81940ad03b1b6defe46ba3ffcec85c9cf69e68b36629afa96e09869&scene=21#wechat_redirect
[Link 3]: http://mp.weixin.qq.com/s?__biz=MzI2OTA3NTk3Ng==&mid=2649284038&idx=1&sn=9230f76a4cbe2503eae4157cae5058c2&chksm=f2f9aea1c58e27b72771459162c5cff450a6eed5e691acdd5c9e8c4ba0eb7fec34e2136fe37c&scene=21#wechat_redirect
[Linux_-]: http://mp.weixin.qq.com/s?__biz=MzI2OTA3NTk3Ng==&mid=2649283987&idx=1&sn=6804ce2841bb66b3085172ed45ec8fa0&chksm=f2f9aef4c58e27e26dfae5711c40037a8976c169f3228601517ebe34c4f482b14002308cc508&scene=21#wechat_redirect
[640_wx_fmt_jpeg]: /images/20220411/9a2e8d2481ab4bacba0caf5e347e2dc2.png