名前

       catman - 整形済みマニュアルページを作成、更新する

書式

       catman [-d?V] [-M path] [-C file] [section] ...

説明

       catman  is  used  to  create  an up to date set of pre-formatted manual pages known as cat
       pages.  Cat pages are generally much faster to display than the original manual pages, but
       require  extra  storage  space.   The  decision  to support cat pages is that of the local
       administrator, who must provide suitable directories to contain them.

       The options  available  to  catman  are  the  manual  page  hierarchies  and  sections  to
       pre-format.   The  default  hierarchies  are  those specified as system hierarchies in the
       man-db configuration file,  and  the  default  sections  are  either  the  colon-delimited
       contents  of  the  environment  variable $MANSECT or the standard set compiled into man if
       $MANSECT is undefined.  Supplying catman with a set of whitespace-delimited section  names
       will override both of the above.

       catman  makes  use of the index database cache associated with each hierarchy to determine
       which files need to be formatted.

オプション

       -d, --debug
              デバッグ情報を表示します。

       -M path, --manpath=path
              代替のコロン区切りのマニュアルページ階層検索パスを指定します。デフォルトでは、シス
              テムの man-db 設定ファイルで指定されているすべてのパスになります。

       -C file, --config-file=file
              デフォルトの ~/.manpath ではなく指定したユーザ設定ファイルを使用します。

       -?, --help
              ヘルプメッセージを表示して終了します。

       --usage
              Print a short usage message and exit.

       -V, --version
              バージョン情報を表示します。

環境変数

       MANSECT
              If  $MANSECT is set, its value is a colon-delimited list of sections and it is used
              to determine which manual sections to search and in what order.  The default is  "1
              n  l  8  3  2  3posix  3pm  3perl  3am 5 4 9 6 7", unless overridden by the SECTION
              directive in /etc/manpath.config.

       MANPATH
              $MANPATH が設定されている場合、その値はコロン区切りのマニュアルページ階層の検索パス
              として使用されます。

ファイル

       /etc/manpath.config
              man-db 設定ファイルです。

       /usr/man/index.(bt|db|dir|pag)
              伝統的な大域インデックス型データベースキャッシュです。

       /var/catman/index.(bt|db|dir|pag)
              代替または FSSTND 準拠の大域インデックス型データベースキャッシュです。

関連項目

       man(1), manpath(5), mandb(8)

著者

       Wilf. (G.Wilford@ee.surrey.ac.uk).
       Fabrizio Polacco (fpolacco@debian.org).
       Colin Watson (cjwatson@debian.org).