相关:getopts,getopt
比如Git
拿 Git 命令举例, git --help 后跳出了诸多文本信息:
git [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]
[--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
[-p | --paginate | -P | --no-pager] [--no-replace-objects] [--no-lazy-fetch]
[--no-optional-locks] [--no-advice] [--bare] [--git-dir=<path>]
[--work-tree=<path>] [--namespace=<name>] [--config-env=<name>=<envvar>]
<command> [<args>]
<>(尖括号)
:通常用来表示必须提供的参数或值,并且这些参数的具体内容由用户根据实际情况提供。例如
[](方括号)
:如果一个选项被包含在方括号中,那么它是可以选择性地使用的,不是必须的。
|(竖线)
:即在同一位置可以提供多种不同的选项中的一个。例如 -v | --version 意味着你可以使用 -v 或者 --version 二者之一。
Git 指令参数详解
● -v | --version
:表示可以使用 -v 或 --version 来显示版本信息。
● -h | --help
:表示可以使用 -h 或 --help 来获取帮助信息。
● -C <path>
:表示可以使用 -C 后跟一个路径参数,该参数是必需的。
● -c <name>=<value>
:表示可以使用 -c 来设置配置变量,其中 和 是必需的具体名称和值。
● --exec-path[=<path>]
:表示可以使用 --exec-path,后面可以跟一个路径参数(这个参数是可选的),如果没有指定路径,则仅使用 --exec-path 作为查询当前路径。
● <command>
:这是执行的一个具体的 Git 命令,如 add, commit, push 等,是必需的。 [<args>]
:表示给定 Git 命令之后可以跟随的参数列表,这些参数是可选的。
总结:
这些符号都有特定的意义:
-
<>
尖括号,通常表示必须提供的参数或值需要用户自行提供 -
[]
,方括号,一般表示可选的选项或参数。 -
|
,表示“或”的意思;竖线分隔的内容,表示选择其一。