Manpages

名 称

refer − groff の た め の 参 考 文 献 目 録 プ リ プ ロ セ ッ サ

書 式

refer [ −benvCPRS ] [ −an ] [ −cfields ] [ −fn ] [ −ifields ] [ −kfield ] [ −lm,n ] [ −pfilename ] [ −sfields ] [ −tn ] [ −Bfield.macro ] [ filename... ] コ マ ン ド ラ イ ン オ プ シ ョ ン と パ ラ メ ー タ の 間 に 、 空 白 を 置 く こ と が 可 能 で す 。

解 説

本 フ ァ イ ル で は groff ド キ ュ メ ン ト フ ォ ー マ ッ テ ィ ン グ シ ス テ ム の 一 部 で あ る GNU バ ー ジ ョ ン の refer に つ い て 記 述 し ま す 。 refer は .[ と .] で 囲 ま れ た 引 用 と し て 解 釈 さ れ る 行 と 、 .R1 と .R2 で 囲 ま れ た 引 用 の 処 理 方 法 を 記 述 し た コ マ ン ド と し て 解 釈 さ れ る 行 を 除 き 、 filename... の 内 容 を 標 準 出 力 に コ ピ ー し ま す 。 各 々 の 引 用 で は 参 考 文 献 を 指 定 し ま す 。 引 用 で は 、 あ る 参 考 文 献 に の み 含 ま れ る キ ー ワ ー ド の 集 合 を 与 え る こ と に よ っ て 、 そ の 参 考 文 献 を 図 書 目 録 デ ー タ ベ ー ス か ら 指 定 で き ま す 。 ま た 、 引 用 の 中 で デ ー タ ベ ー ス レ コ ー ド を 指 定 す る こ と に よ っ て も 参 考 文 献 を 指 定 で き ま す 。 こ れ ら の 方 法 を 組 み 合 わ せ る こ と も 可 能 で す 。 各 々 の 引 用 に お い て refer は テ キ ス ト の 中 に マ ー ク を 作 成 で き ま す 。 こ の マ ー ク は 色 々 な 方 法 で テ キ ス ト や 他 の ラ ベ ル か ら 区 別 さ れ る い く つ か の ラ ベ ル か ら 構 成 さ れ ま す 。 各 引 用 に お け る 参 考 文 献 を マ ク ロ パ ッ ケ ー ジ を 使 っ て フ ォ ー マ ッ ト し て 出 力 す る た め の groff コ マ ン ド を 出 力 す る こ と も で き ま す 。 そ の た め に は refer の 出 力 は 適 切 な マ ク ロ パ ッ ケ ー ジ を 使 っ て 処 理 さ れ な け れ ば な り ま せ ん 。 −ms と −me は い ず れ も 適 切 な マ ク ロ で す 。 引 用 の 参 考 文 献 を フ ォ ー マ ッ ト す る コ マ ン ド を 引 用 の 直 後 に 出 力 す る こ と も 、 参 考 文 献 を 蓄 積 し て 後 で コ マ ン ド を 出 力 す る こ と も で き ま す 。 参 考 文 献 を 蓄 積 し た 時 、 同 じ 参 考 文 献 が 複 数 か ら 引 用 さ れ て い る 場 合 に は 、 参 考 文 献 は 1 つ に ま と め て フ ォ ー マ ッ ト さ れ ま す 。

GNU refer の 新 し い 機 能 と し て .R1 と .R2 の 間 の 行 は コ マ ン ド と し て 解 釈 さ れ ま す 。 こ の 機 能 を 使 用 し て 作 成 さ れ た ド キ ュ メ ン ト は 、 ド キ ュ メ ン ト の 先 頭 に

.de R1
.ig R2
.. の 行 を 追 加 す る こ と に よ り UNIX refer で も 処 理 で き ま す 。 こ の 指 定 に よ っ て troff は .R1 と .R2 の 間 を す べ て 無 視 し ま す 。 こ の オ プ シ ョ ン に よ っ て い く つ か の コ マ ン ド と 同 等 の 効 果 を 得 る こ と が で き ま す 。 こ れ ら の オ プ シ ョ ン は 主 に Unix refer と の 互 換 性 の た め に サ ポ ー ト さ れ て い る も の で す 。 通 常 は コ マ ン ド を 使 っ た 方 が 便 利 で す 。

