詳細は個々の作者に任せたページレイアウトベースのものでした。
.Nm \-mdoc
では、ページレイアウトマクロは
-タイトル、セクションのヘッダ、ディスプレイ、リストのマクロからなる
+ã\82¿ã\82¤ã\83\88ã\83«ã\80\81ã\82»ã\82¯ã\82·ã\83§ã\83³ã\81®ã\83\98ã\83\83ã\83\80ã\83¼ã\80\81ã\83\87ã\82£ã\82¹ã\83\97ã\83¬ã\82¤ã\80\81ã\83ªã\82¹ã\83\88ã\81®ã\83\9eã\82¯ã\83ã\81\8bã\82\89ã\81ªã\82\8b
.Em "ページ構造領域"
を形成しています。これらの項目は整形された
ページでのテキストの物理的な位置に影響を持ちます。
の関連ファイルを記述するための日常使用されるインフォーマルな言葉の
サブセットであるマクロとして定義されています。
マニュアル領域のマクロはコマンド名、コマンド行の引数とオプション、
-関数名、関数のパラメータ、パス名、変数名、他のマニュアルページへの
+é\96¢æ\95°å\90\8dã\80\81é\96¢æ\95°ã\81®ã\83\91ã\83©ã\83¡ã\83¼ã\82¿ã\83¼ã\80\81ã\83\91ã\82¹å\90\8dã\80\81å¤\89æ\95°å\90\8dã\80\81ä»\96ã\81®ã\83\9eã\83\8bã\83¥ã\82¢ã\83«ã\83\9aã\83¼ã\82¸ã\81¸ã\81®
クロスリファレンスなどを扱います。
-これらの領域の項目は作者とマニュアルページの将来のユーザの両者に
+ã\81\93ã\82\8cã\82\89ã\81®é \98å\9f\9fã\81®é \85ç\9b®ã\81¯ä½\9cè\80\85ã\81¨ã\83\9eã\83\8bã\83¥ã\82¢ã\83«ã\83\9aã\83¼ã\82¸ã\81®å°\86æ\9d¥ã\81®ã\83¦ã\83¼ã\82¶ã\83¼ã\81®ä¸¡è\80\85ã\81«
とって価値のあるものです。
マニュアル間で一貫性を高めることによって将来のドキュメントツールへの
移行が容易になることが望まれます。
.Pp
-マニュアルのエントリは、実際の長さに関わらず、
+ã\83\9eã\83\8bã\83¥ã\82¢ã\83«ã\81®ã\82¨ã\83³ã\83\88ã\83ªã\83¼ã\81¯ã\80\81å®\9fé\9a\9bã\81®é\95·ã\81\95ã\81«é\96¢ã\82\8fã\82\89ã\81\9aã\80\81
また男女の区別をするような意図なしで、
.Ux
のマニュアルページを通して、
単純に man ページとして参照されています。
.Sh さあ、始めよう
通常チュートリアルドキュメントは、そこに示された題材をすぐに使いたい時
-に読むものですので、このドキュメントのユーザはせっかちな人だと仮定して
+ã\81«èªã\82\80ã\82\82ã\81®ã\81§ã\81\99ã\81®ã\81§ã\80\81ã\81\93ã\81®ã\83\89ã\82ã\83¥ã\83¡ã\83³ã\83\88ã\81®ã\83¦ã\83¼ã\82¶ã\83¼ã\81¯ã\81\9bã\81£ã\81\8bã\81¡ã\81ªäººã\81 ã\81¨ä»®å®\9aã\81\97ã\81¦
います。このドキュメントの残りの部分で説明されている題材は以下のような
構成になっています。
.Bl -enum -offset indent
.It
.Tn "ページ構造領域"
.Bl -tag -width flag -compact -offset indent
-.It "セクションヘッダ"
+.It "セクションヘッダー"
.It "段落と行スペース"
.It "キープ"
.It "ディスプレイ"
たとえば、関数マクロ
.Ql \&.Fn
では最初の引数は関数名であり、残りの
-引数が関数のパラメータであることが必要です。
+å¼\95æ\95°ã\81\8cé\96¢æ\95°ã\81®ã\83\91ã\83©ã\83¡ã\83¼ã\82¿ã\83¼ã\81§ã\81\82ã\82\8bã\81\93ã\81¨ã\81\8cå¿\85è¦\81ã\81§ã\81\99ã\80\82
.Tn "ANSI C"
の括弧で
-å\9b²ã\81¾ã\82\8cã\81\9fã\83\91ã\83©ã\83¡ã\83¼ã\82¿ã\83ªã\82¹ã\83\88ã\81«ã\81\8aã\81\91ã\82\8bé\96¢æ\95°ã\81®ã\83\91ã\83©ã\83¡ã\83¼ã\82¿の宣言の規定により、
-各パラメータは最低でも 2 語の文字列となります。
+å\9b²ã\81¾ã\82\8cã\81\9fã\83\91ã\83©ã\83¡ã\83¼ã\82¿ã\83¼ã\83ªã\82¹ã\83\88ã\81«ã\81\8aã\81\91ã\82\8bé\96¢æ\95°ã\81®ã\83\91ã\83©ã\83¡ã\83¼ã\82¿ã\83¼の宣言の規定により、
+å\90\84ã\83\91ã\83©ã\83¡ã\83¼ã\82¿ã\83¼ã\81¯æ\9c\80ä½\8eã\81§ã\82\82 2 èª\9eã\81®æ\96\87å\97å\88\97ã\81¨ã\81ªã\82\8aã\81¾ã\81\99ã\80\82
たとえば
.Fa int foo
のようになります。
の
.Xr troff
のすべてのマクロを実装するには処理速度およ
-びメモリ使用量の点でかなり高価な方法となります。
+びメモリー使用量の点でかなり高価な方法となります。
.Xr groff
では高価な処理にはなりませんが、移植性のため、この方法は
空白を含めることが最も必要である以下のマクロだけに限っています。
.Pp
.Dl Fn fetch char *str
.Pp
-パラメータのリストが改行の境界をまたぐ場合に何がおこるかについては、
+ã\83\91ã\83©ã\83¡ã\83¼ã\82¿ã\83¼ã\81®ã\83ªã\82¹ã\83\88ã\81\8cæ\94¹è¡\8cã\81®å¢\83ç\95\8cã\82\92ã\81¾ã\81\9fã\81\90å ´å\90\88ã\81«ä½\95ã\81\8cã\81\8aã\81\93ã\82\8bã\81\8bã\81«ã\81¤ã\81\84ã\81¦ã\81¯ã\80\81
.Sx バグ
のセクションを参照してください。
.Ss 行末の空白文字
.Sx タイトルマクロ
で議論されています。
.Pp
-テンプレート中の残りの項目はセクションのヘッダ
+テンプレート中の残りの項目はセクションのヘッダー
.Pq Li \&.Sh
であり、
それらのうち
と
.Sx DESCRIPTION
は必須項目です。
-これらのヘッダについては
+ã\81\93ã\82\8cã\82\89ã\81®ã\83\98ã\83\83ã\83\80ã\83¼ã\81«ã\81¤ã\81\84ã\81¦ã\81¯
.Sx マニュアル領域
を説明した後、
.Sx ページ構造領域
.Sh タイトルマクロ
タイトルマクロはページ構造領域の最初の部分ですが、man ページを
前日に書き始めたいという人のために、最初に分けて記述されます。
-3 つのヘッダマクロでドキュメントか man ページのタイトル、
+3 ã\81¤ã\81®ã\83\98ã\83\83ã\83\80ã\83¼ã\83\9eã\82¯ã\83ã\81§ã\83\89ã\82ã\83¥ã\83¡ã\83³ã\83\88ã\81\8b man ã\83\9aã\83¼ã\82¸ã\81®ã\82¿ã\82¤ã\83\88ã\83«ã\80\81
オペレーティングシステム、および原著の日付を指定します。
これらのマクロはドキュメントの最初に一度だけ呼び出されるもので、
-ヘッダとフッタを構成するためだけに使用されます。
+ã\83\98ã\83\83ã\83\80ã\83¼ã\81¨ã\83\95ã\83\83ã\82¿ã\82\92æ§\8bæ\88\90ã\81\99ã\82\8bã\81\9fã\82\81ã\81 ã\81\91ã\81«ä½¿ç\94¨ã\81\95ã\82\8cã\81¾ã\81\99ã\80\82
.Bl -tag -width 6n
.It Li \&.Dt ドキュメントタイトル セクション番号 [ボリューム]
.\" .Cl
マクロを用いた
.Ux
コマンドの記述です。
-3 番目はコマンドを通常の言葉の感覚でユーザに示したものです。
+3 ç\95ªç\9b®ã\81¯ã\82³ã\83\9eã\83³ã\83\89ã\82\92é\80\9a常ã\81®è¨\80è\91\89ã\81®æ\84\9fè¦\9aã\81§ã\83¦ã\83¼ã\82¶ã\83¼ã\81«ç¤ºã\81\97ã\81\9fã\82\82ã\81®ã\81§ã\81\99ã\80\82
これはすなわち、man ページのテキスト中でのコマンドの議論となります。
.Pp
最初のケースでは、
.Ss コンフィギュレーション宣言 (セクション 4 のみ)
.Ql \&.Cd
マクロはセクション 4 のマニュアルにおいて、
-デバイスインタフェースの
+ã\83\87ã\83\90ã\82¤ã\82¹ã\82¤ã\83³ã\82¿ã\83¼ã\83\95ã\82§ã\83¼ã\82¹ã\81®
.Xr config 8
による宣言の説明に使われます。
このマクロは引用符 (二重引用符のみ) で囲まれた引数を取ることができます。
は解析され、呼び出し可能です。
.Ss 関数の引数
.Ql \&.Fa
-マクロは関数の引数 (パラメータ) を
+マクロは関数の引数 (パラメーター) を
マニュアルの
.Sx SYNOPSIS
のセクション外、
もしくは
.Sx SYNOPSIS
のセクション内で参照する場合に使われます。
-パラメータのリストが
+ã\83\91ã\83©ã\83¡ã\83¼ã\82¿ã\83¼ã\81®ã\83ªã\82¹ã\83\88ã\81\8c
.Ql \&.Fn
マクロでは長すぎる場合は、
囲って使うマクロ
の呼び出しの終了を意味することに
注意して下さい (閉じ括弧がその点で挿入されます)。
.Pp
-9 個以上のパラメータをとる関数 (これは滅多にないことですが) では、
+9 å\80\8b以ä¸\8aã\81®ã\83\91ã\83©ã\83¡ã\83¼ã\82¿ã\83¼ã\82\92ã\81¨ã\82\8bé\96¢æ\95° (ã\81\93ã\82\8cã\81¯æ»\85å¤\9aã\81«ã\81ªã\81\84ã\81\93ã\81¨ã\81§ã\81\99ã\81\8c) ã\81§ã\81¯ã\80\81
.Ql \&.Fo
マクロ (関数オープン) と
.Ql \&.Fc
マクロは解析され、呼び出し可能です。
.Ss セクションの相互参照
.Ql \&.Sx
-マクロは同一文書内でのセクションのヘッダへの参照を
+ã\83\9eã\82¯ã\83ã\81¯å\90\8cä¸\80æ\96\87æ\9b¸å\86\85ã\81§ã\81®ã\82»ã\82¯ã\82·ã\83§ã\83³ã\81®ã\83\98ã\83\83ã\83\80ã\83¼ã\81¸ã\81®å\8f\82ç\85§ã\82\92
指定します。これは解析され、呼び出し可能です。
.Pp
.Bl -tag -width "Li \&.Sx FILES" -offset 14n
.Ql \&.Xo
が使われていません。
.Sh ページ構造のドメイン
-.Ss セクションヘッダ
-以下にリストされている、最初の 3 つのセクションヘッダマクロ
+.Ss セクションヘッダー
+以ä¸\8bã\81«ã\83ªã\82¹ã\83\88ã\81\95ã\82\8cã\81¦ã\81\84ã\82\8bã\80\81æ\9c\80å\88\9dã\81® 3 ã\81¤ã\81®ã\82»ã\82¯ã\82·ã\83§ã\83³ã\83\98ã\83\83ã\83\80ã\83¼ã\83\9eã\82¯ã\83
.Ql \&.Sh
はすべての man ページで必須のものです。
-残りのセクションヘッダはマニュアルページの作者の裁量において、
+æ®\8bã\82\8aã\81®ã\82»ã\82¯ã\82·ã\83§ã\83³ã\83\98ã\83\83ã\83\80ã\83¼ã\81¯ã\83\9eã\83\8bã\83¥ã\82¢ã\83«ã\83\9aã\83¼ã\82¸ã\81®ä½\9cè\80\85ã\81®è£\81é\87\8fã\81«ã\81\8aã\81\84ã\81¦ã\80\81
推奨されているものです。
.Ql \&.Sh
マクロは 9 つまでの引数を取ることができます。
.It \&.Sh 名前
.Sh 名前
(NAME) マクロは必須のものです。
-これが指定されていないと、ヘッダとフッタ、それにデフォルトの
+ã\81\93ã\82\8cã\81\8cæ\8c\87å®\9aã\81\95ã\82\8cã\81¦ã\81\84ã\81ªã\81\84ã\81¨ã\80\81ã\83\98ã\83\83ã\83\80ã\83¼ã\81¨ã\83\95ã\83\83ã\82¿ã\80\81ã\81\9dã\82\8cã\81«ã\83\87ã\83\95ã\82©ã\83«ã\83\88ã\81®
ページレイアウトが設定されず、結果はかなり好ましくないものになるでしょう。
.Sx NAME
セクションは最低 3 つの項目からなります。
.Pp
以下の
.Ql \&.Sh
-のセクションヘッダはマニュアルページの好ましい
+ã\81®ã\82»ã\82¯ã\82·ã\83§ã\83³ã\83\98ã\83\83ã\83\80ã\83¼ã\81¯ã\83\9eã\83\8bã\83¥ã\82¢ã\83«ã\83\9aã\83¼ã\82¸ã\81®å¥½ã\81¾ã\81\97ã\81\84
レイアウトの一部であり、一貫性を保つために適切に使われなければ
なりません。これらは使われる順番にリストされています。
.Bl -tag -width SYNOPSIS
あきらかな問題はここで記述します...
.El
.Pp
-ユーザ指定の
+ユーザー指定の
.Ql \&.Sh
セクションを追加することができます。
たとえば、このセクションは以下のように設定されています。
でリストしました。
このリストのタイプは
.Tn TeX
-のユーザに非常に人気のあるものですが、
+ã\81®ã\83¦ã\83¼ã\82¶ã\83¼ã\81«é\9d\9e常ã\81«äººæ°\97ã\81®ã\81\82ã\82\8bã\82\82ã\81®ã\81§ã\81\99ã\81\8cã\80\81
tag リストで構成されたページを何ページも読んだ後には幾分変に見える
でしょう。以下のリストタイプを
.Ql ".Bl"
.Tn I/O
の回数
.It UID
-プロセスの所有者の数字表記によるユーザID
+プロセスの所有者の数字表記によるユーザーID
.It PPID
親プロセスの数字表記によるID、プロセスの優先度
(割り込み不可のウエイトであるときには非正値)
\&.Tn I/O
\&の回数
\&.It UID
-\&プロセスの所有者の数字表記によるユーザID
+\&プロセスの所有者の数字表記によるユーザーID
\&.It PPID
\&親プロセスの数字表記によるID、プロセスの優先度
\&(割り込み不可のウエイトであるときには非正値)
.Sh 診断
.Nm \-mdoc
は限られたデバッグ機能しか持っていませんが、
-引数名と内部レジスタやマクロ名との衝突のような
+å¼\95æ\95°å\90\8dã\81¨å\86\85é\83¨ã\83¬ã\82¸ã\82¹ã\82¿ã\83¼ã\82\84ã\83\9eã\82¯ã\83å\90\8dã\81¨ã\81®è¡\9dçª\81ã\81®ã\82\88ã\81\86ã\81ª
潜在的なエラーを検出するのに役立ちます。 (A って何?)
-レジスタは
+ã\83¬ã\82¸ã\82¹ã\82¿ã\83¼ã\81¯
.Xr troff
での演算用記憶クラスであり、
1 文字か 2 文字の名称がついています。
.Xr ditroff
での
.Nm \-mdoc
-のすべての内部レジスタは
+ã\81®ã\81\99ã\81¹ã\81¦ã\81®å\86\85é\83¨ã\83¬ã\82¸ã\82¹ã\82¿ã\83¼ã\81¯
.Ql \&Ar
のように2 文字からなる <大文字><小文字> の形式か、
.Ql \&aR
の形式を取ります。
さらに混乱することに、
.Xr troff
-はそれ自身の内部レジスタを持ち、
+ã\81¯ã\81\9dã\82\8cè\87ªèº«ã\81®å\86\85é\83¨ã\83¬ã\82¸ã\82¹ã\82¿ã\83¼ã\82\92æ\8c\81ã\81¡ã\80\81
それらすべては小文字 2 文字か、ドットに文字もしくはメタ文字が続く形式を取ります。
紹介例の 1 つに、エスケープシーケンス
.Ql \e&
でマクロ名を
-解釈させない方法がありました。これは内部レジスタ名にも有効です。
+解釈させない方法がありました。これは内部レジスター名にも有効です。
.Pp
.\" Every callable macro name has a corresponding register
.\" of the same name (<upper_case><lower_case>).
.\" w[0-9] width tag/label stack
.\" .Ed
.\" .Pp
-エスケープされていないレジスタ名が引数リストに指定されると、
+エスケープされていないレジスター名が引数リストに指定されると、
予期できない振舞いとなります。
一般的には、テキストのかなり大きな部分が出力されるべきところに
出力されないとか、リストのタグのような小さな文字列が消えてしまうとか、
とその長さが
出力されています。引数の長さが 2 文字であれば、
その引数が実行可能
-(ゼロでない値を含むすべてのレジスタは実行可能なように見えます)
+(ã\82¼ã\83ã\81§ã\81ªã\81\84å\80¤ã\82\92å\90«ã\82\80ã\81\99ã\81¹ã\81¦ã\81®ã\83¬ã\82¸ã\82¹ã\82¿ã\83¼ã\81¯å®\9fè¡\8cå\8f¯è\83½ã\81ªã\82\88ã\81\86ã\81«è¦\8bã\81\88ã\81¾ã\81\99)
かどうかテストされます。
3 番目の行ではそのクラスで指定されているスペースとクラスタイプが
出力されています。
は先の例と同様に長さ 2 と表示されています。
しかし、
.Ql \e&aC
-という名称のレジスタが見つからず、
+ã\81¨ã\81\84ã\81\86å\90\8d称ã\81®ã\83¬ã\82¸ã\82¹ã\82¿ã\83¼ã\81\8cè¦\8bã\81¤ã\81\8bã\82\89ã\81\9aã\80\81
タイプは文字列と判断されています。
.Pp
この他の診断は使用方法を報告するものであり、
このパッケージでは改ページと、
.Xr nroff
で改ページ時に通常挿入
-されるヘッダとフッタは禁止されており、マニュアルをオンラインで効率良く
+ã\81\95ã\82\8cã\82\8bã\83\98ã\83\83ã\83\80ã\83¼ã\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
が
において 0 にセットする
ことができる
.Ql \&cR
-の名称を持つレジスタが古いスタイルの振る舞い
+ã\81®å\90\8d称ã\82\92æ\8c\81ã\81¤ã\83¬ã\82¸ã\82¹ã\82¿ã\83¼ã\81\8cå\8f¤ã\81\84ã\82¹ã\82¿ã\82¤ã\83«ã\81®æ\8c¯ã\82\8bè\88\9eã\81\84
を実現するために用意されています。
.Sh ファイル
.Bl -tag -width /usr/share/man0/template.doc -compact
.Pp
あらかじめ定義されている文字列は文書において宣言されていません。
.Pp
-セクション 3f はヘッダルーチンには追加されていません。
+ã\82»ã\82¯ã\82·ã\83§ã\83³ 3f ã\81¯ã\83\98ã\83\83ã\83\80ã\83¼ã\83«ã\83¼ã\83\81ã\83³ã\81«ã\81¯è¿½å\8a ã\81\95ã\82\8cã\81¦ã\81\84ã\81¾ã\81\9bã\82\93ã\80\82
.Pp
.Ql \&.Nm
フォントは
ことがあり、行がフィルモードであるときには全くおかしな結果になること
があります。
.Pp
-nroff 使ç\94¨æ\99\82ã\81«ã\80\81(æ\9c\80å\88\9dã\81®ã\83\98ã\83\83ã\83\80ã\81¨ã\83\95ã\83\83ã\82¿ä»¥å¤\96ã\81®) æ\94¹ã\83\9aã\83¼ã\82¸æ\99\82ã\81®ã\83\98ã\83\83ã\83\80と
+nroff 使ç\94¨æ\99\82ã\81«ã\80\81(æ\9c\80å\88\9dã\81®ã\83\98ã\83\83ã\83\80ã\83¼ã\81¨ã\83\95ã\83\83ã\82¿ä»¥å¤\96ã\81®) æ\94¹ã\83\9aã\83¼ã\82¸æ\99\82ã\81®ã\83\98ã\83\83ã\83\80ã\83¼と
フッタの挿入を行わないようにするのに使用される命令によって、
ときどき見るに耐えない部分的な行詰め (や空行) がページの末尾に
発生する場合がある。
.Xr groff_mdoc 7 ,
.Xr mdoc 7
.Sh この文書について
-This page is part of release 3.54 of the Linux
+この man ページは Linux
.Em man-pages
-project. A
-description of the project, and information about reporting bugs, can be
-found at \%http://www.kernel.org/doc/man\-pages/.
+プロジェクトのリリース 3.78
+の一部である。プロジェクトの説明とバグ報告に関する情報は http://www.kernel.org/doc/man-pages/ に書かれている。
OSDN Git Service
