MDOC.SAMPLES

Section: Environments, Tables, and Troff Macros (7)
Index Return to Main Contents

BSD mandoc
 

NAME (名字)

mdoc.samples - 用 -mdoc 编写 BSD 手册 的 示范教程  

SYNOPSIS (总览)

man mdoc.samples  

DESCRIPTION (描述)

这个 示范教程 用于 编写 BSD 手册页 (manual page), 它 使用了 -mdoc 宏定义包, 这是个 基于内容基于宏域 (domain -base) 的 格式化包, 交由 troff(1) 处理. 它的 前身 -man7 包, 定义了 页面布局 (page layout), 但是 把 诸如 字体控制 和 其他 排版 细节 留给了 每一个 作者. 在 -mdoc 包里, 页面布局宏 构成了 页结构宏域 (page structure domain) 它 由 标题, 小节首部, 显示 (displays) 和 列表 宏 组成. 这些 基本项目 影响 正文 在 格式化页上 的 物理位置. 作为 页结构宏域 的 补充, 这里 还 定义了 另外 两个 宏域, 手册宏域 和 基本正文宏域. 基本正文宏域 定义了 一些 宏, 执行 例如 引文 或 文字强调 之类的任务. 手册宏域 定义的宏 是 非正式 日常用语 的 子集, 用于 描述 命令, 例程 和 相关的 BSD 文件. 手册宏域里 的 宏 用来处理 命令名, 命令行参数和选项, 函数名称, 函数参数, 路径, 变量, 以及 到 其他手册页 的 参照 等. 这些 域项 留有 为 作者 和 手册页的 未来用户 设置的 值. 希望 从 手册集中 获得的 一致性 能够为 将来的 文档工具 提供 更简单的 转换.

从 整个的 UNIX 手册页 上 来看, 每个 手册项 可以 简单的 理解为 一个 man page, 不用 注意 它的 实际长度, 也没有 性别歧视 意图. (译注: 可能是双关语, man page...男人页)  

开始 GETTING STARTED

因为 人们 通常是 为了 能够 马上 使用 这些材料 的 时候 才 阅读 教程,所以 我们 假设 此文档的 用户 是 缺乏耐心的.下面 简述一下 这份文档 剩余部分 的 组织:

  1. TROFF 特性

    "使用宏"
    "参数中传递空白符"
    "尾部的空白符"
    "转义特殊字符"

  2. 手册页的结构分析

    "手册页的模板"

  3. 标题宏
  4. 手册宏域和基本正文宏域的介绍

    "名称背后 ..."
    "基本语法"

  5. 手册宏域

    "地址"
    "作者名字"
    "参数"
    "配置声明 (仅用于手册第四部分)"
    "命令修饰"
    "已定义的变量"
    "Errno's (仅用于手册第二部分)"
    "环境变量"
    "函数参数"
    "函数声明"
    "标志 (Flags)"
    "函数 (库例程)"
    "函数类型"
    "交互命令"
    "名称"
    "选项"
    "路径"
    "变量"
    "参照"

  6. 基本正文宏域

    "AT&T 宏"
    "BSD 宏"
    "FreeBSD 宏"
    "UNIX 宏"
    "嵌入/引用宏 (Enclosure/Quoting)"

    "尖括弧引用/嵌入"
    "方括弧引用/嵌入"
    "双引号引用/嵌入宏"
    "圆括弧引用/嵌入"
    "单引号引用/嵌入"
    "前缀宏"

    "No-[或正文宏]
    "消除空白宏"
    "手册节对照"
    "参考和引用"
    "返回值 (仅用于手册页第二和第三部分)"
    "Trade Names (缩略和类型名称)"
    "参数扩展"

  7. 页结构宏域

    "小节首部"
    "段落和空行"
    "保持 (Keeps)"
    "显示"
    "字体模式 (加重, 原文和 Symbolic)"
    "列表和栏"

  8. 预定义串
  9. 诊断
  10. 用 GROFF, TROFF 和 NROFF 格式化
  11. 臭虫 BUGS

 

TROFF 特性

使用 -mdoc 宏包 的 目的 是 简化 写手册页 的 过程. 理论上讲, 要使用 -mdoc 不一定 要 学习 troff(1) 的 隐藏细节; 然而, 有些 限制 无法回避, 最好 把它们 摆平. 而且 你 应该 知道, 这个 宏包 的 速度 比较 慢.  

宏的用法 Macro Usage

troff(1) 里, 宏调用的形式 是 在行首 以 `.' (句点符) 起始, 紧随其后 是 作为 宏名 的 两个字符. 参数 跟在 宏名 之后, 用 空格符 隔开. 这个 位于行首的 句点符 使 troff(1) 把 紧随其后 的 两个字符 视作 宏名. 在 某些情况下 要把 `.' (句点符) 放在 行首, 但不希望 被理解成 宏请求, 方法是 在 `.' (句点) 前 使用 `\&' 转义序列. `\&' 被 解释成 一段 长度为零 的 空白, 所以 不会 在 输出端 显示 出来.

一般说来, troff(1) 宏 最多 接受 九个参数, 忽略掉 其余的. 大多数 在 -mdoc 里的 宏 支持 九个参数, 某些场合 可以 续加 参数, 或扩展到 下一行. (见 Sx 扩展 Extensions ) . 有些宏 能够 处理 引号 引起来的 参数 (见 下面的 Sx 在参数中传递空格符 ) .

大多数 -mdoc 的 基本正文宏域 和 手册宏域 的宏 拥有 一种特性, 表现在 把 参数列表 当成 可调用的宏 分析 (解释) 这意味着 如果 参数列表里的参数 是 普通正文宏域 或 手册宏域 里的 宏, 并且 是 可调用宏, 那么 处理的时候 会 执行 或 调用. 这种情况下的 参数, 即 宏名, 不需要 用 `.' (句点符) 引导. 这种风格 使 很多 宏 嵌套 在 一起; 例如 这个 选项宏 `.[,] ' 可能 调用 标志和参数宏, `- ' 和 `file ... ' 用来 说明 一个 带参数的 选项:

[-s bytes ]
来自 .[-s bytes ]

为了 防止 把 两个字符的字符串 解释成 宏名, 在这个 字符串 前面 加上 `\&'

转义序列:

[-s bytes ]
来自 .[\&-s \&bytes ]

这里的 字符串 `- ' 和 `file ... ' 没有 被解释成 宏. 在 这篇文档 和 相应的 快速参考手册 mdoc(7) 中, 参数列表 按 可调用参数 分析 的 宏 称为 已分析, 可以 从 参数列表 调用 的 宏 称为 可调用. 这里 用的 术语 '分析' 可能是个 技术失误, 几乎 所有的 -mdoc 宏 都 被分析, 既 用它 指 可调用宏, 又 指 有 调用 其他宏的 能力, 显得 很笨拙.  

在参数中传递空格符 Passing Space Characters in an Argument

某些时候 我们 希望 能够 把 含有 一个或多个 空格符 的 字符串 作为 单个参数 传递. 如果 要 突破 九个参数的限制, 或者 传递给 宏 的 参数 需要 一些 特定布置, 这个 能力 是必须的. 例如, 函数宏 `.Fn 的 ' 第一个参数 是 函数名称, 剩下的参数 作为 函数的参数. ANSI C 规定 函数的参数 在 圆括弧内 声明, 每个 参数 至少 由 两个 标示符 组成. 例如, Fa int foo .

有 两个方法 传递 嵌有空格符 的 参数. 补充一点 不幸的是, 在 AT&T troff 中, 那个 最容易的方法, 就是 作为 单个 参数 传递 两个引号之间的 字符串和空格符, 非常 消耗 时间 和 内存空间. 虽然 它 对 groff 并不费事, 但是 为了 可移植性, 这种 做法 只限于 下列 有迫切需要 的 宏:

配置声明 (手册第四部分
Sx 概要 SYNOPSIS )

列表开始 (指定宽度的)
加重文字
Fn 函数 (手册第二, 四部分)
列表项
原文
Symbolic text
%B
书题
%J
期刊名
%O
参考选注
%R
报告题目(在参考文件中)
%T
在书籍或期刊中的题目

一种 传递 含空格符字符串 的 方法 是 用 `\
 ' 硬编码 或 不可填充空格符, 也就是 在 空格符 前 加上 转义符 `\' 这个 方法 适用于 任何宏, 但 有个 副效应, 它 干扰了 对 长行 的 调整. Troff 把 这种 硬编码的 空格符 看作 可显示字符, 因此 无法 在需要的时候 把 字符串 分段 或 换行. 这种 方法 适用于 字符串 不会 到达 行边界 时, 例如:

