Linux man文档语法解析

  对于Linux中的上百上千个命令和函数,没有人能够全部都记住,甚至只是记住有用的一部分也不容易。这时候man命令就显得额外的重要的。

  然而,在使用man命令查阅一些命令的用法和解析的时候,面对一大堆的英文,不少人都懵了。如查man ar时:

Linux man文档语法解析_第1张图片

SYNOPSIS下的各个项表示什么意思?很多人一开始都懵了!下面总结一下。

1 表述惯例

a)粗体字    照着抄写!
b)斜体字    用适当的参数来替换!
c)[ -abc]      表示可以选择abc中的任意项目!
d)-a|-b       用|分开的选项,表示只能选择其一!
e)...              表示重复!
f)[express]  用[]括住,表示express是可选的!

下面是这个惯例的英文原文:

Linux man文档语法解析_第2张图片

2 实际分析——ar

2.1 符号-

  在第一幅图中可以看到SYNOPSIS中有[-],这表示ar的选项前可带-,也可以将其忽略!

  下图是一个用ar创建一个静态库的过程,分别使用了带-和忽略-的选项,都可以成功!

Linux man文档语法解析_第3张图片

2.2 关于OPTIONS

  在第一幅图中可以看到SYNOPSIS中并没有[options]的说明,那么是不是表示ar没有OPTIONS呢,不是的,下面就是ar的OPTIONS:

Linux man文档语法解析_第4张图片

  另外,由于ar的选项是可以忽略-的,因此OPTIONS说明中,都没有标注-。下图是open(1)的手册,从中可见OPTIONS中的每一项都有-,因为它是不可以忽略-的。

Linux man文档语法解析_第5张图片

  另外,由上图可见,SYNOPSIS中同样没有[options]说明,但是下面还是有OPTIONS!这就更加说明了,SYNOPSIS中的[options]是不必要的!


参考资料

[1]如何看懂man手册1


你可能感兴趣的:(Linux man文档语法解析)