手册页很棒,手册读者才是问题

主要观点:常有人批评 man 页无相互链接及窗口变窄时不换行,实际 man 页支持这些功能,只是读取程序未实现;man 页以 mdoc(7)和 man(7)格式存储,有特定宏标记内容,.Xr 和.Sx 宏可作为链接,转换为 HTML 时会渲染为实际链接,但在终端通过 man(1)命令显示时不显示链接;需要更好的 man 页读取程序,能让用户跟随链接,同时终端窗口变窄时可重排文本。
关键信息:

  • 有多种 man 页相关标签,如 [#documentation]、[#man]、[#unix]。
  • man 页格式中,.Sh 等宏有特定作用,需参考[macro overview]。
  • 两个重要宏.Xr 和.Sx 可作为链接,转换为 HTML 时有效。
  • 当前 man(1)格式并通过 less(1)显示,难以添加链接支持,需原生支持 man 页的分页器。
    重要细节:
  • 文中提到的OpenRC’s man pages可查看完整示例及许可证细节。
  • 有关于 man(7)和 mdoc(7)出现时间的说明及引用↩︎
  • 提供了联系作者讨论该话题的邮箱地址,如[~whynothugo/mailto:public-inbox@lists.sr.ht]和[mailto:hugo@whynothugo.nl]。
阅读 35
0 条评论