技术开发 频道

Linux 文档编写全攻略

    3 、groff命令详解 

    groff命令以符号“.”开始,.TH 是标题每个手册页面只使用一次,它设置页面的标题、段号以及日期。NAME段的格式非常重要,。在.SH NAME的后面是命令的名称。“\-”也很重要,因为makewhatis,apropos以及man-k在搜索手册页面时依赖这种格式。 

    段以 .SH 开始,后跟标题。如果标题包含空格并且和 .SH 在同一行,则需在标题上加双引号。.TP指令创建一个带有起始标志的新段落。 其他的命令指定字体类型和大小,见表2。 
    表2: groff的字体命令

    gruff的其他命令重要涉及段落结构和缩行见表3。 

    表3: groff的段落和缩行命令

    如果要在groff源文件中加入注释,使用.\”开始注释行,像在上面清单的前两行一样。一旦写完手册页面,就可以创建应该预先处理好的版本,然后在/usr/share/man/manN 目录下的合适段中安装它。N的值是1-9。表4是UNIX手册页面的“标准”划分。 
    表4: 标准Linux手册页面

    通常把经过gzip命令压缩好的手册页面方到合适的/usr/share/man 的子目录下。

    4 、使用groff命令把man文件转换为HTML文档 

    从互联网流行起来后,HTML标记格式开始流行,这种标记格式有一定的结构,也便于“展示”,还可通过网络浏览器浏览,对图象和超级链接也有支持。HTML标记语言非常灵活,适用于各种文档。实际上它太灵活了,甚至可以展示Man手册页格式的信息。这种格式也可以很好的被打印出来,相关的制作工具很多。它另外可以通过网络在不同的操作系统中浏览。

$groff -Thtml -mandoc caocao.1 > caocao.html


    HTML格式的文档在浏览器中呈现的结果见图2:

图2: 以HTML格式呈现的文档



    更加详细groff命令使用方法使用命令: groff –help 察看。 

    文档一个好的产品或软件都是伴随着各种文档产生的,文档的好处不用多说,如要作好一个软件开发人员熟悉基本的软件文档内容写法是最好的。下面笔者将介绍更加专业的文档制作工具。

1
相关文章