Fn fetch char *str
来自 `.Fn fetch ' char\ *str
Fn fetch char *str
也可以来自 `.Fn fetch ' \*qchar *str\*q

如果 忽略 `\' 或 引号, `.Fn 宏 ' 会认为 有 三个参数, 结果 成为:

Fn fetch char *str

如果 想知道 参数列表 到达 行边界 时 出现什么, 参看 Sx BUGS 小节.

 

尾部的空白符 Trailing Blank Space Characters

Troff 可能 被 行尾的 空白符 搞乱, 它的防范规则 是 消除 所有 位于行末 的 空白符. 如果 坚持 在 行末 加上 空白符, 可以 用 硬空格符 和 `\&' 转义字符. 例如, `string\\& .'  

转义特殊字符 Escaping Special Characters

特殊字符, 如 换行符 `\n' , 是 通过 用 `\e' 替换 `\' (e.g.例如 `\en' ) 保留住 反斜杠.  

手册页结构分析 THE ANATOMY OF A MAN PAGE

手册页 可以 很容易的 通过 模板 构建, 模板 放在 /usr/share/misc/mdoc.template . 另外 在 /usr/share/examples/mdoc 目录下 有一些 手册页 的 例子.

 

手册页的模板 A manual page template

.\" 所有的手册页都要求有下面的内容
.Dd 月 日, 年Month day, year
.Os 操作系统 [版本/发行号] 
.Dt 文档标题 [手册节号][卷] 
.Sh 名称 NAME
.Nm 名称 name
.Nd 对名称的简单描述 one line description of name
.Sh 总览 SYNOPSIS
.Sh 描述 DESCRIPTION
.\" 后面的内容取消注释后可以用在你需要的任何地方.
.\" 紧接着的这条命令用于手册第二和第三部分, 函数的返回值.
.\" .Sh 返回值 RETURN VALUES
.\" 下面的命令用于手册第1, 6, 7, 8部分.
.\" .Sh 环境 ENVIRONMENT
.\" .Sh 文件 FILES
.\" .Sh 示例 EXAMPLES
.\" 下面的命令用于手册第1, 6, 7, 8部分
.\"     (在shell下的命令返回值和标准错误类型的诊断)
.\" .Sh 诊断 DIAGNOSTICS
.\" 下面的命令用于手册第二和第三部分中的错误和信号处理.
.\" .Sh 错误 ERRORS
.\" .Sh 另见 SEE ALSO
.\" .Sh 遵循 CONFORMING TO
.\" .Sh 历史 HISTORY
.\" .Sh 作者 AUTHORS
.\" .Sh BUGS

模板中 的 第一个部分 是 (., ., . ) 宏; 文档日期, 手册或其内容 针对的 操作系统, 手册页的标题 ((大写) ) 和 该手册页 所属的节 (部分号). 这些宏 确认和标识了 这个手册页. 在 后面的 Sx 标题宏 TITLE MACROS 将 继续 讨论.

这个 模板中 的 其余部分 是 小节首部 (section header) (. 

;

) 其中 Sx 名称 NAME , Sx 总览 SYNOPSIS 和 Sx 描述 DESCRIPTION 是 必不可少的. 这些 首部 在 Sx 页结构宏域 中 讨论 ( 介绍完 Sx 手册域 之后 ) . 有一些 内容宏 被用来 示范 页面布局宏; 建议 接触 页面布局宏 前 先看看 内容宏.  

标题宏 TITLE MACROS

标题宏 是 页结构宏域 的 第一部分, 但 在 过去, 人们 如果 编写 手册页, 它 是 手册的 第一部分, 也是 独立部分. 这里 设计了 三个宏 分别 描述 文档标题 或 手册标题, 操作系统, 和 制作日期. 它们 放在 文档的 最前面, 一次 只 调用 一个, 用来 构建 文档的 页头 和 页脚.

.
文档标题 是 手册页的 主题, 由于 troff 的 限制, 必须 大写 手册节号 (部分号) 介于 1, ..., 8, 如果 指明了 手册节号, 可以 忽略 卷标. 卷标 用 下列 标识的 一个 或 任意个:

AMD    UNIX 历史遗留的手册文档 Ancestral Manual Documents
SMM      UNIX 系统管理员手册 System Manager's Manual
URMUNIX 参考手册 Reference Manual
PRMUNIX 程序员手册 Programmer's Manual

缺省的卷标
URM 代表 手册区 1, 6, and 7; SMM 代表 手册区 8; PRM 代表 手册区 2, 3, 4, and 5.

.操作系统 发行号#
操作系统 的 名字 可能 是 缩写, 像 BSDFreeBSDATT 发行号 应该 是 系统 专用的 标准发行术语, 像 4.3, 4.3+Tahoe, V.3, V.4. 识别不出的 参数 就 照原样 显示在 页脚. 例如, 典型的页脚 可能是:

.BSD 4.3

.FreeBSD 2.2

或者 象 订制的产品

.CS Department

作为 伯克利的缺省设置, 不带 参数 的 `.定义为 ' BSD (指定在文件 /usr/share/tmac/mdoc/doc-common 中). 你 应该 把缺省值 设成 本机. 注意, 如果 不设置 `.宏, ' 页面的左下角 会 很难看.

.月 日, 年 (month day, year)
日期 应当 写的 正规点:

January 25, 1989

 

手册宏域 和 基本正文宏域的介绍

 

名称背后 What's in a name...

手册宏域 的 宏名 来自 非正式的 日常用语, 用来 描述 命令, 子程序 及其 相关文件. 在 写 手册页 时, 文字用语 有些 轻微的变化, 分别描述 三个 不同 应用面. 首先是 -mdoc 宏请求 的 用法. 其次, 用 -mdoc 宏 描述 UNIX 命令. 最后, 对 用户 具体的描述 这条命令; 也就是 在 手册页 正文 里 讨论这条命令.

第一种 情况 下, troff(1) 宏 本身 就是 一种 命令; troff 命令 的 基本语法 是:

.Va argument1 argument2 ... argument9

这里的 `. ' 宏命令 或 宏请求, 紧随其后 的 是 待处理的参数. 第二种 情况 下, 使用 内容宏 描述 一条 UNIX 命令 要 复杂 些; 一个 典型的 Sx 总览 SYNOPSIS 命令行 显示 如下:

filter [-flag ] infile outfile

这里的 filter 是 命令名称, 方括弧内 的 -flag 是一个 标志 参数, 作为 可选参数 放在 代表 选项 的 方括弧内. 在 -mdoc 术语 中, infileoutfile 称为 参数 产生 上述效果 的 宏 是 这样的:

.Nm filter
.Op Fl flag
.Ar infile outfile

第三种 情况 讨论 命令 及其语法, 包括 它们的例子, 可能 还有 更多细节. 上面的例子里, 可以把 infileoutfile 理解为 操作参数 operands文件参数 file arguments 有些 命令行参数 罗列的 十分 长:

make
[-eiknqrstv ] [-D variable ] [-d flags ] [-f makefile ] -words [-I directory ] [-j max_jobs ] [variable=value ] -words [target ... ]

这里 你 可能 讨论 make 命令 和 它的参数 makefile 作为 一个 标志的参数, -f 或者 讨论 一个 可选的文件操作对象 target 在 具体的上下文 中, 这种细节 能够 防止 混淆. 然而 -mdoc 宏包中 没有为 标志的参数 准备 宏. 作为 替代 是 `file ... ' 参数宏, 用于 描述 操作对象 或 文件参数 如 target 以及 标志的参数 如 variable 上面的 make 命令行 是 这样 产生的:

