Linux Man Page Howto

Jens Schweikhardt

Pradeep Padala - 从 HTML 到 DocBook v4.1 的转换。

v0.1, 2002-09-07

修订历史
修订 0.12002-09-07修订者:ppadala
从 HTML 到 Docbook v4.1 的转换

$Id: Man-Page.sgml,v 1.2 2002/12/15 17:51:43 schweikh Exp schweikh $

本 HOWTO 解释了当您要编写在线文档(所谓的 man page),并希望通过man(1) 命令访问它时,您应该牢记的事项。 在本 HOWTO 中,无论实际长度如何,并且没有性别歧视的意图,手册条目都简称为 man page。


目录
1. 关于文档的一些思考
2. 如何访问 man page?
3. 格式化的 man page 应该是什么样子?
4. 如何在单个 man page 中记录多个程序/函数?
5. 我应该使用哪个宏包?
6. 我可以使用的预处理器有哪些?
7. 我应该分发源代码和/或已格式化的文档吗?
8. 字体约定是什么?
9. 润色您的 man page
10. 如何获得不带所有 ^H^_ 乱码的纯文本 man page?
11. 如何获得高质量的 PostScript man page?
12. 如何使 `apropos' 和 `whatis' 工作?
13. 复制条件
14. 致谢
15. 更新日志