Linux man 帮助文件

 

    在 Linux 系统中，如果对某个命令不熟悉，可以使用 man 查看该命令的使用方法。例如在命令行输入：man sudo，回车后将显示 sudo 的使用方法。

    如果系统中没有安装 man 帮助文档，可以使用这个命令安装：sudo apt-get install manpages-dev

    然后你可以在 /usr/share/man/manX/ 目录下找到相应的帮助文件（其中的X为代表 man 类型的数字）。

$ tree /usr/share/man

/usr/share/man

...

|-- man1

|-- man2

|-- man3

|-- man4

|-- man5

|-- man6

|-- man7

|-- man8

|   |-- sudo.8.gz

|   ...

|   `-- zic.8.gz

...

`-- zh_CN

    |-- man1

    |-- man5

    `-- man8

 

可以看到 sudo 对应了到一个 /usr/share/man/man8/sudo.8.gz 文件。

 

    我们也可以自己实现一个帮助文件：

1. 新建一个名为“你的函数名.类别”的文件，比如“hello.3"
2. 然后在文件中边写入帮助内容（可以参考现有的MAN文件的格式和语法）
3. 使用 gzip 将文件压缩，如“hello.3.gz"
4. 切换 root 账户，将文件拷贝至 /usr/share/man/manX/
5. 测试，完工。

例：
$echo this is hello. > hello.3

$gzip hello.3

$su

...

#cp hello.3.gz /usr/share/man/man3
#man hello

 

附：

Linux下最通用的领域及其名称及说明如下： 
领域   名称及说明 
1       用户命令， 可由任何人启动的。 
2       系统调用， 即由内核提供的函数。 
3       例程， 即库函数。 
4       设备， 即/dev目录下的特殊文件。 
5       文件格式描述， 例如/etc/passwd。 
6       游戏， 不用解释啦！ 
7       杂项， 例如宏命令包、惯例等。 
8       系统管理员工具， 只能由root启动。 
9       其他（Linux特定的）， 用来存放内核例行程序的文档。 
n       新文档， 可能要移到更适合的领域。 
o       老文档， 可能会在一段期限内保留。 
l        本地文档， 与本特定系统有关的。