groff_man(7) FreeBSD 一般コマンドマニュアル

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

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

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

       -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' と
              すると、マニュアルページの特定のサブセクションを 示
              し ます。 titlesection は、ともにヘッダ行の左端
              と右端に置かれます (括弧でくくられ た  sectiontitle の直後に付きます)。 extra1 は、フッタ行の中央
              に置かれます。 extra2 は、フッタ行の左に置かれま す

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

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

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

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

       .IP [designator] [nnn]
              インデントされた段落を設定します。その際、 designa-
              tor  を段落の始まりに印をつけるためのタグとして使用
              します。インデント幅は、引数が与えられている場合 は
              nnn  に設定されます (デフォルトの単位は `n' です)。
                  ぶら下げインデントされた段落を生成します。

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

       .HP [nnn]
              左側にぶら下げインデントされた段落を設定します。 引
              数が与えられている場合、インデント幅は nnn に設定さ
              れます (デフォルトの単位は `n' です)。引数が与え ら
              れ ていない場合、デフォルトのインデント幅が使用され
              ます。フォントサイズおよびフェースはデフォルト値 に
              戻されます。次の段落は、インデント幅を 4 に設定され
              ているときのこのマクロの効果を示したものです:

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

       .RS [nnn]
              このマクロは、値が与えられていれば (デフォルト単 位
              は `n' です) その値だけ左側の余白を右に移動します。
              値が与えられていなければ、デフォルトのインデント 幅
              が 使用されます。 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 ポイントだけ小さいフォントで表示される

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

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

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

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

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

       .R [text]
              text   がローマン体フォントで表示されるようになりま
              す。マクロが呼び出された行にテキストがない場合 は、
              次 の 行 のテキストがローマン体で表示されます。これ
              が、他のマクロを処理し終わったときに返されるテキ ス
              トのデフォルトのフォントです。

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

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


その他

       grohtml  を除いた出力デバイス用のインデント幅はすべて 7.2n
       です。 grohtml の場合はインデントを無視します。

       .DT    0.5 インチごとにタブを設定します。このマクロは常 に
              TH リクエスト中で呼ばれるため、タブ位置が変更された

       \*R    「登録」マークです。

       \*(Tm  「商標」マークです。

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

       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.tmacman マクロが、このファイルに含まれます。

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


関連項目

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

         http://www.cs.pdx.edu/~trent/gnu/groff/groff_toc.html
       から入手できます。

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


作者

       このマニュアルページは、本来 Debian GNU/Linux システム用に
       Susan G. Kleinmann <sgk@debian.org> が書いたものです。それ

ABELNET VPSサービス