如何自动对手册中的选项标志进行排序?

如何自动对手册中的选项标志进行排序?

我即将创建一个脚本来编辑手册,以便在该OPTIONS部分中按字母顺序排列选项标志。有没有更直接、更优雅的方法呢?

答案1

没有看到手册页,很难说。但假设您的手册格式一致,例如,

.TP 5
.B \-a
description of \fB\-a\fP option
.TP 5
.B \-b
description of \fB\-b\fP option

等等,你可以编写一个 Perl 脚本来选取包含以下段落的选项,并编写一个对选项进行排序的手册页。 (bash 和 awk 对于这项任务来说似乎动力不足,至少对于xterm, 例如)。

如果您的手册页标记不一致,例如,使用容易被误认为其他描述性内容的选项标记,这将使脚本变得复杂。但实际上,一旦对其进行排序,您就不会经常重新访问该任务,并且(如果您有足够的手册页来证明在脚本上花费的时间是合理的),该脚本将是可重用的。

或者,您可以将所有选项存储在文件中并对该列表进行排序(按选项名称)。这肯定不太优雅,并且对可重用性没有多大帮助。

有人可能已经有了可重用的脚本;不过,获得一致的输入有很大帮助。

相关内容