概要

1、版本信息

Ubuntu 18.04.5
Docker 19.03.6

正文

1、docker commands --help

docker commands --help 的命令文档与 Linux 下的命令帮助文档基本一致，但这里面还是有一些细小的差距还有一些细节的地方需要理解。

2、以 docker version --help 为例

docker version --help 命令说明

• 第一部分是命令用法，[OPTIONS] 表示这部分是可选参数，也就是说可传也可不传。

• 第二部分是命令用途描述。 

• 第三部分的 Options 下方是命令用法中的 [OPTIONS] 的可选参数的解释。

• 单中横线表示的是速记参数（比如 -f），双中横线表示的是完整参数（比如 --format）。

• 速记参数一般是完整参数首字母，区分大小写（-f 与 -F 表示不同参数），使用速记参数与完整参数是相同的效果。

• 不是所有参数都有速记参数，也不是所有参数都有完整参数名，比如 --kubeconfig 参数就没有速记参数，前面没有单中横线表示没有速记参数。 

• 参数后面如果有 string/int 等数据类型单词，表示这是一个需要传值的参数，参数值的数据类型就是后面给的数据类型。

• 如果参数后面没有数据类型给出，表示这是一个不需要传值的参数（比如 docker version --help 的 --help 就是一个不需要传值的参数）。

• 每一行最后面部分的内容表示的是该可选参数的描述，如果有默认值，一般也会在描述中给出。

• 可选参数的传值方式一般是 参数 + 空格 + 参数值 的方式或者 参数 + 等号 + 参数值 的方式（比如 docker version -f '{{.Server.Version}}' 或 docker version -f='{{.Server.Version}}'）

总结

如果我们理解了命令的帮助文档的规范与规则，那么我们在日常使用命令的时候，就算是不熟悉的命令，我们也可以通过阅读帮助文档来进行命令的操作使用。