Chinaunix首页 | 论坛 | 博客
  • 博客访问: 408717
  • 博文数量: 76
  • 博客积分: 3016
  • 博客等级: 中校
  • 技术积分: 782
  • 用 户 组: 普通用户
  • 注册时间: 2007-04-27 12:05
文章分类

全部博文(76)

文章存档

2017年(1)

2015年(1)

2009年(2)

2008年(28)

2007年(44)

我的朋友

分类: LINUX

2008-03-03 15:31:40

以下内容主要来自 groff_man(7), 同时参考了 man(7)。

.TH title section [date] [source] [manual]

每个 man 手册页,必须要有一个 .TH 开始。
title 是指手册页的标题名称,如 ls、mount 等。
section 是指 man 手册页中 1~8 的分类,具体的怎么分类的请用 man man 来看。此参数还能再跟一个字符串,如写成 1.1,表示 section 1.1, 即第一部分中的第一小部分。
source 会显示在页脚的左方(一般正常的 manpage 是左边,如果要用双面打印的话,它在奇数页中显示在右边)。
当以 HTML 格式输出时,页眉和页脚会完全被忽略掉的。这一点请注意。
此宏命令将会新建一个手册页面,新行号重置为1(除非以 -rc1 选项从命令行再指定一个),此特性只是为了格式化多个 manpages;单独一个 manpages 应该仅在文件开头用一次 TH 宏。

最后的输出样子:
title(setcion)			manual				title(section)

... body ....


source date



.SH [text for a heading]

靠左新建一个未编号的 section(标题)。 SH 后跟的文本将会显示成粗体,且比正文字体大一号。另外,后续内容的左边界将恢复为默认值。如果 SH 后面不带参数的话,那就用 SH 宏后面的第一行输入作为 SH 的参数来用。

.SS [text for a heading]

建一个二级未编号的 section(标题)。SS 后跟的文本将会显示成粗体,且与正文字体一样大。另外,后续内容的左边界将恢复为默认值。如果 SS 后面不带参数的话,那就用 SS 宏后面的第一行输入作为 SS 的参数来用。

.TP [nnn]

新建一个带有 label(无缩进)的缩进段落。如果定义了参数 nnn,就将缩进设置为 nnn(默认缩进所用的单位为 n)。如果未定义参数,则使用默认缩进值。此宏后跟的第一行输入文本被设为是 label,同时 label 是不带缩进量的。标签不是段落的一部分。如果标签长度比缩进量小,那段落将附在标签后面,缩进量 = 缩进值 - 标签长度。如果标签长度大于缩进量,则段落就在下一行开始,且缩进量 = 设定的缩进值,字体大小为正常大小。

输出实例:

.TP 2n
test                 输出为           test
this is a test                         this is a test

.TP 5n
test              输出为          test this is a test
this is a test   

注意以上两种输出形式中的空格。


.LP(.PP 或 .P)

这三个宏是等同的。它们将在当前位置引起一个断行(line break),后带一个垂直段间距,此段间距由 PD 宏指定。使用 PP 宏后,字形和字体大小都会还原成默认值(10pt, Roman),同时还将还原左边距。

.IP [designator] [nnn]

新建一个带缩进的段落,用 designator 作为行首标记。nnn 代表了缩进量,单位为 n。如果不定义缩进的话,就用默认缩进。如果只想为一个段落指定缩进,但不要 designator,可以在 designator 参数的位置用双引号(" ")一对作为参数。

输出实例:

.IP \(bu 4              输出为        ○   This is a test
this is a test       

这里的那个圆圈实际上应该是个实心的菱形,我的电脑上打不出来那个图形。designator 就类似于 word 中的项目符号列表。

.HP [nnn]

建一个带有左侧缩进的段落,但首行是不缩进的。

.RS [nnn]

将左边界向右移动 nnn 个单位。

.RE [nnn]

将左边界移回 nnn 个单位。如果不带参数,那就移回一层。第一级缩进编号为1。所谓的第一级是指未调用过 RS 宏时的缩进。还有每次调用 RS 宏而又不带参数的话,就会增长缩进1级。

此 RS/RE 宏使用时必须配合在一起用,即一个 RS 对应一个 RE。而且,这两个宏可以嵌套使用的。如

RS
RS
RS
.....
RE
RE
RE

总结

以下宏引起一个断行,并带上一个段间距(由 PD 宏控制):

SH、SS、TP、LP(PP、P)、IP和HP。

RS和RE宏也会引起断行(Line Break),但不插入段间距。

最后还要记住,SH、SS、LP(PP、P),还有RS,它们会重置缩进量为默认值。


阅读(1537) | 评论(0) | 转发(1) |
给主人留下些什么吧!~~