man 手册
man(Manual)命令用于访问存储在 Linux 系统上的手册页面。
基本语法:man [选项] [[章节] 关键字/命令]
常用参数:
-k [关键字]:根据关键字搜索手册页面(相当于apropos)。man [1-9] [命令]:查看指定章节的手册页(例如man 5 passwd查看配置文件格式)。
手册页内部常见的小节(Sections)
| 节 (Section) | 描述 |
|---|---|
| NAME | 显示命令名和一段简短的描述 |
| SYNOPSIS | 命令的语法格式 |
| CONFIGURATION | 命令的配置信息 |
| DESCRIPTION | 命令的功能、一般性描述 |
| OPTIONS | 命令可用的参数/选项详细说明 |
| EXIT STATUS | 命令的退出状态/返回值 |
| RETURN VALUE | 库函数等的返回值说明 |
| ERRORS | 可能抛出的错误及原因 |
| FILES | 命令用到的相关文件 |
| VERSIONS | 命令或软件的版本信息 |
| CONFORMING TO | 命令所遵从的标准(如 POSIX) |
| NOTES | 其他补充资料或注意事项 |
| BUGS | 已知的缺陷或提供提交 bug 的途径 |
| EXAMPLE | 展示命令的用法示例 |
| AUTHORS | 命令开发人员的信息 |
| COPYRIGHT | 版权和许可证状况 |
| SEE ALSO | 与该命令相关的其他命令或文档 |
注意:手册页将与命令相关的信息分成了不同的小节,但并不是每一个命令的手册页都包含上述所有小节。
手册页的区域号(Manual Sections)
| 区域号 | 所涵盖的内容 |
|---|---|
| 1 | 可执行程序或 shell 命令(普通用户命令) |
| 2 | 系统调用(内核提供的函数) |
| 3 | 库调用(C 语言等程序库函数) |
| 4 | 特殊文件(通常在 /dev 中) |
| 5 | 文件格式与约定(如 /etc/passwd) |
| 6 | 游戏 |
| 7 | 概览、约定及杂项(如 protocols, iptables 等) |
| 8 | 超级用户和系统管理员命令 |
| 9 | 内核例程(非标准) |
info & pinfo
info:比man更详细的文档系统,采用超链接节点(Nodes)的方式组织,适合阅读长篇大论的 GNU 工具文档。pinfo:info的增强版,提供了更友好的彩色界面和类似浏览器的操作体验。- 常用命令:
info info(查看 info 自己的用法)。
—help 与 -h 选项
--help 是 Linux/Unix 命令行最通用的标准选项,用于在终端直接显示命令的简明使用帮助和参数说明。
- 特点:直接输出在终端,不需要翻页,适合快速查找某个参数。
whatis
whatis 用于快速查询其他命令的简短描述(通常是一行摘要)。它相当于 man -f 命令。
- 工作流程:
whatis 命令查询mandb数据库 返回匹配的命令描述。 - 提示:如果新安装了软件
whatis查不到,可以先运行sudo mandb手动更新数据库。
/usr/share/doc 文件夹
在 Linux 系统中,/usr/share/doc 目录主要用于存放系统中已安装软件包的原生自带文档。根据文件系统层次结构标准(FHS),该目录下的每个软件包通常都有一个对应的子目录,其中包含:
- README 文件:介绍软件的基本功能、使用方法和注意事项。
- 变更日志(changelog):记录软件的版本更新历史和修复的问题。
- 版权和许可证信息(copyright):说明软件的版权归属及使用条款。
- 示例配置文件(Examples):帮助用户快速上手配置软件。
- 其他文档:如 HTML 手册、教程、作者联系信息等。