[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
apropos.1 in man-db

From: UCHIDA Norihiro <KY4N-UCD@xxxxxxxxxxxxxxx>
Subject: apropos.1 in man-db
Date: Tue, 3 Oct 2000 01:23:56 +0900
X-dispatcher: imput version 20000228(IM140)
X-ml-info: If you have a question, send e-mail with the body "help" (without quotes) to the address debian-doc-ctl@debian.or.jp; help=<mailto:debian-doc-ctl@debian.or.jp?body=help>
X-ml-name: debian-doc
X-mlserver: fml [fml 3.0pl#17]; post only (only members can post)
Message-id: <20001003004543P.KY4N-UCD@xxxxxxxxxxxxxxx>
X-mail-count: 02105
X-mailer: Mew version 1.94.2 on Emacs 20.7 / Mule 4.1 (AOI)
続いて、apropos.1です。

.\" Man page for apropos
.\"
.\" 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>
.\" Modified Sun 6 Dec 1998 by NAKANO Takeo <nakano@xxxxxxxxxxxxxxxx>
.\" Updated Mon 2 Oct 2000 by UCHIDA Norihiro <KY4N-UCD@xxxxxxxxxxxxxxx>
.\"
.\"WORD:	hierarchy	階層
.\"WORD:	description	要約(文)
.\"

.\"O .TH apropos 1 "Wed Feb 23 00:00:00 EET 2000" "" "Manual pager utils"
.\"O .SH NAME
.\"O apropos \- search the manual page names and descriptions
.\"O .SH SYNOPSIS
.\"O .B apropos 
.\"O .RB [\| \-dhV  \|] 
.\"O .RB [\| \-e \||\| \-w \||\| \-r\c
.\"O \|]
.\"O .RB [\| \-m
.\"O .IR system \|[\|,.\|.\|.\|]\|]
.\"O .RB [ \-M
.\"O .IR path \|]
.\"O .I keyword
.\"O \&.\|.\|.

.TH apropos 1 "Wed Feb 23 00:00:00 EET 2000" "" "Manual pager utils"
.SH 名前
apropos \- マニュアルページの名前と内容を検索する
.SH 書式
.B apropos 
.RB [\| \-dhV  \|] 
.RB [\| \-e \||\| \-w \||\| \-r\c
\|]
.RB [\| \-m
.IR system \|[\|,.\|.\|.\|]\|]
.RB [ \-M
.IR path \|]
.I keyword
\&.\|.\|.

.\"O .SH DESCRIPTION
.\"O Each manual page has a short description available within
.\"O it. 
.\"O .B apropos
.\"O searches the descriptions for instances of
.\"O .IR keyword .

.SH 説明
それぞれのマニュアルページには、内容を説明する要約文が含まれている。
.B apropos
は、この要約文を対象にして
.I keyword
を検索する。

.\"O .I keyword
.\"O is usually a regular expression, as if 
.\"O .RB ( \-r )
.\"O was used, or
.\"O may contain wildcards
.\"O .RB ( \-w ) \ ,
.\"O or match the exact keyword
.\"O .RB ( \-e ) \ .
.\"O Using these options, 
.\"O it may be
.\"O necessary to quote the
.\"O .I keyword
.\"O or escape (\\) the special characters to stop the shell from interpreting them.

.I keyword
は、通常は正規表現
.RB ( \-r )
や、ワイルドカードを含めたり
.RB ( \-w )
、厳密な一致
.RB ( \-e )
を用いることができる。

これらのオプションを用いるときには、シェルによる解釈を防ぐために、
.I keyword
を引用符で囲むか、特殊文字をエスケープする (\\) 必要があるだろう。

.\"O The standard matching rules allow matches to
.\"O be made against the page name and word boundaries in 
.\"O the description.

標準的なマッチングパターンを指定すれば、
要約文中の単語の境界やページの名前もマッチの対象となる。

.\"O .SH OPTIONS
.\"O .TP
.\"O .B \-d, \-\-debug
.\"O Print debugging information.

.SH オプション
.TP
.B \-d, \-\-debug
デバッグ情報を表示する。

.\"O .TP
.\"O .B \-r, \-\-regex
.\"O Interpret each keyword as a regular expression. This is the default
.\"O behaviour.
.\"O Each keyword will be matched against the page names and the descriptions
.\"O independently. It can match any part of either. The match is not limited to
.\"O word boundaries.

.TP
.B \-r, \-\-regex
キーワードをそれぞれ正規表現として扱う。
これがデフォルトの動作である。
ページの名前と
要約文とが、それぞれ独立にキーワードマッチの対象になる。キーワードは
各々のあらゆる部分にマッチする。マッチは単語の境界に影響されない。

.\"O .TP
.\"O .B \-w, \-\-wildcard
.\"O Interpret each keyword as a pattern containing shell style wildcards.
.\"O Each keyword will be matched against the page names and the descriptions
.\"O independently. Only if an expanded keyword matches an entire description or
.\"O page name, will a match be found.

.TP
.B \-w, \-\-wildcard
それぞれのキーワードを、シェル形式のワイルドカードを含んだパターン
として扱う。ページの名前と
要約文とが、それぞれ独立にキーワードマッチの対象になる。
展開されたキーワードが要約文の全体またはページの名前にマッチする場合にのみ、
マッチしたと判定される。

.\"O .TP
.\"O .B \-e, \-\-exact
.\"O Each keyword will be exactly matched against the page names and the descriptions.

.TP
.B \-e, \-\-exact
それぞれのキーワードは、ページの名前と要約文に対して厳密にマッチする。

.\"
.\" 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).
.\"
.\"O .PP
.\"O .B \-m 
.\"O .I system\c 
.\"O .RB \|[\|,.\|.\|.\|]\| ,
.\"O .BI \-\-systems= system\c 
.\"O \|[\|,.\|.\|.\|]
.\"O .RS
.\"O If this system has access to other operating system's manual page
.\"O descriptions, they can be searched using this option. 
.\"O To search NewOS's manual page descriptions, 
.\"O use the option
.\"O .B \-m
.\"O .BR NewOS .
.\"O 
.\"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 .B whatis
.\"O descriptions, include the system name
.\"O .B man 
.\"O in the argument string.
.\"O This option will override the
.\"O .RB $ SYSTEM
.\"O environment variable.
.\"O .RE

.PP
.B \-m 
.I system\c 
.RB \|[\|,.\|.\|.\|]\| ,
.BI \-\-systems= system\c 
\|[\|,.\|.\|.\|]
.RS
現在のシステムから、他のオペレーティングシステムについてのマニュアルに
アクセスできる場合には、このオプションをつけるとそれらのマニュアルが
検索される。
NewOS のマニュアルページを検索する場合には、
.B \-m
.B NewOS
のようにオプションを指定する。

.I system
には複数のオペレーティングシステム名をコンマで区切った形式で指定できる。
ネイティブのオペレーティングシステムの
.B whatis
要約文を検索の対象に含めるためには、システム名
.B man
を引き数文字列に加える。
このオプションは
.RB $ SYSTEM
環境変数を上書きする。
.RE

.\"O .TP
.\"O .BI \-M\  path ,\ \-\-manpath= path
.\"O Specify an alternate set of colon delimited, manual page hierarchies to 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.
.\"O This option overrides the contents of
.\"O .RB $ MANPATH .

.TP
.BI \-M\  path ,\ \-\-manpath= path
検索対象にするマニュアルページの階層 (hierarchy) を変えたい場合、それ
らをコロンで区切った形式で指定する。
デフォルトでは、
.B apropos
は環境変数
.RB $ MANPATH
を用いる。これが空だったり設定されていなかった場合には、
.RB $ PATH
環境変数に基づいて、適切な manpath を決めようと試みる。
このオプションは
.RB $ MANPATH
の内容を上書きする。

.\"O .TP
.\"O .B \-h, \-\-help
.\"O Print a help message and exit.
.\"O .TP
.\"O .B \-V, \-\-version
.\"O Display version and author information.

.TP
.B \-h, \-\-help
ヘルプメッセージを表示して終了する。
.TP
.B \-V, \-\-version
バージョンと著者に関する情報を表示する。

.\"O .SH "EXIT STATUS"
.\"O .TP
.\"O .B 0
.\"O Successful program execution.
.\"O .TP
.\"O .B 1
.\"O Usage, syntax or configuration file error.
.\"O .TP
.\"O .B 2
.\"O Operational error.
.\"O .TP
.\"O .B 16
.\"O Nothing was found that matched the criteria specified.

.SH 返り値
.TP
.B 0
プログラムの実行に成功した。
.TP
.B 1
使用法、文法、設定ファイルのいずれかにエラーがある。
.TP
.B 2
実行時エラー。
.TP
.B 16
指定したキーワードにマッチするものが見つからなかった。


.\"O .SH ENVIRONMENT
.\"O .TP
.\"O .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.
.\"O .TP
.\"O .B MANPATH
.\"O If
.\"O .RB $ MANPATH
.\"O is set, its value is interpreted as the colon delimited, manual page hierarchy
.\"O search path to use.
.\"O .TP
.\"O .B POSIXLY_CORRECT
.\"O If 
.\"O .RB $ POSIXLY_CORRECT
.\"O is set, even to a null value, the default 
.\"O .B apropos 
.\"O search will be as an extended regex 
.\"O .RB ( \-r ) \ .
.\"O This is anyway the default behaviour.

.SH 環境変数
.TP
.B SYSTEM
.RB $ SYSTEM
環境変数が設定されている場合には、その内容が
.B \-m
オプションの引き数として指定された場合と同じ効力を持つ。
.TP
.B MANPATH
.RB $ MANPATH
が設定されている場合には、その内容は検索対象とするマニュアルの階層を
コロンで区切ったリストとみなされる。
.TP
.B POSIXLY_CORRECT
.RB $ POSIXLY_CORRECT
が設定されていると (内容が空であっても)、デフォルトの
.B apropos
の検索は拡張正規表現形式
.RB ( \-r )
で行われる。
どのみち、これがデフォルトの動作である。

.\"O .SH FILES
.\"O .TP
.\"O .I /usr/share/man/index.(bt|db|dir|pag)
.\"O A traditional global
.\"O .I index
.\"O database cache.
.\"O .TP
.\"O .I /var/cache/man/index.(bt|db|dir|pag)
.\"O An alternate or FHS
.\"O compliant global
.\"O .I index
.\"O database cache.
.\"O .TP
.\"O .I /usr/share/man/\|.\|.\|.\|/whatis
.\"O A traditional 
.\"O .B whatis
.\"O text database.

.SH ファイル
.TP
.I /usr/share/man/index.(bt|db|dir|pag)
従来形式の、 global なデータベースキャッシュの
インデックス。
.TP
.I /var/cache/man/index.(bt|db|dir|pag)
新しい (FHS 準拠の)、 global なデータベースキャッシュのインデックス。
.TP
.I /usr/share/man/\|.\|.\|.\|/whatis
従来形式の、
.B whatis
テキストデータベース。

.\"O .SH "SEE ALSO"
.\"O .BR whatis (1),
.\"O .BR man (1).
.\"O .SH AUTHOR
.\"O Wilf. (G.Wilford@xxxxxxxxxxxxxxx).
.\"O Fabrizio Polacco (fpolacco@debian.org).

.SH 関連項目
.BR whatis (1),
.BR man (1)
.SH 著者
Wilf. (G.Wilford@xxxxxxxxxxxxxxx).
Fabrizio Polacco (fpolacco@debian.org).

-----
内田憲宏 (UCHIDA Norihiro)
KY4N-UCD@xxxxxxxxxxxxxxx
Prev by Date: japanese man.1 in man-db
Next by Date: manpath.1 in man-db
Previous by thread: japanese man.1 in man-db
Next by thread: manpath.1 in man-db
Index(es):
- Date
- Thread