cbear小站
large picture of the cover

2-3-命令帮助手册


在linux 中需要查看各种知道命令具体的使用方式,此时就需要查看linux中的命令手册。

对于不同类型的命令查看,有不同的方式查看帮助文档

按照以下方式分类:

  • 内部命令 : help COMMAND 或 man bash

  • 外部命令 :

    • COMMAND --help 或 COMMAND -h

    • 使用手册(manual) : man COMMAND

    • 信息页 : info COMMAND

    • 程序自身的帮助文档:README;INSTALL;ChangeLog

    • 程序官方文档: 官方站点,Documentation

    • 发行版的官方文档

    • 通过Google查询

1. whatis查看命令简要说明

whatis可以快速查看到命令或相关内容的简短功能。whatis命令等同于使用man -f命令。whatis是基于一个数据库中查找简要帮助说明的。如果新安装的系统,此数据库是不存在,可使用mandb创建数据库。同时查询命令在man中所在章节。

提示:在Centos6以前版本,使用makewhatis创建数据库

示例说明:

[root@node1 ~]# whatis ls
ls (1)               - list directory contents
[root@node1 ~]# whatis watch
watch (1)            - execute a program periodically, showing output fullscreen
[root@node1 ~]# whatis cd
cd (1)               - bash built-in commands, see bash(1)
​
​

2. help帮助查询

2.1 内部命令

内部命令帮助使用: help COMMAND。COMMAND表示要查询帮助的命令。 使用help可以列出所有内部命令的帮助列表。

另外,help命令看到的帮助可能不全,可以用man bash可查看到全部的内部命令的帮助和详解说明。

2.2 外部命令

显示用法总结和参数列表,同时显示命令的大部分帮助内容。对外部命令,一般可使用下面格式获取帮助: COMMAND --help

  • 示例

date --help
 Usage: date [OPTION]... [+FORMAT] or: date [-u|--utc|--universal] [MMDDhhmm[[CC]YY][.ss]]

  • [] : 表示可选项

  • CAPS或<> 表示变化的数据

  • ... :表示一个列表

  • x|y|z :"x或y或z"

  • {} : 分组

3. man

man命令主要是提供命令帮助的文件,手册页存放在/usr/share/man目录下面,几乎每个命令都有man的页面。同时在man页面中分组为不同的章节。

man命令的配置文件:/etc/man.config或/etc/man_db.conf。Centos6中是/etc/man.config;Centos7中是/etc/man_db.conf

配置文件中MANPATH /PATH/TO/SOMEWHERE用于 指明man文件搜索位置。

其中手册中大部分都是英文的,如果需要在帮助文档中看到中文,需要安装man-pages-zh-CN这个RPM包

3.1 man章节

man手册主要分为9大章节,9个章节分别是对应以下内容

  1. 用户命令

  2. 系统调用

  3. C库调用

  4. 设备文件及特殊文件

  5. 配置文件格式

  6. 游戏

  7. 杂项

  8. 管理类的命令

  9. Linux 内核API

3.2 man帮助段落说明

  • NAME : 名称及简要说明

  • SYNOPSIS : 用法格式说明

    • [] : 可选内容

    • <> : 必选内容

    • a|b : 二选一

    • { } : 分组

    • ... : 同一内容可出现多次

  • DESCRIPTION : 详细说明

  • OPTIONS : 选项说明

  • EXAMPLES : 示例

  • FILES: 相关文件

  • AUTHOR : 作者

  • COPYRIGHT 版本信息

  • REPORTING BUGS bug信息

  • SEE ALSO : 其它帮助参考

3.3 man命令

  • 语法 : man [section] WORD

  • 选项:

    • -M /PATH/TO/SOMEDIR :到指定目录下查找命令手册并打开

    • -k:man -k keyword,列出所有匹配的页面,使用whatis数据库

    • man -f keyword : 相当于whatis

    • man -w [章节] keyword : 打开man帮助文件的路径

注意：并非每个COMMAND在所有章节下都有手册。

3.4 man手册操作说明