refer は refer の 出 力 を 読 む コ マ ン ド に よ っ て 生 成 さ れ る メ ッ セ ー ジ の 中 の フ ァ イ ル 名 と 行 番 号 が 正 し く な る よ う に .lf 行 を 生 成 し ま す 。 入 力 が soelim (1) の よ う な コ マ ン ド に よ っ て 前 処 理 さ れ て い る 場 合 で も 、 メ ッ セ ー ジ 中 の フ ァ イ ル 名 と 行 番 号 と 生 成 さ れ る .lf 行 が 正 確 に な る よ う に .lf で 始 ま る 行 も 解 釈 し ま す 。

オ プ シ ョ ン

ほ と ん ど の オ プ シ ョ ン に は 同 等 な コ マ ン ド が あ り ま す (こ れ ら の コ マ ン ド に つ い て は コ マ ン ド セ ク シ ョ ン の 説 明 を 参 照 し て 下 さ い )。

−cfields

capitalize fields

−ifields

search-ignore fields

−kfield

label field~%a

−pfilename

database filename

こ れ ら の オ プ シ ョ ン は 以 下 の コ マ ン ド と 同 等 で す 。 た だ し 、 通 常 の 方 法 の か わ り に コ マ ン ド 行 で 指 定 さ れ る フ ァ イ ル 名 が bibliography コ マ ン ド へ の 引 数 で あ る よ う に 処 理 さ れ ま す 。

−Bfield.macro

annotate field macro; no-label-in-reference 以 下 の オ プ シ ョ ン に は 同 等 な コ マ ン ド は あ り ま せ ん 。

.R1 / .R2 で 始 ま る 行 を 認 識 し ま せ ん 。

使 用 法

図 書 目 録 デ ー タ ベ ー ス 図 書 目 録 デ ー タ ベ ー ス は 1 行 以 上 の 空 白 行 で 区 切 ら れ た レ コ ー ド か ら な る テ キ ス ト フ ァ イ ル で す 。 各 レ コ ー ド で は フ ィ ー ル ド は % で 始 ま る 行 で 開 始 し ま す 。 各 フ ィ ー ル ド に は % に 続 く 1 文 字 の 名 称 が あ り ま す 。 フ ィ ー ル ド の 名 称 に は 大 文 字 か 小 文 字 の み を 使 う の が 最 良 の 方 法 で す 。 フ ィ ー ル ド の 名 称 の 後 に は 正 確 に 1 つ の ス ペ ー ス が 続 か な け れ ば な り ま せ ん 。 空 の フ ィ ー ル ド は 無 視 さ れ ま す 。 各 フ ィ ー ル ド の 慣 例 的 な 意 味 は 次 の 通 り で す 。

マ で ラ ス ト ネ ー ム と 区 切 ら れ て い な け れ ば な り ま せ ん 。 A フ ィ ー ル ド は 複 数 回 現 れ て も 構 い ま せ ん 。 出 現 す る 順 番 は 意 味 を 持 ち ま す 。 A フ ィ ー ル ド か Q フ ィ ー ル ド は 常 に 指 定 す る の が 良 い で し ょ う 。

(都 市 ) で す 。

3 文 字 を 指 定 す れ ば 十 分 で す 。 D フ ィ ー ル ド は 常 に 指 定 す る の が 良 い で し ょ う 。 た だ し 、 出 版 の 日 付 が 分 か ら な け れ ば in press や unknown の よ う な 値 を 使 う こ と も で き ま す 。

A フ ィ ー ル ド で 指 定 し 、 , (ed) ま た は , (eds) を 最 後 の 著 者 の 後 に 指 定 し な け れ ば な り ま せ ん 。

(発 行 人 ) で す 。

m − n で 指 定 で き ま す 。

