989d921f5d
I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
235 lines
5.6 KiB
Groff
235 lines
5.6 KiB
Groff
.\" Man page for man
|
|
.\"
|
|
.\" Copyright (c) 1990, 1991, John W. Eaton.
|
|
.\"
|
|
.\" You may distribute under the terms of the GNU General Public
|
|
.\" License as specified in the README file that comes with the man 1.0
|
|
.\" distribution.
|
|
.\"
|
|
.\" John W. Eaton
|
|
.\" jwe@che.utexas.edu
|
|
.\" Department of Chemical Engineering
|
|
.\" The University of Texas at Austin
|
|
.\" Austin, Texas 78712
|
|
.\"
|
|
.\" %FreeBSD: src/gnu/usr.bin/man/man/man.man,v 1.23 2004/07/02 21:53:39 ru Exp %
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.Dd January 5, 1991
|
|
.Dt MAN 1
|
|
.Os
|
|
.Sh 名称
|
|
.Nm man
|
|
.Nd オンラインマニュアルのフォーマット、表示を行なう
|
|
.Sh 書式
|
|
.Nm
|
|
.Op Fl adfhkotw
|
|
.Op Fl m Ar machine
|
|
.Op Fl p Ar string
|
|
.Op Fl M Ar path
|
|
.Op Fl P Ar pager
|
|
.Op Fl S Ar list
|
|
.Op Ar section
|
|
.Ar name ...
|
|
.Sh 解説
|
|
.Nm
|
|
はオンラインマニュアルをフォーマットし、表示します。
|
|
このバージョンでは、環境変数
|
|
.Ev MANPATH
|
|
と
|
|
.Ev PAGER
|
|
を参照するので、
|
|
各ユーザが固有のオンラインマニュアルを持つ事や、画面で見る際のページャを
|
|
選ぶ事が可能です。
|
|
セクションを指定した場合、
|
|
.Nm
|
|
はそのセクションのみを探します。
|
|
また、コマンドラインオプションや環境変数によって、
|
|
検索するセクションの順序や、ソースファイルを処理するプリプロセッサを
|
|
指定することもできます。
|
|
システム管理者の設定によっては、
|
|
ディスクスペースを節約するために、フォーマット済みのオンライン
|
|
マニュアルを `/usr/bin/gzip -c' コマンドにより
|
|
圧縮し格納するようにすることも出来ます。
|
|
.Pp
|
|
オプションを以下に示します:
|
|
.Bl -tag -width Fl
|
|
.It Fl M Ar path
|
|
別の manpath を指定します。通常、
|
|
.Nm
|
|
は
|
|
.Xr manpath 1
|
|
(
|
|
.Nm
|
|
バイナリに組み込まれています) を使い、検索するパスを決めます。
|
|
このオプションは環境変数
|
|
.Ev MANPATH
|
|
よりも優先されます。
|
|
.It Fl P Ar pager
|
|
使用するページャを指定します。通常、
|
|
.Nm
|
|
は、
|
|
.Nm more -s
|
|
を使用します。
|
|
このオプションは環境変数
|
|
.Ev PAGER
|
|
よりも優先されます。
|
|
.It Fl S Ar list
|
|
list はコロンで区切られた検索するマニュアルのセクションのリストです。
|
|
このオプションは環境変数
|
|
.Ev MANSECT
|
|
よりも優先されます。
|
|
.It Fl a
|
|
通常、
|
|
.Nm
|
|
は最初にみつかったマニュアルページを表示した後終了しますが、
|
|
このオプションを使用すると、最初にみつかったマニュアルページだけでなく、
|
|
.Ar name
|
|
にマッチしたマニュアルページを全て表示します。
|
|
.It Fl d
|
|
マニュアルページは表示せず、デバッグ用の情報を表示します。
|
|
.It Fl f
|
|
.Nm whatis
|
|
と同じです。
|
|
.It Fl h
|
|
ヘルプメッセージを表示して終了します。
|
|
.It Fl k
|
|
.Nm apropos
|
|
と同じです。
|
|
.It Fl m Ar machine
|
|
マニュアルページによっては、特定のアーキテクチャに特化したものがあります。
|
|
.Nm
|
|
は、検索対象のすべてのディレクトリ中で、
|
|
現在のアーキテクチャと同じ名前のサブディレクトリを検索します。
|
|
マシン固有の検索範囲が、一般的な検索範囲の前に検索されます。
|
|
現在のマシンタイプは、環境変数
|
|
.Ev MACHINE
|
|
を特定のアーキテクチャ名に設定することで変えられます。
|
|
本オプションは、
|
|
.Ev MACHINE
|
|
環境変数に優先します。
|
|
.It Fl o
|
|
元の、非ローカライズ版マニュアルページのみを検索します。
|
|
.Pp
|
|
デフォルトでは、
|
|
.Nm
|
|
は、
|
|
各
|
|
.Xr manpath 1
|
|
構成要素毎にローカライズ版サブディレクトリを検索します。
|
|
.Pp
|
|
ロケール名は、3 個の環境変数
|
|
.Ev LC_ALL ,
|
|
.Ev LC_CTYPE ,
|
|
.Ev LANG
|
|
のうち、この順番における最初の空ではないものから得られます。
|
|
.Pp
|
|
値を決定できない場合か、無効なロケール名である場合、
|
|
ローカライズされていないマニュアルページのみが検索されます。
|
|
.Pp
|
|
そうでない場合、
|
|
.Nm
|
|
は次のサブディレクトリを、次の優先順位で検索します:
|
|
.Pp
|
|
.Bl -item -offset indent -compact
|
|
.Sm off
|
|
.It
|
|
.Pa <lang> _ <country> . <charset>
|
|
.It
|
|
.Pa <lang> . <charset>
|
|
.It
|
|
.Pa en . <charset>
|
|
.Sm on
|
|
.El
|
|
.Pp
|
|
例えば
|
|
.Dq de_DE.ISO8859-1
|
|
ロケールの場合、
|
|
.Pa /usr/share/man
|
|
manpath 構成要素中の次のサブディレクトリを
|
|
.Nm
|
|
は検索します:
|
|
.Pp
|
|
.Bl -item -offset indent -compact
|
|
.It
|
|
.Pa /usr/share/man/de_DE.ISO8859-1
|
|
.It
|
|
.Pa /usr/share/man/de.ISO8859-1
|
|
.It
|
|
.Pa /usr/share/man/en.ISO8859-1
|
|
.El
|
|
.Pp
|
|
最後に、ローカライズされたマニュアルページが見付からなかった場合、
|
|
デフォルトの
|
|
.Pa /usr/share/man
|
|
ディレクトリを検索します。
|
|
.It Fl p Ar string
|
|
nroff や troff を行う前に実行するプリプロセッサの順序を指定します。
|
|
全てのプリプロセッサがインストールされているとはかぎりません。
|
|
プリプロセッサとそれを指定するのに使われる文字は以下の通りです。
|
|
eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r).
|
|
このオプションは環境変数
|
|
.Ev MANROFFSEQ
|
|
よりも優先されます。
|
|
.It Fl t
|
|
マニュアルページをフォーマットするのに
|
|
.Nm /usr/bin/groff -S -man
|
|
を使い、標準出力に出力します。
|
|
.Nm /usr/bin/groff -S -man
|
|
の出力は表示する前に何らかのフィルタを通す必要があるでしょう。
|
|
.It Fl w
|
|
マニュアルページの表示は行わず、フォーマットや表示を行なうべきファイルの
|
|
場所を表示します。
|
|
.El
|
|
.Sh 環境変数
|
|
.Bl -tag -width MANROFFSEQ
|
|
.It Ev LC_ALL , LC_CTYPE , LANG
|
|
これらの環境変数は、マニュアルページの好みの言語を指定します (前述の
|
|
.Fl o
|
|
オプションを参照してください)。
|
|
.It Ev MACHINE
|
|
.Ev MACHINE
|
|
が設定されると、マシン固有のサブディレクトリを検索するときに、
|
|
この値が現在のマシンタイプに優先します。
|
|
.It Ev MANPATH
|
|
.Ev MANPATH
|
|
がセットされていれば、その値はマニュアルページを検索するパスとして使われます。
|
|
.It Ev MANROFFSEQ
|
|
.Ev MANROFFSEQ
|
|
がセットされていれば、その値は nroff や troff を行う前に実行される
|
|
プリプロセッサの順序を示すのに使われます。
|
|
デフォルトでは、nroff の前に tbl プリプロセッサが実行されます。
|
|
.It Ev MANSECT
|
|
.Ev MANSECT
|
|
がセットされていれば、その値はどのマニュアルセクションを検索するのかを
|
|
決定するのに使われます。
|
|
.It Ev PAGER
|
|
.Ev PAGER
|
|
がセットされていれば、その値はマニュアルページを表示するのに使われる
|
|
プログラムの名前を指定するのに使われます。セットされていなければ、
|
|
.Nm more -s
|
|
が使われます。
|
|
.El
|
|
.Sh 使用例
|
|
通常、getopt の適切なマニュアルページ情報を検索するには、次のようにします:
|
|
.Pp
|
|
.Dl man getopt
|
|
.Pp
|
|
一方、特定のマニュアルセクション、例えば
|
|
.Xr getopt 3
|
|
を検索するには、次のようにします:
|
|
.Pp
|
|
.Dl man 3 getopt
|
|
.Sh 関連項目
|
|
.Xr apropos 1 ,
|
|
.Xr groff 1 ,
|
|
.Xr manpath 1 ,
|
|
.Xr more 1 ,
|
|
.Xr whatis 1 ,
|
|
.Xr man 7 ,
|
|
.Xr mdoc 7
|
|
.Sh バグ
|
|
.Fl t
|
|
オプションは
|
|
.Xr troff 1
|
|
ライクなプログラムがインストールされている場合のみ有効です。
|