.Nm make
.Op Fl eiknqrstv
.Op Fl D Ar variable
.Op Fl d Ar flags
.Op Fl f Ar makefile
.Op Fl I Ar directory
.Op Fl j Ar max_jobs
.Op Ar variable=value
.Bk -words
.Op Ar target ...
.Ek

在 Sx Keeps 小节中 将会 解释 `.和 ' `.宏. '  

基本语法 General Syntax

手册宏域 和 基本正文宏域 的 宏 有着 相似的语法, 仅有 微小差别: `.file ... ' `.- ' `.man mdoc.samples ' 和 `.仅当 ' 无参数调用时 才有 区别; `.Fn 和 ' `.的 ' 参数列表 要求 一定的 顺序; `.[和] ' `.Fn 宏有嵌套限制. ' 所有的 内容宏 能够 识别和正确处理 标点符号, 每个 标点符号 要在 前面 用 空格 隔开. 如果 给出 这样的 宏请求:

.sptr, ptr),

结果是:

sptr, ptr),

标点符号 没有 被识别 出来, 全都按 原文字体 输出. 如果 标点符号 前面用 空格符 隔开:

.sptr , ptr ) ,

结果是:

sptr , ptr

标点符号 被 识别出来 了, 缺省的字体 也 有别于 原文文字的字体.

用 `\&' 转义符 可以 去掉 标点字符 的 特殊意义. Troff 作为 宏语言 有一定 的 限制, 当 表达的字串 中 含有 数学, 逻辑 或 引用 符号时 将 难于 处理:

{+,-,/,*,%,<,>,<=,>=,=,==,&,`,',"}

问题是 troff 会 认为 它 应该 执行或运算 这些 符号 代表的操作. 要 防止 这一点 可以 用 `\&' 转义 这些 字符. 典型语法 在 下面 显示的 第一个 内容宏 中 可以见到, `. '  

手册域 MANUAL DOMAIN

 

地址宏 Address Macro

地址宏 用 这种 格式 标明地址: addr1[,addr2[,addr3]].

Usage: .address ...

.addr1
addr1
.addr1
addr1
.addr1 , file2
addr1 , file2
.f1 , f2 , f3:
f1 , f2 , f3
.addr ) ),
addr ) )

不带参数 调用 `.是个 ' 错误. `.可以被 ' (其他宏) 调用和分析.  

作者名称 Author Name

The `.An 宏用以 ' 说明 这个文档的 描述对象的 作者, 或者 这篇手册页的 作者. 名字 信息 后面的 其他参数 被认为是 标点符号.

Usage: .An author_name ...

.An Joe Author
An Joe Author
.An Joe Author,
An Joe Author ,
.An Joe Author Aq [email protected]
An Joe Author Aq [email protected]
.An Joe Author ) ),
An Joe Author ) ) ,

`.An 宏可以被 ' (其他宏) 分析和调用, 不带参数调用 `.An 是个错误. '  

参数宏 Argument Macro

当 引用 命令行参数时 可以使用 `.file ... ' 参数宏.

Usage: .argument ...

.file ...
file ...
.file1
file1
.file1
file1
.file1 file2
file1 file2
.f1 f2 f3:
f1 f2 f3
.file ) ),
file ) )

如果不带参数调用 `.file ... ' 宏, 缺省为 `file ... ' `.file ... ' 宏可以被 (其他宏) 分析和调用.  

配置定义 (手册第四部分) Configuration Declaration

`.宏用于描述 ' config(8) 对 设备接口的定义 (手册第四部分). 这个宏 接受 引号内的参数 (只能是双引号).

device le0 at scode?
来自: `.device ' le0 at scode? .

 

命令修饰 Command Modifier

命令修饰宏和 `.- ' (标志) 命令相似, 除了 `. ' 不在 任何参数 前 加 短横线 (dash). 传统的标志 以 短横线 开头, 但 一些 命令 或 命令的子集 不用这个. 命令修饰宏 也可以 和 交互命令 结合 使用, 如 编辑命令. 另见 Sx Flags .  

已定义的变量 Defined Variables

在 头文件 中 已经 定义了的变量 用 `.宏说明. '

Usage: .defined_variable ...

.MAXHOSTNAMELEN
MAXHOSTNAMELEN
.TIOCGPGRP )
TIOCGPGRP

不带参数调用 `.是个错误. ' `.宏可以被 ' (其他宏) 分析和调用.  

Errno's (仅供手册第二部分)

这个 `.Er errno ' 宏 指明 手册 第二部分, 库函数 的 错误返回值.(译注: 应该是系统调用) 下面的 第二个 例子 显示了 `.Er 配合 ' `.Bq 基本正文宏 ' 的 使用, 就象 用在 手册 第二部分 一样.

Usage: .Er ERRNOTYPE ...

.Er ENOENT
Er ENOENT
.Er ENOENT );
Er ENOENT ) ;
.Bq Er ENOTDIR
Bq Er ENOTDIR

不带参数调用 `.Er 宏是个错误. ' `.Er 宏可以被 ' (其他宏) 分析和调用.  

环境变量 Environment Variables

`.宏说明一个环境变量. '

Usage: .argument ...

.DISPLAY
DISPLAY
.PATH
PATH
.PRINTER ) ),
PRINTER ) )

不带参数调用 `.宏是个错误. ' `.宏可以被 ' (其他宏) 分析和调用.  

函数参数 Function Argument

`.Fa 宏 ' 用来 说明 在手册的 Sx 总览 SYNOPSIS 小节 之外的 函数参数, 或者在 Sx 总览 SYNOPSIS 小节内, 其 参数列表对 `.Fn 宏 ' 而言 过长, 并且 必须 使用 `.Fo 和 ' `.Fc 宏时. ' `.Fa 也 ' 有可能 用来 说明 结构成员.

Usage: .Fa function_argument ...

.Fa d_namlen ) ),
Fa d_namlen ) ) ,
.Fa iov_len
Fa iov_len

不带参数调用 `.Fa 宏是个错误. ' `.Fa 宏可以被 ' (其他) 宏分析和调用.  

函数声明 Function Declaration

`.Fd 宏 ' 用于 第二或 第三部分 手册页 的 Sx 总览 SYNOPSIS 小节. `.Fd 宏 ' 既 不调用 其他宏, 也 不能 被 其他宏调用.

Usage: .Fd include_file (or defined variable)