man 文档打开后,实际上是使用less命令进行的。执行man命令后,进入man的交互式使用界面。支持下面快捷键。

  • 翻屏操作

    • 向文件尾部翻一屏 : space(空格键),ctrl+v,ctrl+f,ctrl+F

    • 向文件首部翻一屏 : b,ctrl+b

    • 向文件尾部翻半屏 : d,Ctrl+d

    • 向文件首部翻半屏 : u,Ctrl+u

    • 向文件尾部翻一行 : 回车键,Ctrl+N,e,ctrl+E,j,Ctrl+J

    • 向文件首部翻一行 : k,ctrl+k,ctrl+P,y,ctrl+Y

  • 退出 : q , quit

  • 跳转

    • 跳转至文件尾部 : G

    • 跳转到第#行 : #(直接输入数字即可,#表示要跳转到的行数),#G。

    • 跳转至文件首行 : 1G,gg

  • 文本搜索

    • /keyword : 以指定字符串为关键字,从当前位置向尾部搜索,不区分大小写

    • ?keyword : 以指定字符串为关键字,从当前位置向首部搜索,不区分大小写

      • n ：与查找命令方向相同：

      • N ：与查找命令方向相反

4. info命令

man 常用于命令查看,info命令适合通用文档参考。info没有参数,列出的是所有的内容,内容结果就像一个网站,每一页分为节点,连接节点之前有个*号。

  • 使用格式 : info [命令]

  • 导航info页的使用:

    • 方向键 : PgUp,PgDn翻页导航

    • Tab键 : 移动到下一个链接。

    • d : 显示主题目录。

    • Home : 显示主题首部。

    • Enter : 进入选定的链接。

    • n : 进入下一层链接

    • p : 进入前一层链接

    • u : 进入上一层链接

    • l : 进入最后一层链接

    • s : 文字文本搜索

    • q : 退出info

5. 本地帮助文档

多数安装软件包后会在/usr/share/doc/目录下生成子目录,这些子目录路面包含了这些软件的相关原理说明。其常见文档有 : README,INSTALL,CHANGES等文件。

  • README : 程序的相关信息

  • INSTALL :安装帮助

  • CHANGES : 版本迭代时的改动信息

查看内核的帮助文档:

[root@node1 ~]# ls /usr/share/doc/kernel-doc-3.10.0/Documentation/
00-INDEX                   cpu-hotplug.txt             filesystems           kbuild                       mn10300                  remoteproc.txt           sysrq.txt
ABI                        cpuidle                     firmware_class        kdump                        module-signing.txt       rfkill.txt               target
accounting                 cpu-load.txt                flexible-arrays.txt   kernel-doc-nano-HOWTO.txt    mono.txt                 robust-futex-ABI.txt     thermal
acpi                       cputopology.txt             frv                   kernel-docs.txt              mtd                      robust-futexes.txt       this_cpu_ops.txt
admin-guide                crc32.txt                   futex-requeue-pi.txt  kernel-parameters.txt        mutex-design.txt         rpmsg.txt                timers
aoe                        cris                        gcov.txt              kernel-per-CPU-kthreads.txt  namespaces               rtc.txt                  tpm
...

6. 各种应用的官网在线文档

一般第三方的软件程序都会在官方网站发布器在线的使用文档,类似于用户手册一样的帮助文档。比如:要获取nginx软件的官方的帮助文档,就可以通过访问http://www.nginx.org官网获取。

如果某软件包是发行版官方发行的,就需要访问这个发行版官方站点来获取安装指南、部署指南、虚拟化指南等内容。比如:Centos系统的帮助,可以参考红帽的知识库和官方在线文档,如下面网站 :

7. 其它网站和搜索

以上介绍了如何直接获取linux命令或服务软件的使用帮助,还有一种途径获取使用帮组,就是通过搜索引擎来搜索自己需要查询的使用帮助文档,或是在一些开源的社区站点上查找。如Linux Documentation Project,简称LDP,其站点为: http://www.tldp.org/ ,列出了所有linux上面可看到的文献资料,只是都是英文资料,所以如果英文足够好,会让你在学习方面如虎添翼。使用较多的搜索引擎google、交流的社区站点 https://stackoverflow.com 等等,好多这样的站点。


熊熊

site logo

Hi,Friend

© 2025 cbear小站