.\" Translated Fri 25 Sep 1998 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\" Modified Sun 6 Dec 1998 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\"
-.\"WORD: hierarchy ³¬ÁØ
-.\"WORD: description Í×Ìó(ʸ)
+.\"WORD: hierarchy 階層
+.\"WORD: description 要約(文)
.\"
.TH whatis 1 "July 12th, 1995" "2.3.10" "Manual pager utils"
-.SH ̾Á°
-whatis \- ¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ÎÍ×Ìó¤òɽ¼¨¤¹¤ë
-.SH ½ñ¼°
+.SH 名前
+whatis \- マニュアルページの要約を表示する
+.SH 書式
.RB [\| \-dhV \|]
.RB [\| \-r \||\| \-w\c
\|]
.IR path \|]
.I name
\&.\|.\|.
-.SH ÀâÌÀ
-¤½¤ì¤¾¤ì¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Ë¤Ï¡¢ÀèƬ¤Ëû¤¤Í×Ìóʸ¤¬½ñ¤«¤ì¤Æ¤¤¤ë¡£
+.SH 説明
+それぞれのマニュアルページには、先頭に短い要約文が書かれている。
.B whatis
-¤Ï¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î̾Á°¤ò¸¡º÷¤·¡¢
+はマニュアルページの名前を検索し、
.I name
-¤Ë¥Þ¥Ã¥Á¤·¤¿¤¹¤Ù¤Æ¤Î¥Þ¥Ë¥å¥¢¥ë¤«¤é¡¢¤³¤ÎÍ×Ìóʸ¤ò¼è¤ê½Ð¤·¤Æɽ¼¨¤¹¤ë¡£
+にマッチしたすべてのマニュアルから、この要約文を取り出して表示する。
.I name
-¤Ë¤Ï¥ï¥¤¥ë¥É¥«¡¼¥É
+にはワイルドカード
.RB ( \-w )
-¤äÀµµ¬É½¸½
+や正規表現
.RB ( \-r )
-¤òÍѤ¤¤ë¤³¤È¤¬¤Ç¤¤ë¡£
-¤³¤ì¤é¤Î¥ª¥×¥·¥ç¥ó¤òÍѤ¤¤¿ºÝ¤Ë¤Ï¡¢
+を用いることができる。
+これらのオプションを用いた際には、
.I name
-¤ò¥¯¥©¡¼¥È¤¹¤ë¤«¡¢Æü쥥ã¥é¥¯¥¿¤ò¥¨¥¹¥±¡¼¥× (\\) ¤·¤Æ¡¢
-¥·¥§¥ë¤Ë¤è¤Ã¤Æ²ò¼á¤µ¤ì¤Ê¤¤¤è¤¦¤Ë¤¹¤ëɬÍפ¬¤¢¤ë¤«¤â¤·¤ì¤Ê¤¤¡£
+をクォートするか、特殊キャラクタをエスケープ (\\) して、
+シェルによって解釈されないようにする必要があるかもしれない。
.B index
-¥Ç¡¼¥¿¥Ù¡¼¥¹¤¬¸¡º÷¤ÎºÝ¤ËÍѤ¤¤é¤ì¤ë¡£¸Å¤¤¥¹¥¿¥¤¥ë¤Î
+データベースが検索の際に用いられる。古いスタイルの
.B whatis
-¥Æ¥¥¹¥È¥Ç¡¼¥¿¥Ù¡¼¥¹¤ò¡¢Âбþ¤¹¤ë
+テキストデータベースを、対応する
.B index
-¥Ç¡¼¥¿¥Ù¡¼¥¹¤«¤éºî¤ê¤¿¤¤¾ì¹ç¤Ë¤Ï¡¢°Ê²¼¤Î¤è¤¦¤Ê¥³¥Þ¥ó¥É¤ò¼Â¹Ô¤¹¤ì¤Ð¤è¤¤¡£
+データベースから作りたい場合には、以下のようなコマンドを実行すればよい。
.B whatis \-M
.I manpath
.B \-w '*' | sort >
.I manpath/whatis
-¤³¤³¤Ç
+ここで
.I manpath
-¤Ë¤Ï
+には
.I /usr/man
-¤Î¤è¤¦¤Ê¡¢¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î³¬ÁØ (hierarchy) ¤ò»ØÄꤹ¤ë¡£
-.SH ¥ª¥×¥·¥ç¥ó
+のような、マニュアルページの階層 (hierarchy) を指定する。
+.SH オプション
.TP
.B \-d, \-\-debug
-¥Ç¥Ð¥Ã¥°¾ðÊó¤òɽ¼¨¤¹¤ë¡£
+デバッグ情報を表示する。
.TP
.B \-r, \-\-regex
.I name
-¤òÀµµ¬É½¸½¤È¤·¤Æ²ò¼á¤¹¤ë¡£
+を正規表現として解釈する。
.I name
-¤¬¥Ú¡¼¥¸Ì¾¤Î°ìÉôʬ¤Ë¥Þ¥Ã¥Á¤¹¤ì¤Ð¡¢¥Þ¥Ã¥Á¤·¤¿¤È¤ß¤Ê¤µ¤ì¤ë¡£
-¤³¤Î¥ª¥×¥·¥ç¥ó¤ò»ØÄꤹ¤ë¤È¡¢¥Ç¡¼¥¿¥Ù¡¼¥¹¸¡º÷¤ÎÀ¼Á¾å¡¢
+がページ名の一部分にマッチすれば、マッチしたとみなされる。
+このオプションを指定すると、データベース検索の性質上、
.B whatis
-¤ÎÆ°ºî¤¬Â¿¾¯ÃÙ¤¯¤Ê¤ë¡£
+の動作が多少遅くなる。
.TP
.B \-w, \-\-wildcard
.I name
-¤ò¥·¥§¥ë·Á¼°¤Î¥ï¥¤¥ë¥É¥«¡¼¥É¤ò´Þ¤à¥Ñ¥¿¡¼¥ó¤È¤·¤Æ²ò¼á¤¹¤ë¡£
-¥Þ¥Ã¥Á¤¹¤ë¤¿¤á¤Ë¤Ï¡¢Å¸³«¤µ¤ì¤¿
+をシェル形式のワイルドカードを含むパターンとして解釈する。
+マッチするためには、展開された
.I name
-¤¬¥Ú¡¼¥¸Ì¾¤ÎÁ´ÂΤ˥ޥåÁ¤·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
-¤³¤Î¥ª¥×¥·¥ç¥ó¤ò»ØÄꤹ¤ë¤È¡¢¥Ç¡¼¥¿¥Ù¡¼¥¹¸¡º÷¤ÎÀ¼Á¾å¡¢
+がページ名の全体にマッチしなければならない。
+このオプションを指定すると、データベース検索の性質上、
.B whatis
-¤ÎÆ°ºî¤¬Â¿¾¯ÃÙ¤¯¤Ê¤ë¡£
+の動作が多少遅くなる。
.PP
.B \-m
.I system\c
.BI \-\-systems= system\c
\|[\|,.\|.\|.\|]
.RS
-¸½ºß¤Î¥·¥¹¥Æ¥à¤«¤é¡¢Â¾¤Î¥ª¥Ú¥ì¡¼¥Æ¥£¥ó¥°¥·¥¹¥Æ¥à¤Ë¤Ä¤¤¤Æ¤Î¥Þ¥Ë¥å¥¢¥ë¤Ë
-¥¢¥¯¥»¥¹¤Ç¤¤ë¾ì¹ç¤Ë¤Ï¡¢¤³¤Î¥ª¥×¥·¥ç¥ó¤ò¤Ä¤±¤ë¤È¤½¤ì¤é¤Î¥Þ¥Ë¥å¥¢¥ë¤¬
-¸¡º÷¤µ¤ì¤ë¡£
-NewOS ¤Î¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤ò¸¡º÷¤¹¤ë¾ì¹ç¤Ë¤Ï¡¢
+現在のシステムから、他のオペレーティングシステムについてのマニュアルに
+アクセスできる場合には、このオプションをつけるとそれらのマニュアルが
+検索される。
+NewOS のマニュアルページを検索する場合には、
.B \-m
.B NewOS
-¤Î¤è¤¦¤Ê¥ª¥×¥·¥ç¥ó¤ò»ØÄꤹ¤ë¡£
+のようなオプションを指定する。
.I system
-¤Ë¤ÏÊ£¿ô¤Î¥ª¥Ú¥ì¡¼¥Æ¥£¥ó¥°¥·¥¹¥Æ¥à¤ò¥³¥ó¥Þ¤Ç¶èÀڤä¿·Á¼°¤Ç»ØÄê¤Ç¤¤ë¡£
-¥Í¥¤¥Æ¥£¥Ö¤Î¥ª¥Ú¥ì¡¼¥Æ¥£¥ó¥°¥·¥¹¥Æ¥à¤Î
-¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸Ì¾¤ò¸¡º÷¤ÎÂоݤ˴ޤá¤ë¤¿¤á¤Ë¤Ï¡¢¥·¥¹¥Æ¥à̾
+には複数のオペレーティングシステムをコンマで区切った形式で指定できる。
+ネイティブのオペレーティングシステムの
+マニュアルページ名を検索の対象に含めるためには、システム名
.B man
-¤ò°ú¤¿ôʸ»úÎó¤Ë²Ã¤¨¤ë¡£
-¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï
+を引き数文字列に加える。
+このオプションは
.RB $ SYSTEM
-´Ä¶ÊÑ¿ô¤ò¾å½ñ¤¤¹¤ë¡£
+環境変数を上書きする。
.RE
.TP
.BI \-M\ path ,\ \-\-manpath= path
-¸¡º÷Âоݤˤ¹¤ë¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤Î³¬ÁؤòÊѤ¨¤¿¤¤¾ì¹ç¡¢¤½¤ì¤é¤ò¥³¥í¥ó¤Ç
-¶èÀڤä¿·Á¼°¤Ç»ØÄꤹ¤ë¡£
-¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï¡¢
+検索対象にするマニュアルページの階層を変えたい場合、それらをコロンで
+区切った形式で指定する。
+デフォルトでは、
.B whatis
-¤Ï´Ä¶ÊÑ¿ô
+は環境変数
.RB $ MANPATH
-¤òÍѤ¤¤ë¡£¤³¤ì¤¬¶õ¤À¤Ã¤¿¤êÀßÄꤵ¤ì¤Æ¤¤¤Ê¤«¤Ã¤¿¾ì¹ç¤Ë¤Ï¡¢
+を用いる。これが空だったり設定されていなかった場合には、
.RB $ PATH
-´Ä¶ÊÑ¿ô¤Ë´ð¤Å¤¤¤Æ¡¢Å¬ÀÚ¤Ê manpath ¤ò·è¤á¤è¤¦¤È»î¤ß¤ë¡£
-¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï
+環境変数に基づいて、適切な manpath を決めようと試みる。
+このオプションは
.RB $ MANPATH
-¤ÎÆâÍƤò¾å½ñ¤¤¹¤ë¡£
+の内容を上書きする。
.TP
.B \-h, \-\-help
-¥Ø¥ë¥×¥á¥Ã¥»¡¼¥¸¤òɽ¼¨¤·¤Æ½ªÎ»¤¹¤ë¡£
+ヘルプメッセージを表示して終了する。
.TP
.B \-V, \-\-version
-¥Ð¡¼¥¸¥ç¥ó¤ÈÃø¼Ô¤Ë´Ø¤¹¤ë¾ðÊó¤òɽ¼¨¤¹¤ë¡£
-.SH ÊÖ¤êÃÍ
+バージョンと著者に関する情報を表示する。
+.SH 返り値
.TP
.B 0
-¥×¥í¥°¥é¥à¤Î¼Â¹Ô¤ËÀ®¸ù¤·¤¿¡£
+プログラムの実行に成功した。
.TP
.B 1
-»ÈÍÑË¡¡¢Ê¸Ë¡¡¢ÀßÄê¥Õ¥¡¥¤¥ë¤Î¤¤¤º¤ì¤«¤Ë¥¨¥é¡¼¤¬¤¢¤ë¡£
+使用法、文法、設定ファイルのいずれかにエラーがある。
.TP
.B 2
-¼Â¹Ô»þ¥¨¥é¡¼¡£
+実行時エラー。
.TP
.B 16
-»ØÄꤷ¤¿¥¡¼¥ï¡¼¥É¤Ë¥Þ¥Ã¥Á¤¹¤ë¤â¤Î¤¬¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿¡£
-.SH ´Ä¶ÊÑ¿ô
+指定したキーワードにマッチするものが見つからなかった。
+.SH 環境変数
.TP
.B SYSTEM
.RB $ SYSTEM
-´Ä¶ÊÑ¿ô¤¬ÀßÄꤵ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ë¤Ï¡¢¤½¤ÎÆâÍƤ¬
+環境変数が設定されている場合には、その内容が
.B \-m
-¥ª¥×¥·¥ç¥ó¤Î°ú¤¿ô¤È¤·¤Æ»ØÄꤵ¤ì¤¿¾ì¹ç¤ÈƱ¤¸¸úÎϤò»ý¤Ä¡£
+オプションの引き数として指定された場合と同じ効力を持つ。
.TP
.B MANPATH
.RB $ MANPATH
-¤¬ÀßÄꤵ¤ì¤Æ¤¤¤ë¤È¡¢¤½¤ÎÆâÍƤϡ¢¸¡º÷ÂоݤȤ¹¤ë¥Þ¥Ë¥å¥¢¥ë¤Î³¬Áؤò
-¥³¥í¥ó¤Ç¶èÀڤ俥ꥹ¥È¤È¤ß¤Ê¤µ¤ì¤ë¡£
-.SH ¥Õ¥¡¥¤¥ë
+が設定されていると、その内容は、検索対象とするマニュアルの階層を
+コロンで区切ったリストとみなされる。
+.SH ファイル
.TP
.I /usr/man/index.(bt|db|dir|pag)
-½¾Íè·Á¼°¤Î¡¢ global ¤Ê¥Ç¡¼¥¿¥Ù¡¼¥¹¥¥ã¥Ã¥·¥å¤Î
-¥¤¥ó¥Ç¥Ã¥¯¥¹¡£
+従来形式の、 global なデータベースキャッシュの
+インデックス。
.TP
.I /var/catman/index.(bt|db|dir|pag)
-¿·¤·¤¤ (FSSTND ½àµò¤Î)¡¢ global ¤Ê¥Ç¡¼¥¿¥Ù¡¼¥¹¥¥ã¥Ã¥·¥å¤Î¥¤¥ó¥Ç¥Ã¥¯¥¹¡£
+新しい (FSSTND 準拠の)、 global なデータベースキャッシュのインデックス。
.TP
.I /usr/man/\|.\|.\|.\|/whatis
-½¾Íè·Á¼°¤Î¡¢
+従来形式の、
.B whatis
-¥Æ¥¥¹¥È¥Ç¡¼¥¿¥Ù¡¼¥¹¡£
-.SH ´ØÏ¢¹àÌÜ
+テキストデータベース。
+.SH 関連項目
.BR apropos (1),
.BR man (1)
-.SH Ãø¼Ô
+.SH 著者
Wilf. (G.Wilford@ee.surrey.ac.uk)
OSDN Git Service