在 Sx 总览 SYNOPSIS 小节, 如果 已经 说明了 某个 函数, 并且 没有 出现 省略号, 则 `.Fd 宏请求 ' 能够 产生 一个 断行. 在 函数 和 函数声明 之间, 垂直方向上 产生 一定的 空白.  

标志 Flags

`.- ' 宏 处理 命令行标志. 它 在 标志前 加一个 短横线 `-' , 对于 交互命令 标志, 它 不需要 短横线, 可以用 `.(命令修饰 ' command modifier) 宏替换, 它 没有 短横线.

Usage: .-argument ...

.-
-
.-cfv
-cfv
.-cfv
-cfv
.-s v t
-s v t
.--,
--
.-xyz ),
-xyz )

如果 `.- ' 宏 不带 任何 参数, 将 只产生 一个 短横线, 代表 stdin/stdout. 注意 如果 把 一个 短横线 做为 `.- ' 的参数, 结果 会 得到 两个短横线. `.- ' 宏可以被 (其他宏) 分析和调用.  

函数(库函数) Functions (library routines)

宏 .Fn 是 ANSI C 函数风格 的 模型.
Usage: .Fn [type] function [[type] parameters ... 

.Fn getchar
Fn getchar
.Fn strlen ) ,
Fn strlen ) ,
.Fn \*qint align\*q \*qconst * char *sptrs\*q
Fn int align const * char *sptrs ,

不带参数调用 `.Fn 是一个错误. ' `.Fn 宏可以被 ' (其他宏) 分析和调用, 注意 任何 对 其他宏 的 调用 应该在 `.Fn 宏调用 ' 的 结尾处 给出 标记 (反括弧).

对于 八个 参数 以上的 函数 (尽管少见), 可以 用 宏 `.Fo (function ' open) 和 `.Fc (function ' close) 配合 `.Fa (function ' argument) 宏 的 使用, 突破 参数 过多 的 限制, 例如:

.Fo "int res_mkquery"
.Fa "int op"
.Fa "char *dname"
.Fa "int class"
.Fa "int type"
.Fa "char *data"
.Fa "int datalen"
.Fa "struct rrec *newrr"
.Fa "char *buf"
.Fa "int buflen"
.Fc

产生:

Fo int res_mkquery Fa int op Fa char *dname Fa int class Fa int type Fa char *data Fa int datalen Fa struct rrec *newrr Fa char *buf Fa int buflen Fc

宏 `.Fo 和 ' `.Fc 可以被 ' (其他宏) 分析和调用. 在 Sx 总览 SYNOPSIS 小节, 函数 总是 位于 行的开始 处. 如果 在 Sx 总览 SYNOPSIS 小节 有 一个以上的 函数声明, 而且 函数类型 没有 说明, 则 会产生 一个 断行. 在 函数 和 函数 的 垂直方向 上 产生 一定的 空白. 此时 `.Fn 宏 ' 不按 troff 的 行长 检查 单词 边界, 有可能 难看的 从 单词中间 断开. 以后 会 解决 这个 问题.  

函数类型 Function Type

这个宏 设计 用在 Sx 总览 SYNOPSIS 小节. 它 可以 毫无困难的 用在 手册页的 其他 地方, 但 它的 主要 目的 是 为 第二 和 第三部分 手册页的 Sx 总览 SYNOPSIS 小节, 以 核心标准形式 (kernel normal form) 描述 函数类型 (它 导致 断行, 在 下一行 显示 函数 名称).

Usage: .Ft type ...

.Ft struct stat
Ft struct stat

`.Ft 宏不能被其他宏调用. '  

交互命令 Interactive Commands

宏 `.用于 ' 说明 交互 或 内部命令.

Usage: .argument ...

.:wq
:wq
.do while {...}
do while {...}
.setenv , unsetenv
setenv , unsetenv

不带参数调用 `.是个错误. ' `.宏可以被 ' (其他宏) 分析和调用.  

名称宏 Name Macro

`.man mdoc.samples ' 宏 用于 说明 文档题目 或 主题. 它的特点 是 能够 记住 调用时 带的 第一个 参数, 这个 参数 就是 该页的 主题. 当 不带 参数 调用它 时, `.man mdoc.samples ' 宏 把 以前 记住的 参数 显示 出来, 可以 为作者 省点劲. 注意: 手册第二部分或第三部分的函数名称, 在 Sx 名称 NAME 小节 用 `.man mdoc.samples ' 说明, 在 Sx 总览 SYNOPSIS 和 其余 小节 用 `.Fn 说明. ' 对于 交互命令, 例如 在 csh(1) 中的 `while' 命令, 应该 使用 `.宏. ' `.宏和 ' `.man mdoc.samples ' 宏 非常接近, 只是 它 不能够 记忆 调用时的 参数.

Usage: .argument ...

.mdoc.sample
mdoc.sample
.\-mdoc
-mdoc
.foo ) ),
foo ) )
.man mdoc.samples
man mdoc.samples

`.man mdoc.samples ' 宏可以被 (其他宏) 分析和调用.  

选项 Options

`.[宏] ' 把 命令行上 剩余的 所有 参数 用 方括弧 括在一起, 把 最后的 标点符号 放到 方括弧 外面. 宏 `.] ' 和 `.[用于 ' 处理 跨行.

Usage: .[options ... ]

.[[
.[-k ]
] ]
[-k ]
.[-k ) . ]
[-k ]
.[-k kookfile ]
[-k kookfile ]
.[-k kookfile , ]
[-k kookfile ]
.[objfil [corfil ] ]
[objfil [corfil ] ]
.[-c objfil [corfil , ] ]
[-c objfil [corfil ] ]
.[word1 word2]
[word1 word2]

应用 `.] ' 和 `.[宏: '

.Oo
.Op Fl k Ar kilobytes
.Op Fl i Ar interval
.Op Fl c Ar count
.Oc

产生: [[-k kilobytes ] [-i interval ] [-c count ] ]

宏 `.[,] ' `.] ' 和 `.[可以被 ' (其他宏) 分析和调用.  

路径名 Pathnames

`.宏 ' 用于 格式化 路径 或 文件名.

Usage: .pathname

./usr/share
/usr/share
./tmp/fooXXXXX )
/tmp/fooXXXXX )

`.宏可以被 ' (其他宏) 分析和调用.  

变量 Variables

基本的 变量 参考:

Usage: .variable ...

.count
count
.settimer
settimer
.int *prt ):
int *prt )
.char s ] ) ),
char s ] ) )

不带参数调用 `.宏是个错误. ' `.宏可以被 ' (其他宏) 分析和调用.  

手册页参照 Manual Page Cross References

`.宏 ' 把 第一个参数 当做 手册页 名称, 第二个参数, 如果 存在, 当做 标点符号 或 手册页 的 部分号 (节号). 剩下 所有的参数 视做 标点符号.

Usage: .man_page[1,...,8]

.mdoc
mdoc
.mdoc
mdoc,
.mdoc(7)
mdoc(7)
.mdoc(7)))
mdoc(7))),

`.宏可以被 ' (其他宏) 分析和调用. 不带参数调用 `.宏是个错误. '  

基本正文宏域 GENERAL TEXT DOMAIN

 

AT&T 宏

Usage: .At [v6 | v7 | 32v | V.1 | V.4] ... 

.At
AT&T System
.AT&T System v6 .
AT&T System v6 .

`.AT&T System ' 宏 不能 被 (其他宏) 分析, 也 不能 被 (其他宏) 调用. 该宏 最多 接受 两个 参数.  

BSD 宏

Usage: .BSD [Version/release] ...

.Bx
BSD
.BSD 4.3 .
BSD 4.3

`.BSD 宏可以被 ' (其他宏) 分析和调用.  

FreeBSD 宏

Usage: .Fx Version.release ... 

.Fx 2.2 .
Fx 2.2 .

`.Fx 宏 ' 不能 被 (其他宏) 分析, 也 不能 被 (其他宏) 调用. 该宏 最多 接受 两个 参数.  

UNIX 宏

Usage: .UNIX

.Ux
UNIX

`.UNIX ' 宏可以被 (其他宏) 分析和调用.  

嵌入和引用宏 Enclosure and Quoting Macros

嵌入 的 概念 和 引用 类似. 把 一句 或 多句 引用对象 嵌到 一对 字符 中, 象 引号 或 括弧. 本篇 文档中 将 混用 术语 `嵌入' 和 `引用.' 大多数 单行的 引用宏名 用 一个 小写字母 `q' 结尾, 表明 这是 一个 引用(quoting), 但 也有 不规则变化. 每个 引用宏 都有 一对 开始(open) 和 结束(close) 宏, 各自 以 `o' 和 `c' 结尾. 在 某些限制时 这些宏 可以 跨行 使用, 单行的引用宏 可以 嵌套在里面.

Quote         Close   Open   Function        Result .Aq    .Ac     .Ao     Angle Bracket Enclosure<string>
.Bq     .Bc     .Bo     Bracket Enclosure       [string]
.Dq     .Dc     .Do     Double Quote    ``string''
        .Ec     .Eo     Enclose String (in XX)  XXstringXX
