如何编写手册页？

Question

如何编写手册页？

我在哪里可以找到所有格式代码的参考？

有没有关于编写手册页的好教程？

编写手册页最方便的方法是什么？我应该直接在文本编辑器中输入吗？有 WYSIWYG 编辑器吗？或者我应该以不同的格式编写它然后转换？

一个好的手册页应该遵循哪些规则？

Answer 1

以下是一些可以帮助您入门的网页：

• 创建和格式化手册页
• 创建您自己的 MAN 页面
• 创建您自己的手册页
• 如何编写手册页
• 编写手册页需要了解的内容

几个有用的工具：

• txt2man
• 帮助2人

Answer 2

有一些工具可以编写绕过 troff 格式的手册页。联机帮助页是一种很小的、分隔良好的语言，并且易于定位。

两个流行的工具是：

• xmltoman，一种小型且结构良好的 xml 语言，可以生成联机帮助页和 html。它被 Lennart Poettering 的项目使用，例如syrep和pulseaudio。
• asciidoc，例如由 git 使用。

yodl和zoem在这个领域似乎是其他不错的格式。

总而言之，我推荐 xmltoman，因为它是一个非常特定于联机帮助页的 dsl，将密切指导您。

Answer 3

我写了一篇关于这个主题的相当广泛的博客文章，你可以在这里找到：

http://2buntu.com/articles/1034/how-to-write-a-manpage/