Man

在 UNIX 手冊頁中添加“子小節”是否有任何準標準?

  • April 19, 2022

我想知道:使用宏包編寫 UNIX 手冊頁man.SH(節標題)和.SS(子節)。但是,如果我想有“子小節”怎麼辦?

有這樣的標準嗎?我想我已經看到一些頁面擺弄了字型大小(troff至少).SS,但我想知道是否真的有一些(準)標準。

我相信簡短的回答是“不”——手冊頁中的小節沒有標準。

去年 9 月,該問題出現linux-man郵件列表中,其中整理了大量man材料,沒有人知道這樣做的任何公認習語。

我要強調的一點是:“如果您需要手冊頁中的小節,

$$ then $$整個頁面的討論水平太粗糙了。”沒有法律禁止將手冊頁分成多個文件。groff 和 Perl 這樣做。 甚至最初man的宏包自己的手冊頁(1979)也被淘汰了,SS甚至沒有記錄分段宏。

對我來說,這種(故意的?)疏忽似乎與手冊頁作為“簡潔”文件的原始概念一致。

如果您必須這樣做,我不會編寫自己的宏或濫用執行緒TP中討論的內容。linux-man我可能只會使用“run-in-header”。換句話說,以斜體或粗體的標題開始一個段落。

.P
.B Error handling.
The Z language does not support an exception mechanism.
Therefore you have to check return values at every point blah blah blah

引用自:https://unix.stackexchange.com/questions/698037