在Linux系统上,通常键入progname –help来查看该程序的帮助输出.之后,您将看到类似这样的描述:progname [SWITCHES] [FILES] … [ETC]
我的问题是;他的(命令行使用)文档类型是否有标准化语法?
为了描述诸如可选开关,多个参数(例如文件列表),开关模式等之类的东西.似乎会有一个标准,以便所有知道它的人都可以准确地解释您的文档.
注意:这纯粹是关于编写我自己的文档,而不是解析参数.
解决方法:
我浏览了许多linux手册页,这里有一些我看过的东西似乎是linux附带的手册页的标准内容.就像上面的一些贡献者所说的那样,似乎没有任何已发布的文档标准.我在网上看到了一些差异,但是linux随附的页面似乎非常一致.
>有问题的命令首先出现.
>将由用户提供的参数内容放在尖括号“<>”中,并在括号内给出一个名称,以描述参数是什么.例如
>可选参数放在方括号“ []”中.
>如果必须从定义的集合中选择一个参数值,则不同的选项将由代表“或”的管道符号“ |”分隔.
>如果列表的内容遵循逻辑顺序,则可以使用点点点“ …”简化列表.例如[…].
>小心空间.空格分隔事物,因此在单个事物的名称中没有空格.使用“文件名”或“文件名”,而不是“文件名”.
我现在能想到的就是这些.如果您认为合适,请随时添加和更正.