我如何编写手册页?

如何编写手册页?

我在哪里可以find所有格式化代码的参考?

有没有什么好的教程来编写手册页?

写一个手册页最方便的方法是什么? 我应该直接在文本编辑器中input吗? 有没有所见即所得的编辑器? 或者,我应该写在不同的格式,然后转换?

好人页面遵循什么规则?

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

  • 创build和格式化手册页
  • 创build你自己的MAN页面
  • 创build你自己的手册页
  • 如何写一个男人的页面
  • 你需要知道写手册页

几个有用的工具:

  • txt2man
  • help2man

有用于编写绕过troff格式的手册页的工具。 manpages是一个小的,界定分明的语言,易于定位。

两个stream行的工具是:

  • xmltoman ,一个小巧,结构良好的xml语言,可以生成manpage和html。 例如 ,Lennart Poettering的项目使用了syrep和pulseaudio 。
  • asciidoc , git使用例如 。

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

总而言之,我会推荐xmltoman,因为这是一个非常特定于联机帮助的dsl,它将引导您密切关注。

我写了一篇相当广泛的关于这个话题的博客文章,你可以在这里find:

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

我不知道任何IDE或教程,但是您可以先复制现有的手册页并对其进行修改以适应您的需求。

有关MANmacros的groff语言的参考(man手册使用的内容),请参阅groff_man手册页,或者在线阅读

看看ronn项目 。 它是一个手册页生成器的降价 。 它也可以像这样在html中生成手册页。

我喜欢用一种格式编写我所有的软件文档。 Markdown IMO是一个不错的select