自写linux下的简单man帮助文件
刘伟_luvi
·
2008-11-20
·
via 博客园 - 刘伟_luvi
我 们 一 直 在 努 力 ! |
写一个函数的帮助文件,如果只是为了自己方便(不要求严格的格式,自己能看懂就行,别拿出来让别人难以理解)的话,是相当简单的,看一下MAN文件就大致了解了。 在/usr/share/man/manX/
其中‘X’代表的是数字,也就是MAN的类别。
***************************************
Linux下最通用的领域及其名称及说明如下: 领域 名称 说明 1 用户命令, 可由任何人启动的。 2 系统调用, 即由内核提供的函数。 3 例程, 即库函数。 4 设备, 即/dev目录下的特殊文件。 5 文件格式描述, 例如/etc/passwd。 6 游戏, 不用解释啦! 7 杂项, 例如宏命令包、惯例等。 8 系统管理员工具, 只能由root启动。 9 其他(Linux特定的), 用来存放内核例行程序的文档。 n 新文档, 可能要移到更适合的领域。 o 老文档, 可能会在一段期限内保留。 l 本地文档, 与本特定系统有关的。 ***************************************** 一般普通的函数是在man3目录下。 你建一个文件,文件名为“你的函数名.类别”,比如叫“hello.3",然后在里边写内容,最好是看看别的MAN文件的格式和语法。
例: #echo abcd1234>/usr/share/man/man3/hello.3 #man hello
打包可以执行如下命令: #gzip /usr/ share/man/man3/hello.3 #man hello
|
此内容由惯性聚合(RSS阅读器)自动聚合整理,仅供阅读参考。 原文来自 — 版权归原作者所有。