对于某些命令或者函数,可能网上搜索的资料并不准确。或者缺乏系统性,可以使用 man
命令来查看官方帮助信息。man
命令来自于英文单词 manual
的缩写,中文译为帮助手册,其功能是用于查看命令、配置文件及服务的帮助信息。
可以使用 man man
查看整个帮助文档,其目录如下:
- 可执行程序或shell命令
- 系统调用(内核提供的函数)
- 库调用(程序库中的函数)
- 特殊文件(通常位于 /dev)
- 文件格式和规范,如
/etc/passwd
- 游戏
- 杂项(包括宏包和规范,如 man(7), groff(7))
- 系统管理命令(通常只针对 root 用户)
- 内核例程 [非标准]
一份完整的帮助信息包含以下信息
结构名称 | 代表意义 |
---|---|
NAME | 命令的名称 |
SYNOPSIS | 参数的大致使用方法 |
DESCRIPTION | 介绍说明 |
EXAMPLES | 演示(附带简单说明) |
OVERVIEW | 概述 |
DEFAULTS | 默认的功能 |
OPTIONS | 具体的可用选项(带介绍) |
ENVIRONMENT | 环境变量 |
FILES | 用到的文件 |
SEE ALSO | 相关的资料 |
HISTORY | 维护历史与联系方式 |
语法
man [参数] 对象
常用参数
-a
在所有的man
帮助手册中搜索-d
检查新加入的文件是否有错误-f
显示给定关键字的简短描述信息-p
指定内容时使用分页程序-M
指定man
手册搜索的路径-w
x显示文件所在位置
快捷键
q
退出Enter
按行下翻Space
按页下翻b
上翻一页/字符串
在手册页中查找字符串
示例
- 查看指定命令的帮助信息:
man ls
- 查看指定配置文件的帮助信息,如果既有
passwd
命令,又有/etc/passwd
文件,则需要手动指定帮助信息的编号。编号规则:普通命令为1,函数为2,库文件为3,设备为4,配置文件为5,游戏为6,宏文件为7,系统命令为8,内核程序为9,TK指令为10。
man 5 passwd
- 找到某个命令的帮助信息的存储位置