我正在学习编辑man
页面。我刚刚注意到源文件中的 SEE ALSO 部分由单独的行组成(显示为一行长行man
)。这有什么意义吗?或者我也可以将长参考文献列表放在一行上?
PS 简单的相关问题只是与主要问题一起出现(随意忽略)。在某些源文件中,行以“,”( grep
) 结尾,有些则不以“,” ( cgcreate
) 结尾。以.BR
(grep
)开头或不以(cgcreate
)开头。除了缩进还有什么意义吗?
答案1
将引用保留在单独的行上的价值在于,当添加或删除引用时,该更改会自行出现,而不是每次都重新处理整行。
我的建议是遵循手册页项目约定:
以逗号分隔的相关手册页列表,可能后跟其他相关页面或文档。
该列表应按章节编号排序,然后按名称字母顺序排列。不要以句点结束此列表。
.BR
使用时,手册页标题是粗体的,但章节不是粗体的。