使用＆lt;＆gt;在手册页中指示可选的空格

Question

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

shell脚本的命令行选项包括 -w 宽度（无中间空间）和 -w width （具有插入的空白区域），具有相同的效果。在手册页中，这在“概要”部分中记录为[ -w ＆lt;＆gt; width ]，显然使用＆lt;＆gt;表示可选的空格。

我无法在Web上找到使用＆lt;＆gt;的其他UNIX或Linux手册页为此，我认为这不符合UNIX或Linux用户期望的约定，因此用户可能会被＆lt;＆gt;所困惑。在手册页中。

手册页中的以下哪个表示清楚地表明 -w 和 width 之间的空格是可选的：

• [ -w ＆LT;＆GT; 宽度]，
• [ -w [] width ]或
• [ -w 宽度 | -w 宽度]？

只有 -w 宽度]或[ -w <的一个更好吗？手册页中的em> width ]，基于它们执行相同的操作，因此用户很少或没有添加任何值来记录这些这些替代方案是否可用？

Answer 1

我只记录-w width，因为它是一个普遍的约定，带参数的选项可以在同一命令行参数（-w80）或后面的命令行参数中获取参数（-w 80）。

任何不遵循惯例的工具/选项都应该记录它，但是你的情况看起来非常标准。