.Pq     .Pc     .Po     Parenthesis Enclosure   (string)
.Ql                     Quoted Literal  `st' or string
.Qq     .Qc     .Qo     Straight Double Quote   "string"
.Sq     .Sc     .So     Single Quote    `string'

除了 下面的 不规则宏, 所有的 引用宏 可以被 (其他宏) 分析和调用. 所有的 引用宏 能够 正确 处理 标点符号, 只要 一次 一个字符, 中间 用 空格 隔开. 引用宏 检查 开始和结束 符号, 以决定 把 它 放在 引用串的 前面还是后面. 这样 就 有了 一定的 嵌套能力.

.Ec , .Eo 这些宏 的 第一个参数 是 各自的 开始和结束串.
.`原文引用宏'
的 表现在 troff 中和 nroff 不一样. 如果用 nroff 格式化, 引用的原文 始终 被引用. 如果用 troff 格式化, 只有 宽度 小于 三个定宽字符 的 项 才被 引用. This is to make short strings more visible where the font change to literal (constant width) is less noticeable. 当 字体 变成 原文(定宽) 时, 短串显得更容易被看到.
.前缀宏不能被 (其他宏) 调用, 但是可以被分析.

.( Fa name2
变成 ( Fa name2

这个 `.(无空格) ' 宏 执行 类似的 后缀 功能.

引用举例:

.Aq Aq
.Aq ctype.h ),
Aq Ar ctype.h ) ,
.Bq Bq
.Bq Greek , French .
Bq Em Greek , French .
.````
.``string abc .''
'' ''
``string abc''
.``'^[A-Z]'''
``'^[A-Z]'''
.`man'
mdoc `man' mdoc
.Qq Qq
.Qq string ) ,
Qq string ) ,
.Qq string ),
Qq string Ns ),
.``
.`string'
' '
`string'

作为 嵌套引用宏的 典型范例, 参见 `.[选项宏.] ' 它们 都 来自 上面 列出的 基本 引用宏. `. ' 和 `. ' 扩展的 参数列表宏 同样 来自 相同的 基本例程, 并且, 在 最坏的情况 下, 是 -mdoc 宏 用法的 很好范例.  

No-[或正文宏 or Normal Text Macro]

宏 `.用在 ' 某个 宏命令行 上, 意如其名, 将 被格式化, 语法 遵循 一般的 内容宏.  

无空格宏 Space Macro

`. ' 宏请求 之间 消除 不需要的 空格. 它 用在 旧式风格的 参数列表 中, 标志和参数 间 没有 空格:

.[-I directory ]
产生 [-I directory ]

注意: `. ' 在 消除空格后 总会 调用 `.宏, ' 除非 还有 其他 宏名 跟在 后面. `.宏可以被 ' (其他宏) 分析和调用.  

手册页对照参考 Section Cross References

`.Sx 宏 ' 指定了 到 同一个文档内的 小节首部 的 对照参考. 该宏可以被 (其他宏) 分析和调用.

.Sx FILES
Sx FILES

 

参考和引言 References and Citations

The following macros make a modest attempt to handle references. At best, the macros make it convenient to manually drop in a subset of refer style references. 下面的宏 试图 适度的 处理 参考资料. 最好情况时, 这些宏 便于 手工 插入 一段 相关风格的 参考资料.

.Rs
参考开始. 它 导致 一次 断行, 并且 开始 收集 参考资料, 直到 遇到 参考结束宏.
.Re
参考结束. 则 打印出 参考信息.
.%A
参考资料 的 作者名字, 一次一个.
.%B
书名.
.%C
城市/地点.
.%D
日期.
.%J
期刊名.
.%N
发行号.
.%O
可选信息.
.%P
页码.
.%R
报告名.
.%T
文章题目.
.%V
卷.

用 `%' 符号 开始的 宏 不能被 (其他宏) 调用, 只能 被 trade name macro 分析, 结果 返回给 调用者 (此时 结果 不太好 预测). 其目的 是 允许 trade name 能够 很好的 打印在 troffNs/NsXrditroff 的 输出端.  

返回值 Return Values

`.Rv 宏 ' 产生 一些 用在 Sx 返回值 RETURN VALUES 小节的 文字.

Usage: .Rv [-std function]

`.Rv -std ' atexit 将输出 下列文字:

.Rv -std atexit

这个 -std 选项 仅用于 手册页的 第二和第三部分.  

Trade Names (或缩略和类型名)

trade name 宏 一般说来 是 一个 很小的 大写字母宏, 用于 所有 大于 两个字符的 大写单词.

Usage: .symbol ...

.DEC
DEC
.ASCII
ASCII

`.宏可以被 ' (其他宏) 分析和调用.  

扩展参数 Extended Arguments

`. ' 和 `. ' 宏 可以 在 宏的边界 扩展 参数列表. 如果 某个宏 要求 所有的参数 在 一行上 出现, 则 参数列表 不能 在 这儿 被 扩展. 例如 `.[] '

这里有 `. ' 宏的一个示例, 用 空格模式宏 把 空格 去掉:

.Sm off
.It Xo Sy I Ar operation
.No \en Ar count No \en
.Xc
.Sm on

产生

I operation \n count \n

还有一个:

.Sm off
.It Cm S No / Ar old_pattern Xo
.No / Ar new_pattern
.No / Op Cm g
.Xc
.Sm on

产生

S / old_pattern / new_pattern / [g ]

另一个示例用 `. ' 和 引用宏: 测试一个变量的值.

.It Xo
.Ic .ifndef
.Oo \&! Oc Ns Ar variable
.Op Ar operator variable ...
.Xc

产生

.ifndef [! variable ] [operator variable ... ]

上面 所有的例子 都在 `. ' (list-item) 宏 的 参数列表 中 使用了 `. ' 宏. 扩展宏 不经常 使用, 一般用来 扩展 list-item 宏 的 参数列表. 这也 不幸的 是 扩展宏 最苛刻的 地方. 前两个例子里 空格 被去掉; 第三个 例子中, 希望 能 输出 部分 空格, 而不是 全部. 在 这种情况下 用 这些宏, 要 确保 `. ' 和 `.

' 宏 摆放到 第三个例子 中 示范的位置. 如果 `. ' 宏 没有 单独 出现在 `. ' 的 参数表 中, 则 无法预测 空格 情况. 这种情况下, `.(no '
space macro) 一定 不能 作为 一行的 第一个宏 或 最后一个宏. 当前 BSD 发布的 超过 900个 手册页 (事实上大约1500个) 中, 只有 十五个 用到了 `. ' 宏.  

页结构宏宏域 PAGE STRUCTURE DOMAIN

 

小节首部 Section Headers

每个 手册页 里 都用到了 下面 列出的 三个 `. 

小节首部宏.

' 作者 写 手册页 时 可以 酌情考虑 其他 建议使用的 小节首部. `. 

' 最多 带 九个 参数. 它 可以 被 (其他宏) 分析, 但不能 被调用.

.
 

名称 NAME

