File: apropos.1

package info (click to toggle)
manpages-ja 0.5.0.0.20210215%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 28,568 kB
  • sloc: perl: 161; makefile: 58
file content (162 lines) | stat: -rw-r--r-- 5,191 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
.\" 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@ee.surrey.ac.uk) 
.\" 
.\" Japanese Version Copyright (c) 1998 NAKANO Takeo all rights reserved.
.\" 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	要約(文)
.\"
.TH apropos 1 "July 12th, 1995" "2.3.10" "Manual pager utils"
.SH 名前
apropos \- マニュアルページの名前と内容を検索する
.SH 書式
.B apropos 
.RB [\| \-dhV  \|] 
.RB [\| \-r \||\| \-w\c
\|]
.RB [\| \-m
.IR system \|[\|,.\|.\|.\|]\|]
.RB [ \-M
.IR path \|]
.I keyword
\&.\|.\|.
.SH 説明
それぞれのマニュアルページには、内容を説明する要約文が含まれている。
.B apropos
は、この要約文を対象にして
.I keyword
を検索する。
.I keyword
にはワイルドカード
.RB ( \-w )
や正規表現
.RB ( \-r )
を用いることもできる。
これらのオプションを用いるときには、シェルによる解釈を防ぐために、
.I keyword
を引用符で囲むか、特殊文字をエスケープする (\\) 必要があるかもしれない。

標準的なマッチングパターンを指定すれば、
要約文中の単語の境界やページの名前もマッチの対象となる。
.SH オプション
.TP
.B \-d, \-\-debug
デバッグ情報を表示する。
.TP
.B \-r, \-\-regex
キーワードをそれぞれ正規表現として扱う。ページの名前と
要約文とが、それぞれ独立にキーワードマッチの対象になる。キーワードは
各々のあらゆる部分にマッチする。マッチは単語の境界に影響されない。
.TP
.B \-w, \-\-wildcard
それぞれのキーワードを、シェル形式のワイルドカードを含んだパターン
として扱う。ページの名前と
要約文とが、それぞれ独立にキーワードマッチの対象になる。
展開されたキーワードがページまたは記述の全体にマッチする場合にのみ、
マッチしたと判定される。
.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
.TP
.BI \-M\  path ,\ \-\-manpath= path
検索対象にするマニュアルページの階層 (hierarchy) を変えたい場合、それ
らをコロンで区切った形式で指定する。
デフォルトでは、
.B apropos
は環境変数
.RB $ MANPATH
を用いる。これが空だったり設定されていなかった場合には、
.RB $ PATH
環境変数に基づいて、適切な manpath を決めようと試みる。
このオプションは
.RB $ MANPATH
の内容を上書きする。
.TP
.B \-h, \-\-help
ヘルプメッセージを表示して終了する。
.TP
.B \-V, \-\-version
バージョンと著者に関する情報を表示する。
.SH 返り値
.TP
.B 0
プログラムの実行に成功した。
.TP
.B 1
使用法、文法、設定ファイルのいずれかにエラーがある。
.TP
.B 2
実行時エラー。
.TP
.B 16
指定したキーワードにマッチするものが見つからなかった。
.SH 環境変数
.TP
.B SYSTEM
.RB $ SYSTEM
環境変数が設定されている場合には、その内容が
.B \-m
オプションの引き数として指定された場合と同じ効力を持つ。
.TP
.B MANPATH
.RB $ MANPATH
が設定されている場合には、その内容は検索対象とするマニュアルの階層を
コロンで区切ったリストとみなされる。
.TP
.B POSIXLY_CORRECT
.RB $ POSIXLY_CORRECT
が設定されていると (内容が空であっても)、デフォルトの
.B apropos
の検索は拡張正規表現形式
.RB ( \-r )
で行われる。
.SH ファイル
.TP
.I /usr/man/index.(bt|db|dir|pag)
従来形式の、 global なデータベースキャッシュの
インデックス。
.TP
.I /var/catman/index.(bt|db|dir|pag)
新しい (FSSTND 準拠の)、 global なデータベースキャッシュのインデックス。
.TP
.I /usr/man/\|.\|.\|.\|/whatis
従来形式の、
.B whatis
テキストデータベース。
.SH 関連項目
.BR whatis (1),
.BR man (1)
.SH 著者
Wilf. (G.Wilford@ee.surrey.ac.uk)