構文
man file ...
nroff -man [option]... [file]...
説明
man マクロは、 man および nroff コマンド man(1) および nroff(1) を参照) によって使用され、 ― さらに、 troff (他社のマニュアルを参照) によって使用可能で、― 『HP-UX Reference』 および他の関連リファレンスマニュアル内にあるオンラインバージョンのマンページを書式化することができます。 man コマンドは、 nroff を呼び出します。
man
および nroff のデフォルト値
デフォルトのページサイズは、85 文字 66 行 (8.5×11
インチ) で、75 文字 60 行のテキスト領域を持ちます。 ハイフネーションはオフになり、パラグラフは左詰めされ、右端は不揃いになります。
troff
のデフォルト値
デフォルトのページサイズは、8.5×11 インチで、6.5×10
インチのテキスト領域を持ちます。 タイプサイズは 10 ポイントで、行間隔は
12 ポイントです。 ハイフネーションはオンになり、パラグラフは左右で揃えられます。
他のデフォルト値
タイプフォントとタイプサイズは、各パラグラフの前、および、 .I, .RB,
および .SM などのフォント設定マクロやサイズ設定マクロを処理した後に、デフォルト値にリセットされます。タブストップは、 .DT や .TH 以外のマクロでは、使用されず、設定されません。 .TH マクロは .DT を実行します
(以下を参照)。
オプション
nroff または troff には、以下のオプションを指定することができます。 これらのオプションは、 man コマンドには許可されていません。
| -rs1 | | troff の寸法を 4.75×8.375 インチのテキスト領域を持つ
6×9 インチのページサイズに、タイプサイズを 9 ポイントに、行間隔を
10 ポイントに削減します。 このオプションは、 nroff によって無効になります。 |
| -rV2 | | 特定のパラメータに特殊な Versatec プリンタに適した値を設定します。つまり、行長を
82 文字 (ens) に、ページ長を 84 行に、アンダーラインを禁止に設定します。
このオプションと man コマンドの -Tvp オプションを混同しないでください。後者は
HP-UX 以外の一部のオペレーティングシステムで使用可能なオプションです。 |
マクロ、文字列、および数値の一覧
定義済みの man のマクロ、文字列、および数値の一覧をここで記載し、次の項で詳細に説明します。
| .B | | text をボールド体で設定します。 |
| .BC | | word をボールド体と固定幅フォントと交互に設定します。 |
| .BI | | word をボールド体とイタリック体と交互に設定します。 |
| .BR | | word をボールド体とローマン体と交互に設定します。 |
| .C | | text を固定幅フォントで設定します。 |
| .CB | | word を固定幅フォントとボールド体と交互に設定します。 |
| .CD | | コマンド名を指定します。 |
| .CI | | word を固定幅フォントとイタリック体と交互に設定します。 |
| .CR | | word を固定幅フォントとローマン体と交互に設定します。 |
| .CT | | 引用文のタイトルを指定します。 |
| .DT | | デフォルトのタブ設定を復元します。 |
| .EM | | 強調を指定します。 |
| .ER | | エラー名を指定します。 |
| .EV | | 環境関数名を指定します。 |
| .GT | | 用語集の用語を指定します。 |
| .HP | | ぶら下げインデント付きのパラグラフを開始します。 |
| .I | | text をイタリック体で設定します。 |
| .IB | | word をイタリック体とボールド体と交互に設定します。 |
| .IC | | word をイタリック体と固定幅フォントと交互に設定します。 |
| .IP | | 任意指定のタグを付けてインデントされたパラグラフを開始します。 |
| .IR | | word をイタリック体とローマン体と交互に設定します。 |
| .KC | | キーキャップを指定します。 |
| .P | | 通常のパラグラフを開始します。 |
| .PD | | パラグラフ間隔を設定します。 |
| .PM | | Bell System 所有のサブフッタを使用します。 |
| .PP | | 通常のパラグラフを開始します。 |
| .RB | | word をローマン体とボールド体と交互に設定します。 |
| .RC | | word をローマン体と固定幅フォントと交互に設定します。 |
| .RE | | 相対的なマージンインデントを終了します。 |
| .RI | | word をローマン体とイタリック体と交互に設定します。 |
| .RS | | 相対的なマージンインデントを開始します。 |
| .RV | | 戻り値を指定します。 |
| .S3 | | 第 3 レベルのヘッダを挿入します。 |
| .SC | | システム定数名を指定します。 |
| .SH | | 項のヘッダを挿入します。 |
| .SM | | text を 1 ポイントだけ小さくプリントします。 |
| .SS | | 副項目のヘッダを挿入します。 |
| .TH | | 新しいマンページを開始し、ページのヘッダおよびフッタを定義します。 |
| .TP | | タグ付きのパラグラフを開始します。 |
| \*R | | 登録商標 |
| \*S | | デフォルトのタイプサイズに変更します。 |
| \*(Tm | | 商標 |
| \n(IN | | 左テキストマージン。つまり、デフォルトのマージンインデントおよびパラグラフインデント |
| \n(LL | | \n(IN を含む行長 |
| \n(PD | | パラグラフ間の距離 |
マクロパラメータ
すべてのマクロパラメータは、位置で指定されるので、省略して右のパラメータから開始することができます。
それぞれのパラメータは、以下に説明するように、 意味のあるワード(word) です。
| mi | | マージンの増分。 これは、左テキストマージンを増加する量です。
省略すると、デフォルトとして \n(IN 基本単位
(u) を使用します。 mi のデフォルトの寸法は ens (n) です。
左テキストマージンの基本の値は \n(IN です。 |
| in | | パラグラフインデント。 これは、パラグラフのインデントされる行をインデントする量です。
省略すると、デフォルトとして最新のパラグラフマクロによって設定された値を使用します。
つまり、 .HP、 .IP、 または .TP によって明示的に設定されるかまたはデフォルトとして解釈された値、あるいは、 .P、 .PP、 .RE、
または .RS によって暗黙に設定された値がデフォルトとして使用されます。 in のデフォルトの寸法は、ens (n)
です。 |
| text | | ゼロから 6 個までの word で構成されます。 text が空の場合には、次のプリントすべきテキストを含む行に特殊な扱いが適用されます。 例えば、 .I を使用すると行全体をイタリック体にすることができ、 .SM の後に .B を付けてを使用すると小さなボールド体のテキストを作成します。 |
| word | | スペース (タグではない) で区切られた文字の列です。
引用符を使用する (" [word]" ) と、 word の中にスペースを含めたり (" string string " )、ヌルの word を指定したり ("" ) することができます。
(非分割のパディング不能なスペース (\ )
は、分割スペースではありません。) |
ヘッダに関するマクロ
| .TH t1 s2 c3 n4 a5 |
| | | 表題とエントリの見出しを設定します。 t1、 s2、 c3、 n4、 および a5 は word | t1 | | エントリの表題 | | s2 | | セクション番号。 t1 と、かっこで囲まれた s2 を合わせたものが、ページの左上隅、右上隅の見出しになります。 | | c3 | | 「Optional Software Required」などの特殊なコメント。2 行または
3 行のページ見出し領域の最下行の中央に、かっこで囲って表示されます。 | | n4 | | 「Series 300/400 Only」などの他の表記法。 これは、最初のページ見出し行のタイトルと項の間の中央に表示されます。 | | a5 | | 代わりの名前付け用。例えば、 t1 という名の C 関数に相当する FORTRAN ルーチンの名前など。 |
結果の出力は次の形式です。
|
| .SH text | | 『構文』 などの項の見出しの text をここに指定します。 項の見出しは、左マージンから始まります。
項の見出しは、通常すべて大文字なので、 troff 内で 1 ポイント小さいサイズでプリントされます。 |
| .SS text | | Options などの副項目の見出しの text をここに指定します。 副項目の見出しは、左マージンと通常のテキストインデントの間から始まります。 |
| .S3 text | | 副見出しなどの第 3 レベルの見出しの text をここに指定します。 第 3 レベルの見出しは、通常のテキストインデントから始まります。 |
パラグラフに関するマクロ
| .P | | |
| .PP | | ブロックパラグラフを開始します。 in を \n(IN にリセットして、以前の .HP、 .IP、
および .TP マクロによって設定した値をすべて「取り消します」。 |
| .HP in | | ぶら下げインデント付きのパラグラフを開始します。
テキストは、現在のマージンから始まります。 2 行目以降の出力行はインデントされます。 |
| .TP in | | 見出しタグを付けてインデントされたパラグラフを開始します。
プリントするテキストを含む次の入力行は、そのタグとして利用されます。
タグは現在のマージンから始まります。 タグがインデント内に収まる場合には、パラグラフテキストは同じ行のインデント位置から始まります。
タグがインデント内に収まらない場合には、パラグラフテキストは次の行のインデント位置から始まります。 |
| .IP t in | | タグ t を付けた .TP in と同じです。 タグなしでインデントされたパラグラフを置くために頻繁に使用されます。 |
| .RS mi | | 現在の左マージンを mi だけ増加させます。 mi を省略すると、デフォルトとして現在の in の値を使用します。 新しいマージンレベルのパラグラフインデント in を \n(IN に設定します。
指定できる .RS 増分レベルは 9 つまでです。 マージンの増分は、 .RE マクロによって取り消すことができ、 .TH、 .SH、 .SS、
および .S3 ヘッダマクロによって基本のマージンにリセットすることができます。 |
| .RE k | | k 番目 (最初は k=1 で、 k=0 は k=1 と同じです) の左マージンの設定値に戻します。 k を省略すると、前のマージン値に戻します。 パラグラフインデント in は、対応する .RS マクロの前に設定されていた値に復元されます。 |
| .PD pd | | パラグラフ間の距離を pd で示す縦の間隔に設定します。 pd を省略すると、パラグラフ間の距離は、 nroff では 1 行、 troff では 0.4 行というデフォルト値に設定されます。 pd の寸法は縦の行間隔 (v) です。 |
フォントに関するマクロ
| .B text | | text をボールド体に設定します。 |
| .C text | | text を固定幅フォントに設定します。 「警告」の項を参照してください。 |
| .I text | | text をイタリック体に設定します。 |
(.R (ローマン) マクロはありませんが、必要なら、 .XY の組み合わせの 1 つを使用することができます。)
| .XY a b | | フォント X の a とフォント Y の b を連結して、6 個までの word に対してこれらの 2 つのフォントを交互に設定します。
フォント文字 X および Y には、以下の組み合わせで、 B (ボールド)、 C (固定幅フォント)、 I (イタリック)、および R (ローマン)
を指定することができます。 .CB .IB .RB
.BC .IC .RC
.BI .CI .RI
.BR .CR .IR 固定幅フォントについては、「警告」の項を参照してください。 |
| .SM text | | text をデフォルトのポイントサイズよりも 1 ポイント小さくします。
これは、 nroff では効果がありません。 |
特殊なマクロ
これらのマクロは、マンページ内の一般的なテキスト要素を指定します。
これらのマクロは、HP の書体の中で統一されているフォントの使用を提供したり、他の書式化システムへの変換を利用したりする手助けになります。
最初のパラメータは、適切な書体 (フォント) またはフォーマットに設定されます。
2 番目のパラメータ punctuation は、ローマン体で設定され、連結される句読点に与えられます。
この 2 つのパラメータは、フォントマクロの場合と同様に連結されます。
| .CD commandname punctuation |
| | | commandname は、 man などのコマンド名で、通常は、セクション 1 または 1M のマンページ内に定義されています。
これは、固定幅フォントで表示されます。 |
| .CT citationtitle punctuation |
| | | citationtitle は、 『HP-UX Reference』 などのドキュメントの名前です。
これは、イタリックで表示されます。(マンページリファレンスには、標準の .IR マクロを使用します。) |
| .EM emphasis punctuation |
| | | emphasis は、 Do not(してはいけません)
などの強調したいワードまたはフレーズです。 強調は多用しないでください。これは、イタリック体で表示されます。
(変数名には、標準の .I マクロを使用します。) |
| .ER errorname punctuation |
| | | errorname は、関数によって errno に代入されマンページの
ERRORS の項で説明される値に対応するエラー名です。 これは、大かっこで囲まれたローマン体で表示されます。
例えば、 .ER EIO . は EIO のように表示されます。 |
| .EV environvarname punctuation |
| | | environvarname は、 PATH のような環境変数の名前です。
これは、固定幅フォントで表示されます。 |
| .GT glossterm punctuation |
| | | glossterm は、 path name (パス名) などの用語集の用語、または後で使用するためにユーザーがマンページ内で定義している用語です。
これは、ボールド体で表示されます。 |
| .KC keycap punctuation |
| | | keycap は、 Tab などのキーボードキーの名前です。 これは、ボールド体で表示されます。 |
| .RV returnvalue punctuation |
| | | returnvalue は、通常、「戻り値」または「終了ステータス」の項で定義される、関数の戻り値またはコマンドの終了ステータスです。
これは、通常、 0、 >3、
および <>0 などの数値式に対して使用されますが、"nonzero"
などのワードによる説明には使用されません。 これは、固定幅フォントで表示されます。 |
| .SC systemconstant punctuation |
| | | systemconstant は、 PATH_MAX などのオペレーティングシステムの通常の名前です。
これは、固定幅フォントで表示されます。 getconf(1) を参照してください。 |
他のマクロ
| .DT | | デフォルトのタブ設定 (troff では半角で 3.6 文字、 nroff では半角で 5 文字) に戻します。 |
| .PM sf | | Bell System 所有のサブフッタを生成します。 | sf | | によって、次のように 生成されます。 | | P | | PRIVATE | | N | | NOTICE | | BP | | BELL LABORATORIES PROPRIETARY | | BR | | BELL LABORATORIES RESTRICTED |
|
文字列
次の文字列が定義されています。
| \*R | | 登録商標記号 : nroff 内では (Reg.) として表示され、 troff 内では \(rg インラインマクロを使用しています。 |
| \*S | | デフォルトのタイプサイズに変更します。 これは、 \s インラインマクロとして実行されます。 |
| \*(Tm | | 可能なら上付けとして表示される商標指示記号 TM です。 |
数値
以下の数値参照が定義されています。
| \n(IN | | セクション見出しから相対的に見た左余白インデントの mi、 および in 用のデフォルト (troff では半角で 3.6 文字、 nroff では半角で 5 文字) \n(IN は、基本単位
(u) で表されます。 |
| \n(LL | | \n(IN を含む行長で、 nroff では 75 文字、 troff では 6.5 インチです。 「オプション」の項も参照してください。 LL は、基本単位
(u) で表されます。 |
| \n(PD | | 現在のパラグラフ間の距離です。 .PD によって設定します。 PD は、縦の行間隔
(v) で表されます。 |
寸法
nroff および troff は、多数の尺度指示子を使用して、縦または横の寸法を示します。 マクロパラメータの多くは、デフォルトの寸法の単位を持っています。
数値変数へのすべての割り当ては基本単位 (u) に変換されるので、値を割り当てたり参照したりする際に注意することが重要です。
| 尺度 | | 基本単位 |
|---|
| 指示子 | 寸法 | troff | nroff |
|---|
| c | センチメートル | 240/2.54 | D/2.54 |
| i | インチ | 240 | D |
| m | em | C | p*S |
| n | en = em/2 | C | p*S/2 |
| p | ポイント = 1/72 インチ | 240/72 | D/72 |
| P | パイカ = 1/6 インチ | 240/6 | D/6 |
| u | 基本単位 | 1 | 1 |
| v | 縦の行間隔 | V | V |
| C | | 出力デバイスの文字幅 |
| D | | 出力デバイスの 1 インチあたりのドット数 (dpi) |
| S | | ポイントで表した現在のタイプサイズ |
| V | | 基本単位で表した現在の縦の行間隔 |
フォントの使い分け
『HP-UX リファレンス』のエントリでは、次のようにフォントを使い分けています。
| roman | | 通常のタイプフェースです。 |
| italic | | 変数などの語で、ユーザー定義の値や変化する値を持つ引き数を表します。また、 強調 のためにも用いられます。 |
| boldface | | 主として見出しとして用いられますが、場合によっては、用語が最初に現れる場所や定義される場所でも用いられます。 |
| constant-width | | キーボードコマンドやコマンド行オプション、プログラム中などで用いられるもので、正確にそのままタイプされる字面のすべてに用います。 |
ページフッタ
ページフッタで用いられる文字列は .TH マクロで初期化されます。 )H は、デフォルトとして非プリント
(ヌル) 文字列を使用します。 ]W は、 Formatted: July
5, 1995 内に記載されるように、デフォルトとして、マンページが書式化された日付を使用します。
HP マンページでは、 )H には会社の名前 "Hewlett-Packard
Company" が設定されます。 ]W には、"HP-UX Release
10.10: November 1995" 内に記載されるように、リリース情報が設定されます。
この機能を使えば、ユーザーや他社のソフトウェア提供者が、独自のマニュアルエントリを作成する際に、必要に応じて、フッタ行の左右フィールドを直接使って社名やリリースバージョンなどを表示することができます。文字列 )H は左に表示されます。文字列 ]W は右に表示されます。ページ番号は中央に表示されます。文字列の定義は、 .TH マクロコールの後ならどこで行ってもかまいません。ただし、その定義は、最初のページの末尾よりも前に現れなければなりません。次に、ソースファイルの部分を例として示します。
.TH man 5
.ds )H XYZ Company
.ds ]W Release 2.3: May 1996
すると、次のようなフッタが生成されます。
| XYZ Company | - 1 - | Release 2.3: May 1996 |
表
tbl プリプロセッサ tbl(1) を参照) を使用すると、マンページ内に表を挿入することができます。 man マクロによって、標準的な tbl マクロ .TS、 .T&、
および .TE を使用することができます。 これらのマクロは、 mm マクロ展開、 .TS H および .TH をサポートしていません mm(5) を参照)。
通常の場合、テーブル内では man マクロを使用しないようにします。特にフォントマクロは、予想外の結果を生成する可能性があります。
代わりに nroff/troff 組み込みマクロを使用します。
例えば、ボールドタイプを指定するには、インラインマクロ \fB を使用するか、またはもっと一般的には \f3 を使用します。
横方向の空白行を挿入するには、そのテーブルの前に何があるかによって、 .PP または .IP マクロを使用することができますが、その後に、 center および expand のテーブルフォーマット指定を使用しないようにしなければなりません。
そうでないと、インデントがエラーとなる可能性があります。
警告
HP は、プリントされたマニュアルに目次およびインデックスを準備するために、もう NAME
というセクションを使用することはありません。 その代わり、この情報はそれぞれのマンページ
ソースファイルの最後にコメントとしてコードされています。希望があれば、各種のツールおよびプログラムによって、この情報をそこからアクセスすることができます。
NAME セクションは、後で説明するように、 whatis データベースではまだ使用されています。
HP-UX Reference をプリントするためにマクロパッケージを使用すると、各エントリの 『構文』 の項のワード間のスペースが増加します
(あいまいさを除去するため)。
上記のマクロ、文字列、数値レジスタ以外に、多数の内部マクロ、文字列、数値レジスタが定義されています。
定義されているものは、次のとおりです。
nroff/troff プロセッサによってあらかじめ定義されている名前
)x, ]x, および }x の形式のマクロ、文字列、および数値の名前。この x は、なんらかの英数字を表します。
XY の形式のマクロ、文字列、および数値の名前。この X および Y は、英字の大文字です。
フォント
nroff は、ローマン、イタリック、ボールドという 3 つのフォントだけを使用し、それぞれフォント位置
1、2、および 3 で示されます。 マクロパッケージ内の固定幅フォントのフォントマクロ
(.C、 .RC、 .IC、 .BC、 .CR、 .CI、 .CB)
は、固定幅フォントをボールド体でシミュレートします。その理由は、すべての nroff 出力が固定幅フォントまたはタイプライタフォーマットであるためです。
troff によって本当の固定幅フォントを使用するには、それぞれの固定幅フォントのフォントマクロ内の該当するフォント
3 の指定をフォント 4 に変更して、次のように、 troff .fp 要求を使用して、位置 4 に固定幅フォントを設定します。
whatis
データベース
それぞれのマンページの「名称」の項は、 catman catman(1M) を参照) が処理して、 whatis データベース内にエントリを作成します。このエントリは、 man コマンドの -f および -k オプションによって使用されます。 catman は、「名称」の項の行を次のフォーマットで
1 行に処理します。
name[, name]... - explanatory-text
ハイフン (- または \- として入力される)、二分ダッシュ
(\(mi), および全角ダッシュ (\(em)
は、同じに扱われます。 行内の最後のスペース-ハイフン-スペースは、名前と説明のテキストの間の分割点になります。
ファイル
| /usr/share/lib/macros/an |
| | | man マクロ |
| /usr/share/lib/tmac/tmac.an |
| | | man によって呼び出されます。 /usr/share/lib/macros/an 内にあるマクロ
(.so) のソースです。 ここで他のマクロファイルを指定すると、マンページに追加のマクロ要求を与えることができます。 |
| /usr/share/lib/whatis |
| | | マンページの「名称」の項からの文字列のファイルで、 catman によって作成され、 man -k および -f オプションによって使用されます。 |
参照
col(1), man(1), neqn(1), nroff(1), tbl(1), catman(1M), mm(5)
印刷用画面へ 
