man 手册规范 & troff文件使用

在Linux下有许多命令，他们都有自己的帮助文档，有一天我们自己的的程序也需要帮助类似的帮助文档的时候应该如何来编写呢 ？ 相对这方面的资料较少，这里总结下。

• man 的帮助文件位置：

存放目录：

首先是目录以及存放规范,linux文档经常放在：MANPATH环境变量指定的目录中。一般在：/usr/share/man 这个目录里面。这个目录下面结构还有定义的：

remon@debian:/usr/share/man$ ls -l
total 212
drwxr-xr-x 5 root root  4096 Feb 15 15:50 cs
drwxr-xr-x 6 root root  4096 Jul 26 22:25 de
drwxr-xr-x 5 root root  4096 Jul 26 22:01 es
drwxr-xr-x 4 root root  4096 Jul 26 22:01 fi
drwxr-xr-x 7 root root  4096 Jul 26 22:25 fr
drwxr-xr-x 3 root root  4096 Jul 26 22:01 gl
drwxr-xr-x 5 root root  4096 Jul 26 22:01 hu
drwxr-xr-x 5 root root  4096 Jul 26 22:01 id
drwxr-xr-x 5 root root  4096 Feb 15 15:50 it
drwxr-xr-x 5 root root  4096 Feb 15 15:50 ja
drwxr-xr-x 5 root root  4096 Feb 15 15:50 ko
drwxr-xr-x 2 root root 57344 Jul 26 22:34 man1
drwxr-xr-x 2 root root  4096 Jul 26 22:01 man2
drwxr-xr-x 2 root root 20480 Jul 26 22:29 man3
drwxr-xr-x 2 root root  4096 Jul 26 22:29 man4
drwxr-xr-x 2 root root 12288 Jul 27 03:01 man5
drwxr-xr-x 2 root root  4096 Jul 26 22:27 man6
drwxr-xr-x 2 root root 12288 Jul 26 22:29 man7
drwxr-xr-x 2 root root 20480 Jul 27 03:01 man8
drwxr-xr-x 5 root root  4096 Feb 15 15:50 pl
drwxr-xr-x 5 root root  4096 Jul 26 22:01 pt
drwxr-xr-x 5 root root  4096 Jul 26 22:01 pt_BR
drwxr-xr-x 5 root root  4096 Feb 15 15:50 ru
drwxr-xr-x 5 root root  4096 Feb 15 15:50 sv
drwxr-xr-x 5 root root  4096 Feb 15 15:50 tr
drwxr-xr-x 5 root root  4096 Feb 15 15:50 zh_CN
drwxr-xr-x 5 root root  4096 Feb 15 15:50 zh_TW

man[*]这类目录表示意思。linux帮助文档，一个特别的有意思的是，按照文档表示不同类型，分领域的（也就是分类别），过会我们会说这个类别按照什么分了。还有就是类似：zh_CN pl.ISO8859-2这些。文档还分语言.地域.字符编码 。可以支持统一命令，多个语言版本的文档，并且地域可以不一样，还可以指定字符集。如：zh_TW.big5 这个意思就是：中文_台湾地区.使用big5字符集编码的文档。

文档领域区分方法（就是类别）

我们看下下面的表格：

领域	描述	说明
1	用户命令	可由任何人启动的,如env、cat、man、touch文档
2	系统调用或内核函数	即由内核提供的函数 如link、sethostname、mkdir
3	库程序	即库函数 如acosh、asctime、btree、locale
4	与设备有关的信息	即/dev目录下的特殊文件 如zero null sda
5	文件格式描述	如/etc/passwd 文件格式描述说明在这个分类下
6	游戏	游戏的帮助文件
7	其他	包括 宏命