帮助系统
Linux提供了多层次的帮助系统,从简短的命令提示到详细的手册页面,满足不同场景的需求。
man 手册页
man(manual)是Linux最核心的帮助系统,用于查看命令、函数、配置文件等的详细手册。
基本用法
man [选项] [章节] 页面名
# 常用示例
man ls # 查看ls命令手册
man 5 passwd # 查看passwd文件格式(第5章)
man 2 open # 查看open系统调用(第2章)
man -k password # 关键字搜索(等同于apropos)
man -f ls # 精确匹配(等同于whatis)常用选项
| 选项 | 说明 |
|---|---|
-k | 关键字搜索手册页(等同于 apropos) |
-f | 精确匹配命令名(等同于 whatis) |
-a | 显示所有匹配的手册页(逐个浏览) |
-w | 显示手册页文件路径 |
-P | 指定分页程序 |
手册章节
手册页按内容类型分为9个章节:
| 章节 | 内容类型 | 示例 |
|---|---|---|
| 1 | 可执行程序或shell命令 | man 1 ls |
| 2 | 系统调用(内核提供的函数) | man 2 open |
| 3 | 库调用(C库函数) | man 3 printf |
| 4 | 特殊文件(通常在/dev) | man 4 null |
| 5 | 文件格式与约定 | man 5 passwd |
| 6 | 游戏 | man 6 fortune |
| 7 | 概览、约定及杂项 | man 7 regex |
| 8 | 超级用户和管理员命令 | man 8 fdisk |
| 9 | 内核例程 | man 9 intro |
手册页结构
手册页内部按固定格式组织:
| 小节 | 说明 |
|---|---|
| NAME | 命令名称和简短描述 |
| SYNOPSIS | 命令语法格式 |
| DESCRIPTION | 详细功能描述 |
| OPTIONS | 所有选项说明 |
| ARGUMENTS | 参数说明 |
| EXAMPLES | 使用示例 |
| FILES | 相关文件 |
| ENVIRONMENT | 环境变量 |
| EXIT STATUS | 退出状态码 |
| NOTES | 注意事项 |
| BUGS | 已知问题 |
| SEE ALSO | 相关命令 |
| AUTHOR | 作者信息 |
阅读技巧
# 导航快捷键
空格键 # 下一页
b # 上一页
/keyword # 向下搜索
?keyword # 向上搜索
n # 下一个匹配
N # 上一个匹配
q # 退出
h # 帮助
# 搜索技巧
man -k "copy file" # 搜索描述包含"copy file"的命令
man -k "^copy" # 正则:以copy开头
apropos "list" # 同 man -kinfo 信息页
info 是GNU项目的帮助系统,提供比man更详细的文档,支持超链接导航。
# 基本用法
info # 进入info主菜单
info bash # 查看bash信息页
info coreutils # 查看coreutils文档
info --help # 显示info帮助
# pinfo(彩色版本的info)
pinfo bash # 更友好的界面info导航快捷键
| 快捷键 | 功能 |
|---|---|
n | 下一个节点 |
p | 上一个节点 |
u | 上级节点 |
m | 选择菜单项 |
l | 返回上一个位置 |
t | 返回顶级节点 |
q | 退出 |
h | 帮助 |
—help 快速帮助
大多数命令支持 --help 或 -h 选项,显示简明的使用说明。
# 常用格式
command --help
command -h
# 示例
ls --help # 显示ls选项概览
grep --help # 显示grep用法
tar --help | head -20 # 查看前20行帮助
# 注意:内置命令需要用help
help cd # bash内置命令
help echo # 查看echo帮助help(bash内置)
# bash内置命令的帮助
help # 显示所有内置命令
help cd # cd命令帮助
help echo # echo命令帮助
help -m cd # man风格格式输出whatis & apropos 快速查询
whatis - 一行描述
whatis 显示命令的简短描述(来自手册页的NAME部分)。
whatis ls # ls (1) - list directory contents
whatis passwd # 显示所有章节的passwd
whatis -l passwd # 详细列出所有匹配
# 等同于
man -f lsapropos - 关键字搜索
apropos 搜索手册页的名称和描述,适合不知道确切命令名时使用。
apropos "copy" # 搜索与copy相关的命令
apropos "network" # 搜索网络相关命令
apropos "file list" # 多关键字搜索
apropos -e "ls" # 精确匹配
# 等同于
man -k "copy"数据库维护
# 更新whatis/apropos数据库
sudo mandb # 更新手册数据库
sudo makewhatis # 旧版命令type & which 命令定位
type - 命令类型
type ls # ls is aliased to `ls --color=auto'
type cd # cd is a shell builtin
type grep # grep is /usr/bin/grep
type -a echo # 显示所有匹配(内置+外部)
type -t ls # 只显示类型:alias/builtin/file/functionwhich - 命令路径
which ls # /usr/bin/ls
which python # /usr/bin/python
which -a python # 显示所有匹配路径whereis - 相关文件
whereis ls # 显示二进制、源码、手册页位置
# ls: /usr/bin/ls /usr/share/man/man1/ls.1.gz
whereis -b ls # 只找二进制
whereis -m ls # 只找手册页/usr/share/doc 文档目录
系统级文档存放在 /usr/share/doc 目录,每个软件包有独立子目录。
# 查看文档
ls /usr/share/doc/ # 列出所有软件文档
ls /usr/share/doc/bash/ # bash的文档
# 常见文件
README # 软件介绍
changelog # 版本更新历史
copyright # 版权信息
examples/ # 示例文件
TODO # 待办事项在线帮助资源
# tldr - 简化版手册(需安装)
tldr ls # 显示ls常用示例
tldr tar # tar常用用法
# cheat - 速查表(需安装)
cheat tar # tar命令速查在线资源
- Bash官方文档
- TLDR Pages: https://tldr.sh - 简化版命令手册
- Explainshell: https://explainshell.com - 命令解释工具
- Man7: https://man7.org/linux/man-pages/ - 在线man手册
- Arch Wiki: https://wiki.archlinux.org - 高质量Linux文档
💡 帮助系统使用建议:
- 快速查看选项 →
command --help- 详细学习命令 →
man command- 忘记命令名 →
apropos keyword- 确认命令位置 →
type command或which command- 学习复杂工具 →
info command或/usr/share/doc/
🔗 相关笔记: 01_Linux概述 01_目录结构