日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
MAN(7) FreeBSD 多方面の情報マニュアル MAN(7)
名称
man -- マニュアルページのための古い書式化言語
解説
伝統的に、man 言語は、man(1) ユーティリティのための UNIX マニュアルを書く
ために使用されました。それは、フォント、インデンテーション (段付け) とス
ペーシング (間隔) のような表象的な詳細の制限された制御をサポートします。
このリファレンス文書は、マニュアルページの構造と man 言語の構文と使用法に
ついて記述しています。
利用者のマニュアルを書くために man を使用しません: それは、セマンティック
なマークアップのサポートが不足しています。代わりに、mdoc(7) 言語を使用し
ます。
man 文書では、制御文字 `.' で始まる行は、``マクロ行'' と呼ばれます。最初
の単語は、マクロの名前です。それは、通常、2 つの頭文字から成ります。利用
可能なマクロのリストについては、「マクロの概観」を参照してください。マク
ロの名前に続く単語は、マクロへの引数です。
制御文字で始まらない行は、``テキスト行'' と呼ばれます。それらは、印刷され
る自由な形式のテキストを提供します。テキストの書式化は、それぞれの処理の
コンテキストに依存します:
.SH Macro lines change control state.
Text lines are interpreted within the current state.
man 言語の基本的な構文の多くの側面は、roff(7) 言語に基づいています。詳細
については、特に、コメント、エスケープシーケンス、空白類と引用に関して、
roff(7) マニュアルの言語構文とマクロ構文セクションを参照してください。
マニュアルの構造
各 man 文書は、文書のセクションとタイトルについて記述する TH マクロを含ん
でいなければなりません。それは、文書のいかなる場所にも現れるかもしれませ
んが、通常、それは、最初のマクロとして現れます。
TH を過ぎて、少なくとも 1 つのマクロまたはテキスト行が、文書に現われなけ
ればなりません。
次は、ユーティリティ "progname" のための形の整ったスケルトン (骨格) の
man ファイルです:
.TH PROGNAME 1 2009-10-10
.SH NAME
\fBprogname\fR \(en one line about what it does
.\" .SH LIBRARY
.\" For sections 2, 3, and 9 only.
.\" Not used in OpenBSD.
.SH SYNOPSIS
\fBprogname\fR [\fB\-options\fR] \fIfile ...\fR
.SH DESCRIPTION
The \fBfoo\fR utility processes files ...
.\" .Sh CONTEXT
.\" For section 9 functions only.
.\" .SH IMPLEMENTATION NOTES
.\" Not used in OpenBSD.
.\" .SH RETURN VALUES
.\" For sections 2, 3, and 9 function return values only.
.\" .SH ENVIRONMENT
.\" For sections 1, 6, 7, and 8 only.
.\" .SH FILES
.\" .SH EXIT STATUS
.\" For sections 1, 6, and 8 only.
.\" .SH EXAMPLES
.\" .SH DIAGNOSTICS
.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
.\" .SH ERRORS
.\" For sections 2, 3, 4, and 9 errno settings only.
.\" .SH SEE ALSO
.\" .BR foobar ( 1 )
.\" .SH STANDARDS
.\" .SH HISTORY
.\" .SH AUTHORS
.\" .SH CAVEATS
.\" .SH BUGS
.\" .SH SECURITY CONSIDERATIONS
.\" Not used in OpenBSD.
man 文書のセクションは、それらが上記に現れるように通常規則付けられます。
セクションは、次のように構成されるべきです:
NAME (名称)
(複数の) 名前と文書化された題材の短い記述。このための構文は、一般的
に次の通りです:
\fBname\fR \(en description
LIBRARY (ライブラリ)
セクション 2 または 3 のマニュアルで関数であると仮定される、文書化
された題材を含んでいるライブラリの名前。C ライブラリの関数につい
て、これは、次の通りです:
Standard C Library (libc, -lc)
SYNOPSIS (書式)
ユーティリティの呼び出し構文、関数呼び出しの構文、またはデバイスの
設定を文書化しています。
最初に、(セクション 1、6 と 8 の) ユーティリティ、これは、一般的に
次のように構造化されています:
\fBname\fR [-\fBab\fR] [-\fBc\fR\fIarg\fR] \fBpath\fR...
2 番目に、(セクション 2、3、9 の) 関数呼び出しは、次の通りです:
.B char *name(char *\fIarg\fR);
そして 3 番目に、(セクション 4 の) 設定は、次の通りです:
.B name* at cardbus? function?
一般的に、これらのセクションでないマニュアルは、SYNOPSIS を必要とし
ません。
DESCRIPTION (解説)
これは、NAME の 1 行の記述の概要から展開します。それは、通常、(コマ
ンドを文書化するなら) オプションの分類を含んでいます。
CONTEXT
このセクションは、関数がセクション 9 で呼び出すことができますコンテ
キストをリストしています。コンテキストは、autoconf、プロセス、また
は割り込みです。
IMPLEMENTATION NOTES (実装に関する注)
実装に特有の注意は、ここで保持されるべきです。これは、副作用または
注目されるアルゴリズムの意味合いがある標準関数を実装するとき、役に
立ちます。
RETURN VALUES (戻り値)
このセクションは、セクション 2、3 と 9 の機能の返り値を文書化してい
ます。
ENVIRONMENT (環境変数)
例えば、environ(7) の環境変数のあらゆる使用法を文書化しています。
FILES (関連ファイル)
使用されるファイルを文書化しています。それは、ファイル名とファイル
がどのように使用されるか (作成する、修正したなど) の短い記述の両方
を文書化するために役に立ちます。
EXIT STATUS (終了ステータス)
このセクションは、セクション、6 と 8 つのユーティリティのためのコマ
ンドの終了ステータスを文書化しています。歴史的に、この情報は、現
在、推奨されない DIAGNOSTICS (診断) プラクティスに記述されていまし
た。
EXAMPLES (使用例)
使用法の使用例。これは、しばしば形が整えられ、良くテストされた呼び
出しの断片を含んでいます。使用例が適切に動作することを確かめてくだ
さい!
DIAGNOSTICS (診断)
エラー状態を文書化しています。セクション 4 と 9 のマニュアルで、こ
れらは、通常カーネルによってコンソールとカーネルのログに印刷 (表示)
されるメッセージです。セクション 1、6、7 と 8 で、これらは、通常、
ユーザランドのプログラムによって標準エラー出力に印刷 (表示) される
メッセージです。
歴史的に、このセクションは、セクション 1、6 と 8 のマニュアルのため
の EXIT STATUS (終了ステータス) の代わりに使用されました。しかしな
がら、このプラクティスは、推奨されません。
ERRORS (エラー)
セクション 2、3、4 と 9 の errno(2) の設定を文書化しています。
SEE ALSO (関連項目)
関連するトピックがある他のマニュアルを参照します。このセクション
は、ほとんどのマニュアルに存在するべきです。
.BR bar ( 1 ),
相互参照 (クロスリファレンス) は、通常セクションの最初からアルファ
ベットの順序であるべきです。
STANDARDS (規格)
次のように、あらゆる標準の実装または使用を参照します。
IEEE Std 1003.2 (\(lqPOSIX.2\(rq)
あらゆる標準を厳守しないなら、HISTORY (歴史) セクションが使用される
べきです。
HISTORY (歴史)
サポートが最初にどこに登場するか含む主題の概要の歴史。
AUTHORS (作者)
コードおよび文書を書いた (複数の) 人の功績。作者は、一般的に名前と
メールアドレスの両方が注記されるべきです。
CAVEATS (警告)
共通の誤用と解釈違いは、このセクションで説明されるべきです。
BUGS (バグ)
既知のバグ、制限と対処は、このセクションに記述されるべきです。
SECURITY CONSIDERATIONS (セキュリティの考察)
オペレータが考慮するべきあらゆるセキュリティの対策を文書化します。
マクロの概観
この概観は、あらゆる与えられた目的のために最もよいマクロを見つけることを
助けるために、同様な目的のマクロが、一緒にリストされるように、ソートされ
ています。推奨されないマクロは、概観に含められていませんが、以下のアル
ファベット順の参照で見つけることができます。
ページヘッダとフッタのメタデータ
TH タイトルを設定する: title section date [source [volume]]
AT ページフッタに AT&T UNIX バージョンを表示する (<= 1 引数)
UC ページフッタに BSD バージョンを表示する (<= 1 引数)
セクションとパラグラフ
SH セクションヘッダ (1 行)
SS サブセクションヘッダ (1 行)
PP, LP, P 装飾されていないパラグラフを開始する (引数なし)
RS, RE 左マージンをリセットする: [幅]
IP 段付けされたパラグラフ: [head [幅]]
TP タグ付けられたパラグラフ: [幅]
HP ハングされたパラグラフ: [幅]
PD 垂直のパラグラフ距離を設定する: [高さ]
fi, nf fill モードと no-fill モード (引数なし)
in 追加の段付け: [幅]
物質的なマークアップ
B ボールドのフォント
I イタリックのフォント
R ロマン (デフォルト) のフォント
SB 小さなボールドのフォント
SM 小さいロマンのフォント
BI ボールドとイタリックのフォントを繰り返す
BR ボールドとロマンのフォントを繰り返す
IB イタリックとボールドのフォントを繰り返す
IR イタリックとロマンのフォントを繰り返す
RB ロマンとボールドのフォントを繰り返す
RI ロマンとイタリックのフォントを繰り返す
マクロのリファレンス
このセクションは、アルファベット順に整えられたすべてのマクロの正式のリ
ファレンスです。個別のマクロのスコープについては、「マクロの構文」を参照
してください。
AT
AT&T UNIX のリリースのマニュアルページで互換性のためのフッタのためにボ
リュームを設定します。オプションの引数は、それがどのリリースであるかを指
定します。
B
テキストは、ボールド体で表現されます。
また I と R 参照。
BI
テキストは、ボールド体とイタリック体に交互に表現されます。したがって、
`.BI this word and that' によって、`this' と `and' は、ボールド体で表現さ
れ、一方 `word' と `that' は、イタリック体で表現されます。引数の間の空白
類は、出力で省略されます。
使用例:
.BI bold italic bold italic
この例の出力は、引数の間の空白は取り除かれて、``bold'' でエンベロールさ
れ、``italic'' でイタリック化されます。
また IB, BR, RB, RI と IR 参照。
BR
テキストは、ボールド体とロマン体で交互に表現されます (デフォルトフォン
ト)。引数の間の空白類は、出力で省略されます。
同等の例については、BI 参照。
また BI, IB, RB, RI と IR 参照。
DT
デフォルトのタビュレータ (tabulator) 位置を復元します。それらは、0.5 イン
チの間隔があります。これは、タビュレータ (tabulator) の位置が roff(7) ta
要求で変更されなかったなら、効果はありません。
EE
これは、互換性だけのためにインクルードされる、非標準の GNU 拡張です。
mandoc(1) において、それは、fi と同じことを行います。
EX
これは、互換性だけのためにインクルードされる、非標準の GNU 拡張です。
mandoc(1) において、それは、nf と同じことを行います。
HP
初期の出力行が左ぞろえであるパラグラフを開始しますが、続く出力行は、次の
構文で段付けされます:
.HP [width]
width 引数は、roff(7) のスケーリングの幅です。指定されるなら、それは、後
のパラグラフの左マージンのために保存されます。指定されないなら、保存また
はデフォルト幅が使用されます。
また IP, LP, P, PP と TP 参照。
I
テキストは、イタリック体で表現されます。
また B と R 参照。
IB
テキストは、イタリック体とボールド体で交互に表現されます。引数の間の空白
類は、出力で省略されます。
同等の例については、BI 参照。
また BI, BR, RB, RI と IR 参照。
IP
次の構文で段付けされたパラグラフを開始します:
.IP [head [width]]
width 引数は、左のマージンを定義する roff(7) のスケーリング幅です。それ
は、後のパラグラフの左マージンのために保存されます。指定されないなら、保
存またはデフォルト幅が使用されます。
head 引数は、左のマージンをフラッシュして先導する用語として使用されます。
これは、中黒が付けられたパラグラフなどに役に立ちます。
また HP, LP, P, PP と TP 参照。
IR
テキストは、イタリック体とロマン体で交互に表現されます (デフォルトフォン
ト)。引数の間の空白類は、出力で省略されます。
同等の例については、BI 参照。
また BI, IB, BR, RB と RI 参照。
LP
装飾していないパラグラフを開始します。パラグラフのスコープは、続くパラグ
ラフ、サブセクション、セクション、またはファイルの終わりによって閉じられ
ます。保存されたパラグラフの左マージンの幅は、デフォルトにリセットされま
す。
また HP, IP, P, PP と TP 参照。
ME
mailto ブロックを終了します。これは、互換性のためだけに含まれる標準でない
GNU の拡張です。MT を参照
MT
mailto ブロックを開始します。これは、互換性のためだけに含まれる標準でない
GNU の拡張です。それには、次の構文があります:
.MT address
link description to be shown
.ME
OP
オプションのコマンド行の引数。これは、互換性だけのためにインクルードされ
る、非標準の GNU 拡張です。それいは、次構文があります:
.OP key [value]
key は、通常、コマンド行のフラグと value その引数です。
P
LP と同義語です。
また HP, IP, LP, PP と TP 参照。
PD
各新しいパラグラフの前に挿入される垂直の空白を指定します。
構文は、次の通りです:
.PD [height]
height 引数は、roff(7) のスケーリング幅です。そのデフォルトは、1v です。
ユニットが省略されるなら、v が、仮定されます。
このマクロは、HP, IP, LP, P, PP, SH, SS と TP のあらゆる続くインスタンス
の前のスペーシング (間隔) に影響します。
PP
LP と同義語です。
また HP, IP, LP, P と TP 参照。
R
テキストは、ロマン体で表現されます (デフォルトフォント)。
また I と B 参照。
RB
テキストは、ロマン体 (デフォルトフォント) とボールド体で交互に表現されま
す。引数の間の空白類は、出力で省略されます。
同等の例については、BI 参照。
また BI, IB, BR, RI と IR 参照。
RE
事前の RS のスコープを明示的に閉じます。デフォルトの左マージンは、RS 呼び
出しの前の状態に復旧されます。
構文は、次の通りです:
.RE [level]
引数なしで、最も最近の RS ブロックは、閉じられます。level が 1 であるな
ら、すべての開いている RS ブロックは、閉じられます。そうでなければ、level
- 1 のネストされた RS ブロックは、ノコリを開きます。
RI
テキストは、ロマン体 (デフォルトフォント) とイタリック体で交互に表現され
ます。引数の間の空白類は、出力で省略されます。
同等の例については、BI 参照。
また BI, IB, BR, RB と IR 参照。
RS
一時的に、デフォルトの左マージンをリセットします。これには、次構文があり
ます:
.RS [width]
width 引数は、roff(7) のスケーリング幅です。指定されないなら、保存または
デフォルトの幅が使用されます。
また RE 参照。
SB
テキストは、小さいサイズ (デフォルトフォントより 1 ポイント小さい) ボール
ド体で表現されます。
SH
セクションを開始します。セクションのスコープは、別のセクションまたはファ
イルの終わりによってのみ閉じられます。パラグラフの左マージンの幅は、デ
フォルトでリセットされます。
SM
テキストは、小さいサイズで表現されます (デフォルトフォントより 1 ポイント
小さい)。
SS
サブセクションを開始します。サブセクションのスコープは、続くサブセクショ
ン、セクション、またはファイルの終わりで閉じられます。パラグラフの左マー
ジンの幅は、デフォルトでリセットされます。
TH
次の構文があるページヘッダとページフッタで使用されるマニュアルページのタ
イトルを設定します:
.TH title section date [source [volume]]
伝統的に、文書の title は、すべて大文字で与えられます。推奨される date 形
式は、ISO-8601 標準で明記されているように YYYY-MM-DD です。引数が準拠して
いないなら、それは、そのまま印刷 (表示) されます。date が空か、または指定
されていないなら、現在の日付が使用されます。オプションの source 文字列
は、ユーティリティを提供している組織を指定します。指定されないとき、
mandoc(1) は、その -Ios 引数を使用します。volume 文字列は、マニュアルのセ
クションによって決定される、デフォルトで表現されるボリュームを置き換えま
す。
使用例:
.TH CVS 5 1992-02-12 GNU
TP
段付けの幅を越えているなら、ヘッドに改行がつづくところで、パラグラフを開
始します。そうでければ、本体は、段付けの幅へのバッファの後に同じ行に続き
ます。続く出力行は、段付けされます。構文は、次の通りです:
.TP [width]
width 引数は、roff(7) のスケーリング幅です。指定されるなら、それは、後の
パラグラフの左マージンのために保存されます。指定されないなら、保存または
デフォルトの幅が使用されます。
また HP, IP, LP, P と PP 参照。
UC
BSD リリースのマニュアルページの互換性のためにフッタのボリュームを設定し
ます。オプションの最初の引数は、それがどのリリースであるかを指定します。
UE
均一のリソース識別子のブロックを終了します。これは、互換性だけのためにイ
ンクルードされる、非標準の GNU 拡張です。UE 参照。
UR
均一のリソース識別子のブロックを開始します。これは、互換性だけのためにイ
ンクルードされる、非標準の GNU 拡張です。それは、次の構文があります:
.UR uri
link description to be shown
.UE
fi
nf によって開始されたリテラルモードを終了します。
in
現在の段付けに関連して段付けします:
.in [width]
width が符号付きであるなら、新しいオフセットは、相対的です。そうでなけれ
ば、それは、絶対的です。この値は、次のパラグラフ、セクション、またはサブ
セクションをリセットします。
nf
リテラルモードを開始します: すべての続く自由な形式の行は、それらの保存さ
れた行の境界の終わりがあります。fi によって終了されます。リテラルモード
は、SH または SS によって暗黙に終了されます。
マクロの構文
man マクロは、スコープによって分類されます: 行のスコープまたはブロックの
スコープ。行マクロは、現在の行だけにスコープされます (そして、いくつかの
状況で、続く行)。ブロックマクロは、別のブロックマクロよって閉じられるま
で、現在の行と続く行までスコープされます。
行マクロ
行マクロは、一般的に 0 以上の引数から成る本体で、現在の行までスコープされ
ます。マクロが次の行までスコープされ、行の引数が空であるなら、代わりに、
テキストでなければならない、次の行が使用されます。したがって:
.I
foo
は、`.I foo' と同等です。次の行マクロが連続的に呼び出されるなら、最後だけ
が使用されます。次の行マクロが次の行マクロでないものが続いているなら、エ
ラーが起こります。
構文は、次の通りです:
.YO [body...]
[body...]
マクロ 引数 スコープ 注
AT <=1 current
B n next-line
BI n current
BR n current
DT 0 current
EE 0 current compat
EX 0 current compat
I n next-line
IB n current
IR n current
OP 0, 1 current compat
PD 1 current
R n next-line
RB n current
RI n current
SB n next-line
SM n next-line
TH >1, <6 current
UC <=1 current
fi 0 current compat
in 1 current compat
nf 0 current compat
"compat" としてマークされたマクロは、roff の混合された方言である既存のマ
ニュアルの重要なコーパス (corpus) で互換性のためにインクルードされます。
これらのマクロは、移植性のある man マニュアルのために使用されるべきではあ
りません。
ブロックマクロ
ブロックマクロは、ヘッドと本体から成ります。インラインマクロと同様に、
ヘッドは、(同様にここで適用する「ラインマクロ」でのように次の行の規定) 次
の行の 1 つの状況で、現在の行にスコープされます。
構文は、次の通りです:
.YO [head...]
[head...]
[body...]
本体のスコープを閉じることは、セクションのためにあります、ここで、マクロ
は、SH によって閉じられます。セクションまたは SS によって閉じられたサブセ
クション。セクション、サブセクション、または RE によって閉じられた部分。
または、セクション、サブセクション、部分、HP, IP, LP, P, PP または TP に
よって閉じられたパラグラフ。閉じることは、マクロを閉じる明示的なブロック
を参照しません。
通例、ブロックマクロは、入れ子にされません。したがって、別のブロックマク
ロのスコープが開かれ、開らかれたスコープは、暗黙に閉じられない間に、ブ
ロックマクロを呼び出すことは、構文的に不正確です。
Macro Arguments Head Scope Body Scope Notes
HP <2 current paragraph
IP <3 current paragraph
LP 0 current paragraph
P 0 current paragraph
PP 0 current paragraph
RE 0 current none compat
RS 1 current part compat
SH >0 next-line section
SS >0 next-line sub-section
TP n next-line paragraph
UE 0 current none compat
UR 1 current part compat
"compat" とマークされたマクロは、「行マクロ」について言及されます。
ブロックマクロが、次の行にスコープされるなら、それは、テキストを飾るため
のインラインマクロだけが続きます。
フォント操作
man の文書で、「物理的なマークアップ」マクロと roff(7) `\f' フォントの
ケープシーケンスの両方は、フォントを選択するために使用することができま
す。テキスト行で、エスケープシーケンスによってマニュアルのフォントの選択
の効果は、次のマクロの呼び出しまで、単に存続します。マクロ行で、それは、
マクロのスコープの終わりまで、単に存続します。BR のようなマクロは、引数ご
とにフォントのスコープを開いて、閉じることに注意してください。
関連項目
man(1), mandoc(1), eqn(7), mandoc_char(7), mdoc(7), roff(7), tbl(7)
歴史
man 言語は、Version 7 AT&T UNIX の roff 植字システムのためのマクロパッ
ケージとしてはじめて登場しました。それは、後に、groff のためのマクロパッ
ケージとして James Clark によって書き直されました。Eric S. Raymond は、
2007 年に、groff のための拡張された man マクロを書きました。mandoc(1)
ユーティリティの一部であるスタンドアロンの実装は、OpenBSD 4.6 で登場し、
Kristaps Dzonsons によって書かれました。
作者
この man のリファレンスは、Kristaps Dzonsons <kristaps@bsd.lv> によって書
かれました。
警告
この言語を使用しないでください。代わりに、mdoc(7) を使用します。
FreeBSD 11.2 June 25, 2017 FreeBSD 11.2