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.

.操做系統 發行號#

操做系統 的 名字 可能 是 縮寫, 像 BSD 或 FreeBSD 或 ATT 發行號 應該 是 系統 專用的 標準發行術語, 像 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 術語 中, infile 和 outfile 稱爲 參數 產生 上述效果 的 宏 是 這樣的:

.Nm filter
.Op Fl flag
.Ar infile outfile

第三種 狀況 討論 命令 及其語法, 包括 它們的例子, 可能 還有 更多細節. 上面的例子裏, 能夠把 infile 和 outfile 理解爲 操做參數 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 nobody@FreeBSD.ORG

An Joe Author Aq nobody@FreeBSD.ORG

.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

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

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/* 一些 手冊頁 的 例子