`. 

名称

'
NAME 宏是 必不可少的. 否则 无法设置 页头, 页脚 和 缺省的 页布局, 样子 会 很难看. Sx 名称 NAME 小节 至少 由 三项 组成. 第一个 是 `.man mdoc.samples ' 名称宏, 命名 手册页的 主题. 第二个 是 名称描述宏 `. - , ' 它 把 主题名称 和 第三项, 描述, 分离开来. 描述 应该 尽可能的 精简易懂, 少占空间. .Sh 总览 SYNOPSIS Sx SYNOPSIS 总览小节 描述 该 手册页对象 的 典型用途. 请求的宏 是 下面 的 任意一个, `.Nm' , `.Cd' , `.Fn' , (也可能是 `.Fo' , `.Fc' , `.Fd' , `.Ft' 宏). 函数名称宏 `.Fn' 用在 手册页 的 第二第三部分, 命令 和 基本名称宏 `.man mdoc.samples ' 用在 手册页 的 1, 5, 6, 7, 8 部分. 手册 第四部分 需要 `.Nm' , `.Fd' 或 `.Cd' 配制设备用途宏. 其他一些 宏 可能 用来 产生 概要行, 象下面的:

cat [-benstuv ] [- ] file ...

下面 用到的 宏

.cat
.[-benstuv ]
.[- ]
.file ...

注意 宏 `.[,] ' `.- ' 和 `.file ... ' 能够 识别 管道符 `|' 因此 命令行 如:

".[-a | -b ]

的 表现 会 出轨. Troff 一般把 | 当做 特殊符号. 参见 Sx 预定义串 PREDEFINED STRINGS , 在 其他情况下 | 的使用. .Sh 描述 DESCRIPTION 大多数 情况下 Sx 描述 DESCRIPTION 小节 的 第一段话 是 关于 这个 命令, 函数 或 文件 的 摘要, 后跟 字典式的 选项 以及 相应的解释. 创建 这样的 列表, 应该 使用 `.

' 列表开始, `.

列表项和 ' `.

' 列表结束宏 (参见下面的 Sx 列表和栏目 Lists and Columns ).

下面的 `. 

小节首部

' 是 手册页 编排的 常见内容, 为了 保证 连续性, 应 适当 使用. 它们 按照 应该 出现 的 顺序 排列.

.
 

环境 ENVIRONMENT

Sx 环境 ENVIRONMENT 小节 用来 揭示 相关的 环境变量 和 线索, 它们的 行为, 表现, 用法. .Sh 示例 EXAMPLES 有 很多 办法 创建 示例, 详见 下面的 Sx 示例 EXAMPLES 小节. .Sh 文件 FILES 由 手册页的 主题对象 创建 或 使用 的 文件, 应该 通过 `.宏在 ' Sx 文件 FILES 小节 陈列 出来. .Sh 另见 SEE ALSO 如果 提及 其他 手册页 或 参照 相应的 手册, 应 把它们 放在 Sx 另见 SEE ALSO 小节. 参照主题 由 `.宏指定. ' 在 Sx 另见 SEE ALSO 小节 的 参照主题 应该按 手册节号 排序, 按 字母顺序 陈列, 并用 逗号 隔开, 例如:

ls(1), ps(1), group(5), passwd(5).

这时候 不太适合 用 refer(1) 风格 的 参考引用. .Sh 遵循 CONFORMING TO 如果 那些 命令, 库函数 或 文件 遵循 一定的 标准 实现, 如 St -p1003.2 或 St -ansiC , 那就 不需要 这一小节. 如果 命令 不符合 任何标准, 应该 把 它的历史 放在 Sx 历史 HISTORY 小节. .Sh 历史 HISTORY 任何 不属于 已知标准 的 命令 应该 在 这一节 给出 它的 大致历史. .Sh 作者 AUTHORS 如果 有 必要, 把 致谢名单 也 列这儿. .Sh 诊断 DIAGNOSTICS 应该 把 诊断命令 放在 这一节. .Sh 错误 ERRORS 特定的 错误处理, 尤其是 库函数 (手册页第二第三部分), 放这儿. `.Er 宏 ' 用来 指定 一个 errno. .Sh BUGS 明显的 问题 放这儿...

可以 增加一些 用户 制定的 `. 

小节,

' 例如, 这样 设 小节:
.Sh PAGE STRUCTURE DOMAIN
 

段落和空行 Paragraphs and Line Spacing.

.

`.

' 把 段落命令 放在 所需的位置, 可以 产生 一个空行. 在 `.

 

' `. 

' 后面 不需要 这个 宏, `.

' 宏 的 前面 也不需要. ( `.

' 声明了 垂直方向 的 距离, 除非 给出 -compact 标志).

 

保持 Keeps

目前 只实现了 对单词的 保持 能力. 这个宏 有 `.(开始保持 '
begin-keep) 和 `.(结束保持 ' end-keep ) . `.宏 ' 的 唯一 参数是 -words 用于 防止 在 选项语句 的 中间 断行. 在 make 命令行参数的 例子里 (参见 Sx 名称背后 What's in a name ) , keep 宏防止 nroff 把 标志 和 参数 分成 两行. (事实上 可以 用 选项宏 防止 此类 事情, 但 当我们 决定 在 troff 中 作为 基本选项, 强制 右边界对齐 时, 它 在 稀疏行里 展开的 很糟糕. 使用 保持宏 时 需要 多做点事, 增加 一个 -line 选项 ) .  

示例和显示

有 五种类型 的 显示, 一个 快速的单行缩进显示 `.D1' , 快速的单行原文显示 `.
,
' 原文块, 填充块, 和由 `. ' (begin-display) 显示开始 和 `. ' (end-display) 显示结束 宏对 组成的 不规则块.

.D1 (D-one) 显示 一行 缩进文字. 该宏 可以被 (其他宏) 分析, 但 不能 被调用.

-ldghfstru

上面是这样产生的: .

-ldghfstru
.
(D-ell) 显示 一行 缩进的
原文 literal `.
示例宏
' 已经 遍布 这篇 文档. 它 允许 缩进 (显示) 一行 文字. 其 缺省字体 设为 定宽 (原文), 它 可以 被 其他宏 分析 和 识别. 然而 不能 被 其他宏 调用.

% ls -ldg /usr/local/bin

上面是这样产生的 .

% ls -ldg /usr/local/bin
. 显示开始. `. ' 的 显示 必须由 `. ' 宏 结束. 显示 可以 嵌套在 显示 和 列表中. `. ' 有 这样的 语法:

".

显示类型 必须是 下面四个 之一, 可以 指定 一个 缩进量. `. '

-ragged 以 打字 形式 显示 一块 正文, 其 右(和左)边界 是 不平整边界.
-filled 显示 填充 (格式化) 块. 块中文字 被 格式化 (边界 已经 填充过, 不再是 左边 不对齐 ).
-literal 显示 原文块, 适用于 源程序, 或 那种 简单的, 用 table 和 空格 调整的 文字.
-file file_name 阅读 并 显示 跟在 -file 标志 后面的 文件. 原文模式 被打开, table 设为 8个字符 宽, 然而 文件中 出现的 任何 troff/NsNm-mdoc 命令 都将 被处理.
-offset string 如果 -offset 指定为 下面 字符串 之一, 这些 字符串 解释为 对 以后的 正文块的 缩进层次.

left 正文块 按 当前 左边界 对齐, 这是 `. ' 的 缺省模式.
center 应该 是把 正文块 布在 中间. 不幸的是, 目前 只能在 大致的 中间位置 靠左 对齐.
indent 按 缺省 缩进值 或 table 值 缩进. 这个 缺省 缩进值 同时 用于 `.D1' 显示, 因此 你 应该 使 这两种 显示 一致. 缩进值 一般 设为 6n, 大约 2/3 英寸 (六个字符宽度).
indent-two 缩进 缺省值的 两倍.
right 在 距离 右边界 大约 两英寸处 把 正文块 靠 对齐. 这个宏 要 试验 效果, 有可能 troff 怎么 都 弄不对.

".Ed"
End-display. 显示结束.

 

字体模式 Font Modes

现有 五个宏 用于 改变 手册页的 文字外观:

.文字 可以 用 `. ' 加重或强调. 常用的 强调字体 是 斜体 (italic).

Usage: .argument ...

.does not does not
.exceed 1024 . exceed 1024
.vide infra ) ) , vide infra ) )

`.宏可以被 ' (其他宏) 分析和调用. 不带参数 调用 `. ' 是 一个错误.

.`.原文宏 ' 用来 显示 字符, 变量, 常数, 任何 希望 照 输入文字 原样显示 的 内容.

Usage: .argument ...

.\en \n
.M1 M2 M3; M1 M2 M3
.cntrl-D ), cntrl-D )
.1024 ... 1024 ...

`.宏可以被 ' (其他宏) 分析和调用.

