命令行帮助

更新时间：2021-08-30

更新版本：v1.1

一、命令帮助

1.1 whatis

whatis 命令用于显示手册页面说明。作用等同于 man -f

1.1.1 语法

whatis [-dlv?V] [-r|-w] [-s list] [-m system[,...]] [-M path] [-L locale] [-C file] name ...

1.1.2 构建数据库

Whatis 使用依赖于数据库，所以刚安装完后不能立即使用，需要快速创建帮助数据库

mandb 或 /usr/sbin/makewhatis

1.1.3 示例

可以使用 whatis 或 man -f 命令查看命令的作用和帮助文档，例如：

[root@CentOS7 ~]# whatis cal
cal (1)              - display a calendar
[root@CentOS7 ~]# man -f cal
cal (1)              - display a calendar

1.2 man

提供命令帮助的文件，手册页存放在 /usr/share/man，几乎每个命令都有 man 的页面，man 页面分组为不同的章节，统称为 linux 手册。man 命令的配置文件 /etc/man.config 或 /etc/man_db.conf。中文 man 需安装包 man-pages-zh-CN

1.2.1 语法

man [OPTION...] [章节] 手册页...

1.2.1.1 选项

参数选项	描述
-C, --config-file=FILE	定义 man.conf 供使用；默认使用的是 /etc/man.config
-d, --debug	输出调试信息
-D, --default --warnings[=警告]	将所有选项都重置为默认值 开启 groff 的警告
-f, --whatis	等同于 whatis
-k, --apropos	等同于 apropos
-K, --global-apropos	search for text in all pages
-l, --local-file	把“手册页”参数当成本地文件名来解
-w, --where, --path, --location	输出手册页的物理位置
-W, --where-cat, --location-cat	输出 cat 文件的物理位置
-c, --catman	由 catman 使用，用来对过时的 cat 页重新排版
-R, --recode=编码	output source page encoded in ENCODING

1.2.1.2 手册页

参数选项	描述
-L, --locale=区域	定义本次手册页搜索所采用的区域设置
-m, --systems=系统	use manual pages from other systems
-M, --manpath=路径	定义一组查找 man 手册页的目录。如果没有指定此参数，系统环境变量 MANPATH 将被使用
-S, -s, --sections=列表	使用以半角冒号分隔的章节列表
-e, --extension=扩展	将搜索限制在扩展类型为“扩展”的手册页之内
-i, --ignore-case	查找手册页时不区分大小写字母 (默认)
-I, --match-case	查找手册页时区分大小写字母
-a, --all	寻找所有匹配的手册页
-u, --update	强制进行缓存一致性的检查

1.2.1.3 区段清单

语法：man -S [区段] keyword

区段清单	描述
1	用户指令
2	系统调用
3	程序库调用
4	设备文件及特殊文件
5	配置文件格式
6	游戏
7	杂项
8	系统指令
9	内核内部指令，Linux 内核 API

1.2.2 帮助段落说明

段落	描述
NAME	名称及简要说明
SYNOPSIS	用法格式说明。[] 可选内容；<> 必选内容；a|b 二选一；{} 分组；… 同一内容可出现多次
DESCRIPTION	详细说明
OPTIONS	选项说明
EXAMPLES	示例
FILES	相关文件
AUTHOR	作者
COPYRIGHT	版本信息

1.2.3 man 操作

操作	描述
space, ^v, ^f, ^F	向文件尾翻屏
b, ^b	向文件首部翻屏
d, ^d	向文件尾部翻半屏
u, ^u	向文件首部翻半屏
RETURN, ^N, e, ^E or j or ^J	向文件尾部翻一行
y or ^Y or ^P or k or ^K	向文件首部翻一行
q	退出
#	跳转至第#行
1G	回到文件首部
G	翻至文件尾部
/KEYWORD	以KEYWORD指定的字符串为关键字，从当前位置向文件尾部搜索，不区分字符大小写
?KEYWORD	以KEYWORD指定的字符串为关键字，从当前位置向文件首部搜索，不区 分字符大小写

1.2.4 示例

查看man手册页

man [章节] keyword

列出所有帮助

man –a keyword

搜索man手册

# 列出所有匹配的页面
man -k keyword 

使用 whatis 数据库，相当于 whatis

man –f keyword

1.3 info

man 常用于命令参考，GNU 工具 info 适合通用文档参考没有参数，列出所有的页面。info 页面的结构就像一个网站，每一页分为“节点”