日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.4-RELEASE-K, 13.0-RELEASE-K から 13.3-RELEASE-K, 14.0-RELEASE-K から 14.1-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
MAKEWHATIS(8) FreeBSD システム管理者マニュアル MAKEWHATIS(8)
名称
makewhatis -- UNIX マニュアルをインデックス付けする
書式
makewhatis [-aDnpQ] [-T utf8] [-C file]
makewhatis [-aDnpQ] [-T utf8] dir ...
makewhatis [-DnpQ] [-T utf8] -d dir [file ...]
makewhatis [-Dnp] [-T utf8] -u dir [file ...]
makewhatis [-DQ] -t file ...
解説
makewhatis ユーティリティは、キーワードを UNIX マニュアルから抽出し、
apropos(1), whatis(1) と man(1) の -k オプションによって速い検索のための
データベースに、それらをインデックス付けします。
デフォルトで、makewhatis は、ファイル mansection/[arch/]title.section と
そのディレクトリの catsection/[arch/]title.0 を使用して各 dir のデータ
ベースを作成します。既存のデータベースは、置き換えられます。ディレクトリ
がマニュアルページを含んでいないなら、データベースは、そのディレクトリに
作成されません。dir が提供されないなら、makewhatis は、man.conf(5) によっ
て規定されたデフォルトパスを使用します。
引数は、次の通りです:
-a すべてのディレクトリと下位の dir ... で見つけられるファイルを使
用します。
-C file man.conf(5) 形式で、代わりの設定 file を指定します。
-D インデックスに追加されるか、または削除されるすべてのファイルを表
示します。また、2 番目の -D で、各ファイルのために追加されたすべ
てのキーワードを表示します。
-d dir dir のデータベースに file ... をマージ (削除し、再追加) します。
-n 何もデータベースを作成せず、修正しません。スキャンと解析のみ、マ
ニュアルページ名と説明を標準出力に印刷 (表示) します。
-p 標準エラー出力にマニュアルページで潜在的な問題に関して警告を印刷
(表示) します。
-Q マニュアルの「名称」セクションだけを読み込むことによって、縮小さ
れたサイズのデータベースを早急に構築します。結果のデータベース
は、通常、名前と説明だけを含んでいます。
-T utf8 データベースに格納された文字列のための ASCII の代わりに UTF-8 エ
ンコーディングを使用します。
-t file ...
潜在的な問題について、与えられた files をチェックします。-a, -n
と -p の意味も含みます。すべての診断のメッセージは、標準出力に印
刷 (表示) されます。標準エラー出力は、使用されません。
-u dir dir のデータベースから file ... を削除します。それによって、デー
タベースが空になるなら、データベースファイルも削除します。
致命的な解析エラーが解析の間に遭遇するなら、原因となるファイルは、標準エ
ラーに印刷 (表示) され、インデックスから省力され、解析は、次の入力ファイ
ルで続行します。
環境変数
MANPATH データベースを作成するディレクトリのコロンで区切られたリスト。
dir 引数または -t オプションが指定されるなら、無視されます。
関連ファイル
mandoc.db
ファイルのディレクトリと関連するマニュアルページのデータベース。
このファイルは、マニュアルページの階層構造のインデックスが変更さ
れない限り、アーキテクチャとシステムに渡って移植性があります。
/etc/man.conf
デフォルトの man(1) 設定ファイル。
終了ステータス
makewhatis ユーティリティは、次の値の 1 つで終了します:
0 エラーは、起こらなかった。
5 無効のコマンド行引数が、指定された。入力ファイルは、読み込まれま
せん。
6 オペレーティングシステムエラーが、起こりました、例えば、メモリの
使い果たし、入力ファイルのアクセスエラー。そのようなエラーによっ
て、makewhatis は、たぶんファイルを解析するか、または書式化する途
中で、直ちに終了します。出力データベースが、破損している、削除さ
れるべきです。
関連項目
apropos(1), man(1), whatis(1), man.conf(5)
歴史
makewhatis ユーティリティは、2BSD ではじめて登場しました。それは、
OpenBSD 2.7 のために perl(1) で書き直され、OpenBSD 5.6 のために C で書き
直されました。
dir 引数は、NetBSD 1.0 ではじめて登場しました。OpenBSD 2.7 のオプション
-dpt。OpenBSD 3.4 のオプション -u。と、OpenBSD 5.6. のオプション -aCD-
nQT。
作者
Bill Joy は、1979 年 2 月にオリジナルの BSD makewhatis を書きました、Marc
Espie は、2000 年に Perl バージョンを開始しました、makewhatis の現在の
バージョンは、Kristaps Dzonsons <kristaps@bsd.lv> と Ingo Schwarze
<schwarze@openbsd.org> によって書かれました。
FreeBSD 11.4 May 17, 2017 FreeBSD 11.4