.一般说来 symbolic 强调宏 无论在 象徵主义 角度, 还是 传统的英语 里, 都是 用 黑体 (bold) 显示.

Usage: .symbol ...

.Important Notice Important Notice

`.宏可以被 ' (其他宏) 分析和调用. `.的参数 ' 可以 用 引号括起.

.Bf 字体模式开始. `.Bf 字体模式 ' 必须用 `.Ef 宏结束. ' 字体模式宏 可以 嵌套. `.Bf 宏 ' 用 下面的 语法:

".Bf font-mode

字体模式 必须 是 下列 三种 之一: `.Bf '

| -emphasis 就象 是 把 `. ' 用在 整个 正文块 一样.
| -literal 就象 是 把 `. ' 用在 整个 正文块 一样.
| -symbolic 就象 是 把 `. ' 用在 整个 正文块 一样.

".Ef" 字体模式结束.

 

标记栏和列表 Tagged Lists and Columns

有 多种 用 `.Bl' 列表开始宏 初始化的 列表. 表项 用 `.It' 项目宏 指定, 每一个 列表 必须 用 `.El' 宏结束. 列表 可以 嵌套在 列表和显示 中. 栏 可以 用在 列表 中, 但是 列表 不能 列在 栏里.

另外 还可以 指定 列表属性, 像标记宽度, 列表偏移, 以及 紧凑模式 (允许 或 不允许 表项间的 空行) 在本文中 大多 使用了 标记风格 (tag style) 的 列表 (-tag ) 作为 步距变化, 表示 列表类型的 列表类型 是个 突出来 (overhanging) 的 列表 (-ohang ) 这种 列表类型 在 TeX 用户中 很流行, 但 看过 很多 页 的 标记列表 后 可能会 觉得 有点 滑稽. `.Bl'

宏 可以 接受 下面的 列表类型:

-bullet
-item
-enum 这三个 是 最简单的 列表类型. 一旦 使用了 `.Bl' 宏, 只能用 `.It' 宏 组织 表项 . 例如, 可以 这样 写 一个 简单的 数字列表"
.Bl -enum -compact
.It
Item one goes here.
.It
And item two here.
.It
Lastly item three goes here.
.El

结果是:

  1. Item one goes here.
  2. And item two here.
  3. Lastly item three goes here.

简单的布告栏:

.Bl -bullet -compact
.It
Bullet one goes here.
.It
Bullet two here.
.El

产生:

  • Bullet one goes here.
  • Bullet two here.

-tag
-diag
-hang
-ohang
-inset 这些 列表类型 收集 `.
' 指定的 参数, 并且 创建 一个 标签, 它 可能会 插入 inset 后面的 文字中, 悬挂 (hanged) 显示在 后面的 文字前, 突前 (overhanged) 显示在 更高 位置, 并且 不能 缩进 或 标记 tagged 这个 列表 由 `-ohang ' 列表类型 构建. `.
' 只能 被 插入 (inset), 悬挂 (hang), 和 标记列表类型宏 分析, 且 不能 被调用.

这是 一个 插入标签 的 例子:

Tag
The tagged list (also called a tagged paragraph) is the most common type of list used in the Berkeley manuals.
Diag
Diag lists create section four diagnostic lists and are similar to inset lists except callable macros are ignored.
Hang
Hanged labels are a matter of taste.
Ohang
Overhanging labels are nice when space is constrained.
Inset
Inset labels are useful for controlling blocks of paragraphs and are valuable for converting -mdoc manuals to other formats.

下面是 产生 这个例子 的 源文本:

.Bl -inset -offset indent
.It Em Tag
The tagged list (also called a tagged paragraph) is the
most common type of list used in the Berkeley manuals.
.It Em Diag
Diag lists create section four diagnostic lists
and are similar to inset lists except callable
macros are ignored.
.It Em Hang
Hanged labels are a matter of taste.
.It Em Ohang
Overhanging labels are nice when space is constrained.
.It Em Inset
Inset labels are useful for controlling blocks of
paragraphs and are valuable for converting
.Nm -mdoc
manuals to other formats.
.El

这是 含有 两个表项 的 悬挂列表:

Hanged
labels appear similar to tagged lists when the label is smaller than the label width.
Longer hanged list labels
blend in to the paragraph unlike tagged paragraph labels.

它们的 源文本为:

.Bl -hang -offset indent
.It Em Hanged
labels appear similar to tagged lists when the
label is smaller than the label width.
.It Em Longer hanged list labels
blend in to the paragraph unlike
tagged paragraph labels.
.El

带有 可选 宽度项的 标记列表 可以 控制 标记的 宽度.

SL
sleep time of the process (seconds blocked)
PAGEIN
number of disk I/O 's resulting from references by the process to pages not loaded in core.
UID
numerical user-id of process owner
PPID
numerical id of parent of process process priority (non-positive when in non-interruptible wait)

源文本是:

.Bl -tag -width "PAGEIN" -compact -offset indent
.It SL
sleep time of the process (seconds blocked)
.It PAGEIN
number of disk
.Tn I/O Ns 's
resulting from references
by the process to pages not loaded in core.
.It UID
numerical user-id of process owner
.It PPID
numerical id of parent of process process priority
(non-positive when in non-interruptible wait)
.El

可接受的 宽度说明:

-width Fl 把 宽度 设置为 标志 (flag) 的 缺省 宽度. 所有 可调用的 宏 都有 一个 缺省 宽度值. 目前 `.- ' 的 值 设为 十个 字符宽度, 大约 5/6 英寸.
-width 24n 设置 宽度 为 24 个 字符宽度, 大约 两英寸. 要使 比例 调整正常, 字母 `n' 必不可少
-width ENAMETOOLONG 设置 宽度为 所给串的 长度.
-width \*qint mkfifo\*q 同样, 设置 宽度为 所给串的 长度.

如果 没有 为 标记列表类型 指定 宽度, 第一次 调用 `. ' 的 时候, 格式化软件 试图 决定 适当的宽度. 如果 `.It' 的 第一个 参数 是 可调用宏, 就 使用 这个宏的 缺省宽度, 就像 把 宏名 当做宽度. 可是 如果 列表中 的 其他表项 得到 另一个 可调用宏, 则 认为 它是 新的, 嵌套的 列表.  

预定义串 PREDEFINED STRINGS

下面的串 是 预定义的, 可以 用在 troff 的 串翻译序列 `\*(xx' 中, 这里的 xx 就是 定义的 串名; 以及 串翻译序列 `\*x' , 这里的 x 是串名. 翻译序列 可以 用在 文本 的 任何地方.

String        Nroff   Troff
<= Ta <= Ta <=
>= Ta >= Ta >=;
Rq Ta '' Ta ”
Lq Ta `` Ta “
ua Ta ^ Ta ^
aa Ta ' Ta '
ga Ta ` Ta `
q Ta Ta "
Pi Ta pi Ta Pi
Ne Ta != Ta !=
Le Ta <= Ta <=
Ge Ta >= Ta >=;
Lt Ta < Ta >
Gt Ta > Ta <
Pm Ta +- Ta ±
If Ta infinity Ta ∞
Na Ta NaN Ta NaN
Ba Ta | Ta |

注意
那个 名为 `q' 的 串 应该 写成 `\*q' , 因为 它 只有 一个字符.  

诊断 DIAGNOSTICS

