groff_man − マニュアルページ生成サポート用 groff ‘man’ マクロ

groff −man [ options... ] [ files... ]
groff −m man [ options... ] [ files... ]

groff で マニュアルページを生成するのに使用される man マクロは、James Clark が書きました。このドキュメントは、パッケージ中の各マクロの使い 方 を、短くまとめたものです。

man マクロは、次のようなコマンドラインオプションを理解します (レジスタ をいくつか定義します)。

−rcR=1

本オプション (nroff モードではデフォルト) は、複数 ペー ジの代りに、長い単一ページを出力します。無効にするには、 −rcR=0 としてください。

−rC1

コマンドラインに複数のマニュアルページを与えた場合、そ れ ぞれのページ番号が 1 から始まるのではなく、連続した番号になりま す。

−rD1

両面印字にします。偶数ページと奇数ページのフッ タ は、 異 なった整形が成されます。

−rFT=dist

フッ タ 位 置を設定します。負数の場合、ボトムからの相対位置であ り、正数の場合、トップからの相対位置です。デフォルトは -0.5i で す。

−rHY=flags

ハ イフネーションフラグを設定します。設定可能な値は、1 が制限無 しのハイフネーション、 2 がページの最後の語をハイフネーションし ない、 4 が語の最後の 2 文字をハイフネーションしない、 8 が語の 最初の 2 文字をハイフネーションしないです。値は加算可能です。デ フォルトは 14 です。

−rIN=width

本 文のインデントを width に設定します。デフォルトは、 nroff で は 7n であり troff では 7.2n です。 nroff では、一貫性のある イ ン デ ントを得るために、この値は ‘n’ の整数倍であることが必要で す。

−rLL=line-length

行の長さを設定します。このオプションを設定しないと、行 の 長 さ は、 nroff モードではデフォルトの 78n に、 troff モードではデ フォルトの 7.5i になります。

−rLT=title-length

タイトルの長さを設定します。このオプションを設定しないと、タ イ トルの長さは、 nroff モードではデフォルトの 78n に、 troff モー ドではデフォルトの 7.5i になります。

−rPnnn

ページの数え始めを 1 ではなく nnn からにします。

−rSxx

ベースドキュメントフォントサイズを 10 ポイントでは な く xx ポイントにします (xx には 10, 11, 12 のいずれかが使用できま す)。

−rSN=width

副副見出しのインデントを width に設定します。デフォルトは 3n で す。

−rXnnn

ページ nnn の後のページを nnna, nnnb, nnnc などというよ うに数えます。例えば、‘−rX2’ というオプションの場合、ペー ジ を 1, 2, 2a, 2b, 2c というように割り振ります。

こ のセクションは、マニュアルページ用に使用可能なマクロについて述べてい ます。さらにカスタマイズしたい場合は、 man.local ファイル中に追加のマク ロおよびリクエストを置いてください。このファイルは man の直後にロードさ れます。

.TH title section [extra1] [extra2] [extra3]

このマニュアルページのタイトルを title に、セクションを section に 設定します。セクションは、 1 から 8 までの値をとらなくてはな りません。 section 値には、後ろに文字列を置くこともできます。例 えば、 ‘.pm’ とすると、マニュアルページの特定のサブセクションを 示します。 title と section は、ともにヘッダ行の左端と右端に 置 かれます (括弧でくくられた section が title の直後に付きます)。 extra1 は、フッタ行の中央に置かれます。 extra2 は、フッタ行の左 に 置かれます (両面印字がアクティブになっている場合、偶数ページ には左に、奇数ページには右に、置かれます)。 extra3 はヘッダ行の 中央に置かれます。

HTML 出力用には、ヘッダおよびフッタは完全に取り除かれます。

さ らに、このマクロは改ページします。新しい行番号は、再度 1 にな ります (コマンドラインで ‘-rC1’ オプションが指定されている場合を 除 きます)。この機能は、複数のマニュアルページを整形する場合のた めだけにあります。マニュアルページが 1 つの場合、 TH は、ファ イ ルの先頭において、まさに 1 つだけ存在すべきです。

.SH [text for a heading]

番 号づけをしないセクション用の見出しを設定します。これは左詰め になります。 SH に続いたテキスト ( SH に引数がない場合は次の 入 力 行のテキスト) は、行末までのものがすべてボールド体 (もしくは 文字列 HF で指定されたフォント) で、そしてベースドキュメント サ イズよりも 1 だけ大きなフォントサイズで表示されます。さらに、テ キストの左側の余白およびインデントはデフォルト値に戻されます。

.SS [text for a heading]

番号づけしないセクションの 2 番目の見出しを設定します。 SS に続 い たテキスト ( SS に引数がない場合は次の入力行のテキスト) は、 行末までのものがすべてボールド体 (もしくは文字列 HF で指定さ れ た フォ ン ト) で、そしてベースドキュメントサイズと同じ大きさの フォントで表示されます。さらに、テキストの左側の余白はデフォ ル ト値に戻されます。

.TP [nnn]

