makewhatis(1M)


makewhatis -- キーワードデータベースへのエントリの追加

形式

/usr/man/bin/makewhatis directory ...

機能説明

makewhatis では、ローカルマニュアルページのエントリを whatis(4) 形式でキーワードデータベースに書き込みます。キーワードデータベースファイルは、ユーティリティ man(1)apropos(1bsd)、および whatis(1bsd)で使うことができます。

makewhatis を使うことができるのは、root だけです。

makewhatis では、追加するマニュアルページの troff ソースが、指定した directory 内で検索されます。この場合のディレクトリは、マニュアルページ /usr/lib/scohelp/LANG/man のサブディレクトリでなければなりません(/usr/lib/scohelp/en_US.ISO8859-1/man は、SCO OpenServerTRADEMARK との互換性を保つために /usr/man にリンクされています)。このパスは、MANPATH 環境変数を使って変更できます。

whatis 内のすべてのエントリは、マニュアルページ名、その節、および簡潔な説明を指定する 1 行で構成されます。whatistroff ソースから構築され、troff ソースは次の標準 man キー行を順序どおりに含めなければなりません。

 
   .TH name section
   .SH NAME    
   name \- single-line description 
makewhatis には、マニュアルページに含めることができる内容の面で次のような柔軟性があります。 たとえば、このマニュアルページのソースは、次のようになります。
 
   .TH	makewhatis 1M 
   .\" Note the mixed case of NAME below 
   .SH NaMe 
   .\" This comment line is ignored 
   makewhatis 	\MINUS SIGN add entries to the keyword database 
   . 
   . 
   . 
このソースにより、次のキーワードデータベースエントリが生成されます。
 
   makewhatis (1M)	- add entries to the keyword database 

ファイル

/usr/lib/scohelp/LANG/man/whatis.section
キーワードデータベース

/usr/lib/scohelp/LANG/man
標準マニュアルページディレクトリのサブツリーのルート(/usr/lib/scohelp/en_US.ISO8859-1/man は、SCO OpenServer との互換性を保つために /usr/man にリンクされています)

/usr/lib/scohelp/LANG/man/cat.section/*
nroff されるマニュアルエントリ

/usr/lib/scohelp/LANG/man/man.section/*
フォーマットされていないマニュアルエントリ

/usr/lib/scohelp/LANG/man/html.section/*
マニュアルページの HTML ソース

関連項目

apropos(1bsd), man(1), whatis(1bsd), whatis(4)
SCO UnixWare Forum Beta Release (BL12) -- September 1997
© 1997 The Santa Cruz Operation, Inc. All rights reserved.