Linux预测是否有标准化语法?

时间:2010-07-06 15:09:44

标签: linux command-line syntax documentation parameters

在Linux系统上,通常键入progname --help以查看该程序的帮助输出。在此之后,您会看到如下描述:progname [SWITCHES] [FILES]... [ETC]

我的问题是;他的(命令行使用)文档是否有标准化的语法?

为了描述可选开关,多个参数(如文件列表),开关模式等等,似乎会有一个标准,以便任何知道它的人都可以准确地解释您的文档。

注意:这完全是关于编写我自己的文档,而不是解析参数。

4 个答案:

答案 0 :(得分:2)

我浏览了很多linux手册页,这里有一些我认为似乎是linux标准手册的标准。像上面的一些贡献者所说,似乎没有任何已发布的文档标准。我在网上看到了一些差异,但linux附带的页面看起来非常一致。

  1. 首先显示有问题的命令。
  2. 由用户提供的参数的东西放在尖括号“<>”中,括号内的名称描述参数是什么。恩。
  3. 可选参数放在方括号中,“[]”。
  4. 如果必须从定义的集合中选择参数值,则不同的选项由管道符号“|”分隔,表示“或”。
  5. 如果列表的内容遵循逻辑进展,则可以使用点点“...”来简化列表。恩。 [...]。
  6. 小心空间。空间将事物分开,因此单个事物的名称中没有空格。使用“filename”或“file_name”,而不是“文件名”。
  7. 这就是我现在所能想到的。如果您认为合适,请随意添加并更正。

答案 1 :(得分:1)

GNU Getopt Library可能是现在解析参数的最标准方法。对于您将使用的大多数语言都有库绑定。

答案 2 :(得分:1)

您想在程序中实施此类帮助吗?有一些标准的Linux命令:

getopt - 在脚本http://linuxmanpages.com/man1/getopt.1.php

中使用

getopt,getopt_long - 在C + / C ++ http://linuxmanpages.com/man3/getopt.3.php

中使用

答案 3 :(得分:0)