man手册的阅读障碍一般是:
- 英语差,不知所云(学好英语,你将收获许多原汁原味的知识、技术!)
- 理不清文档内容组织结构,思维很混乱
- 不明白文档描述所用的体例(形式化描述方法),不明白命令各种参数该如何组合
- ......害怕
这里并不说明某个命令的用法,如果你想了解man如何描述一个命令,那么请往下看看,或许你有意想不到的收获;如果如果你想知道某个命令的作用和使用示例,请自觉Ctrl+W,逃...
1.man手册分类
序号 | 英文 | 中文 |
---|---|---|
1 | Executable programs or shell commands | 可执行程序或shell命令 |
2 | System calls (functions provided by the kernel) | 系统调用(由内核提供的函数) |
3 | Library calls (functions within program libraries) | 库调用 (标准库或第三方库提供的函数) |
4 | Special files (usually found in /dev) | 特殊文件(如对文件/dev/random的描述 ) |
5 | File formats and conventions eg /etc/passwd | 描述了文件的格式,各个字段的含义和取值约束等 |
6 | Games | 游戏 |
7 | Miscellaneous (including macro packages and conventions), e.g. man(7), groff(7) | 杂项(不便具体分类的说明都暂且都放这节吧) |
8 | System administration commands (usually only for root) | 系统管理员命令(通常仅适用于root用户) |
9 | Kernel routines [Non standard] | 内核例程(非标准) |
2.man手册的主要内容结构(不同命令的man页略有差异)
标题 | 描述 |
NAME | 命令名称和用途(摘要) |
SYNOPSIS | 命令语法(摘要) |
DESCRIPTION | 详细描述命令作用,及其 选项、参数的作用 |
OPTIONS | 选项和参数 |
AUTHOR | 作者 |
COPYRIGHT | 版权 |
SEE ALSO | 其他参考 |
BUGS | bugs |
3.OPTIONS 中对命令参数的形式记号约定
- options:命令选项有两种形式:长选项(--)和短选项(-)
- 长选项: 用 -- 引导,后面跟完整的单词,eg: --verbose
- 短选项: 用 - 引导,后面跟单个的字符,eg: -A
- options 可以有自己的参数(选项与参数之间一般用空格分隔),
- 命令使用描述中的一些常见记号,这类符号有 [ ]、 { }、 ... , 粗体或下划线字体:
- | 表示选择;
- prefix... prefix选项或参数可以重复零或多次;
- 斜体字根据实际需要替换
- 黑体字 必须逐字输入,这一类可能是命令名或选项名;
- { } 大括号中项是必选项;
- [ ]中的项是可选的;