7

编写手册页的最佳方式是什么？我应该使用标准的 man 宏来编写，还是现在有一些聪明的包可以使用某种 XML 化的源代码并可以输出手册页、HTML、ASCII 等等？

谢谢

4

5 回答 5

2

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

很好的介绍文章在这里：

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

于 2010-05-08T15:10:11.093 回答
1

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

它也可以生成 html、pdf 和 Latex 文档。

于 2010-05-01T04:05:59.153 回答
1

如果您正在考虑编写一次并生成不同的输出格式，例如联机帮助页、HTML、纯 txt 甚至 PDF，那么docbook应该是最好的。

于 2010-05-01T04:08:06.990 回答
1

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

于 2010-05-08T15:20:56.300 回答
0

对于我的atinout程序，我一直在使用ronn，它可以让您以非常非常易读的 markdown 语法编写手册页。我对此非常满意。

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.
...

在这里查看整个页面。

于 2017-10-14T20:23:49.553 回答