Linux 联机帮助
如何使用 `man command` 查看联机帮助?
man-pages 介绍
当你忘记一个命令怎么使用时,除了常见的 command --help 加 --help 参数外,还可以使用 man command 查看联机帮助。
一个命令包含四个方面的内容:
- 命令的用途
- 命令的使用格式
- 命令的参数
- 使用的可用选项
例如用户在使用 man cp 查看 cp 命令的联机帮助手册时,系统会给出包括这四个方面的完整信息。
联机帮助文件的组织形式一般是相同的,通常包含如下几个部分,或多或少
- NAME 描述命令的名称和它的用途
- SYNOPSIS 描述命令的使用格式
- DESCRIPTION 对命令的整体描述
- OPTIONS 描述命令所支持的各种选项
- OPERANDS 描述命令所支持的操作
- ENVIRONMENT VARIABLES 描述命令的执行环境变量
- FILES 列举与命令相关的重要文件
- SEE ALSO 列举与命令相关的其它命令
- NOTES 说明命令的使用注意事项
- EXAMPLES 命令的使用举例
在联机帮助手册中各种符号的意义:
[]表示括号内的内容是可选的。...表示前面的参数可以被重复多次使用。- 如果命令的一部分不在方括号中,则这部分必须原样给出。
如下面示例
SYNOPSIS
cp [−Pfip] source_file target_file
cp [−Pfip] source_file... target
cp −R [−H|−L|−P] [−fip] source_file... target
除了用 man cp 外,也可以用 cp --help 查看帮助,这里只是用 cp 命令举例子,基本上所有命令都可以这么干。
内容太长的话,一般通过管道输出给 more 或 less 命令查看。
cp --help | more
cp --help | less
快捷键
进入 man 后,输入 h 可查看快捷键,比较常用的有这么几个
空格下一页b上一页j下一行k上一行/查找q退出
安装 man-pages
只有安装了联机帮助,才能使用 man 命令查看帮助信息。
在 AlmaLinux OS 上使用下面的命令安装
sudo yum install man-pages
联机帮助会被安装到 /usr/share/man/ 目录下。
在 Ubuntu 上使用下面的命令安装
sudo apt install man-db manpages-posix
针对软件开发人员还可以安装开发文档
sudo apt install manpages-dev manpages-posix-dev
man 目录
在 /usr/share/man 目录下有九个man开头的目录
| man目录 | 描述 | 例子 |
|---|---|---|
| man1 | 可执行程序或 shell 命令 | man cat man 1 date |
| man2 | 系统调用(内核提供的函数) | man 2 sendmsg |
| man3 | 库调用(程序库中的函数) | man 3 abort |
| man4 | 特殊文件(通常在 /dev 中找到) | man 4 intel man 4 amdgpu |
| man5 | 文件格式和约定,例如 /etc/passwd | man 5 shadow |
| man6 | 游戏 | man 6 gti man 6 sl |
| man7 | 杂项(包括宏包和约定),例如 man(7)、groff(7) | man 7 inode |
| man8 | 系统管理命令(通常仅适用于 root) | man 8 ip |
| man9 | 内核例程 [非标准] | man 9 vmxnet |
查看具体目录下的帮助: man [section] name
例如查看 printf() 库函数:man 3 printf