-mdoc 的 除错系统 比较 有限, 但是 可以 帮助你 检测出 微妙的 错误, 例如 参数名 和 内部寄存器 或 宏名 冲突. (是什么?) 寄存器 是 troff 的 算术存储类, 用 一到二个字符 命名. -mdoc 对 troff 和 ditroff 而言, 所有 -mdoc 的 内部寄存器 由 两个字符 组成, 格式是 <大写字母> <小写字母> 如 `file ... ' <小写字母> <大写字母> 如 `aR' 或 <字母> <数字> 如 `C1' 作为 乱上加乱, troff 有 它 自己的 内部寄存器, 由 两个 小写字母 组成, 或者 是 一个点 加上 一个字母, 或者 是 转义字符 (meta-character) 和 字符. 已经 介绍过的 示例中 展示过 怎样用 转义序列 `\&'

防止 解释宏. 这办法 同样 适用于 内部寄存器名.

如果 未经转义的 寄存器名 出现在 宏请求的 参数列表 中, 其 后果 不可预测. 一般说来, 如果 大段的文字 没有 出现在 该出现的 地方, 或者 短句, 如标签, 消失了, 多半是 这个地方 误解了 参数列表中的 参数类型. 既然 你的母亲 都 没打算 让你 记住 那些 乱七八糟的 东西, 那就 用 一种办法 来 找出 参数 是否 有效: `.Db (debug) ' 宏 可以 显示出 对 大多数宏 的 参数列表的 解释. 诸如 `.

' 之类 的 宏 不包含 调试信息, 但是 所有 可调用宏 包含, 我们 强烈建议 一旦 有 疑点, 打开 `.Db 宏. '

Usage: .Db [on | off]

在 这个 示例中, 我们把 介于 debug 宏 之间 的 文本 故意 弄出点 错误 (标志参数 `aC' 应该 写成 `\&aC' ):

.Db on
.Op Fl aC Ar file )
.Db off

结果输出为:

DEBUGGING ON DEBUG(argv) MACRO: `.Op' Line #: 2 Argc: 1 Argv: `Fl' Length: 2 Space: `' Class: Executable Argc: 2 Argv: `aC' Length: 2 Space: `' Class: Executable Argc: 3 Argv: `Ar' Length: 2 Space: `' Class: Executable Argc: 4 Argv: `file' Length: 4 Space: ` ' Class: String Argc: 5 Argv: `)' Length: 1 Space: ` ' Class: Closing Punctuation or suffix MACRO REQUEST: .Op Fl aC Ar file ) DEBUGGING OFF

调试信息的 第一行 是 调用的 宏名, 这里是 `.[和] ' 它 所在的 行号. 如果 涉及了 一个 或 多个 文件 (特别是 其他文件 包含进来), 行号有可能失灵. 但如果 只有 一个文件, 它 应该是 准的. 第二行 给出了 参数计数, 参数 (`- ' ) 和 它的长度. 如果 参数的长度 是 两个字符, 将会 测试 看它 能否 执行 (不幸的是,含有 非零值 的 寄存器 看上去 都能执行). 第三行 给出 分配给类的 空间, 以及 类的类型. 这里的 问题是, 参数 aC 不应该 可执行. 类的 四种类型是 字符串, 可执行类, 结束标点, 和开始标点. 最后一行 显示了 读入的 完整 参数行. 下个例子里, 惹祸的 `aC' 被转义了:

.Db on
.Em An escaped \&aC
.Db off
DEBUGGING ON
DEBUG(fargv) MACRO: `.Em'  Line #: 2
        Argc: 1  Argv: `An'  Length: 2
        Space: ` '  Class: String
        Argc: 2  Argv: `escaped'  Length: 7
        Space: ` '  Class: String
        Argc: 3  Argv: `aC'  Length: 2
        Space: ` '  Class: String
        MACRO REQUEST: .Em An escaped &aC
DEBUGGING OFF

参数 `\&aC' 表现出 同样的 长度2, 这是 因为 `\&' 序列的 长度 为零, 但是 不存在 叫做 `\&aC' 的 寄存器, 因此 它的类型 是 字符串.

其他 诊断内容 是 使用报告等, 能够 自我解释的.  

GROFF, TROFF AND NROFF

The -mdoc 宏包 不需要 和 groff 的 兼容模式.

为了 便于 在线阅读, 这个宏包 阻止了 分页, 页头, 页脚 之类 常常在 nroff 中 出现的 中断. 此时 即使在 手册页 尾, groff (和参数 -T ascii ) 也 不会 提示 什么. 对 分页的 阻止 使得 nroffNs'd 文件 不适合 硬拷贝 (hardcopy). 有一个 名为 `cR' 的 寄存器 可以 通过 在 文件 /usr/src/share/tmac/doc-nroff (依赖于宿主系统) 中置零, 恢复 传统风格.  

相关文件 FILES

/usr/share/tmac/tmac.doc 手册宏包
/usr/share/misc/mdoc.template 编写 手册 的 模板
/usr/share/examples/mdoc/* 一些 手册页 的 例子

 

另见 SEE ALSO

man(1), troff(1), mdoc(7)  

BUGS

仍然 没有 解决 在 标志参数中的 连字符, 在 Sx 描述 DESCRIPTION 小节 偶尔 会 出点麻烦 (在 连字符处 断行).

文档中 没有 声明 预定义串.

还没有 把 3f 小节 加进 头例程 (header routine) 中.

`.man mdoc.samples ' 字体 不应当在 Sx NAME 小节 中 改变.

应该 检查 `.Fn 防止 ' 行 太短 的 时候 断行. 偶然 它会 断开 反括弧, 而 有时候 如果 某行 已满时, 看上去 会 很可笑.

当 使用 nroff 格式化 文档 时, 防止 页头和页脚 (不是 初始的 头和脚) 断开 的 方法 有可能 偶尔 在 页的底部 产生 一个 不可见的 部分填满的 行 (空行).

列表和显示宏不做任何保存, 显然它应该做的.  

[中文版维护人]

徐明 <[email protected]>  

[中文版最新更新]

2003/05/13  

《中国Linux论坛man手册页翻译计划》

http://cmpp.linuxforum.net


 

Index

NAME (名字)
SYNOPSIS (总览)
DESCRIPTION (描述)
开始 GETTING STARTED
TROFF 特性
宏的用法 Macro Usage
在参数中传递空格符 Passing Space Characters in an Argument
尾部的空白符 Trailing Blank Space Characters
转义特殊字符 Escaping Special Characters
手册页结构分析 THE ANATOMY OF A MAN PAGE
手册页的模板 A manual page template
;
标题宏 TITLE MACROS
手册宏域 和 基本正文宏域的介绍
名称背后 What's in a name...
基本语法 General Syntax
手册域 MANUAL DOMAIN
地址宏 Address Macro
作者名称 Author Name
参数宏 Argument Macro
配置定义 (手册第四部分) Configuration Declaration
命令修饰 Command Modifier
已定义的变量 Defined Variables
Errno's (仅供手册第二部分)
环境变量 Environment Variables
函数参数 Function Argument
函数声明 Function Declaration
标志 Flags
函数(库函数) Functions (library routines)
函数类型 Function Type
交互命令 Interactive Commands
名称宏 Name Macro
选项 Options
路径名 Pathnames
变量 Variables
手册页参照 Manual Page Cross References
基本正文宏域 GENERAL TEXT DOMAIN
AT&T 宏
BSD 宏
FreeBSD 宏
UNIX 宏
嵌入和引用宏 Enclosure and Quoting Macros
No-Op 或正文宏 or Normal Text Macro
无空格宏 No Space Macro
手册页对照参考 Section Cross References
参考和引言 References and Citations
返回值 Return Values
Trade Names (或缩略和类型名)
扩展参数 Extended Arguments
页结构宏宏域 PAGE STRUCTURE DOMAIN
小节首部 Section Headers
小节首部宏.
名称 NAME
名称
小节首部
环境 ENVIRONMENT
小节,
段落和空行 Paragraphs and Line Spacing.
保持 Keeps
示例和显示
字体模式 Font Modes
标记栏和列表 Tagged Lists and Columns
预定义串 PREDEFINED STRINGS
诊断 DIAGNOSTICS
GROFF, TROFF AND NROFF
相关文件 FILES
另见 SEE ALSO
BUGS
[中文版维护人]
[中文版最新更新]
《中国Linux论坛man手册页翻译计划》

This document was created by man2html, using the manual pages.
Time: 13:12:51 GMT, December 24, 2015