場 合 に の み 使 用 さ れ ま す 。 Q フ ィ ー ル ド は 1 つ の み 使 う こ と が で き ま す 。

A と E を 除 く す べ て の フ ィ ー ル ド で 、 あ る レ コ ー ド に 複 数 の 特 定 の フ ィ ー ル ド が あ る 場 合 、 最 後 の フ ィ ー ル ド の み が 使 用 さ れ ま す 。 ア ク セ ン ト 文 字 列 は ア ク セ ン ト を つ け る 文 字 に 引 き 続 い て 指 定 さ れ な け れ ば な り ま せ ん 。 こ れ は AM マ ク ロ は −ms マ ク ロ と と も に 使 用 し な け れ ば な ら な い こ と を 意 味 し ま す 。 ア ク セ ン ト 文 字 列 は 引 用 符 で 囲 ん で は い け ま せ ん 。 ま た 、 \ は 2 つ で な く 1 つ の み 使 っ て 下 さ い 。 引 用 引 用 の フ ォ ー マ ッ ト は

.[opening-text
flags keywords
fields
.]closing-text と な り ま す 。

opening-text と closing-text と flags の コ ン ポ ー ネ ン ト は 省 略 可 能 で す 。 keywords か fields の い ず れ か 1 つ の コ ン ポ ー ネ ン ト を 指 定 す る 必 要 が あ り ま す 。

keywords コ ン ポ ー ネ ン ト は keywords に 含 ま れ る 全 て の 単 語 を 含 む 参 考 文 献 を 文 献 デ ー タ ベ ー ス か ら 検 索 す る た め に 指 定 し ま す 。 も し 複 数 の 参 考 文 献 が 見 つ か っ た 場 合 は エ ラ ー と な り ま す 。

fields コ ン ポ ー ネ ン ト は 参 考 文 献 の 中 で 指 定 さ れ る も の を 置 き 換 え る か 付 け 加 え る た め の 追 加 フ ィ ー ル ド を 指 定 し ま す 。 参 考 文 献 が 蓄 積 さ れ る 設 定 で 、 keywords コ ン ポ ー ネ ン ト が 空 で な け れ ば 、 追 加 フ ィ ー ル ド は あ る 特 定 の 参 考 文 献 が 引 用 さ れ て い る 最 初 の 部 分 に お い て の み 指 定 さ れ な け れ ば な ら ず 、 そ の 参 考 文 献 を 引 用 し て い る 全 て の 部 分 に 適 用 さ れ ま す 。

opening-text と closing-text コ ン ポ ー ネ ン ト は bracket-label コ マ ン ド に お い て 指 定 さ れ る 文 字 列 の 代 わ り に ラ ベ ル を 囲 む た め に 使 わ れ る 文 字 列 を 指 定 し ま す 。 こ れ ら の い ず れ も が 空 で な け れ ば 、 bracket-label コ マ ン ド で 指 定 さ れ て い る 文 字 列 は 使 わ れ ま せ ん 。 こ の 処 理 は [ と ] フ ラ グ を 使 っ て 置 き 換 え る こ と が で き ま す 。 こ れ ら の コ ン ポ ー ネ ン ト の 前 と 後 に つ く ス ペ ー ス は 意 味 を 持 つ こ と に 注 意 し て 下 さ い 。

flags コ ン ポ ー ネ ン ト は こ こ で の 引 用 の 扱 い を 変 更 す る た め の ア ル フ ァ ベ ッ ト 以 外 の 文 字 の リ ス ト で す 。 Unix refer は こ れ ら の フ ラ グ を キ ー ワ ー ド の 一 部 と し て 処 理 し ま す が 、 そ れ ら は ア ル フ ァ ベ ッ ト で な い た め 無 視 し ま す 。 以 下 の フ ラ グ が 現 在 認 識 さ れ る も の で す 。

