whatis.1j

[nakano@xxxxxxxxxxxxxxxx]

.\" Man page for whatis
.\"
.\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.)
.\"
.\" You may distribute under the terms of the GNU General Public
.\" License as specified in the file COPYING that comes with the
.\" man_db distribution.
.\"
.\" Sat Oct 29 13:09:31 GMT 1994  Wilf. (G.Wilford@xxxxxxxxxxxxxxx) 
.\" 
.\" Japanese Version Copyright (c) 1998 NAKANO Takeo all rights reserved.
.\" Translated Fri 25 Sep 1998 by NAKANO Takeo <nakano@xxxxxxxxxxxxxxxx>
.\"
.\"WORD:	hierarchy	系列
.\"WORD:	description	要約行
.\"
.TH whatis 1 "July 12th, 1995" "2.3.10" "Manual pager utils"
.\"O .SH NAME
.\"O whatis \- display manual page descriptions
.SH 名前
.B whatis \- マニュアルページの要約行を表示する
.\"O .SH SYNOPSIS
.SH 書式
.RB [\| \-dhV \|] 
.RB [\| \-r \||\| \-w\c 
\|] 
.RB [\| \-m
.IR system \|[\|,.\|.\|.\|]\|]
.RB [\| \-M 
.IR path \|] 
.I name 
\&.\|.\|.
.\"O .SH DESCRIPTION
.SH 説明
.\"O Each manual page has a short description available within
.\"O it. 
.\"O .B whatis
.\"O searches the manual page names and displays the manual page descriptions
.\"O of any 
.\"O .I name
.\"O matched.
それぞれのマニュアルページには、先頭に短い要約が書かれている。
.B whatis
はマニュアルページの名前を検索し、
.I name
にマッチしたすべてのマニュアルから、この要約行を取り出して表示する。

.\"O .I name
.\"O may contain wildcards
.\"O .RB ( \-w )
.\"O or be a regular expression
.\"O .RB ( \-r ).
.\"O Using these options,
.\"O it may be
.\"O necessary to quote the
.\"O .I name
.\"O or escape (\\) the special characters to stop the shell from interpreting
.\"O them.
.I name
にはワイルドカード
.RB ( \-w )
や正規表現
.RB ( \-r )
を用いることができる。
これらのオプションを用いた際には、
.I name
をクォートするか、特殊キャラクタをエスケープ (\\) して、
シェルによって解釈されないようにする必要があるかもしれない。

.\"O .B index 
.\"O databases are used during the search.
.\"O To produce an old style text
.\"O .B whatis 
.\"O database from the relative
.\"O .B index 
.\"O database, issue the command:
.B index
データベースが検索の際に用いられる。古いスタイルの
.B whatis
テキストデータベースを、対応する
.B index
データベースから作りたい場合には、以下のようなコマンドを実行すればよい。

.B whatis \-M 
.I manpath  
.B \-w  '*' | sort > 
.I manpath/whatis

.\"O where 
.\"O .I manpath 
.\"O is a manual page hierarchy such as 
.\"O .IR /usr/man .
ここで
.I manpath
には
.I /usr/man
のような、マニュアルページの系列 (hierarchy) を指定する。
.\"O .SH OPTIONS
.SH オプション
.TP
.B \-d, \-\-debug
.\"O Print debugging information.
デバッグ情報を表示する。
.TP
.B \-r, \-\-regex
.\"O Interpret each 
.\"O .I name 
.\"O as a regular expression.
.\"O If a 
.\"O .I name 
.\"O matches any part of a page name, a match will be made.
.\"O This option causes 
.\"O .B whatis 
.\"O to be somewhat slower due to the nature of database searches.
.I name
を正規表現として解釈する。
.I name
がページ名の一部分にマッチすれば、マッチしたとみなされる。
このオプションを指定すると、データベース検索の性質上、
.B whatis
の動作が多少遅くなる。
.TP
.B \-w, \-\-wildcard
.\"O Interpret each 
.\"O .I name 
.\"O as a pattern containing shell style wildcards.
.\"O For a match to be made, an expanded 
.\"O .I name 
.\"O must match the entire page name.
.\"O This option causes
.\"O .B whatis
.\"O to be somewhat slower due to the nature of database searches.
.I name
をシェル形式のワイルドカードを含むパターンとして解釈する。
マッチするためには、展開された
.I name
がページ名の全体にマッチしなければならない。
このオプションを指定すると、データベース検索の性質上、
.B whatis
の動作が多少遅くなる。
.\"
.\" Due to the rather silly limit of 6 args per request in some `native'
.\" *roff compilers, we have do the following to get the two-line
.\" hanging tag on one line. .PP to begin a new paragraph, then the
.\" tag, then .RS (start relative indent), the text, finally .RE
.\" (end relative indent).
.\"
.PP
.B \-m 
.I system\c 
.RB \|[\|,.\|.\|.\|]\| ,
.BI \-\-systems= system\c 
\|[\|,.\|.\|.\|]
.RS
.\"O If this system has access to other operating system's manual page names, 
.\"O they can be accessed using this option.
.\"O To search NewOS's manual page names,
.\"O use the option
.\"O .B \-m
.\"O .BR NewOS .
現在のシステムから、他のオペレーティングシステムについてのマニュアルに
アクセスできる場合には、このオプションをつけるとそれらのマニュアルが
検索される。
NewOS のマニュアルページを検索する場合には、
.B \-m
.B NewOS
のようなオプションを指定する。