イ ン デ ントされた、ラベルつきの段落を設定します。インデント幅 は、引数が与えられていれば nnn に設定されます (省略されて い れ ば、 デ フォルトの単位は ‘n’ です)。そうでない場合、 TP, IP, HP で指定された以前のインデント (これらのいずれもが未使用の場合 は デフォルト値) に設定します。

こ のマクロの後に続いた入力テキストの 1 行目は、左詰めに表示する 文字列として解釈され、ラベルとして使用するのに適切なものとなりま す。これは段落の一部であるとは解釈はされませんので、引き続く入力 行のテキストで 1 行目を満たそうとはしません。それでも、ラベル が インデント幅ほど広がっていない場合には、同じ行から段落が始まり ( ただし、インデントはされます)、次の行へと続いていきます。ラベ ル がインデント幅よりも広い場合は、段落の説明部分はラベルの次の行か ら始まり、すべてインデントされます。ラベルのフォントの形もサイズ もデフォルト値には設定されないことに注意してください。これに対し て、残りのテキストはデフォルトのフォント設定になります。

TP マクロは、あなたが今ちょうど読んでいるこの解説に使用されて い るマクロです。

.LP

.PP

.P

これらのマクロは、共通の別名です。これらのうちのどれを使用 しても現在の位置で行を打ち切ります。そして、その後に PD マク ロ で 指定した量だけ垂直方向にスペースを置きます。フォントのサイズ および形はデフォルト値に戻されます (10pt ローマン体)。最後 に、 現在の左側の余白の量とインデントを復元します。

.IP [designator] [nnn]

イ ンデントされた段落を設定します。その際、 designator を段落の 始まりに印をつけるためのタグとして使用します。インデント幅 は、 引 数 が与えられている場合は nnn に設定されます (省略されていれ ば、デフォルトの単位は ‘n’ です)。そうでない場合、 TP, IP, HP で 指定された以前のインデント (これらのいずれもが未使用の場合は デフォルト値) に設定します。 こ の 段 落 ( た だ し、 指 示 子 (designator) を含まず) のフォントサイズおよびフェースはデフォル ト値に戻されます。

特定のインデントをするが指示子をつけない段落を開始するには、第 2 引数に ‘""’ (ダブルクォート 2 つ) を使用してください。

