man:命令手册

man ls                       # 看 ls 的手册
man 5 passwd                 # 看第 5 节的 passwd(文件格式,不是命令)
man -k network               # 搜含 network 的所有页(同 apropos)
man -f ls                    # 简短描述(同 whatis)

9 个 section

man page 分章节:

Section 内容
1 命令(你日常用的)
2 系统调用(kernel API)
3 库函数(C 库等)
4 设备 / 特殊文件
5 文件格式 + 协议(如 /etc/passwd 格式)
6 游戏
7 杂项
8 系统管理(sudo 用的)
9 内核例程
man 1 passwd       # passwd 命令
man 5 passwd       # /etc/passwd 文件格式

man page 内部结构

每页大致同样的章节:

NAME           做什么
SYNOPSIS       用法(参数顺序)
DESCRIPTION    详细
OPTIONS        参数表 ★ 90% 时间看这
EXAMPLES       例子(有时有)
SEE ALSO       相关命令

跳到 OPTIONS:在 less 模式里按 /OPTIONS 回车。

less 模式快捷键(在 man 里通用)

作用
j / k 上下行
Space 下一页
b 上一页
/keyword 向下搜
?keyword 向上搜
n 下个匹配
g / G 到头 / 到尾
q 退出
h 帮助

info:详细文档(GNU 工具)

info coreutils
info ls

infoman 更详细,但界面别扭——多数人只用 man。

apropos / whatis:找命令

apropos network             # 找含 "network" 的所有手册(按描述搜)
whatis nginx                # 看一句话简介
man -k user                 # apropos 别名

适合"我想干 X,不知道用哪个命令"。

--help:快速版(推荐)

多数命令支持 --help-h

ls --help
curl --help

比 man 短得多——快速查参数时用 --help

tldr:现代极简版(推荐)

sudo apt install tldr
tldr tar                    # 几个常用例子,秒查
tldr find
tldr ssh

tldr 是社区维护的例子驱动手册——比 man 实用 10 倍。强烈推荐装一个

命令的 --version

ls --version
curl --version
ssh -V                      # 注意:ssh 用 -V 不是 --version

  • man passwd 默认进 section 1(命令)——看文件格式要 man 5 passwd
  • 国产化 / 容器里有些命令没装 man——apt install manpages 装上
  • man page 是 markdown / troff 写的——用 mandocgroff 自己渲染