.\"O The
.\"O .I system
.\"O specified can be a combination of comma delimited operating
.\"O system names.
.\"O To include a search of the native operating system's
.\"O manual page names, include the system name
.\"O .B man
.\"O in the argument string.
.\"O This option will override the
.\"O .RB $ SYSTEM
.\"O environment variable.
.I system
には複数のオペレーティングシステムをコンマで区切った形式で指定できる。
ネイティブのオペレーティングシステムの
.B whatis
記述を検索の対象に含めるためには、システム名
.B man
を引き数文字列に加える。
このオプションは
.BR $ SYSTEM
環境変数を上書きする。
.RE
.TP
.BI \-M\  path ,\ \-\-manpath= path
.\"O Specify an alternate set of colon delimited, manual page hierarchies to
.\"O search.
検索対象にするマニュアルページの系列を変えたい場合、それらをコロンで
区切った形式で指定する。
.\"O By default,
.\"O .B apropos
.\"O uses the
.\"O .RB $ MANPATH
.\"O environment variable unless it is empty or unset in which case it will
.\"O determine an appropriate manpath based on your
.\"O .RB $ PATH
.\"O environment variable.
デフォルトでは、
.B whatis
は環境変数
.RB $ MANPATH
を用いる。これが空だったり設定されていなかった場合には、
.RB $ PATH
環境変数に基づいて、適切な manpath を決めようと試みる。
.\"O This option overrides the contents of
.\"O .RB $ MANPATH .
このオプションは
.RB $ MANPATH
の内容を上書きする。
.TP
.B \-h, \-\-help
.\"O Print a help message and exit.
ヘルプメッセージを表示して終了する。
.TP
.B \-V, \-\-version
.\"O Display version and author information.
バージョンと著者に関する情報を表示する。
.\"O .SH "EXIT STATUS"
.SH 返り値
.TP
.B 0
.\"O Successful program execution.
プログラムの実行に成功した。
.TP
.B 1
.\"O Usage, syntax or configuration file error.
使用法、文法、設定ファイルのいずれかにエラーがある。
.TP
.B 2
.\"O Operational error.
実行時エラー。
.TP
.B 16
.\"O No manual pages were found that matched the criteria specified. 
指定したキーワードにマッチするものが見つからなかった。
.\"O .SH ENVIRONMENT
.SH 環境変数
.TP
.B SYSTEM
.\"O If
.\"O .RB $ SYSTEM
.\"O is set, it will have the same effect as if it had been specified as the
.\"O argument to the
.\"O .B \-m
.\"O option.
.RB $ SYSTEM
環境変数が設定されている場合には、その内容が
.B \-m
オプションの引き数として指定された場合と同じ効力を持つ。
.TP
.B MANPATH
.\"O If
.\"O .RB $ MANPATH
.\"O is set, its value is interpreted as the colon delimited, manual page
.\"O hierarchy search path to use.
.RB $ MANPATH
が設定されていると、その内容は、検索対象とするマニュアルの系列を
コロンで区切ったリストとみなされる。
.\"O .SH FILES
.SH ファイル
.TP
.I /usr/man/index.(bt|db|dir|pag)
.\"O A traditional global
.\"O .I index
.\"O database cache.
従来形式の、 global なデータベースキャッシュの
インデックス。
.TP
.I /var/catman/index.(bt|db|dir|pag)
.\"O An alternate or FSSTND
.\"O compliant global
.\"O .I index
.\"O database cache.
新しい (FSSTND 準拠の)、 global なデータベースキャッシュのインデックス。
.TP
.I /usr/man/\|.\|.\|.\|/whatis
.\"O A traditional 
.\"O .B whatis
.\"O text database. 
従来形式の、
.B whatis
テキストデータベース。
.\"O .SH "SEE ALSO"
.SH 関連項目
.BR apropos (1),
.\"O .BR man (1).
.BR man (1)
.\"O .SH AUTHOR
.SH 著者
Wilf. (G.Wilford@xxxxxxxxxxxxxxx)