151 lines
3.9 KiB
Groff
151 lines
3.9 KiB
Groff
.\" Copyright (c) 1994-1996 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" %Id: makewhatis.1,v 1.12 1998/04/01 06:22:28 charnier Exp %
|
|
.\" jpman %Id: makewhatis.1,v 1.2 1997/04/01 14:15:46 horikawa Stab %
|
|
.Dd January 12, 1995
|
|
.Dt MAKEWHATIS 1
|
|
.Os FreeBSD 2.1
|
|
.Sh 名称
|
|
.Nm makewhatis
|
|
.Nd whatis databaseを作る
|
|
.Sh 書式
|
|
.Nm makewhatis
|
|
.Op Fl a | Fl append
|
|
.Op Fl h | Fl help
|
|
.Op Fl i | Fl indent Ar column
|
|
.Op Fl n | Fl name Ar name
|
|
.Op Fl o | Fl outfile Ar file
|
|
.Op Fl v | Fl verbose
|
|
.Op Ar directories ...
|
|
.Sh 解説
|
|
.Nm
|
|
コマンドはフォーマットされていないマニュアルページから名称と短い記述を抽出し、
|
|
.Xr whatis 1
|
|
データベースを作成します。
|
|
.Nm
|
|
コマンドは gzip されたマニュアルページを読むことができます。
|
|
.Ar directory
|
|
は
|
|
.Pq Pa man.+ という名の
|
|
マニュアルページサブディレクトリを持つディレクトリの名前です。
|
|
コロンは空白として扱われますので、
|
|
.Ic makewhatis $MANPATH
|
|
や
|
|
.Ic makewhatis `manpath`
|
|
も許されます。
|
|
.Sh オプション
|
|
.Bl -tag -width Ds
|
|
.It Fl a , Fl append
|
|
追加モード。
|
|
whatis データベースに既にあるエントリは削除しません。
|
|
注: 新しくできるデータベースはソートされ、同じ項目の行は削除されますが、
|
|
.Nm
|
|
は古いエントリが有効かどうかは判定しません。
|
|
.It Fl h , Fl help
|
|
使用可能なオプションを表示し、終了します。
|
|
.It Fl i , Fl indent Ar column
|
|
解説の文字列の長さを
|
|
.Ar column にします Pq デフォルトは 24 です
|
|
。
|
|
.It Fl n , Fl name Ar name
|
|
.Pa whatis
|
|
の代わりに
|
|
.Ar name
|
|
を使用します。
|
|
.It Fl o , Fl outfile Ar file
|
|
.Pa dirname/whatis
|
|
の代わりに全ての出力を
|
|
.Ar file
|
|
に書き込みます。
|
|
.It Fl v, Fl verbose
|
|
多くの警告を
|
|
.Pq 標準エラー出力に対して
|
|
出力します。
|
|
パースした全てのマニュアルに対して次の 1 文字を表示します:
|
|
.Ql \&.
|
|
は圧縮されていないページ、
|
|
.Ql *
|
|
は圧縮されているページ、
|
|
.Ql +
|
|
はリンクをそれぞれ表します。
|
|
.Sh 使用例
|
|
.Pp
|
|
.Ic makewhatis $MANPATH
|
|
.Pp
|
|
ユーザの
|
|
.Pa $MANPATH
|
|
にある全てのディレクトリに対して whatis データベースを作成します。
|
|
.Pp
|
|
.Ic makewhatis -outfile /tmp/mywhatis /usr/local/man $HOME/man
|
|
.Pp
|
|
whatis データベース
|
|
.Pa /tmp/mywhatis
|
|
を作成します。
|
|
ディレクトリは
|
|
.Pa /usr/local/man
|
|
と
|
|
.Pa $HOME/man
|
|
を見ます。
|
|
.Pa /usr/local/man/whatis
|
|
および
|
|
.Pa $HOME/man/whatis
|
|
は作成しません。
|
|
.Pp
|
|
.Ic makewhatis -name windex $HOME/man
|
|
.Pp
|
|
.Pa whatis
|
|
の代わりに
|
|
whatis データベース
|
|
.Pa windex
|
|
を作成します。
|
|
おそらく Solaris で有効です。
|
|
.Sh 関連ファイル
|
|
.Bl -tag -width /etc/master.passwdxx -compact
|
|
.It Pa */man/whatis
|
|
whatis データベース。
|
|
.It Pa /etc/weekly
|
|
毎週
|
|
.Nm makewhatis.local
|
|
を実行します。
|
|
.El
|
|
.Sh 関連項目
|
|
.Xr apropos 1 ,
|
|
.Xr catman 1 ,
|
|
.Xr getNAME 1 ,
|
|
.Xr man 1 ,
|
|
.Xr manpath 1 ,
|
|
.Xr sort 1 ,
|
|
.Xr uniq 1 ,
|
|
.Xr whatis 1 ,
|
|
.Xr makewhatis.local 8
|
|
.Sh 歴史
|
|
この
|
|
.Nm
|
|
コマンドは
|
|
.Fx 2.1
|
|
から登場しました。
|
|
.Sh 作者
|
|
.An Wolfram Schneider ,
|
|
Berlin.
|