命令行/ shell帮助文本是否有“标准”格式?

前端之家收集整理的这篇文章主要介绍了命令行/ shell帮助文本是否有“标准”格式?前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
如果不是,这里是事实上的标准吗?基本上我写了一个命令行帮助文本,如:
usage: app_name [options] required_input required_input2
  options:
    -a,--argument     Does something
    -b required     Does something with "required"
    -c,--command required     Something else
    -d [optlistitem1 optlistitem 2 ... ]     Something with list

我从基本上只是阅读各种工具的帮助文本,但有一个指南或东西的列表吗?例如,我使用方括号或括号吗?间距如何?如果参数是列表怎么办?谢谢!

通常,您的帮助输出包括

>描述应用程序的功能
>用法语法,其中:

>使用[options]来指示选项的位置
> arg_name表示必需的单数arg
> [arg_name]表示可选的单数arg
> arg_name …对于一个必需的arg,它可以有很多(这是罕见的)
> [arg_name …]用于可以提供任何数字的arg
>请注意,arg_name应该是一个描述性的短名称,在较低的,蛇的情况下

>一个格式很好的选项列表,每个选项:

>具有简短描述
>显示默认值,如果有一个
>显示可能的值,如果适用)
>请注意,如果某个选项可以接受简短表单(例如-l)或长整型(例如–list),请将它们一起包含在同一行,因为它们的描述将是相同的

>配置文件或环境变量的位置的简要指示,可能是命令行参数的来源,例如。 GREP_OPTS
>如果有一个手册页,请注明,否则,简要指示可以在哪里找到更详细的帮助

进一步注意,接受-h和–help来触发这个消息是很好的形式,如果用户弄乱了命令行语法,你应该显示这个消息。省略必需的参数。

猜你在找的Bash相关文章