Bash脚本帮助文本可重复参数组的标准表示语法问询

语法正确性判定 #

你写的(<from> <to>)…括号语法完全符合通行的命令帮助文档编写惯例，是正确的。圆括号在这里的作用就是将多个有绑定关系的非互斥参数合并为一个逻辑分组，搭配末尾的省略号，就能清晰表示「该分组可重复多次、组内参数必须按规则配套出现」的含义，和你给出的change from1 to1 from2 to2 from3 to3用法完全匹配。

帮助文本参数表示的通用规则 #

目前没有强制的全球统一标准，但以下是所有类Unix系统命令、脚本帮助文档广泛遵循的通用约定，包括GNU核心工具、Git等主流开源项目的官方帮助文档都遵循这类规则：

• 方括号[]包裹可选参数/选项
• 尖括号<>包裹需要用户自行替换的占位符
• 竖线|表示前后内容为互斥关系，只能选其一
• 省略号…（或...）表示前面的参数/分组可以重复多次
• 圆括号()用来组合多个关联参数，作为一个整体处理

针对你最开始提到的dl命令，优先推荐你用第一种语法写法：

dl [m|r]… (<file>|<URL> [m|r|<index>]…)…

这种写法的表意更严谨，不会出现第二种写法里「允许连续传入无意义的m参数」的歧义，完全匹配你要表达的参数规则。

内容的提问来源于stack exchange，提问作者Fabian Röling