例 えば次の段落は、‘.IP \(bu 4’ を用いて、すべて指示子として中点 をつけて設定されます。ブロック全体が ‘.RS’ と ‘.RE’ で括られてお り、左余白を一時的に現在のインデント値に設定します。

•

IP は、リストを整形するために man で使用される 3 つのマ クロのうちの 1 つです。

•

HP は、また別のマクロです。このマクロは、左側にぶら下 げ インデントされた段落を生成します。

•

TP は、また別のマクロです。このマクロは、インデントされ ないラベルを生成し、その後にインデントされた段落が 続 き ま す。

.HP [nnn]

左 側にぶら下げインデントされた段落を設定します。引数が与えられ ている場合、インデント幅は nnn に設定されます (省略されて い れ ば、 デ フォルトの単位は ‘n’ です)。そうでない場合、 TP, IP, HP で指定された以前のインデント (これらのいずれもが未使用の場合 は デ フォルト値) に設定します。引数が与えられていない場合、デフォ ルトのインデント幅が使用されます。フォントサイズおよびフェー ス はデフォルト値に戻されます。次の段落は、インデント幅を 4 に設定 されているときのこのマクロの効果を示したものです。ブロック全 体 が ‘.RS’ と ‘.RE’ で括られており、左余白を一時的に現在のインデ ント値に設定します。

この段落は、 HP マクロを実行したあとの段落です。見ての通り、この マクロは、最初の行を除いた行すべてがインデントされた段落を生 成しています。

.RS [nnn]

このマクロは、値が与えられていれば (デフォルト単位は ‘n’ で す) そ の値だけ左側の余白を右に移動します。そうでない場合、 TP, IP, HP で指定された以前のインデント (これらのいずれもが未使用の場合 は デフォルト値) に設定します。その後、インデント値は、デフォル トへ設定されます。

RS マクロの呼び出しは入れ子にできます。

.RE [nnn]

このマクロは、左側の余白を nnn レベルまで戻し、直前の左側の余白 を 回復します。引数が与えられていなければ、このマクロはレベルを 1 つだけ戻します。第 1 レベル (すなわち、まだ RS を呼び出してい ない) は番号 1 を持っており、 RS マクロを呼び出すごとにレベルが 1 ずつ増加します。

まとめると、次のマクロは、垂直方向にスペースを入れた行の折り返しを行 い ます (スペースの量は PD マクロを使用すると変更できます): SH, SS, TP, LP (PP, P), IP, HP 。マクロ RS および RE も行を折り返しますが、垂直方向 に スペースを入れません。

標 準フォントはローマン体です。そして、デフォルトのテキストサイズは 10 ポイントです。

.SM [text]

同じ行にあるテキストあるいは次の入力行にあるテキストが、デ フォ ルトのフォントよりも 1 ポイントだけ小さいフォントで表示されるよ うになります。

.SB [text]

同じ行にあるテキストあるいは次の入力行にあるテキストが、ボー ル ド体のフォントで、そしてデフォルトのフォントよりも 1 ポイントだ け小さいフォントで表示されるようになります。

.BI text

同じ行にあるテキストが、ボールド体とイタリック体を交互に使っ て 表 示されるようになります。テキストはマクロ呼び出しと同じ行にあ ることが必要です。したがって、

.BI this "word and" that

という行は、‘this’ と ‘that’ がボールド体で表示され、それに対 し て ‘word and’ の部分はイタリック体で表示されます。

.IB text

テ キストが、イタリック体とボールド体を交互に使って表示されるよ うになります。テキストはマクロ呼び出しと同じ行にあることが必 要 です。

.RI text

マ クロ呼び出しと同じ行にあるテキストが、ローマン体とイタリック 体を交互に使って表示されるようになります。テキストは、マクロ 呼 び出しと同じ行にあることが必要です。

.IR text

マ クロ呼び出しと同じ行にあるテキストが、イタリック体とローマン 体を交互に使って表示されるようになります。テキストは、マクロ 呼 び出しと同じ行にあることが必要です。

.BR text

マ クロ呼び出しと同じ行にあるテキストが、ボールド体とローマン体 を交互に使って表示されるようになります。テキストは、マクロ呼 び 出しと同じ行にあることが必要です。

.RB text

マ クロ呼び出しと同じ行にあるテキストが、ローマン体とボールド体 を交互に使って表示されるようになります。テキストは、マクロ呼 び 出しと同じ行にあることが必要です。

.B [text]

text がボールド体で表示されるようになります。マクロが呼び出され た行にテキストがない場合は、次の入力行のテキストがボールド体 で 表示されます。

.I [text]

text がイタリック体で表示されるようになります。マクロが呼び出さ れた行にテキストがない場合は、次の行のテキストがイタリック体 で 表示されます。

出 力 デ バイス用のインデント幅は、troff モードでは 7.2n であり、 nroff モードでは 7n です。 grohtml は例外で、インデントを無視します。

.DT

0.5 インチごとにタブを設定します。このマクロは常に TH リク エ スト中で呼ばれるため、タブ位置が変更された場合に限って呼び出 すことには意味があります。

.PD [nnn]

新しい段落やセクションの前のスペースを調整します。オプション の 引 数 は、スペースの量を与えます (デフォルトの単位は ‘v’)。パラ メータ無しの場合、この値はデフォルト値に戻されます (nroff モー ド で は 1 行で、それ以外では 0.4v)。このリクエストは、 SH, SS, TP, LP (それぞれ PP および P), IP, HP マクロに影響を与えます。

.AT [system [release]]

AT&T のマニュアルページを使用するためにフッタを変えます。このコ マンドは互換性のためだけにあるので、使用しないでください。詳 細 は groff info マニュアルを参照してください。

.UC [version]

BSD のマニュアルページを使用するためにフッタを変えます。このコ マンドは互換性のためだけにあるので、使用しないでください。詳 細 は groff info マニュアルを参照してください。

.PT

ヘッダ文字列を印字します。ヘッダを制御するためには、このマ クロを再定義してください。

.BT

フッタ文字列を印字します。フッタを制御するためには、このマ クロを再定義してください。

次の文字列が定義されています:

\*S

デフォルトのフォントサイズに戻します。

\*R

「登録」マークです。

\*(Tm

「商標」マークです。

\*(lq

\*(rq

左 お よ び右クォートです。これは、それぞれ ‘\(lq’ と ‘\(rq’ と同じです。

\*(HF

見出しと副見出しを印字するタイプフェースです。デフォルト は ‘B’ です。

tbl あるいは eqn のようなプリプロセッサが必要な場合、マニュアルページの 1 行目を次のように見えるようにする例になります:

.\" word

ダブルクォートの後には空白文字 1 つが入ることに注意してください。 word は、 必要なプリプロセッサを表す文字で成り立っています。 ‘e’ は eqn を表 し、 ‘r’ は refer を、そして ‘t’ は tbl を表します。最近の man プログラ ムの実装では、この 1 行目を読んで自動的に正しいプリプロセッサを呼び出し ます。

man.tmac

an.tmac

これらは、 andoc.tmac を呼び出すラッパファイルです。

andoc.tmac

このファイルは、 man マクロまたは mdoc パッケージのいずれを使用 すべきかを判定します。

an-old.tmac

全 man マクロが、このファイルに含まれます。

man.local

ローカルの修正とカスタマイズは、このファイルに入れます。

man マクロは、 groff リクエストの集まりでできていますので、原理的には、 必要がある場合には自己流の groff リクエストを作って man の機能を追加 す ることができます。すべてのリクエストの完全な参照は、groff info ページを 参照してください。

tbl(1), eqn(1), refer(1), man(1)

このマニュアルページは、本来 Debian GNU/Linux システム 用 に Susan G. Kleinmann <sgk@debian.org> が 書 いたものです。それを Werner Lemberg <wl@gnu.org> が修正し、更新しました。それが今では GNU troff 配布物の 一 部になっています。