linux - 在手册页中使用 <> 来指示可选的空格

Question

我正在维护一个旧的 KornShell shell 脚本及其手册页。

shell脚本的命令行选项包括-wwidth(中间没有空格)和-w width (中间有空格)，效果相同。在手册页的 SYNOPSIS 部分中，这被记录为 [-w<width]，显然使用 <> 表示可选的空格。

我无法在 Web 上找到将 <> 用于此目的的其他 UNIX 或 Linux 手册页，因此我认为这不符合 UNIX 或 Linux 用户期望的约定，因此用户可能被手册页中的 <> 搞糊涂了。

手册页中的下列表示最清楚地表明 -w 和 width 之间的空白是可选的:

• [-w<宽度],
• [-w[ ]宽度]，或者
• [-w宽度|-w 宽度]?

只有 [-wwidth] 或 [-w 一个更好吗？ em>width] 在手册页中，基于它们做同样的事情，所以很少或没有增加用户的值(value)来记录这些替代方案中的 both 是可用的？

Answer 1

我只记录 -w <i>width</i>因为这是一个通用约定，带参数的选项可以在同一命令行参数 ( -w80 ) 或以下命令行参数 ( -w 80 ) 中采用参数。

任何不遵循约定的工具/选项都应该记录下来，但您的情况看起来很标准。