.\" SUCH DAMAGE.
.\"
.\" @(#)mdoc.samples.7 8.2 (Berkeley) 12/30/93
-.\" %FreeBSD: src/share/man/man7/mdoc.samples.7,v 1.28.2.9 2001/03/13 17:54:18 ru Exp %
+.\" $Id: mdoc.samples.7,v 1.17 1998/12/03 03:38:45 jkoshy Exp $
.\"
.\" This tutorial sampler invokes every macro in the package several
.\" times and is guaranteed to give a worst case performance
.\" for an already extremely slow package.
.\"
-.\" jpman %Id: mdoc.samples.7,v 1.4 1999/01/21 17:52:58 kuma Stab %
+.\"*******************************************************************
.\"
-.\" WORD: display 表示内容
-.\" WORD: angle bracket カギ括弧 <>
-.\" WORD: keep キープ
-.\" WORD: display ディスプレイ
-.\" WORD: literal リテラル
-.\" WORD: content macro コンテントマクロ
-.\" WORD: command modifier コマンド修飾子
-.\" WORD: enclosure 囲い
-.\" WORD: quoting クォート
-.\" WORD: nest 入れ子
-.\" WORD: block ragged 凹凸ブロック
-.\" WORD: constant width character 定幅文字
+.\" This file was generated with po4a. Translate the source file.
.\"
+.\"*******************************************************************
.Dd December 30, 1993
.Os
.Dt MDOC.SAMPLES 7
-.Sh 名称
+.Sh 名前
.Nm mdoc.samples
-.Nd
+.Nd
.Nm \-mdoc
を使って
.Bx
マニュアルを書くためのチュートリアルサンプル
.Sh 書式
.Nm man mdoc.samples
-.Sh 解説
+.Sh 説æ\98\8e
.Xr troff 1
用の
.Em コンテントベース
マニュアルを書くためのチュートリアルサンプルです。
前身である
.Xr \-man 7
-パッケージはフォントの操作や他の写植方法の詳細は個々の作者に任せた
-ページレイアウトベースのものでした。
+パッケージはフォントの操作や他の写植方法の
+詳細は個々の作者に任せたページレイアウトベースのものでした。
.Nm \-mdoc
では、ページレイアウトマクロは
タイトル、セクションのヘッダ、ディスプレイ、リストのマクロからなる
.Em "ページ構造領域"
-を形成しています。
-ページ構造領域に加え、
-さらにマニュアル領域および一般テキスト領域の 2 つの領域があります。
-一般テキスト領域はテキストの一部をクォートしたり、強調するといったような作業を
-実行するマクロとして定義されています。
+を形成しています。これらの項目は整形された
+ページでのテキストの物理的な位置に影響を持ちます。
+ページ構造領域に加え、さらにマニュアル領域および一般テキスト領域
+の 2 つの領域があります。
+一般テキスト領域はテキストの一部をクォートしたり、
+強調するといったような作業を実行するマクロとして定義されています。
マニュアル領域はコマンドやルーチン、それに
.Bx
の関連ファイルを記述するための日常使用されるインフォーマルな言葉の
マニュアルのエントリは、実際の長さに関わらず、
また男女の区別をするような意図なしで、
.Ux
-のマニュアルページを通して、単純に man ページとして参照されています。
+のマニュアルページを通して、
+単純に man ページとして参照されています。
.Sh さあ、始めよう
通常チュートリアルドキュメントは、そこに示された題材をすぐに使いたい時
-に読むものですので、このドキュメントのユーザはせっかちな人だと
-仮定しています。
-このドキュメントの残りの部分で説明されている題材は以下のような構成に
-なっています。
+に読むものですので、このドキュメントのユーザはせっかちな人だと仮定して
+います。このドキュメントの残りの部分で説明されている題材は以下のような
+構成になっています。
.Bl -enum -offset indent
-.It
+.It
.Tn "TROFF に特有な表現"
.Bl -tag -width flag -compact -offset indent
.It "マクロの使用方法"
.It "引数に空白文字を指定する"
-.It "行末の空白文字 (警告)"
-.It "特殊文字のエスケープ"
+.It 行末の空白文字 (警告)
+.It 特殊文字のエスケープ
.El
-.It
+.It
.Tn "MAN ページの分析"
.Bl -tag -width flag -compact -offset indent
.It "マニュアルページのテンプレート"
.El
-.It
+.It
.Tn "タイトルマクロ"
-.It
-.Tn "マニュアル領域および一般テキスト領域の紹介"
+.It
+.Tn "マニュアルと一般テキスト領域の紹介"
.Bl -tag -width flag -compact -offset indent
.It "この名前には何が...?"
.It "一般的な構文"
.El
-.It
+.It
.Tn "マニュアル領域"
.Bl -tag -width flag -compact -offset indent
-.It "アドレス"
+.It アドレス
.It "作者名"
-.It "引数"
+.It 引数
.It "コンフィギュレーション宣言 (セクション 4 のみ)"
.It "コマンド修飾子"
.It "定義済みの変数"
.It "環境変数"
.It "関数の引数"
.It "関数の宣言"
-.It "フラグ"
+.It フラグ
.It "関数 (ライブラリルーチン)"
.It "関数の型"
-.\" .It "ヘッダファイル (ソースコードを含む)"
-.It "ライブラリ名"
+.\" .It "Header File (including source code)" .
.It "対話的なコマンド"
-.It "名称"
-.It "オプション"
-.It "パス名"
-.It "標準"
-.It "変数"
-.It "クロスリファレンス"
-.El
-.It
+.It 名前
+.It オプション
+.It パス名
+.It 変数
+.It 相互参照
+.El
+.It
.Tn "一般テキスト領域"
.Bl -tag -width flag -compact -offset indent
.It "AT&T マクロ"
.It "BSD マクロ"
-.It "FreeBSD/NetBSD/OpenBSD マクロ"
+.It "FreeBSD マクロ"
.It "UNIX マクロ"
-.It "囲い/クォート マクロ"
+.It "囲い/クォートマクロ"
.Bl -tag -width flag -compact -offset indent
.It "カギ括弧 <> によるクォート/囲い"
.It "角括弧 [] によるクォート/囲い"
.El
.It "no\-op もしくは通常テキストマクロ"
.It "空白なしマクロ"
-.It "セクションのクロスリファレンス"
-.It "参考文献と引用"
-.It "戻り値 (セクション 2 および 3 のみ)"
+.It "セクションの相互参照"
+.It "相互参照と引用"
+.It "返り値 (セクション 2, 3 のみ)"
.It "商標名 (頭字語とタイプ名)"
.It "拡張引数"
.El
-.It
+.It
.Tn "ページ構造領域"
.Bl -tag -width flag -compact -offset indent
.It "セクションヘッダ"
.It "段落と行スペース"
.It "キープ"
-.It "例示とディスプレイ"
+.It "ディスプレイ"
.It "フォントモード (強調、リテラル、およびシンボリック)"
.It "リストと列"
.El
-.It
+.It
.Tn "定義済みの文字列"
-.It
+.It
.Tn "診断"
-.It
-.Tn "GROFF、TROFF、および NROFF を使用したフォーマッティング"
-.It
+.It
+.Tn "GROFF、TROFF、NROFF を使用したフォーマッティング"
+.It
.Tn "バグ"
.El
+.ne 7
.Sh TROFF に特有な表現
.Nm \-mdoc
-パッケージは man ページを記述するプロセスを簡単にすることを
-目的としています。
+パッケージは man ページを記述するプロセスを簡単にすること
+を目的としています。
.Nm \-mdoc
を使うために
.Xr troff 1
-のゴタゴタした詳細を学ぶ必要がないのが理想ですが、
-ã\81\84ã\81\8fã\81¤ã\81\8bç\89\87ä»\98ã\81\91ã\82\8bã\81¹ã\81\8dé\81¿ã\81\91ã\82\89ã\82\8cã\81ªã\81\84å\88¶é\99\90äº\8bé \85ã\81\8cã\81\82ã\82\8aã\81¾ã\81\99ã\80\82
-また、このパッケージは高速で
+の
+ã\82´ã\82¿ã\82´ã\82¿ã\81\97ã\81\9f詳細ã\82\92å¦ã\81¶å¿\85è¦\81ã\81\8cã\81ªã\81\84ã\81®ã\81\8cç\90\86æ\83³ã\81§ã\81\99ã\81\8cã\80\81ã\81\84ã\81\8fã\81¤ã\81\8bç\89\87ä»\98ã\81\91ã\82\8bã\81¹ã\81\8d
+避けられない制限事項があります。また、このパッケージは高速で
.Em ない
ということも予め警告しておきます。
.Ss マクロの使用方法
.Xr troff 1
のように、マクロは
-.Ql \&\.
-(ドット文字)
-を行頭に置き、それに続けて 2 文字からなるマクロの名称を指定することによって
-呼び出されます。
-引数はマクロの後にスペースで区切って指定することができます。
+.Ql \&.
+(ドット文字) を行頭に置き、
+それに続けて 2 文字からなるマクロの名称を指定することによって呼び出され
+ます。引数はマクロの後にスペースで区切って指定することができます。
行頭にドット文字を指定することによって
.Xr troff 1
-にそれに続く 2 文字をマクロ名として解釈するよう指示しています。
-マクロを起動せずに、ある文脈の行の先頭に
-.Ql \&\.
-(ドット文字)
-を置くためには、
-.Ql \&\.
+にそれに続く 2 文
+字をマクロ名として解釈するよう指示しています。マクロを起動せずに、ある
+文脈の行の先頭に
+.Ql \&.
+(ドット文字) を置くためには、
+.Ql \&.
(ドット) の前にエスケープシーケンス
.Ql \e&
を指定します。
.Pp
一般的に
.Xr troff 1
-マクロは引数を 9 つまで取ることができ、それ以上指定された引数は無視されます。
+マクロは引数を 9 つまで取ることができ、
+それ以上指定された引数は無視されます。
.Nm \-mdoc
でのほとんどのマクロは 9 つの引数を取ることができ、
-限られた場合にのみ引数は次の行に続けて指定することができます (
+限られた場合にのみ引数は次の行に続けて指定することができます
+(
.Sx 拡張引数
セクションを参照)。
-いくつかのマクロは引用符に囲まれた引数を扱うことができます (下の
+いくつかのマクロは引用符に囲まれた引数を扱うことができます
+(下の
.Sx 引数に空白文字を指定する
セクションを参照)。
.Pp
呼び出し可能であると判断された引数リストの中の引数は、
実行されるか、それが処理される時に呼び出されることを意味しています。
この場合、引数はマクロ名にも関わらず、
-.Ql \&\.
-(ドット)
-で前置されません。
+.Ql \&.
+(ドット) で前置されません。
このようにしてたくさんのマクロを入れ子にすることができます。
例えばオプションマクロ
.Ql \&.Op
はフラグマクロ
.Ql \&Fl
-と引数マクロ
+と
+引数マクロ
.Ql \&Ar
を
.Em 呼び出して
-、オプションのフラグを引数とともに指定することができます。
+、
+オプションのフラグを引数とともに指定することができます。
.Bl -tag -width "\&.Op \&Fl s \&Ar bytes" -offset indent
.It Op Fl s Ar bytes
は
.Ql \&Fl
と
.Ql \&Ar
-はマクロとして解釈されていません。
-本ドキュメントと関連のクイックリファレンスマニュアル
+はマクロとして解釈されていませ
+ん。本ドキュメントと関連のクイックリファレンスマニュアル
.Xr mdoc 7
-を通して、
-引数リストが呼び出し可能な引数として解析されるマクロは「解析される」、
-引数リストから呼び出されることができるマクロは「呼び出し可能」
+を通して、引数リストが呼び出し可能な引数として解析されるマクロは「解析
+される」、引数リストから呼び出されることができるマクロは「呼び出し可能」
と表現します。
.Nm \-mdoc
-のほとんどすべてのマクロは解析されるのですから、これは技術的には
+のほとんどすべてのマクロは解析されるのです
+から、これは技術的には
.Em 不謹慎な
-ことですが、常にマクロを「呼び出し可能である」とか「他のマクロを
-呼び出すことができる」と表現するのは面倒なことであるため、
-「解析される」という用語が使われています。
+ことですが、常にマクロを「呼び出
+し可能である」とか「他のマクロを呼び出すことができる」と表現するのは面
+倒なことであるため、「解析される」という用語が使われています。
.Ss 引数に空白文字を指定する
-ひとつ以上の空白文字を含む文字列をひとつの引数として指定したい場合が
-よくあります。
-これは 9 個を越える引数を指定できないという制限に対処したり、
-引数のリストにある特有な配置をおこなうことが必要なマクロに引数を指定するような
-場合に必要となることがあります。
+ひとつ以上の空白文字を含む文字列をひとつの引数として指定したい場合がよ
+くあります。これは 9 個を越える引数を指定できないという制限に対処したり、
+引数のリストにある特有な配置をおこなうことが必要なマクロに引数を指定す
+るような場合に必要となることがあります。
たとえば、関数マクロ
.Ql \&.Fn
-では最初の引数は関数名であり、残りの引数が関数のパラメータであることが
-必要です。
+では最初の引数は関数名であり、残りの
+å¼\95æ\95°ã\81\8cé\96¢æ\95°ã\81®ã\83\91ã\83©ã\83¡ã\83¼ã\82¿ã\81§ã\81\82ã\82\8bã\81\93ã\81¨ã\81\8cå¿\85è¦\81ã\81§ã\81\99ã\80\82
.Tn "ANSI C"
-の括弧で囲まれたパラメータリストにおける関数のパラメータの宣言の規定に
-より、各パラメータは最低でも 2 語の文字列となります。
+の括弧で
+囲まれたパラメータリストにおける関数のパラメータの宣言の規定により、
+各パラメータは最低でも 2 語の文字列となります。
たとえば
.Fa int foo
のようになります。
.Pp
空白を含む引数を指定するには 2 通りの方法があります。
-.Em 実装における注 :
+.Em 実装上の注意 :
解析の前に個々の引数を再割り当てすることによって、
引用符の間に空白を含めて渡すのが最も便利な方法なのですが、
.Tn AT&T
の
.Xr troff
-のすべてのマクロを実装するには処理速度およびメモリ使用量の点で
-かなり高価な方法となります。
+のすべてのマクロを実装するには処理速度およ
+ã\81³ã\83¡ã\83¢ã\83ªä½¿ç\94¨é\87\8fã\81®ç\82¹ã\81§ã\81\8bã\81ªã\82\8aé«\98価ã\81ªæ\96¹æ³\95ã\81¨ã\81ªã\82\8aã\81¾ã\81\99ã\80\82
.Xr groff
では高価な処理にはなりませんが、移植性のため、この方法は
空白を含めることが最も必要である以下のマクロだけに限っています。
.It Li \&%R
報告書のタイトル (参照の中で)
.It Li \&%T
-æ\9b¸ç±\8dã\82\82ã\81\97ã\81\8fã\81¯定期刊行物の中の記事のタイトル
+æ\9b¸ç±\8dã\82\84定期刊行物の中の記事のタイトル
.El
.Pp
-空白を含む文字列を渡すのに、固定空白、すなわち詰め込まれない空白文字
-.Ql \e\
-を使う方法があります。すなわち、空白の前にエスケープ文字
+空白を含む文字列を渡すのに、固定空白、すなわち詰め込まれない
+空白文字
+.Ql \e\
+を使う方法があります。
+すなわち、空白の前にエスケープ文字
.Ql \e
を指定する方法です。
-この方法はどのマクロでも使うことができますが、1 行を越える長さのテキストの
-調整の邪魔になるという副作用があります。
-.Xr troff
-では固定空白は他の印刷可能文字と同様に扱われ、通常期待されるように、
+この方法はどのマクロでも使うことができますが、1 行を越える長さの
+テキストの調整の邪魔になるという副作用があります。
+.Xr Troff
+では
+固定空白は他の印刷可能文字と同様に扱われ、通常期待されるように、
そこで文字列を空白や改行で分けることを行なわなくなります。
この方法は文字列が行の境界をまたがないであろう場合に有用です。
例えば、
によって生成される
.It Fn fetch "char *str"
は
-.Ql \&.Fn fetch "\\*qchar *str\\*q"
+.Ql \&.Fn fetch "\*qchar *str\*q"
でも生成される
.El
.Pp
.Ql \e
や引用符が省かれると、
.Ql \&.Fn
-は引数を 3 つ取り、その結果は
+は引数を 3 つ取り、
+その結果は以下のようになります。
.Pp
.Dl Fn fetch char *str
.Pp
-となります。
-.Pp
パラメータのリストが改行の境界をまたぐ場合に何がおこるかについては、
.Sx バグ
のセクションを参照してください。
.Ss 行末の空白文字
-.Xr troff
+.Xr Troff
は行末に空白文字があると混乱してしまうことがあります。
-<空白><行末>の文字シーケンスからすべての空白文字を取り除くのは良い予防策です。
+<空白> <行末> の文字シーケンスからすべての
+空白文字を取り除くのは良い予防策です。
どうしても行末に空白文字をおく必要性が出てきた場合は、
詰め込まれない空白とエスケープ文字
.Ql \e&
-を使用することによって対応できます。
+を
+使用することによって対応できます。
例えば、
.Ql string\e\ \e&
のようにします。
で置き換える
(すなわち
.Ql \een
-とする) ことによって、バックスラッシュを残して扱うことができます。
+とする) ことによって、
+バックスラッシュを残して扱うことができます。
.Sh MAN ページの分析
man ページの本文はファイル
.Pa /usr/share/misc/mdoc.template
.Ss マニュアルページのテンプレート
.Bd -literal -offset indent
\&.\e" 以下の項目はすべての man ページで必要な項目です。
-\&.Dd 月\ 日, 年
+\&.Dd 月 日, 年
\&.Os オペレーティングシステム [バージョン/リリース]
\&.Dt ドキュメントタイトル [セクション番号] [ボリューム]
\&.Sh NAME
-\&.Nm 名称
-\&.Nd 名称の 1 行での説明
+\&.Nm 名前
+\&.Nd 名前の 1 行での説明
\&.Sh SYNOPSIS
\&.Sh DESCRIPTION
-\&.\e" 以下の項目については、必要に応じてコメントをはずして使用してく
-\&.\e" ださい。
-\&.\e" .Sh IMPLEMENTATION NOTES
+\&.\e" 以下の項目については、必要に応じてコメントをはずして
+\&.\e" 使用してください。
\&.\e" この次の項目はセクション 2, 3, 9 でのみ必要な、関数の
\&.\e" 戻り値です。
\&.\e" .Sh RETURN VALUE
\&.\e" .Sh FILES
\&.\e" .Sh EXAMPLES
\&.\e" 次の項目はセクション 1, 6, 7, 8, 9 でのみ必要なものです。
-\&.\e" ((シェルへの)コマンドの戻り値と fprintf/stderr の型の診断
-\&.\e" です。)
+\&.\e" ((シェルへの) コマンドの戻り値と
+\&.\e" fprintf/stderr の型の診断です。)
\&.\e" .Sh DIAGNOSTICS
-\&.\e" .Sh COMPATIBILITY
-\&.\e" 次の項目はセクション 2, 3, 9 でのみ必要な、エラーハンドリングと
-\&.\e" シグナルハンドリングです。
+\&.\e" 次の項目はセクション 2, 3, 9 でのみ必要な、
+\&.\e" エラーハンドリングとシグナルハンドリングです。
\&.\e" .Sh ERRORS
\&.\e" .Sh SEE ALSO
-\&.\e" .Sh STANDARDS
+\&.\e" .Sh CONFORMING TO
\&.\e" .Sh HISTORY
\&.\e" .Sh AUTHORS
\&.\e" .Sh BUGS
man ページもしくは題材となっているソースの開発や変更のベースとなった
オペレーティングシステム、
.Pq Em 大文字で
-man ページタイトルをそのページが属するマニュアルのセクション番号とともに
-指定したもの、となっています。
-これらのマクロはそのページを識別するものであり、後述の
+man ページタイトルをそのページが属するマニュアルの
+セクション番号とともに指定したもの、となっています。
+これらのマクロはそのページを識別するものであり、
+後述の
.Sx タイトルマクロ
で議論されています。
.Pp
テンプレート中の残りの項目はセクションのヘッダ
.Pq Li \&.Sh
-であり、それらのうち
+であり、
+それらのうち
.Sx NAME
と
.Sx SYNOPSIS
ヘッダとフッタを構成するためだけに使用されます。
.Bl -tag -width 6n
.It Li \&.Dt ドキュメントタイトル セクション番号 [ボリューム]
+.\" .Cl
+.\" USD UNIX User's Supplementary Documents
+.\" .Cl
+.\" PS1 UNIX Programmer's Supplementary Documents
ドキュメントタイトルは man ページの主題であり、troff の制限により
.Tn 大文字
でなければいけません。
-セクション番号は 1,\ ...,\ 9 となり、これが指定されると
+セクション番号は 1,\ ...,\ 8 となり、これが指定されると
ボリュームタイトルを省略してもかまいません。
-.Pp
-.Fx
では、次のセクション番号と解説について後述します:
+ボリュームタイトルには任意のものか次のいずれかを指定します。
.Pp
.Bl -column SMM -offset indent -compact
-.It Li 1 FreeBSD General Commands Manual
-.It Li 2 FreeBSD System Calls Manaul
-.It Li 3 FreeBSD Library Calls Manual
-.It Li 4 FreeBSD Kernel Interfaces Manual
-.It Li 5 FreeBSD File Formats Manual
-.It Li 6 FreeBSD Games Manual
-.It Li 7 FreeBSD Miscellaneous Information Manual
-.It Li 8 FreeBSD System Manager's Manual
-.It Li 9 FreeBSD Kernel Developers Guide
-.El
-.Pp
-ボリュームタイトルは任意のものか、以下のうちいずれかになります。
-.\" .Cl
-.\" USD UNIX User's Supplementary Documents
-.\" .Cl
-.\" PS1 UNIX Programmer's Supplementary Documents
-.Pp
-.Bl -column SMM -offset indent -compact
-.It Li AMD UNIX Ancestral Manual Documents
-.It Li SMM UNIX System Manager's Manual
-.It Li URM UNIX Reference Manual
-.It Li PRM UNIX Programmer's Manual
+.It Li "AMD UNIX" Ancestral Manual Documents
+.It Li "SMM UNIX" System Manager's Manual
+.It Li "URM UNIX" Reference Manual
+.It Li "PRM UNIX" Programmer's Manual
.El
.Pp
-デフォルトのボリュームは
-セクション 1, 6, 7 では
-.Li URM
-、セクション 8 では
-.Li SMM
-、セクション 2, 3, 4, 5 では
-.Li PRM
-となっています。
.\" .Cl
.\" MMI UNIX Manual Master Index
.\" .Cl
.\" CON UNIX Contributed Software Manual
.\" .Cl
.\" LOC UNIX Local Manual
+デフォルトのボリュームラベルは
+セクション 1, 6, 7 では
+.Li URM
+、
+セクション 8 では
+.Li SMM
+、
+セクション 2, 3, 4, 5 では
+.Li PRM
+となっています。
.It Li \&.Os オペレーティングシステム リリース番号
オペレーティングシステムの名称には一般的な頭字語 (略称)
を使わなければなりません。
例えば、
.Tn BSD
や
-.Fx
+.Tn FreeBSD
や
.Tn ATT
といったものです。
や
.Dl \&.Os FreeBSD 2.2
.Pp
-ã\83ã\83¼ã\82«ã\83«ã\81§ä½\9cã\82\89ã\82\8cã\81\9fã\82»ã\83\83ã\83\88ã\81®ä¾\8bã\80\82
+ã\82\84ã\83ã\83¼ã\82«ã\83«ã\81§ç\94\9fæ\88\90ã\81\95ã\82\8cã\81\9fã\82»ã\83\83ã\83\88
.Pp
.Dl \&.Os CS Department
.Pp
Berkeley でのデフォルトである、引数なしの
.Ql \&.Os
-はサイト固有のファイル
+はサイト固有の
+ファイル
.Pa /usr/share/tmac/mdoc/doc-common
において
.Tn BSD
.Tn LOCAL
として定義すべきです。
.Ql \&.Os
-マクロがない場合は、ページの左下角はみにくくなるであろうことに
+マクロがない場合は、ページの左下角は見にくくなるであろうことに
注意してください。
.It Li \&.Dd 月 日, 年
日付は次のようにフォーマルな形式で記述しなければなりません。
.Pp
+.ne 5
.Dl January 25, 1989
.El
-.Sh マニュアル領域および一般テキスト領域の紹介
+.Sh マニュアルと一般テキスト領域の紹介
.Ss この名前には何が...?
マニュアル領域のマクロ名はコマンドやサブルーチン、それに関連ファイルを
説明するために使われている日常のインフォーマルな言葉から取られています。
この言葉と少し違うバリエーションのものが man ページを書く上での
3 つの異なった面を記述するのに使われます。
-最初のものは、
+最初のものは
.Nm \-mdoc
マクロ使用方法の説明です。
2 番目のものは
.Pp
最初のケースでは、
.Xr troff 1
-マクロはそれ自身、一種のコマンドとなっています。
+マクロはそれ自身、
+一種のコマンドとなっています。
troff コマンドは一般的に以下のような形式をとります。
.Bd -filled -offset indent
\&.Va argument1 argument2 ... argument9
.Ed
.Pp
.Ql \&.Va
-はマクロコマンドもしくは要求を示しており、それに続くものは
-すべて引数として処理されます。
+はマクロコマンドもしくは要求を示しており、
+ã\81\9dã\82\8cã\81«ç¶\9aã\81\8fã\82\82ã\81®ã\81¯ã\81\99ã\81¹ã\81¦å¼\95æ\95°ã\81¨ã\81\97ã\81¦å\87¦ç\90\86ã\81\95ã\82\8cã\81¾ã\81\99ã\80\82
2 番目のケースでは、コンテントマクロを使用する
.Ux
コマンドの記述がもう少し含まれます。
.Pp
ここで
.Nm filter
-はコマンド名であり、角括弧で囲まれた文字列
+はコマンド名であり、
+角括弧で囲まれた文字列
.Fl flag
は
.Em フラグ
-引数で、これは角括弧で囲むことによってオプションであることを示しています。
+引数で、
+これは角括弧で囲むことによってオプションであることを示しています。
.Nm \-mdoc
の用語では
.Ar infile
.Ar makefile
をフラグ
.Fl f
-の引数としています。
-ã\81¾ã\81\9fã\82ªã\83\97ã\82·ã\83§ã\83³ã\81®ã\83\95ã\82¡ã\82¤ã\83«ã\82ªã\83\9aã\83©ã\83³ã\83\89
+の引数としています。またオプションの
+ファイルオペランド
.Ar target
についても議論しています。
言葉での説明では、こういった詳細な記述が混乱を防いでくれますが、
.Nm \-mdoc
パッケージにはフラグ
.Em への
-引数のためのマクロがありません。
-その代わりに
+引数のための
+ã\83\9eã\82¯ã\83ã\81\8cã\81\82ã\82\8aã\81¾ã\81\9bã\82\93ã\80\82ã\81\9dã\81®ä»£ã\82\8fã\82\8aã\81«
.Ar target
-のようなオペランドやファイル引数に使われる引数マクロ
+のような
+オペランドやファイル引数に使われる引数マクロ
.Ql \&Ar
が
.Ar variable
.Pp
.Dl \&.Li sptr, ptr),
.Pp
-その結果は以下のようになります。
+結果は以下のようになります。
.Pp
.Dl Li sptr, ptr),
.Pp
リテラルフォントの文字列と区別されています。
.Pp
.Ql \e&
-でエスケープすることによって句読点文字の特別な意味を取り除くことができます。
+でエスケープすることによって句読点文字の特別な意味を
+取り除くことができます。
.Xr troff
-はマクロ言語としての限界から、数学、論理学、もしくは以下の引用符の
-集合のメンバを含んだ文字列を表現するのは困難です。
+はマクロ言語としての限界から、
+数学、論理学、もしくは以下の引用符の集合のメンバを含んだ文字列を
+表現するのは困難です。
.Bd -literal -offset indent-two
\&{+,\-,/,*,\&%,<,>,<=,>=,=,==,&,`,',"}
.Ed
.Pp
.Xr troff
-が文字によって示唆されている操作もしくは評価を実際に行なっていることが、
-その問題の原因となっています。
+が文字によって示唆されている操作もしくは評価を実際に
+行なっていることが、その問題の原因となっています。
.Ql \e&
-でこれらをエスケープすることによって、これらの文字が予期せずに
-評価されることを防止することができます。
+でこれらをエスケープすることによって、
+これらの文字が予期せずに評価されることを防止することができます。
最初のコンテントマクロは、以下の
.Ql \&.Ad
-において、その典型的な構文が示されています。
+において、
+その典型的な構文が示されています。
.Sh マニュアル領域
.Ss アドレスマクロ
-アドレスマクロは addr1[,addr2[,addr3]] の形式からなるアドレスを識別します。
+アドレスマクロは addr1[,addr2[,addr3]] の形式からなる
+アドレスを識別します。
.Pp
.Dl 使い方: .Ad address ... \*(Pu
.Bl -tag -width ".Ad f1 , f2 , f3 :" -compact -offset 14n
.It Li \&.Ad f1\ , f2\ , f3\ :
.Ad f1 , f2 , f3 :
.It Li \&.Ad addr\ )\ )\ ,
-.Ad addr ) ) ,
+.Ad addr ) ),
.El
.Pp
.Ql \&.Ad
.It Li \&.An Joe\ Author\ \&Aq\ nobody@FreeBSD.ORG
.An Joe Author Aq nobody@FreeBSD.ORG
.It Li \&.An Joe\ Author\ )\ )\ ,
-.An Joe Author ) ) ,
+.An Joe Author ) ),
.El
.Pp
.Ql \&.An
マクロは解析され、呼び出し可能です。
.Ql \&.An
を引数なしで呼び出すのはエラーです。
-.Pp
-.Sx AUTHORS
-セクションでは、
-.Ql \&.An
-要求は改行を引き起こし、各新規の名前がそれぞれの行に表示されます。
-この動作が望ましくない場合、
-.Bd -literal -offset indent
-\&.An -nosplit
-.Ed
-.Pp
-呼び出しで無効化可能です。
-それぞれの行に表示させる動作に戻したい場合は、
-.Bd -literal -offset indent
-\&.An -split
-.Ed
-呼び出しを使用します。
.Ss 引数マクロ
引数マクロ
.Ql \&.Ar
-はコマンド行の引数を参照する際に使用することができます。
+はコマンド行の引数を参照する際に
+使用することができます。
.Pp
.Dl 使い方: .Ar argument ... \*(Pu
.Bl -tag -width ".Ar file1 file2" -compact -offset 15n
.It Li \&.Ar f1 f2 f3\ :
.Ar f1 f2 f3 :
.It Li \&.Ar file\ )\ )\ ,
-.Ar file ) ) ,
+.Ar file ) ),
.El
.Pp
.Ql \&.Ar
マクロは解析され、呼び出し可能です。
.Ss コンフィギュレーション宣言 (セクション 4 のみ)
.Ql \&.Cd
-マクロはセクション 4 のマニュアルにおいて、デバイスインタフェースの
+マクロはセクション 4 のマニュアルにおいて、
+デバイスインタフェースの
.Xr config 8
による宣言の説明に使われます。
-このマクロは引用符 (2 重引用符のみ) で囲まれた引数を取ることができます。
+このマクロは引用符 (二重引用符のみ) で囲まれた引数を取ることができます。
.Pp
.Bl -tag -width "device le0 at scode?" -offset indent
.It Cd "device le0 at scode?"
.Ss コマンド修飾子
コマンド修飾子は
.Ql \&.Cm
-マクロがすべての引数の前にダッシュ文字を付けないことを除いて、
+マクロがすべての引数の前にダッシュ文字を
+付けないことを除いて、
.Ql \&.Fl
(フラグ) コマンドと同じです。
伝統的にフラグはダッシュ文字に引き続いて指定されますが、
.Ss errno (セクション 2 のみ)
エラーマクロ
.Ql \&.Er
-はセクション 2 のライブラリルーチンにおけるエラーの戻り値を指定します。
+はセクション 2 のライブラリルーチンにおける
+エラーの戻り値を指定します。
下記の 2 番目の例では
.Ql \&.Er
は一般テキスト領域マクロである
.Ql \&.Bq
-(これはセクション 2 のマニュアルページで使われています) と共に使われています。
+(これはセクション 2 のマニュアルページで使われています)
+と共に使われています。
.Pp
.Dl 使い方: .Er ERRNOTYPE ... \*(Pu
.Bl -tag -width ".Bq Er ENOTDIR" -compact -offset 14n
.Dl 使い方: .Ev argument ... \*(Pu
.Bl -tag -width ".Ev PRINTER ) ) ," -compact -offset 14n
.It Li \&.Ev DISPLAY
-.Ev DISPLAY
+.Ev DISPLAY
.It Li \&.Ev PATH\ .
.Ev PATH .
.It Li \&.Ev PRINTER\ )\ )\ ,
-.Ev PRINTER ) ) ,
+.Ev PRINTER ) ),
.El
.Pp
.Ql \&.Ev
マクロは関数の引数 (パラメータ) を
マニュアルの
.Sx SYNOPSIS
-のセクション外、もしくは
+のセクション外、
+もしくは
.Sx SYNOPSIS
のセクション内で参照する場合に使われます。
パラメータのリストが
.Dl 使い方: .Fa function_argument ... \*(Pu
.Bl -tag -width ".Fa d_namlen\ )\ )\ ," -compact -offset 14n
.It Li \&.Fa d_namlen\ )\ )\ ,
-.Fa d_namlen ) ) ,
+.Fa d_namlen ) ),
.It Li \&.Fa iov_len
.Fa iov_len
.El
.Ql \&.Fd
マクロは
.Sx SYNOPSIS
-セクションにおいて、セクション 2 または 3 の関数の説明で使われます。
+セクションにおいて、
+セクション 2 または 3 の関数の説明で使われます。
.Ql \&.Fd
-マクロから他のマクロを呼び出すことはなく、他のマクロから呼び出すことも
-できません。
+マクロから他のマクロを呼び出すことはなく、
+他のマクロから呼び出すこともできません。
.Pp
.Dl 使い方: .Fd include_file (or defined variable)
.Pp
.Sx SYNOPSIS
-セクションにおいて、関数がすでに示されていて改行が入っていない場合、
+セクションにおいて、関数がすでに示されていて改行が
+入っていない場合、
.Ql \&.Fd
-によって改行が挿入されます。
-これによって前の関数呼び出しと次の関数の宣言の間に最適な行間が設定されます。
+によって改行が挿入されます。これによって
+前の関数呼び出しと次の関数の宣言の間に最適な行間が設定されます。
.Ss フラグ
.Ql \&.Fl
マクロはコマンド行のフラグを扱います。
が挿入されます。
対話的なコマンドのフラグでは、ダッシュがフラグの前には挿入されませんが、
.Ql \&.Cm
-(コマンド修飾子) マクロは、ダッシュを付けないことを除き、同じ働きをします。
+(コマンド修飾子) マクロは、ダッシュを付けないことを除き、
+同じ働きをします。
.Pp
.Dl 使い方: .Fl argument ... \*(Pu
.Bl -tag -width ".Fl \-s \-t \-v" -compact -offset 14n
.Pp
引数なしで
.Ql \&.Fl
-マクロを指定すると、標準入力/標準出力を意味するダッシュとなります。
+マクロを指定すると、
+標準入力/標準出力を意味するダッシュとなります。
ひとつのダッシュに
.Ql \&.Fl
-マクロを使用すると、2 つダッシュとなることに注意して下さい。
+マクロを使用すると、
+2 つダッシュとなることに注意して下さい。
.Ql \&.Fl
マクロは解析され、呼び出し可能です。
.Ss 関数 (ライブラリルーチン)
.Fn getchar
.It Li "\&.Fn strlen ) ,"
.Fn strlen ) ,
-.It Li \&.Fn "\\*qint align\\*q" "\\*qconst * char *sptrs\\*q" ,
+.It Li \&.Fn "\*qint align\*q" "\*qconst * char *sptrs\*q" ,
.Fn "int align" "const * char *sptrs" ,
.El
.Pp
.Ql \&.Fn
を引数を指定せずに呼び出すのはエラーです。
.Ql \&.Fn
-マクロは解析され、呼び出し可能です。他のマクロの呼び出しは
+マクロは解析され、呼び出し可能です。
+他のマクロの呼び出しは
.Ql \&.Fn
-の呼び出しの終了を意味することに注意して下さい
-(閉じ括弧がその点で挿入されます)。
+の呼び出しの終了を意味することに
+注意して下さい (閉じ括弧がその点で挿入されます)。
.Pp
9 個以上のパラメータをとる関数 (これは滅多にないことですが) では、
.Ql \&.Fo
マクロ (関数オープン) と
.Ql \&.Fc
-マクロ (関数クローズ) を
+マクロ
+(関数クローズ) を
.Ql \&.Fa
-(関数引数) と共に使って、この制限を回避することができます。
+(関数引数) と共に使って、
+この制限を回避することができます。
以下にその例を示します。
.Bd -literal -offset indent
-\&.Ft int
-\&.Fo res_mkquery
+\&.Fo "int res_mkquery"
\&.Fa "int op"
\&.Fa "char *dname"
\&.Fa "int class"
.Pp
これは以下のような結果になります。
.Bd -filled -offset indent
-.Ft int
-.Fo res_mkquery
+.Fo "int res_mkquery"
.Fa "int op"
.Fa "char *dname"
.Fa "int class"
.Sx SYNOPSIS
セクションでは、関数は常に行の先頭から開始されます。
.Sx SYNOPSIS
-セクションにおいて、複数の関数が示されており、関数の型が示されない場合、
-改行が挿入され、現在の関数名とその前の関数名の間に最適な改行量が設定されます。
-現在、
+セクションにおいて、複数の関数が示されており、
+関数の型が示されない場合、改行が挿入され、現在の関数名とその前の関数名
+の間に最適な改行量が設定されます。現在、
.Ql \&.Fn
-は troff の行の長さに対して、語の境界をチェックしておらず、予期しない
-場所で改行が挿入されてしまうことがあります。
-これは近い将来修正されるでしょう。
+は troff の行の長さ
+に対して、語の境界をチェックしておらず、予期しない場所で改行が挿入され
+ã\81¦ã\81\97ã\81¾ã\81\86ã\81\93ã\81¨ã\81\8cã\81\82ã\82\8aã\81¾ã\81\99ã\80\82ã\81\93ã\82\8cã\81¯è¿\91ã\81\84å°\86æ\9d¥ä¿®æ£ã\81\95ã\82\8cã\82\8bã\81§ã\81\97ã\82\87ã\81\86ã\80\82
.Ss 関数の型
このマクロは
.Sx SYNOPSIS
man ページ中の他の場所でも問題なく使うことができますが、
セクション 2 と 3 の
.Sx SYNOPSIS
-セクションでカーネルの通常の形式で関数の型を示すことがこのマクロの目的です
-(このマクロは関数名が次の行に置かれるように改行を挿入します)。
+セクションでカーネルの通常の形式で
+関数の型を示すことがこのマクロの目的です (このマクロは関数名が次の行に
+置かれるように改行を挿入します)。
.Pp
.Dl 使い方: .Ft type ... \*(Pu
.Bl -tag -width "\&.Ft struct stat" -offset 14n -compact
を引数なしで呼び出すのはエラーです。
.Ql \&.Ic
マクロは解析され、呼び出し可能です。
-.Ss ライブラリ名
-.Ql \&.Lb
-マクロは、関数がどのライブラリに組み込まれるかを指定します。
-.Pp
-.Dl 使い方: .Lb argument ... \*(Pu
-.Pp
-.Ql \&.Lb
-マクロに対して使用可能な引数と結果は次の通りです:
-.Pp
-.Bl -tag -width "libnetgraph" -compact -offset indent
-.It Li "libc"
-.Lb libc
-.It Li "libc_r"
-.Lb libc_r
-.It Li "libcalendar"
-.Lb libcalendar
-.It Li "libcam"
-.Lb libcam
-.It Li "libcompat"
-.Lb libcompat
-.It Li "libcrypt"
-.Lb libcrypt
-.It Li "libdevstat"
-.Lb libdevstat
-.It Li "libdisk"
-.Lb libdisk
-.It Li "libedit"
-.Lb libedit
-.It Li "libfetch"
-.Lb libfetch
-.It Li "libipsec"
-.Lb libipsec
-.It Li "libipx"
-.Lb libipx
-.It Li "libkvm"
-.Lb libkvm
-.It Li "libm"
-.Lb libm
-.It Li "libmd"
-.Lb libmd
-.It Li "libnetgraph"
-.Lb libnetgraph
-.It Li "libposix1e"
-.Lb libposix1e
-.It Li "libskey"
-.Lb libskey
-.It Li "libusb"
-.Lb libusb
-.It Li "libutil"
-.Lb libutil
-.It Li "libvgl"
-.Lb libvgl
-.El
-.Ss 名称マクロ
+.Ss 名前マクロ
.Ql \&.Nm
-マクロは文書のタイトルやサブジェクト名を指定するために使われます。
-このマクロは最初に呼び出された時の引数を覚えておくという特性を持っており、
-それは常にそのページのサブジェクト名であるべきです。
+マクロは文書のタイトルやサブジェクト名を指定するために
+使われます。このマクロは最初に呼び出された時の引数を覚えておくという
+特性を持っており、それは常にそのページのサブジェクト名であるべきです。
引数なしで呼び出されると
.Ql \&.Nm
-は作者の作業を少なくするためだけの目的で、最初の名称を出力します。
-注:
-ã\82»ã\82¯ã\82·ã\83§ã\83³ 2 ã\81¾ã\81\9fã\81¯ 3 ã\81®ã\83\89ã\82ã\83¥ã\83¡ã\83³ã\83\88ã\81®é\96¢æ\95°å\90\8dã\81¯
+は作者の作業を少なくするためだけの
+目的で、最初の名称を出力します。注意: セクション 2 または 3 のドキュメント
+の関数名は
.Sx NAME
セクションにおいて
.Ql \&.Nm
.Sx SYNOPSIS
セクションや残りのセクションでは
.Ql \&.Fn
-で指定されます。
+で指定され
+ます。
.Xr csh 1
での
.Ql while
-コマンドのキーワードのような対話的なコマンドでは
+コマンドのキーワードのような対話的
+なコマンドでは
.Ql \&.Ic
マクロを使うべきです。
.Ql \&.Ic
-はほとんど
+は
+ほとんど
.Ql \&.Nm
-と同一ですが、
-それが最初に使われたときの引数を記憶することはできません。
+と同一ですが、それが最初に使われたときの引数を
+記憶することはできません。
.Pp
.Dl 使い方: .Nm argument ... \*(Pu
.Bl -tag -width ".Nm mdoc.sample" -compact -offset 14n
.It Li \&.Nm \e-mdoc
.Nm \-mdoc .
.It Li \&.Nm foo\ )\ )\ ,
-.Nm foo ) ) ,
+.Nm foo ) ),
.It Li \&.Nm
.Nm
.El
マクロは解析され、呼び出し可能です。
.Ss オプション
.Ql \&.Op
-マクロはコマンド行の残りのすべての引数を
-オプションであることを示す角括弧で囲み、
-末尾の句読点は角括弧の外に置きます。
+マクロはコマンド行の残りのすべての引数をオプションである
+ことを示す角括弧で囲み、末尾の句読点は角括弧の外に置きます。
.Ql \&.Oc
マクロと
.Ql \&.Oo
-マクロは複数行に渡って使うことができます。
+マクロは複数行に渡って使うことが
+できます。
.Pp
.Dl 使い方: .Op options ... \*(Pu
.Bl -tag -width ".Op Fl c Ar objfil Op Ar corfil ," -compact -offset indent
\&.Oc
.Ed
.Pp
-出力結果:
+生成結果:
.Oo
.Op Fl k Ar kilobytes
.Op Fl i Ar interval
.Ql \&.Oc
と
.Ql \&.Oo
-マクロは解析され、呼び出し可能です。
+マクロは
+解析され、呼び出し可能です。
.Ss パス名
.Ql \&.Pa
マクロはパス名もしくはファイル名をフォーマットします。
.Pp
.Ql \&.Pa
マクロは解析され、呼び出し可能です。
-.Ss 規格
-.Ql \&.St
-マクロは、規格の短縮名称を正式名称に置換します。
-.Pp
-.Dl 使い方: .St abbreviature
-.Pp
-使用可能な
-.Dq 短縮名称/正式名称
-の組は次の通りです:
-.Bl -tag -width "-p1003.2-92XX." -compact -offset indent
-.It Li "-ansiC"
-.St -ansiC
-.It Li "-ansiC-89"
-.St -ansiC-89
-.It Li "-ieee754"
-.St -ieee754
-.It Li "-iso8802-3"
-.St -iso8802-3
-.It Li "-isoC"
-.St -isoC
-.It Li "-isoC-99"
-.St -isoC-99
-.It Li "-p1003.1"
-.St -p1003.1
-.It Li "-p1003.1-88"
-.St -p1003.1-88
-.It Li "-p1003.1-90"
-.St -p1003.1-90
-.It Li "-p1003.1-96"
-.St -p1003.1-96
-.It Li "-p1003.1b-93"
-.St -p1003.1b-93
-.It Li "-p1003.1g-2000"
-.St -p1003.1g-2000
-.It Li "-p1003.2"
-.St -p1003.2
-.It Li "-p1003.2-92"
-.St -p1003.2-92
-.It Li "-susv2"
-.St -susv2
-.It Li "-xpg3"
-.St -xpg3
-.It Li "-xpg4"
-.St -xpg4
-.It Li "-xpg4.2"
-.St -xpg4.2
-.El
.Ss 変数
一般的な変数への参照です。
.Pp
.It Li \&.Va int\ *prt\ )\ :
.Va int\ *prt ) :
.It Li \&.Va char\ s\ ]\ )\ )\ ,
-.Va char\ s ] ) ) ,
+.Va char\ s ] )),
.El
.Pp
.Ql \&.Va
を引数なしで呼び出すのはエラーです。
.Ql \&.Va
マクロは解析され、呼び出し可能です。
-.Ss マニュアルページのクロスリファレンス
+.Ss マニュアルページの相互参照
.Ql \&.Xr
-マクロは最初の引数にマニュアルページの名称を取り、もしあれば次の引数に
-セクションのページ数か句読点を取ります。
+マクロは最初の引数にマニュアルページの名称を取り、
+ã\82\82ã\81\97ã\81\82ã\82\8cã\81°æ¬¡ã\81®å¼\95æ\95°ã\81«ã\82»ã\82¯ã\82·ã\83§ã\83³ã\81®ã\83\9aã\83¼ã\82¸æ\95°ã\81\8bå\8f¥èªç\82¹ã\82\92å\8f\96ã\82\8aã\81¾ã\81\99ã\80\82
すべての残りの引数は句読点と見なされます。
.Pp
-.Dl 使い方: .Xr man_page [1,...,9] \*(Pu
+.Dl 使い方: .Xr man_page [1,...,8] \*(Pu
.Bl -tag -width ".Xr mdoc 7 ) ) ," -compact -offset 14n
.It Li \&.Xr mdoc
.Xr mdoc
.It Li \&.Xr mdoc 7
.Xr mdoc 7
.It Li \&.Xr mdoc 7\ )\ )\ ,
-.Xr mdoc 7 ) ) ,
+.Xr mdoc 7 ) ),
.El
.Pp
.Ql \&.Xr
使い方: .At [v6 | v7 | 32v | V.1 | V.4] ... \*(Pu
.Ed
.Bl -tag -width ".At v6 ) ," -compact -offset 14n
-.It Li ".At"
+.It Li .At
.At
.It Li ".At v6 ."
.At v6 .
マクロは解析
.Em されず
、呼び出し
-.Em 不可能
+.Em 不可
です。
最大 2 つまでの引数を取ることができます。
.Ss BSD マクロ
.Dl 使い方: .Bx [Version/release] ... \*(Pu
.Bl -tag -width ".Bx 4.3 ) ," -compact -offset 14n
-.It Li ".Bx"
+.It Li .Bx
.Bx
.It Li ".Bx 4.3 ."
.Bx 4.3 .
.Pp
.Ql \&.Bx
マクロは解析され、呼び出し可能です。
-.Ss FreeBSD/NetBSD/OpenBSD マクロ
+.Ss FreeBSD マクロ
.Bd -literal -offset indent -compact
-使い方: .Fx [ Version.release ] ... \*(Pu
+使い方: .Fx Version.release ... \*(Pu
.Ed
.Bl -tag -width ".Fx 2.2 ) ," -compact -offset 14n
.It Li ".Fx 2.2 ."
.Fx 2.2 .
.El
.Pp
-.Bd -literal -offset indent -compact
-使い方: .Nx [ Version.release ] ... \*(Pu
-.Ed
-.Bl -tag -width ".Nx 1.4 ) ," -compact -offset 14n
-.It Li ".Nx 1.4 ."
-.Nx 1.4 .
-.El
-.Pp
-.Bd -literal -offset indent -compact
-使い方: .Ox [ Version.release ] ... \*(Pu
-.Ed
-.Bl -tag -width ".Ox 2.5 ) ," -compact -offset 14n
-.It Li ".Ox 2.5 ."
-.Ox 2.5 .
-.El
-.Pp
-.Ql \&.Fx ,
-.Ql \&.Nx ,
-.Ql \&.Ox
-マクロは解析され、呼び出し可能です。
+.Ql \&.Fx
+マクロは解析
+.Em されず
+、呼び出し
+.Em 不可
+です。
最大 2 つまでの引数を取ることができます。
.Ss UNIX マクロ
.Dl 使い方: .Ux ... \*(Pu
.Bl -tag -width ".Ux 4.3 ) ," -compact -offset 14n
-.It Li ".Ux"
+.It Li .Ux
.Ux
.El
.Pp
1 つ以上の文字列が引用符や括弧のような文字のペアで囲まれている
オブジェクトを指します。
クォートと囲いという用語はこの文書を通して同じ意味で使われます。
-ほとんどの 1 行の囲いマクロはクォート (quote) のヒントとするために、小文字の
+ほとんどの 1 行の囲いマクロはクォート (quote) のヒントとするために、
+小文字の
.Ql q
で終了しますが、いくつかの例外があります。
-各々の囲いマクロに対し、開始マクロと終了マクロのペアもあり、それぞれ小文字の
+各々の囲いマクロに対し、開始マクロと終了マクロのペアもあり、
+それぞれ小文字の
.Ql o
と
.Ql c
入れ子にする場合に制限があります。
その中では 1 行形式のクォートマクロのみ使用することができます。
.Pp
+.ne 5
.Bd -filled -offset indent
-.Bl -column "クォート " "終了 " "開始 " "クォートされたリテラル " XX文字列XX
-.Em " クォート 終了 開始 機能 結果"
+.Bl -column "quote " "close " "open " "Enclose Stringx(in XX) " XXstringXX
+.Em "クォート 終了 開始 機能 結果"
\&.Aq .Ac .Ao カギ括弧による囲い <文字列>
\&.Bq .Bc .Bo 角括弧による囲い [文字列]
-\&.Dq .Dc .Do 2 重引用符 ``文字列''
+\&.Dq .Dc .Do 二重引用符 ``文字列''
.Ec .Eo 囲い文字列 (XXによる) XX文字列XX
\&.Pq .Pc .Po 括弧による囲い (文字列)
-\&.Ql クォートされたリテラル `st' または文字列
-\&.Qq .Qc .Qo まっすぐな 2 重引用符 "文字列"
-\&.Sq .Sc .So 1 重引用符 `文字列'
+\&.Ql クォートされたリテラル `st' or 文字列
+\&.Qq .Qc .Qo まっすぐな二重引用符 "文字列"
+\&.Sq .Sc .So 一重引用符 `文字列'
.El
.Ed
.Pp
-下記の不正なマクロを除き、すべてのクォートマクロは解析され、呼び出し可能です。
-句読点がひとつずつ置かれていて、スペースで区切られていれば、
-すべてのクォートマクロは句読点を適切に扱います。
-クォートマクロは開く句読点、閉じる句読点
-(訳注: 句読点には括弧なども含みます) を調べ、
-それが囲む文字列より前か後かを決めます。
-これによって、ある程度の入れ子が可能になっています。
+下記の不正なマクロを除き、すべてのクォートマクロは解析され、呼び出し
+可能です。句読点がひとつずつ置かれていて、スペースで区切られていれば、
+すべてのクォートマクロは句読点を適切に扱います。クォートマクロは開く
+句読点、閉じる句読点(訳注: 句読点には括弧なども含みます) を調べ、
+それが囲む文字列より前か後かを決めます。これによって、ある程度の入れ子
+が可能になっています。
.Bl -tag -width xxx,xxxx
.It Li \&.Ec , \&.Eo
これらのマクロは各々開始および終了の文字列を最初の引数に取ります。
.Xr troff
では
.Xr nroff
-と異なった処理を行ないます。
+と異なっ
+た処理を行ないます。
.Xr nroff
-でフォーマットされた場合、クォート指定されたリテラルは常にクォートされます。
+でフォーマットされた場合、クォート指定
+されたリテラルは常にクォートされます。
.Xr troff
-でフォーマットされた場合は、アイテムの幅が固定幅文字 3 つ分より
-狭い場合にのみクォートされます。
-ã\81\93ã\82\8cã\81¯ã\83ªã\83\86ã\83©ã\83« (å\9bºå®\9aå¹\85) ã\81®ã\83\95ã\82©ã\83³ã\83\88ã\81®å¤\89æ\9b´ã\81\8cã\81\82ã\81¾ã\82\8aæ°\97ã\81¥ã\81\8bã\82\8cã\81ªã\81\84ã\82\82ã\81®ã\81§ã\81\82ã\82\8bã\81\9fã\82\81ã\80\81
-短い文字列を良く見えるようにするためです。
+でフォーマットされた
+場合は、アイテムの幅が固定幅文字 3 つ分より狭い場合にのみクォートされま
+ã\81\99ã\80\82ã\81\93ã\82\8cã\81¯ã\83ªã\83\86ã\83©ã\83« (å\9bºå®\9aå¹\85) ã\81®ã\83\95ã\82©ã\83³ã\83\88ã\81®å¤\89æ\9b´ã\81\8cã\81\82ã\81¾ã\82\8aæ°\97ã\81¥ã\81\8bã\82\8cã\81ªã\81\84ã\82\82ã\81®ã\81§
+あるため、短い文字列を良く見えるようにするためです。
.It Li \&.Pf
プレフィックスマクロは呼び出し可能ではありませんが、解析されます。
-.Bl -tag -width "(namexx" -offset indent
+.Bl -tag -width (namexx -offset indent
.It Li ".Pf ( Fa name2"
は
.Pf ( Fa name2
(空白なし) マクロはサフィックス機能と同様の作用があります。
.El
.Pp
+.ne 4
クォートの例:
.Bl -tag -width ".Aq Pa ctype.h ) ,xxxxxxxx" -compact -offset indent
.It Li \&.Aq
.Qq string Ns ),
.It Li \&.Sq
.Sq
-.It Li "\&.Sq string
+.It Li "\&.Sq string"
.Sq string
.El
.Pp
.Ql \&.Xo
と
.Ql \&.Xc
-もまた同じルーチンをベースに作られており、
+もまた同じルーチンを
+ベースに作られており、
.Nm \-mdoc
-マクロの使い方の非常に良い例となっています。
+マクロの使い方の非常に良い例と
+なっています。
.Ss no\-op もしくは通常テキストマクロ
.Ql \&.No
-マクロはマクロコマンド行において、コンテントマクロの構文形式に従うが、
-フォーマットされては
+マクロはマクロコマンド行において、コンテントマクロの構文
+形式に従うが、フォーマットされては
.Em ならない
-単語をハックするものです。
+単語をハックする
+ものです。
.Ss 空白なしマクロ
.Ql \&.Ns
マクロはマクロ間での不要な空白を除去します。
-これはフラグと引数の間に空白を含まない古いスタイルの引数リストを使う場合に
-便利です。
+これはフラグと引数の間に空白を含まない古いスタイルの引数リストを使う
+場合に便利です。
.Bl -tag -width ".Op Fl I Ns Ar directoryxx" -offset indent
.It Li ".Op Fl I Ns Ar directory"
-ã\81\93ã\82\8cã\81¯ä»¥ä¸\8bã\81®çµ\90æ\9e\9cã\81«ã\81ªã\82\8aã\81¾ã\81\99ã\80\82
+ã\81¯
.Op Fl I Ns Ar directory
+という結果になります。
.El
.Pp
注:
.Ql \&.Ns
-マクロは他のマクロ名が続かなければ、スペースを除去したあとに
+マクロは他のマクロ名が続かなければ、
+スペースを除去したあとに
.Ql \&.No
マクロを常に起動します。
.Ql \&.Ns
マクロは解析され、呼び出し可能です。
-.Ss セクションのクロスリファレンス
+.Ss セクションの相互参照
.Ql \&.Sx
-マクロは同一文書内でのセクションのヘッダへの参照を指定します。
-これは解析され、呼び出し可能です。
+マクロは同一文書内でのセクションのヘッダへの参照を
+指定します。これは解析され、呼び出し可能です。
.Pp
.Bl -tag -width "Li \&.Sx FILES" -offset 14n
.It Li \&.Sx FILES
.Sx FILES
.El
-.Ss 参考文献と引用
+.Ss 相互参照と引用
以下のマクロは多少なりとも参考文献を扱えるようにと意図したものです。
これらのマクロは、せいぜい参照スタイルの参考文献のサブセットを手動で
作成しやすくする程度です。
.Pp
.Bl -tag -width 6n -offset indent -compact
-.It Li ".Rs"
+.It Li .Rs
参考文献の開始。
改行を挿入してから、参考文献の終了マクロが読み込まれるまで
参考文献の情報を収集する。
-.It Li ".Re"
-参考文献の終了。
-参考文献が表示される。
-.It Li ".%A"
+.It Li .Re
+参考文献の終了。参考文献が表示される。
+.It Li .%A
参考文献の作者名。1 回の呼び出しにつき、作者名をひとつ指定する。
-.It Li ".%B"
+.It Li .%B
書籍のタイトル。
-.It Li ".\&%C"
-市 / 場所。
-.It Li ".\&%D"
+.It Li .\&%C
+都市/場所。
+.It Li .\&%D
日付。
-.It Li ".%J"
+.It Li .%J
定期刊行物の名称。
-.It Li ".%N"
+.It Li .%N
発行番号。
-.It Li ".%O"
-追加情報。
-.It Li ".%P"
+.It Li .%O
+追加の情報。
+.It Li .%P
ページ番号。
-.It Li ".%R"
+.It Li .%R
報告書の名称。
-.It Li ".%T"
+.It Li .%T
記事のタイトル。
-.It Li ".%V"
+.It Li .%V
巻数。
.El
.Pp
(現時点では予期できないことです。)
商標名のみ解析されるのは
.Xr troff Ns / Ns Xr ditroff
-の出力をきれいにするためです。
-.Ss 戻り値
+の出力を
+きれいにするためです。
+.Ss 返り値
.Ql \&.Rv
マクロは
.Sx RETURN VALUE
-のセクションで使うテキストを生成します。
+のセクション
+で使うテキストを生成します。
.Pp
.Dl 使い方: .Rv [-std function]
.Pp
.Ql \&.Rv -std atexit
-ã\81\93ã\82\8cã\81¯ä»¥ä¸\8bã\81®ã\83\86ã\82ã\82¹ã\83\88ã\82\92ç\94\9fæ\88\90ã\81\97ã\81¾ã\81\99ã\80\82
+は以下のテキストを生成します。
.Pp
+.\" fake chapter 3 to avoid error message from Rv
+.ds cH 3
+.\" and back to 7 again
.Rv -std atexit
+.ds cH 7
.Pp
.Fl std
オプションはセクション 2 と 3 のマニュアルページでのみ有効です。
-.Ss 商標名 (頭字語とタイプ名)
-商標名マクロは一般的に長さが 2 文字を越えるすべてが大文字の単語用
-に使われる小さな大文字のマクロです。
+.Ss 商標名 (頭文字とタイプ名)
+商標名マクロは一般的に長さが 2 文字を越えるすべてが大文字の単語用に
+使われる小さな大文字のマクロです。
.Pp
.Dl 使い方: .Tn symbol ... \*(Pu
.Bl -tag -width ".Tn ASCII" -compact -offset 14n
.Ql \&.Xo
と
.Ql \&.Xc
-マクロでマクロの境界における引数リストを拡張することができます。
-引数リストは
+マクロでマクロの境界における引数リストを
+拡張することができます。引数リストは
.Ql \&.Op
-のようなすべての引数が 1 行中に指定されていることを前提としている
-マクロの中では行に渡って拡張することができません。
+のようなすべての引数
+が 1 行中に指定されていることを前提としているマクロの中では行に渡って
+拡張することができません。
.Pp
-以下に空白モードマクロをスペーシングをオフにするために使った
+以下に空白モードマクロをスペーシングをオフにするために
+使った
.Ql \&.Xo
での例を示します。
.Bd -literal -offset indent
\&.Xc
.Ed
.Pp
-結果は以下の通りです。
+これは以下のような結果になります。
.Bd -filled -offset indent
.Bl -tag -width flag -compact
.It Xo
.Pp
上のすべての例では
.Ql \&.It
-(リスト項目) マクロの引数リストに
+(リスト項目) マクロの
+引数リストに
.Ql \&.Xo
マクロを使用しています。
-拡張マクロが使われることはあまりありません。
-使われるとすれば、リスト項目の引数リストを拡張する場合です。
-残念なことに、これが拡張マクロが最も懲り性であるところでもあります。
-最初の 2 つの例では、スペーシングはオフになっています。
-3 番目では、ある箇所にはスペーシングを入れることが望ましいのですが、
-出力全体に入れたいわけではありません。
-そのような状況でこれらのマクロが適切に動作するためには、
+拡張マクロが使われることはあまりありません。使われるとすれば、リスト
+項目の引数リストを拡張する場合です。残念なことに、これが拡張マクロが
+最も懲り性であるところでもあります。最初の 2 つの例では、スペーシングは
+オフになっています。3 番目では、ある箇所にはスペーシングを入れることが
+望ましいのですが、出力全体に入れたいわけではありません。そのような状況
+でこれらのマクロが適切に動作するためには、
.Ql \&.Xo
と
.Ql \&.Xc
.Ql \&.Xo
マクロが置かれた
.Ql \&.It
-の引数リストに他のものが置かれると、スペーシングがどうなるかは予測不可能です。
+の引数リストに他のものが
+置かれると、スペーシングがどうなるかは予測不可能です。
この場合、
.Ql \&.Ns
-(空白なしマクロ)
-は行中の最初もしくは最後のマクロに指定してはいけません。
-現在
+(空白なしマクロ) は行中の最初もしくは最後の
+マクロに指定してはいけません。現在
.Bx
-でリリースされている 900 のマニュアルページ (実際のページでは約 1500
-ページ) のうち 15 のマニュアルページでのみしか
+でリリースされている 900 の
+マニュアルページ (実際のページでは約 1500 ページ) のうち 15 の
+マニュアルページでのみしか
.Ql \&.Xo
が使われていません。
-.Sh ページ構造領域
+.Sh ページ構造のドメイン
.Ss セクションヘッダ
以下にリストされている、最初の 3 つのセクションヘッダマクロ
.Ql \&.Sh
マクロは 9 つまでの引数を取ることができます。
これは解析されますが、呼び出し不可能です。
.Bl -tag -width ".Sh SYNOPSIS"
-.It \&.Sh NAME
-.Ql \&.Sh NAME (訳注: 名称)
-マクロは必須のものです。
+.It \&.Sh 名前
+.Sx 名前
+(NAME) マクロは必須のものです。
これが指定されていないと、ヘッダとフッタ、それにデフォルトの
ページレイアウトが設定されず、結果はかなり好ましくないものになるでしょう。
.Sx NAME
セクションは最低 3 つの項目からなります。
最初のものは名称マクロ
.Ql \&.Nm
-であり、man ページのサブジェクトとなります。
-2 番目のものは名称説明マクロ
+であり、man ページのサブジェクトと
+なります。2 番目のものは名称説明マクロ
.Ql \&.Nd
-であり、サブジェクト名を 3 つめの項目、
-すなわちその名称の説明と分離します。
+であり、
+ã\82µã\83\96ã\82¸ã\82§ã\82¯ã\83\88å\90\8dã\82\92 3 ã\81¤ã\82\81ã\81®é \85ç\9b®ã\80\81ã\81\99ã\81ªã\82\8fã\81¡ã\81\9dã\81®å\90\8d称ã\81®èª¬æ\98\8eã\81¨å\88\86é\9b¢ã\81\97ã\81¾ã\81\99ã\80\82
説明に割り当てられるスペースは小さいものですので、
できるだけ簡潔で分かりやすいものでなければなりません。
-.It \&.Sh SYNOPSIS
-.Sx SYNOPSIS (訳注: 書式)
-セクションはその man ページのサブジェクトとなっている項目の
-典型的な使用法を説明します。
+.It \&.Sh 書式
+.Sx 書式
+(SYNOPSIS) セクションはその man ページのサブジェクト
+となっている項目の典型的な使用法を説明します。
必須のマクロは
.Ql ".Nm" ,
.Ql ".Cd" ,
.Ql ".Fc" ,
.Ql ".Fd" ,
.Ql ".Ft"
-のマクロも必要な場合があります。)
+の
+マクロも必要な場合があります。)
関数名マクロ
.Ql ".Fn"
-はセクション 2 と 3 のマニュアルページにおいて必須のもので、
-コマンドと一般名称マクロ
+はセクション 2 と 3 のマニュアルページに
+ã\81\8aã\81\84ã\81¦å¿\85é \88ã\81®ã\82\82ã\81®ã\81§ã\80\81ã\82³ã\83\9eã\83³ã\83\89ã\81¨ä¸\80è\88¬å\90\8d称ã\83\9eã\82¯ã\83
.Ql \&.Nm
-はセクション 1, 5, 6, 7, 8 で必須の項目です。
+は
+セクション 1, 5, 6, 7, 8 で必須の項目です。
セクション 4 のマニュアルでは
.Ql ".Nm"
か
.Ql ".Fd"
-、もしくはコンフィギュレーションデバイス使用法マクロ
+、もしくは
+コンフィギュレーションデバイス使用法マクロ
.Ql ".Cd"
が必要です。
-その他のいくつかのマクロが下に示すような書式行を生成するために必要なこと
-があります。
+その他のいくつかのマクロが下に示すような書式行を生成するために必要な
+ã\81\93ã\81¨ã\81\8cã\81\82ã\82\8aã\81¾ã\81\99ã\80\82
.Pp
.Bd -filled -offset indent
.Nm cat
.Ql \&.Op ,
.Ql \&.Fl ,
.Ql \&.Ar
-はパイプの文字
+は
+パイプの文字
.Ql \*(Ba
を認識し、下記のようなコマンド行
.Pp
.Pp
はうまくいきません。
.Xr troff
-は通常 \*(Ba を特別のオペレータとして解釈します。
-この他で \*(Ba が使える場合については
+は通常 \*(Ba を特別のオペレータとして
+解釈します。この他で \*(Ba が使える場合については
.Sx 定義済みの文字列
セクションを参照して下さい。
-.It \&.Sh DESCRIPTION
-.Sx DESCRIPTION (訳注: 解説)
-セクションでの最初のテキストは、ほとんどの場合ではそのコマンド、
-関数もしくはファイルについての短い段落で、オプションの構文リストと
-それぞれの説明がそれに続きます。
+.It \&.Sh 説明
+.Sx 説明
+(DESCRIPTION) セクションでの最初のテキストは、
+ほとんどの場合ではそのコマンド、関数もしくはファイルについての短い
+段落で、オプションの構文リストとそれぞれの説明がそれに続きます。
そのようなリストを作成するには
リスト開始マクロ
.Ql \&.Bl
、リスト項目マクロ
.Ql \&.It
-、リスト終了マクロ
+、
+リスト終了マクロ
.Ql \&.El
-を使います (後述の
+を使います
+(後述の
.Sx リストと列
セクションを参照)。
.El
.Pp
以下の
.Ql \&.Sh
-のセクションヘッダはマニュアルページの好ましいレイアウトの一部であり、
-一貫性を保つために適切に使われなければなりません。
-これらは使われる順番にリストされています。
-.Bl -tag -width 書式
-.It \&.Sh ENVIRONMENT (訳注: 環境変数)
-.Sx ENVIRONMENT
-セクションは関連する環境変数を明らかにし、
-それらの振舞や使用方法を示します。
-.It \&.Sh EXAMPLES (訳注: 使用例、実行例)
+のセクションヘッダはマニュアルページの好ましい
+レイアウトの一部であり、一貫性を保つために適切に使われなければ
+ã\81ªã\82\8aã\81¾ã\81\9bã\82\93ã\80\82ã\81\93ã\82\8cã\82\89ã\81¯ä½¿ã\82\8fã\82\8cã\82\8bé \86ç\95ªã\81«ã\83ªã\82¹ã\83\88ã\81\95ã\82\8cã\81¦ã\81\84ã\81¾ã\81\99ã\80\82
+.Bl -tag -width SYNOPSIS
+.It \&.Sh 環境変数
+.Sx 環境変数
+(ENVIRONMENT) セクションは関連する環境変数を明らかにし、
+ã\81\9dã\82\8cã\82\89ã\81®æ\8c¯è\88\9eã\81\84ã\82\84使ç\94¨æ\96¹æ³\95ã\82\92示ã\81\97ã\81¾ã\81\99ã\80\82
+.It \&.Sh 例
使用例、実行例を作成するには様々な方法があります。
詳細については、下の
-.Sx 例示とディスプレイ
+.Sx 例
のセクションを参照してください。
-.It \&.Sh FILES (訳注: 関連ファイル)
+.It \&.Sh ファイル
man ページのサブジェクトによって使用されるか生成されるファイルで、
-.Sx FILES
+.Sx ファイル
のセクション中でマクロ
.Ql \&.Pa
-によってリストされます。
-.It \&.Sh SEE ALSO (訳注: 関連項目)
-.Sx SEE ALSO
-セクションには、その man ページの題材に関する資料への参照と
-他の関連する man ページへのクロスリファレンスが記載されます。
-クロスリファレンスは
+によってリスト
+されます。
+.It \&.Sh 関連項目
+.Sx 関連項目
+(SEE ALSO) セクションには、その man ページの題材に
+関する資料への参照と他の関連する man ページへのクロスリファレンスが
+記載されます。クロスリファレンスは
.Ql \&.Xr
-マクロによって指定されます。
-.Sx SEE ALSO
-セクションでのクロスリファレンスはセクション番号順に並べ、
-セクション中ではカンマで区切ってアルファベット順に並べなければなりません。
-以下に例を示します。
+マクロによって指定
+されます。
+.Sx 関連項目
+セクションでのクロスリファレンスは
+セクション番号順に並べ、セクション中ではカンマで区切って
+アルファベット順に並べなければなりません。以下に例を示します。
.Pp
.Xr ls 1 ,
.Xr ps 1 ,
.Xr group 5 ,
-.Xr passwd 5
+.Xr passwd 5 .
.Pp
ここで参考スタイルである
.Xr refer 1
は適応されていません。
-.It \&.Sh STANDARDS (訳注: 規格)
+.It \&.Sh 準拠
コマンドやライブラリ関数やファイルが、
.St -p1003.2
や
.St -ansiC
のような特定の実装によるものであれば、ここで記述します。
-ã\82\82ã\81\97ã\82³ã\83\9eã\83³ã\83\89ã\81\8cã\81©ã\81®è¦\8fæ ¼ã\81«ã\82\82å\9fºã\81¥ã\81\84ã\81¦ã\81\84ã\81ªã\81\91ã\82\8cã\81°ã\80\81ã\81\9dã\81®æ´å\8f²ã\81¯
-.Sx HISTORY
-のセクションで説明されなければなりません。
-.It \&.Sh HISTORY (訳注: 歴史)
+コマンドがどの規格にも基づいていなければ、その歴史は
+.Sx 歴史
+(HISTORY)のセクションで説明されなければなりません。
+.It \&.Sh 歴史
特定の規格に基づいていないコマンドは、
このセクションでその歴史の概要が説明されるべきです。
-.It \&.Sh AUTHORS (訳注: 作者)
+.It \&.Sh 作者
クレジットが必要であれば、ここで入れます。
-人物名を指定するには
-.Ql \&.An
-マクロを使用すべきです。
-.It \&.Sh DIAGNOSTICS (訳注: 診断)
+.It \&.Sh 診断
コマンドからの診断はこのセクションに入れます。
-.It \&.Sh ERRORS (訳注: エラー)
+.It \&.Sh エラー
特定のエラーハンドリング、特にライブラリ関数
(man ページのセクション 2, 3, 9) でのエラーハンドリングは、ここで説明します。
.Ql \&.Er
マクロが errno を記述するために使われます。
-.It \&.Sh BUGS (訳注: バグ)
-あきらかな問題はここで記述します。
+.It \&.Sh バグ
+あきらかな問題はここで記述します...
.El
.Pp
ユーザ指定の
.Bl -tag -width 6n
.It \&.Pp
.Ql \&.Pp
-段落コマンド
-は必要な場合に行スペースを指定するために使われます。
-このマクロは
+段落コマンドは必要な場合に行スペースを指定するために使われます。
+このマクロは、
.Ql \&.Sh
マクロや
.Ql \&.Ss
-マクロのあと、それに
+マクロの後や、
.Ql \&.Bl
マクロの前では必要ありません。
(
.Ql \&.Bl
-マクロは -compact フラグが指定されていなければ、縦方向の距離を宣言します
-)。
+マクロは -compact フラグが指定されていなければ、
+縦方向の距離を宣言します)。
.El
.\" This worked with version one, need to redo for version three
.\" .Pp
.Ql \&.Bk
(キープ開始) マクロと
.Ql \&.Ek
-(キープ終了) マクロです。
+(キープ終了)
+マクロです。
.Ql \&.Bk
に指定できるオプションは
.Fl words
-のみであり、これはオプションの途中で改行が入らないようにするのに便利です。
+のみで
+あり、これはオプションの途中で改行が入らないようにするのに便利です。
コマンド行の引数を生成する例 (
.Sx この名前には何が...?
-セクションを参照) において、キープは
+セクションを
+参照) において、キープは
.Xr nroff
-がフラグと引数を別の行に分けないように使われています。
-(実際には、オプションマクロがこの目的で使われていましたが、
-ã\82ªã\83\97ã\82·ã\83§ã\83³ã\81\8cè¡\8cä¸ã\81«ã\82\8fã\81\9fã\81£ã\81¦æ\95£ã\82\89ã\81°ã\81£ã\81¦ã\81\97ã\81¾ã\81\86ã\81¨
-一般的に見栄えが悪くなるという理由により
+がフラグと引数を別の行に分けない
+ように使われています。 (実際には、オプションマクロがこの目的で使われて
+ã\81\84ã\81¾ã\81\97ã\81\9fã\81\8cã\80\81ã\82ªã\83\97ã\82·ã\83§ã\83³ã\81\8cè¡\8cä¸ã\81«ã\82\8fã\81\9fã\81£ã\81¦æ\95£ã\82\89ã\81°ã\81£ã\81¦ã\81\97ã\81¾ã\81\86ã\81¨ä¸\80è\88¬ç\9a\84ã\81«è¦\8bæ \84ã\81\88
+が悪くなるという理由により
.Xr troff
-で右揃えのマージンを強制的に行なう (宗教的な) 決定がなされてから、
-オプションマクロをこの目的で使わないようになりました。
-キープマクロについてはもっと機能を向上する作業が必要であり、
+で右揃えのマージンを強制的に
+行なう (宗教的な) 決定がなされてから、オプションマクロをこの目的で
+使わないようになりました。キープマクロについてはもっと機能を向上する
+作業が必要であり、
.Fl line
オプションを追加していく必要があります。)
-.Ss 例示とディスプレイ
+.Ss 例やディスプレイ
ディスプレイには 5 つのタイプがあります。
即席 1 行インデントディスプレイ
.Ql \&.D1
-、即席 1 行リテラルディスプレイ
+、
+即席 1 行リテラルディスプレイ
.Ql \&.Dl
、それに
ディスプレイ開始マクロ
.Ql \&.Bd
-とディスプレイ終了マクロ
+と
+ディスプレイ終了マクロ
.Ql \&.Ed
-を使用するリテラルブロック、フィルブロックおよび凸凹ブロックです。
+を使用する
+リテラルブロック、フィルブロックおよび凸凹ブロックです。
.Pp
.Bl -tag -width \&.Dlxx
.It Li \&.D1
(D-いち) インデントされたテキストを 1 行表示します。
このマクロは解析されますが、呼び出し不可能です。
.Pp
-.D1 Fl ldghfstru
+.Dl Fl ldghfstru
.Pp
-ã\81\93ã\82\8cã\81¯æ¬¡ã\81®æ\8c\87å®\9aã\81§ç\94\9fæ\88\90ã\81\95ã\82\8cã\81\9fã\82\82ã\81®ã\81§ã\81\99ã\80\82
-.Li \&.D1 \&Fl ldghfstru
+ã\81\93ã\82\8cã\81¯æ¬¡ã\81®æ\8c\87å®\9aã\81§ç\94\9fæ\88\90ã\81\95ã\82\8cã\81¾ã\81\99:
+.Li \&.Dl Fl ldghfstru
.It Li \&.Dl
-(D-エル)
-インデントされた
+(D-エル) インデントされた
.Em リテラル
テキストを 1 行表示します。
.Ql \&.Dl
.Pp
.Dl % ls -ldg /usr/local/bin
.Pp
-これは
-.Li \&.Dl % ls -ldg /usr/local/bin
-から生成されています。
+これは次の指定で生成されます:
+.Li \&.Dl % ls -ldg /usr/local/bin .
.It Li \&.Bd
ディスプレイ開始です。
.Ql \&.Bd
によるディスプレイは
.Ql \&.Ed
-マクロによって終了しなければなりません。
+マクロによって
+終了しなければなりません。
ディスプレイはディスプレイ内およびリスト内で入れ子にすることができます。
.Ql \&.Bd
は以下の書式をとります。
.Ql \&.Bd
のオフセット値を指定することができます。
.Pp
-.Bl -tag -width "file ファイル名 " -compact
+.Bl -tag -width "file file_name " -compact
.It Fl ragged
テキストのブロックをタイプされた通りに表示します。
右マージン (と左マージン) のエッジは左に不揃いに寄せられます。
テキストのブロックがフォーマットされます
(エッジは左非揃えではなく、フィルされます)。
.It Fl literal
-リテラルなブロックを表示します。
-ã\82½ã\83¼ã\82¹ã\82³ã\83¼ã\83\89ã\82\84ã\80\81å\8d\98ç´\94ã\81«ã\82¿ã\83\96ã\82\82ã\81\97ã\81\8fã\81¯ã\82¹ã\83\9aã\83¼ã\82¹ã\81§æ\95´ã\81\88ã\82\89ã\82\8cã\81\9fã\83\86ã\82ã\82¹ã\83\88ã\81§ä¾¿å\88©ã\81§ã\81\99ã\80\82
+リテラルなブロックを表示します。ソースコードや、単純にタブもしくは
+スペースで整えられたテキストで便利です。
.It Fl file Ar ファイル名
.Fl file
-フラグに続く名称のファイルが読み込まれ、表示されます。
-表示はリテラルなモードで行われ、タブは定幅文字 8 つ分に固定されますが、
+フラグに続く名称のファイルが読み込まれ、表示されます。表示
+はリテラルなモードで行われ、タブは定幅文字 8 つ分に固定されますが、
ファイル中のすべての
.Xr troff/ Ns Nm \-mdoc
コマンドは解釈されます。
-.It Fl offset Ar 文字列
+.It Fl offset Ar string
.Fl offset
が以下の文字列のいずれかとともに指定されていると、
その文字列は次のテキストのブロックのインデントのレベルを示すものとして
解釈されます。
.Pp
-.Bl -tag -width "indent-two" -compact
+.Bl -tag -width indent-two -compact
.It Ar left
ブロックを現在の左マージンに揃えます。
これは
.Ql \&.Bd
のデフォルトのモードです。
.It Ar center
-ブロックを中央揃えにします。
-残念ながら現時点では、
+ブロックを中央揃えにします。残念ながら現時点では、
単にブロックの左側を仮想的な中央マージンに揃えるだけです。
.It Ar indent
デフォルトのインデント値もしくはタブの分だけインデントします。
デフォルトのインデント値はディスプレイ
.Ql \&.D1
-でも使われ、これら 2 つのタイプのディスプレイを使った場合、
+でも使われ、
+これら 2 つのタイプのディスプレイを使った場合、
行が揃うことが保証されています。
このインデントは通常 6n か約 2/3 インチ (定幅文字 6 つ分) です。
.It Ar indent-two
.It Ar right
これはブロックをページの右端から約 2 インチ離して
.Em 左
-揃えします。
-このマクロはちゃんと動作する必要があるのですが、
+揃えします。このマクロはちゃんと動作する必要があるのですが、
.Xr troff
ではまったくちゃんと動作してくれていません。
.El
.El
-.It ".Ed"
+.It .Ed
ディスプレイ終了。
.El
.Ss フォントモード
.It Li ".Em exceed 1024 ."
.Em exceed 1024 .
.It Li ".Em vide infra ) ) ,"
-.Em vide infra ) ) ,
+.Em vide infra ) ),
.El
.Pp
.Ql \&.Em
.It \&.Li
リテラルマクロ
.Ql \&.Li
-は特殊文字や変数定数、その他タイプされた通りに表示する必要があるものに
-使用することができます。
+は特殊文字や変数定数、その他タイプされた
+通りに表示する必要があるものに使用することができます。
.Pp
.Dl 使い方: .Li argument ... \*(Pu
-.Bl -tag -width ".Li cntrl-D ) ," -compact -offset 14n
+.Bl -tag -width ".Li cntrl-D ) ," -compact -offset 14n
.It Li \&.Li \een
.Li \en
.It Li \&.Li M1 M2 M3\ ;
.Ql \&.Bf
は
.Ql \&.Ef
-マクロで終了しなければなりません。
+マクロで
+終了しなければなりません。
フォントモードは他のフォントモードと入れ子にすることができます。
.Ql \&.Bf
は次の構文を取ります。
.Pp
-.Dl ".Bf フォントモード"
+.Dl ".Bf font-mode"
.Pp
-フォントモードは以下の 3 つのタイプのうちのいずれかでなければなりません。
+font-mode は以下の 3 つのタイプのうちのいずれかでなければなりません。
.Pp
.Bl -tag -width "file file_name " -compact
.It Sy \&Em | Fl emphasis
.Ql \&.Sy
マクロがテキストブロック全体に使われているのと同様です。
.El
-.It ".Ef"
+.It .Ef
フォントモードの終了。
.El
-.Ss タグつきリストと列
+.Ss タグ付きリストと列
リスト開始マクロ
.Ql ".Bl"
-で開始されるリストにはいくつかのタイプがあります。
-リスト中の項目は項目マクロ
+で開始されるリストにはいくつかのタイプが
+ã\81\82ã\82\8aã\81¾ã\81\99ã\80\82ã\83ªã\82¹ã\83\88ä¸ã\81®é \85ç\9b®ã\81¯é \85ç\9b®ã\83\9eã\82¯ã\83
.Ql ".It"
-で指定され、各リストは
+で指定され、各リスト
+は
.Ql ".El"
-マクロで終了しなければなりません。
-リストはリスト自身やディスプレイの中で入れ子にすることができます。
-列はリストの中で使うことができますが、
-リストが列の中で使えるかどうかは検証されていません。
-.Pp
-さらに、タグの幅、リストのオフセット、コンパクトさ
-(項目間の空白行が許されているかどうか) のような、
-いくつかのリストの属性を指定することができます。
-本ドキュメントのほとんどはタグ
+マクロで終了しなければなりません。リストはリスト自身や
+ディスプレイの中で入れ子にすることができます。列はリストの中で使うこと
+ができますが、リストが列の中で使えるかどうかは検証されていません。
+.Pp
+さらに、タグの幅、リストのオフセット、コンパクトさ(項目間の空白行が
+許されているかどうか) のような、いくつかのリストの属性を指定することが
+できます。本ドキュメントのほとんどはタグ
.Pq Fl tag
-スタイルリストでフォーマットされています。
-各種リストタイプは、調子を変えるためにオーバーハング
+スタイルリストで
+フォーマットされています。各種リストタイプは、調子を変えるために
+オーバーハング
.Pq Fl ohang
でリストしました。
このリストのタイプは
.Tn TeX
-のユーザに非常に人気のあるものですが、tag リストで構成されたページを
-何ページも読んだ後には幾分変に見えるでしょう。
-以下のリストタイプを
+のユーザに非常に人気のあるものですが、
+tag リストで構成されたページを何ページも読んだ後には幾分変に見える
+でしょう。以下のリストタイプを
.Ql ".Bl"
で使うことができます。
.Pp
これら 3 つは最も単純なリストのタイプです。
一旦
.Ql ".Bl"
-マクロが与えられると、リスト中の項目は単に
+マクロが与えられると、リスト中の項目は
+単に
.Ql ".It"
マクロによってのみ構成される行で指定されます。
例として、簡単な列挙リストのソーステキストは、このようになります。
これらの結果は以下のようになります。
.Pp
.Bl -enum -offset indent-two -compact
-.It
+.It
ひとつめはここ。
-.It
+.It
そしてふたつめ。
-.It
+.It
最後にみっつめはここ。
.El
.Pp
\&.El
.Ed
.Pp
-ã\81\9dã\81®çµ\90æ\9e\9cã\81¯ã\81\93ã\81\86なります。
+ã\81\93ã\82\8cã\81¯ä»¥ä¸\8bã\81®ã\82\88ã\81\86ã\81ªçµ\90æ\9e\9cã\81«なります。
.Bl -bullet -offset indent-two -compact
-.It
+.It
ひとつめの bullet。
-.It
+.It
これはふたつめの bullet。
.El
.Pp
.It Fl inset
これらのリストタイプは
.Ql \&.It
-マクロによって指定されている引数からラベルを生成します。
+マクロによって指定されている引数
+からラベルを生成します。
そして、
.Em inset
では、次のテキストへそのラベルを挿入します。
.Em hang
では、次のテキストをラベルの位置へインデントします。
.Em ohang
-(オーバーハング) では、次のテキストをラベルの位置にぶら下げ、インデントしません。
+(オーバーハング) では、次のテキストをラベルの位置に
+ぶら下げ、インデントしません。
.Em tag
-では、タグつきテキストの形式にします。
-ちなみに上のリストは
+では、タグつきテキストの形式にします。ちなみに上のリストは
.Ql Fl ohang
リストタイプで構成されています。
.Ql \&.It
マクロは inset, hang, tag のリストタイプでのみ解析され、
-呼び出し不可能です。
-以下に inset ラベルの例を示します。
+呼び出し不可能です。以下に inset ラベルの例を示します。
.Bl -inset -offset indent
-.It Em tag
+.It Em Tag
tag リスト (tag 段落とも呼ばれる) は、
Berkely マニュアルで使われているリストのうち最も一般的なタイプです。
-.It Em diag (診断)
+.It Em Diag
診断リストはセクション 4 の診断リストを生成するもので、
呼び出し可能なマクロが無視されることを除き、inset リストと似ています。
-.It Em hang
+.It Em Hang
hang ラベルは好みの問題です。
-.It Em ohang
+.It Em Ohang
ohang ラベルはスペースに制限がある時に便利です。
-.It Em inset
+.It Em Inset
inset ラベルは段落のブロックを制御するのに便利で、
.Nm \-mdoc
マニュアルを他の形式に変換する時に役立ちます。
上の例を生成したソーステキストはこうなっています。
.Bd -literal -offset indent
\&.Bl -inset -offset indent
-\&.It Em tag
+\&.It Em Tag
\&tag リスト (tag 段落とも呼ばれる) は、
\&Berkely マニュアルで使われているリストのうち最も一般的なタイプです。
-\&.It Em diag (診断)
+\&.It Em Diag
\&診断リストはセクション 4 の診断リストを生成するもので、
\&呼び出し可能なマクロが無視されることを除き、inset リストと似ています。
-\&.It Em hang
+\&.It Em Hang
\&hang ラベルは好みの問題です。
-\&.It Em ohang
+\&.It Em Ohang
\&ohang ラベルはスペースに制限がある時に便利です。
-\&.It Em inset
+\&.It Em Inset
\&inset ラベルは段落のブロックを制御するのに便利で、
\&.Nm \-mdoc
\&マニュアルを他の形式に変換する時に役立ちます。
.Pp
以下は 2 つの項目を持つ hang リストです。
.Bl -hang -offset indent
-.It Em hang
+.It Em Hanged
ラベルがラベルの幅より小さいときには、
ラベルは tag リストと同じようになります。
.It Em 長い hang リストラベル
これを生成している元のテキストは以下の通りです。
.Bd -literal -offset indent
\&.Bl -hang -offset indent
-\&.It Em hang
+\&.It Em Hanged
\&ラベルがラベルの幅より小さいときには、
\&ラベルは tag リストと同じようになります。
\&.It Em 長い hang リストラベル
タグ幅を制御するためのオプションの幅指定を使ったタグつきリストは
以下の通りです。
.Pp
-.Bl -tag -width "PAGEIN" -compact -offset indent
+.Bl -tag -width PAGEIN -compact -offset indent
.It SL
プロセスが sleep している時間 (ブロックされた秒数)
.It PAGEIN
-そのプロセスによるコアにロードされていないページへの参照によるディスク
+そのプロセスによるコアにロードされていないページへの参照による
+ディスク
.Tn I/O
の回数
.It UID
(割り込み不可のウエイトであるときには非正値)
.El
.Pp
-元のテキストは以下の通りです。
+The raw text:
.Bd -literal -offset indent
\&.Bl -tag -width "PAGEIN" -compact -offset indent
\&.It SL
.Pp
幅指定として以下のものを使うことができます。
.Bl -tag -width Ar -offset indent
-.It Fl width Ar "\&Fl"
-そのフラグでのデフォルトの幅を指定します。
-すべての呼び出し可能なマクロは各々デフォルトの幅の値を持っています。
-現在、
+.It Fl width Ar \&Fl
+そのフラグでのデフォルトの幅を指定します。すべての呼び出し可能なマクロ
+は各々デフォルトの幅の値を持っています。現在、
.Ql \&.Fl
-の値は定幅文字 10 個分、もしくは約 5/6 インチとなっています。
-.It Fl width Ar "24n"
+の値は定幅
+文字 10 個分、もしくは約 5/6 インチとなっています。
+.It Fl width Ar 24n
定幅文字 24 個分の幅、もしくは約 2 インチの幅をセットします。
これが正しく動作するには
.Ql n
が必ず必要となります。
-.It Fl width Ar "ENAMETOOLONG"
+.It Fl width Ar ENAMETOOLONG
指定された文字列の固定長に幅をセットします。
-.It Fl width Ar "\\*qint mkfifo\\*q"
+.It Fl width Ar "\*qint mkfifo\*q"
これも、指定された文字列の固定長に幅をセットします。
.El
.El
.Pp
タグつきリストタイプで幅が指定されていないと、
.Ql \&.It
-が最初に起動された時に適した幅を決定することが試みられます。
+が最初に
+起動された時に適した幅を決定することが試みられます。
.Ql ".It"
-の最初の引数が呼び出し可能なマクロであれば、そのマクロのデフォルトの幅が
-そのマクロ名が幅として指定されたように使用されます。
-しかしながら、そのリスト中に他の項目が別の呼び出し可能なマクロ名で
-与えられていると、新しく入れ子となったリストとして処理されます。
+の
+最初の引数が呼び出し可能なマクロであれば、そのマクロのデフォルトの幅が
+そのマクロ名が幅として指定されたように使用されます。しかしながら、その
+リスト中に他の項目が別の呼び出し可能なマクロ名で与えられていると、
+新しく入れ子となったリストとして処理されます。
.Sh 定義済みの文字列
-以下の文字列はあらかじめ定義されているものであり、
-troff の文字列解釈シーケンス
+以下の文字列はあらかじめ定義されているものであり、troff の文字列解釈
+シーケンス
.Ql \&\e*(xx
もしくは
.Ql \&\e*x
は定義されている文字列の名称です。
解釈シーケンスはテキストのどこでも使うことができます。
.Pp
-.Bl -column "文字列 " "Nroff " "Troff " -offset indent
+.Bl -column "String " "Nroff " "Troff " -offset indent
.It Sy "文字列 Nroff Troff"
-.It Li "<=" Ta \&<\&= Ta \*(<=
-.It Li ">=" Ta \&>\&= Ta \*(>=
-.It Li "Rq" Ta "''" Ta \*(Rq
-.It Li "Lq" Ta "``" Ta \*(Lq
-.It Li "ua" Ta ^ Ta \*(ua
-.It Li "aa" Ta ' Ta \*(aa
-.It Li "ga" Ta \` Ta \*(ga
+.It Li <= Ta \&<\&= Ta \*(<=
+.It Li >= Ta \&>\&= Ta \*(>=
+.It Li Rq Ta '' Ta \*(Rq
+.It Li Lq Ta `` Ta \*(Lq
+.It Li ua Ta ^ Ta \*(ua
+.It Li aa Ta ' Ta \*(aa
+.It Li ga Ta \` Ta \*(ga
.\" .It Li "sL" Ta ` Ta \*(sL
.\" .It Li "sR" Ta ' Ta \*(sR
-.It Li "q" Ta \&" Ta \*q
-.It Li "Pi" Ta pi Ta \*(Pi
-.It Li "Ne" Ta != Ta \*(Ne
-.It Li "Le" Ta <= Ta \*(Le
-.It Li "Ge" Ta >= Ta \*(Ge
-.It Li "Lt" Ta < Ta \*(Gt
-.It Li "Gt" Ta > Ta \*(Lt
-.It Li "Pm" Ta +- Ta \*(Pm
-.It Li "If" Ta infinity Ta \*(If
-.It Li "Na" Ta \fINaN\fP Ta \*(Na
-.It Li "Ba" Ta \fR\&|\fP Ta \*(Ba
+.It Li q Ta \(dq Ta \*q
+.It Li Pi Ta pi Ta \*(Pi
+.It Li Ne Ta != Ta \*(Ne
+.It Li Le Ta <= Ta \*(Le
+.It Li Ge Ta >= Ta \*(Ge
+.It Li Lt Ta < Ta \*(Gt
+.It Li Gt Ta > Ta \*(Lt
+.It Li Pm Ta +- Ta \*(Pm
+.It Li If Ta infinity Ta \*(If
+.It Li Na Ta \fINaN\fP Ta \*(Na
+.It Li Ba Ta \&| Ta \*(Ba
.El
.Pp
.Sy 注 :
.Ql q
-の名称がつけられている文字列は、1 文字であるため
+の名称がつけられている文字列は、
+1 文字であるため
.Ql \e*q
と書かなければなりません。
.Sh 診断
.Nm \-mdoc
は限られたデバッグ機能しか持っていませんが、
引数名と内部レジスタやマクロ名との衝突のような
-潜在的なエラーを検出するのに役立ちます。
-(A って何?)
+潜在的なエラーを検出するのに役立ちます。 (A って何?)
レジスタは
.Xr troff
-での演算用記憶クラスであり、1 文字か 2 文字の名称がついています。
+での演算用記憶クラスであり、
+1 文字か 2 文字の名称がついています。
.Xr troff
と
.Xr ditroff
.Ql \&aR
のように <小文字><大文字> の形式か、
.Ql \&C\&1
-のように <大文字もしくは小文字><数字> の形式を取ります。
+のように <大文字もしくは小文字><数字>
+の形式を取ります。
さらに混乱することに、
.Xr troff
はそれ自身の内部レジスタを持ち、
それらすべては小文字 2 文字か、ドットに文字もしくはメタ文字が続く形式を取ります。
-紹介例の 1 つに、
-エスケープシーケンス
+紹介例の 1 つに、エスケープシーケンス
.Ql \e&
-でマクロ名を解釈させない方法がありました。
-これは内部レジスタ名にも有効です。
+でマクロ名を
+解釈させない方法がありました。これは内部レジスタ名にも有効です。
.Pp
.\" Every callable macro name has a corresponding register
.\" of the same name (<upper_case><lower_case>).
きっとあなたのお母さんは、あなたにこんな面倒なことを覚えるようにとは
考えていないでしょう。
そこで、与えられた引数が有効か無効かを判断する方法があります。
+
そんなときには、
.Ql \&.Db
-(デバッグ) マクロによってほとんどのマクロの引数リストがどう解釈されるか
-を表示することができます。
+(デバッグ) マクロによってほとんどのマクロ
+ã\81®å¼\95æ\95°ã\83ªã\82¹ã\83\88ã\81\8cã\81©ã\81\86解é\87\88ã\81\95ã\82\8cã\82\8bã\81\8bã\82\92表示ã\81\99ã\82\8bã\81\93ã\81¨ã\81\8cã\81§ã\81\8dã\81¾ã\81\99ã\80\82
.Ql \&.Pp
-(段落) マクロのようなマクロはデバッグ情報を含んでいません。
-呼び出し可能なマクロはすべてデバッグ情報を含んでおり、
-疑いがある場合はいつでも
+(段落) マクロのようなマクロはデバッグ情報を含んでいません。呼び出し可能
+なマクロはすべてデバッグ情報を含んでおり、疑いがある場合はいつでも
.Ql \&.Db
マクロをオンにすることを強くお勧めします。
.Pp
.Dl 使い方: \&.Db [on | off]
.Pp
-以下の例では、
-問題が故意に発生するようにされた部分の上と下で
+以下の例では、問題が故意に発生するようにされた部分の上と下で
デバッグマクロが指定されています
(フラグ引数
.Ql \&aC
ファイルが 1 つだけの場合には正しい行番号が出力されます。
2 番目の行では引数の個数と引数
.Pq Ql \&Fl
-とその長さが出力されています。
-引数の長さが 2 文字であれば、
+とその長さが
+å\87ºå\8a\9bã\81\95ã\82\8cã\81¦ã\81\84ã\81¾ã\81\99ã\80\82å¼\95æ\95°ã\81®é\95·ã\81\95ã\81\8c 2 æ\96\87å\97ã\81§ã\81\82ã\82\8cã\81°ã\80\81
その引数が実行可能
(ゼロでない値を含むすべてのレジスタは実行可能なように見えます)
かどうかテストされます。
は先の例と同様に長さ 2 と表示されています。
しかし、
.Ql \e&aC
-という名称のレジスタが見つからず、タイプは文字列と判断されています。
+という名称のレジスタが見つからず、
+タイプは文字列と判断されています。
.Pp
この他の診断は使用方法を報告するものであり、
それ自身が説明を含んでいます。
.Nm \-mdoc
パッケージは
.Xr groff
-との互換モードは必要ではありません。
+との互換モードは
+必要ではありません。
.Pp
このパッケージでは改ページと、
.Xr nroff
-で改ページ時に通常挿入されるヘッダとフッタは禁止されており、
-ã\83\9eã\83\8bã\83¥ã\82¢ã\83«ã\82\92ã\82ªã\83³ã\83©ã\82¤ã\83³ã\81§å\8a¹ç\8e\87è\89¯ã\81\8fè¦\8bã\82\8bã\81\93ã\81¨ã\81\8cã\81§ã\81\8dã\82\8bã\82\88ã\81\86ã\81«ã\81ªã\81£ã\81¦ã\81\84ã\81¾ã\81\99ã\80\82
-現在の所、
+で改ページ時に通常挿入
+ã\81\95ã\82\8cã\82\8bã\83\98ã\83\83ã\83\80ã\81¨ã\83\95ã\83\83ã\82¿ã\81¯ç¦\81æ¢ã\81\95ã\82\8cã\81¦ã\81\8aã\82\8aã\80\81ã\83\9eã\83\8bã\83¥ã\82¢ã\83«ã\82\92ã\82ªã\83³ã\83©ã\82¤ã\83³ã\81§å\8a¹ç\8e\87è\89¯ã\81\8f
+見ることができるようになっています。現在の所、
.Fl T Ns Ar ascii
-が指定された
+が
+指定された
.Xr groff
-はページ内容の無いファイル末の残りの部分まで出力します。
-改ページを禁止することによって
+はページ内容の無いファイル末の残りの部分まで
+出力します。改ページを禁止することによって
.Xr nroff
-による出力はハードコピーには適さないものとなっています。
-サイト依存のスタイルファイル
+による出力は
+ハードコピーには適さないものとなっています。サイト依存のスタイル
+ファイル
.Pa /usr/src/share/tmac/doc-nroff
-において 0 にセットすることができる
+において 0 にセットする
+ことができる
.Ql \&cR
-の名称を持つレジスタが古いスタイルの振る舞いを実現するために用意されています。
-.Sh 関連ファイル
+の名称を持つレジスタが古いスタイルの振る舞い
+を実現するために用意されています。
+.Sh ファイル
.Bl -tag -width /usr/share/man0/template.doc -compact
.It Pa /usr/share/tmac/doc.tmac
マニュアルマクロパッケージ
man ページのいくつかの例
.El
.Sh バグ
+フラグ引き数のダッシュが意図せずハイフンにより折り返しになるバグは
+まだ修正されておらず、
+.Sx DESCRIPTION
+セクションでときどき
+意図しない動作 (ハイフンでの改行) が起こることがある。
+.Pp
あらかじめ定義されている文字列は文書において宣言されていません。
.Pp
セクション 3f はヘッダルーチンには追加されていません。
.Pp
.Ql \&.Nm
フォントは
-.Sx NAME
-セクションにおいて変更されるべきです。
+.Sx 名前
+セクションにおいて
+変更されるべきです。
.Pp
.Ql \&.Fn
-は分割されるのを防止するために、
-行の長さが短すぎないかどうかをチェックする必要があります。
-ときどき、最後の括弧が分割されることがあり、
-行がフィルモードであるときには全くおかしな結果になることがあります。
+は分割されるのを防止するために、行の長さが短すぎないか
+どうかをチェックする必要があります。ときどき、最後の括弧が分割される
+ことがあり、行がフィルモードであるときには全くおかしな結果になること
+があります。
+.Pp
+nroff 使用時に、(最初のヘッダとフッタ以外の) 改ページ時のヘッダと
+フッタの挿入を行わないようにするのに使用される命令によって、
+ときどき見るに耐えない部分的な行詰め (や空行) がページの末尾に
+発生する場合がある。
.Pp
-リストマクロとディスプレイマクロはキープを行いませんが、
-これはキープを行うべきです。
.\" Note what happens if the parameter list overlaps a newline
.\" boundary.
.\" to make sure a line boundary is crossed:
.\" .Xr nroff
.\" the right margin adjustment is normally ragged and the problem is
.\" not as severe.
+リストマクロとディスプレイマクロはキープを行いませんが、
+これはキープを行うべきです。
.Sh 関連項目
.Xr man 1 ,
.Xr troff 1 ,
.Xr groff_mdoc 7 ,
.Xr mdoc 7
+.Sh この文書について
+この man ページは Linux
+.Em man-pages
+プロジェクトのリリース 3.40 の
+一部である。プロジェクトの説明とバグ報告に関する情報は
+http://www.kernel.org/doc/man-pages/ に書かれている。
OSDN Git Service