ン ド で 指 定 さ れ る も の の 代 わ り に 使 用 す る こ と を 指 示 し ま す 。 も し シ ョ ー ト ラ ベ ル が 指 定 さ れ な け れ ば 、 通 常 の ラ ベ ル が 使 用 さ れ ま す 。 普 通 は シ ョ ー ト ラ ベ ル は auther-date ラ ベ ル に 使 用 さ れ 、 日 付 と お そ ら く は 曖 昧 さ が 取 り 除 か れ た 文 字 か ら 構 成 さ れ ま す 。 こ こ で 、 # は ラ ベ ル の 数 字 に よ る タ イ プ を 示 唆 す る も の と 考 え ら れ ま す 。

opening-text と closing-text の 中 に 括 弧 を 含 め る の で は な く 、 [ と ] フ ラ グ を 使 う こ と の 1 つ の 利 点 は bracket-label コ マ ン ド で 変 更 す る だ け で ド キ ュ メ ン ト の 中 で 使 っ て い る 括 弧 の ス タ イ ル を 変 更 で き る こ と で す 。 も う 1 つ の 利 点 と し て 、 こ れ ら の フ ラ グ を 使 う こ と に よ っ て 引 用 の ソ ー ト と マ ー ジ を 禁 止 す る 必 要 が な い こ と が あ げ ら れ ま す 。 も し ラ ベ ル が テ キ ス ト 中 に 挿 入 さ れ る べ き も の で あ れ ば 、 そ れ は .[ 行 の 前 の 行 に 挿 入 さ れ ま す 。 そ の よ う な 行 が な い 場 合 に は .[ の 前 に 余 分 の 行 が 挿 入 さ れ て 警 告 が 表 示 さ れ ま す 。 複 数 の 参 考 文 献 に 対 す る 引 用 を 作 成 す る 特 別 の 表 記 法 は あ り ま せ ん 。 た だ 引 用 を 1 つ の 参 考 文 献 に つ き 1 つ ず つ 連 続 し て 使 用 し ま す 。 引 用 の 間 に は 何 も 入 れ な い で 下 さ い 。 全 て の 引 用 に 対 す る ラ ベ ル は 最 初 の 引 用 の 前 の 行 に 付 加 さ れ ま す 。 ラ ベ ル は ま た ソ ー ト し た り 、 マ ー ジ し た り す る こ と も で き ま す 。 ラ ベ ル の 表 記 法 <> と コ マ ン ド sort-adjacent-labels と abbreviate-label-ranges の 説 明 を 参 照 し て 下 さ い 。 ラ ベ ル は 引 用 に 空 で な い opening-text か closing-text が あ る 時 に は マ ー ジ さ れ ま せ ん 。 し か し 、 opening-text が 伴 わ ず [ フ ラ グ を 使 っ た 引 用 が そ の 直 後 に 続 く 、 closing-text を 伴 わ な い ] フ ラ グ を 使 っ た 引 用 の ラ ベ ル は 最 初 の 引 用 の opening-text か 次 の 引 用 の closing-text が 空 で な い 場 合 に お い て も 、 ソ ー ト と マ ー ジ を 行 な う こ と が で き ま す 。 (も し こ れ を 行 な い た く な い 場 合 は 、 最 初 の 引 用 で closing-text を \& と し て く だ さ い 。 ) コ マ ン ド コ マ ン ド は .R1 で 始 ま る 行 と .R2 の 間 に 指 定 さ れ ま す 。 こ れ ら の 行 は −R オ プ シ ョ ン を 使 う こ と に よ っ て 認 識 さ れ な い よ う に で き ま す 。 .R1 行 が 認 識 さ れ た 時 、 す べ て の 蓄 積 さ れ て い る 参 考 文 献 は 消 去 さ れ ま す 。 .R1 行 と .R2 行 お よ び こ れ ら の 間 に 指 定 さ れ た も の は す べ て 出 力 さ れ ま せ ん 。 コ マ ン ド は 改 行 か ; に よ っ て 区 切 ら れ ま す 。 # か ら そ の 行 の 最 後 ま で は コ メ ン ト と な り ま す (し か し 、 改 行 自 身 は 改 行 と し て あ つ か わ れ ま す ） 。 各 コ マ ン ド は ワ ー ド に 分 割 さ れ ま す 。 ワ ー ド は ス ペ ー ス か タ ブ に よ っ て 区 切 ら れ ま す 。 " で 始 ま る ワ ー ド は 次 の " (た だ し も う 1 つ の " が 直 後 に な い も の ) ま で が ワ ー ド と し て 扱 わ れ ま す 。 も し 、 次 の " が な い 場 合 に は そ の 行 の 最 後 ま で が ワ ー ド と な り ま す 。 " で 始 ま る ワ ー ド 中 の " の ペ ア は ひ と つ の " と し て 扱 わ れ ま す 。 " の 中 で は # と ; は 認 識 さ れ ま せ ん 。 行 は 末 尾 に \ を つ け る こ と に よ っ て 継 続 で き ま す 。 た だ し # の 後 の 場 合 は 継 続 さ れ ま せ ん 。

* で マ ー ク さ れ た 各 コ マ ン ド name に は name の 効 果 を 打 ち 消 す 否 定 コ マ ン ド no-name が あ り ま す 。 例 え ば 、 no-sort コ マ ン ド は 参 考 文 献 を ソ ー ト し な い こ と を 指 定 し ま す 。 否 定 コ マ ン ド は 引 数 を 取 り ま せ ん 。 以 下 の 説 明 で 各 引 数 は ひ と つ の ワ ー ド と な り ま す 。 field は フ ィ ー ル ド の 名 前 と な る 1 文 字 の 小 文 字 ま た は 大 文 字 で す 。 fields は そ の よ う な 文 字 の シ ー ケ ン ス で す 。 m と n は 非 負 の 数 字 で す 。 string は 任 意 の 文 字 列 で す 。 filename は フ ァ イ ル 名 で す 。
abbreviate* fields string1 string2 string3 string4

fields の フ ァ ー ス ト ネ ー ム を 短 縮 形 に し ま す 。 頭 文 字 と も う 1 つ の 頭 文 字 の 間 に は string1 が 挿 入 さ れ ま す 。 ラ ス ト ネ ー ム と の 間 に は string2 が 挿 入 さ れ 、 そ の 他 の も の ( von や de の よ う な も の ) と の 間 に は string3 が 挿 入 さ れ ま す 。 こ れ ら の ス ト リ ン グ の デ フ ォ ル ト は ピ リ オ ド に ス ペ ー ス が 続 い た も の と な り ま す 。 ハ イ フ ン で 区 切 ら れ た フ ァ ー ス ト ネ ー ム の 中 で 、 名 前 の 最 初 の 部 分 の 頭 文 字 は string4 (デ フ ォ ル ト は ピ リ オ ド ) に よ っ て ハ イ フ ン と 分 離 さ れ ま す 。 省 略 形 に 起 因 す る 曖 昧 さ に つ い て は 特 に 考 慮 し て い ま せ ん 。 名 前 は ソ ー ト す る 前 お よ び ラ ベ ル が 構 築 さ れ る 前 に 省 略 形 に さ れ ま す 。

abbreviate-label-ranges* string 連 続 し た 参 考 文 献 を 参 照 す る 3 つ 以 上 の 隣 接 す る ラ ベ ル は 、 最 初 の ラ ベ ル string 最 後 の ラ ベ ル の 順 か ら な る 1 つ の ラ ベ ル に 省 略 さ れ ま す 。 こ れ は 主 に 数 字 ラ ベ ル に お い て 便 利 で す 。 string が 省 略 さ れ た 場 合 の デ フ ォ ル ト は − で す 。

.R1 行 が 認 識 さ れ た 後 に 、

.[
$LIST$
.] の 形 式 の 参 照 が 指 定 さ れ た 時 に 書 き 出 さ れ ま す 。

.string の 行 の 後 に パ ラ グ ラ フ と し て 印 刷 さ れ ま す 。 macro が 省 略 さ れ る と デ フ ォ ル ト の AP と な り ま す 。 も し 、 field も 省 略 さ れ る と デ フ ォ ル ト の X と な り ま す 。 注 釈 に な れ る フ ィ ー ル ド は 1 つ の み で す 。