groff命令 – 编写手册页面

groff 是一套用GNU 实现troff 的程序。它还包括一个脚本,用来模仿nroff 和其他roff 家族。

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

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

语法格式:groff [参数]

常用参数:

.B黑体
.I下划线(或斜体)
.RI普通体和下划线(或斜体)交替
.SM小号字(用于缩写)
.HP开始悬挂式缩进

参考实例

把man文件转换为HTML文档:

[root@linuxcool ~]# groff -Thtml -mandoc test.1 > test.html

把标准的文本和特殊的命令翻译成格式化的输出:

[root@linuxcool ~]# groff -test1 -man test2.1

将 lorem-ipsum.me 文件保存到您的系统并通过 groff 运行:

[root@linuxcool ~]# groff -Tps -me lorem-ipsum.me > lorem-ipsum.me.ps