对 scdoc 生成手册页的赞扬—kokada

H1:长时间未更新博客及新写 man 页经历

  • 长时间未更新博客主要是没东西可写,这符合预期,且目前这种不定期更新方式符合其长期写博客的计划。
    H2:需要写 man 页及遇到的问题
  • 多年来首次需写 man 页,讨厌用于 man 页的 troff 排版系统,其格式晦涩难懂且缺乏好的工具。
  • 如今多数人用其他格式生成 man 页,如过去用 Pandoc 将 Markdown 转 man 页,但效果不佳,Pandoc 体积大。
  • 此次项目需小而轻的工具,AsciiDoc 虽灵活但复杂,且之前用其生成 man 页效果不好。
    H2:找到合适的 man 页生成工具 scdoc
  • Drew DeVault 创建的 scdoc 是简单的 man 页生成器,用 inspired by Markdown 的 DSL 编写,二进制文件用 C 写,体积小无依赖,符合项目需求。
  • scdoc 的 man 页格式不错,但简洁且缺示例,此博客将尝试补充。
    H3:scdoc 语法总结
  • 语法以注释形式呈现,如 # 新部分、; 注释开头、- 列表、加粗、[表格]等,需用硬制表符配置编辑器。
    H3:.scd 格式的 man 页示例
  • 以 nixos-rebuild-ng 为例展示 man 页格式,包括名称、概要、描述、选项、环境、文件、作者等内容。
  • 展示生成的 man 页截图,说明其效果不错,与 Markdown 有相似之处也有差异,如加粗符号等。
    H2:scdoc 格式的优缺点
  • 优点是格式简单,生成的 man 页效果好,易于更新,即使不懂格式也可修改。
  • 缺点是首行格式要求固定需用硬制表符,错误信息不佳,用[表示表格需转义。
    H1:总结
  • 最终结果重要,此次写 man 页对 scdoc 格式满意,以后若需再写会继续使用。
阅读 7
0 条评论