我该如何编写手册页？

Question 1

以下几个网页可以帮助您入门：

一些有用的工具：

Answer

以下几个网页可以帮助您入门：

一些有用的工具：

Question 2

有一些编写手册页的工具可以绕过 troff 格式。手册页是一种小型的、界限明确的语言，并且易于定位。

两种流行的工具是：

xmltoman，一种小型且结构良好的 xml 语言，可以生成手册页和 html。它被 Lennart Poettering 的项目使用，糖浆和例如 pulseaudio。
asciidoc，例如 git 使用。

约德尔和佐姆在这个空间里似乎还有其他不错的格式。

总而言之，我推荐 xmltoman，因为它是一个非常适合手册页的 dsl，可以为您提供密切的指导。

Answer

有一些编写手册页的工具可以绕过 troff 格式。手册页是一种小型的、界限明确的语言，并且易于定位。

两种流行的工具是：

xmltoman，一种小型且结构良好的 xml 语言，可以生成手册页和 html。它被 Lennart Poettering 的项目使用，糖浆和例如 pulseaudio。
asciidoc，例如 git 使用。

约德尔和佐姆在这个空间里似乎还有其他不错的格式。

总而言之，我推荐 xmltoman，因为它是一个非常适合手册页的 dsl，可以为您提供密切的指导。

Question 3

我已经写了一篇关于该主题的相当详尽的博客文章，您可以在这里找到：

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

Answer

我已经写了一篇关于该主题的相当详尽的博客文章，您可以在这里找到：

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

Question 4

看看ronn 项目。它是降价到手册页生成器。它还可以生成 html 格式的手册页，例如这。

我喜欢用一种格式编写所有软件文档。Markdown 在我看来是个不错的选择

Answer

看看ronn 项目。它是降价到手册页生成器。它还可以生成 html 格式的手册页，例如这。

我喜欢用一种格式编写所有软件文档。Markdown 在我看来是个不错的选择

相关内容