man手册一般结构


标题 内容
NAME 命令的名称和用途概括
SYNOPSIS 命令语法,指令键入格式
DESCRIPTION 完整描述
ENVIRONMENT 命令要使用到的环境变量
AUTHOR 作者
FILES 对该命令很重要的文件列表
SEE ALSO 查看命令相关信息的位置
DIAGNOSTICS 可能的错误和警告
BUGS

指令键入格式


find [-H] [-L] [-P] [-D debugopts] [-Olevel] [starting-point...] [expression]

grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] -e PATTERN ... [FILE...]
grep [OPTIONS] -f FILE ... [FILE...]

以 find 和 grep 命令为例分析指令参数的使用

  • [ ] 方括号括起来的部分代表是可选的,不是必须有的
  • 不在方括号里,或者在大括号{}尖括号<>中的部分是必须有的
  • 黑体(或粗体)必须按原样键入
  • 斜体(或带下划线必须使用适当的值替代
    例如 grep -e PATTERN 中的 PATTERN 就必须替换为需要查找的字符串
  • 后接省略号 ... 的参数可以多次重复出现
  • 如果一个单独选项和一个参数组合在一起同时出现,则二者须同时使用
    例如 grep -e PATTERN 中的 -e PATTERN-e 后必须接上 PATTERN
  • 由竖线 | 字符分开的两个或多个项表示从中选一个使用

参考


  1. 如何看懂man手册
posted on 2022-07-14 15:54  WORMARZ  阅读(55)  评论(0)    收藏  举报