我正在维护一个旧的KornShell shell脚本及其手册页。
shell脚本的命令行选项包括-w
宽度(无中间空间)和-w
宽度(带有插入的空格),它们具有相同的效果。在手册页中,这在“概要”部分中记录为[ -w
<> width ],显然使用<>表示可选的空格。
我无法在Web上找到使用<>的其他UNIX或Linux手册页,因此我认为这不遵循UNIX或Linux用户期望的约定,因此用户可能会被手册页中的<>。
手册页中的以下哪个表示最清楚地表明宽度-w
和宽度之间的空白是可选的:
-w
<> 宽度 ],-w
[] 宽度 ],或-w
宽度 | -w
宽度 ]?在手册页中只有[ width ]或[ width ]中的一个是更好的,因为它们做同样的事情,因此很少或没有添加到用户的值来记录这两个备选方案都是可用的?-w-w
发布于 2018-12-12 15:01:25
我只是记录,因为它是一个普遍的约定,带参数的选项可以在相同的命令行参数()或下面的命令行参数()中获取参数。-w width-w80-w 80
任何不遵循惯例的工具/选项都应该记录它,但是你的情况看起来非常标准。
https://stackoverflow.com/questions/-100005130
复制相似问题