Question

创作手册页的最佳方法是什么？我应该使用标准的man宏编写，还是现在有一些聪明的包可以使用某种XML-ified源并可以输出手册页，HTML，ASCII，什么不是？

由于

Answer 1

我以前使用名为groff的GNU版本的nroff来编写手册页。

这里有很好的介绍文章：

http://www.linuxjournal.com/article/1158

Answer 2

Doxygen正是您要找的。请记住，它旨在记录源代码，但您可以轻松地对其进行调整。

它也可以生成html，pdf和latex文档。

Answer 3

如果您正在编写一次并生成不同的输出格式（如联机帮助页，HTML，纯文本格式甚至PDF），那么docbook应该效果最佳。

Answer 4

Tcl社区中常用的工具是doctools，它可以生成手册页格式的受限（但有用）子集，适合使用groff或nroff进行渲染。它还可以直接生成纯文本和HTML。

Answer 5

对于我atinout程序，我一直在使用ronn，它允许您以非常，非常易读的标记语法来编写手册页。我对它非常满意。

atinout(1) -- Send AT commands to modem, capturing the response
===============================================================

## SYNOPSIS

`atinout` <input_file>|`-` <modem_device> <output_file>|`-`<br>
`atinout` `--version`<br>
`atinout` `--usage`<br>
`atinout` `--help`<br>

## DESCRIPTION

**Atinout** reads a list of AT commands. It sends those commands one by one
to the modem, waiting for the final result code for the
currently running command before continuing with the next command in
the list. The output from the commands is saved.
...

see the whole page here

创作手册页的最佳方式？

5 个答案: