![手册页中的嵌套列表](https://linux22.com/image/22850/%E6%89%8B%E5%86%8C%E9%A1%B5%E4%B8%AD%E7%9A%84%E5%B5%8C%E5%A5%97%E5%88%97%E8%A1%A8.png)
我有一个命令行参数,之后需要一些标志,我希望将其作为手册页参数列表中的列表。
目前我只是简单地制作Flag - Description
(手册页),但这并不理想,原因如下:
- 不缩进换行。我可以手动缩进它们,但随后我必须假设设定的控制台宽度,这是我不想做的
- 必须依靠双换行符才能转到下一行,我宁愿有类似的东西
.TP
。
答案1
- 列表以 开始
.RS
,以 结束.RE
。 - 以术语开头的列表项
.IP
。如果包含多个单词,请将术语用双引号引起来。 - 将描述文本放在列表项开始后的下一行中。
- 是可嵌套的,因此描述可能包含更多列表。
- 使用
\fB
..\fP
将术语加粗,而不是.B
. (下划线相同 - 使用\fI
..\fP
代替.I
.)
.RS
.IP \fBA\fP
\- Flag 1
.IP \fBB\fP
\- Flag 2
.IP \fBC\fP
\- A slightly longer flag description that could take up more than the width
of the average console. In fact you'd need a very wide console to read all
this.
.RE
为了提高您的工作效率,我建议以更友好的格式编写手册页,然后进行转换。一些合适的工具列举在我可以为脚本创建手册页吗?。