File: catman.8

package info (click to toggle)
manpages-ja 0.5.0.0.20161015%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 28,488 kB
  • ctags: 7
  • sloc: perl: 161; makefile: 99
file content (99 lines) | stat: -rw-r--r-- 3,680 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
.\" Man page for catman
.\"
.\" 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 Dec 10 14:17:29 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	階層
.\"
.TH catman 8 "July 12th, 1995" "2.3.10" "Manual pager utils"
.SH 名前
catman \- フォーマットされたマニュアルページを生成・更新する
.SH 書式
.B catman 
.RB [\| \-dhV \|] 
.RB [\| \-M 
.IR path \|] 
.RI [\| section \|]
\&.\|.\|.
.SH 説明
.B catman
は、フォーマット済みマニュアルページ (cat ページと呼ばれる) の最新の
セットを生成するために用いられる。
通常 cat ページはオリジナルの man ページよりもずっと速く表示できるが、
余分な保存領域が必要とされる。 cat ページをサポートするかどうかは、
ローカルな管理者 (cat ページを保存するディレクトリに関する権限を持って
いる人) の判断による。

.B catman
に与えることのできるオプションは、フォーマットを行うマニュアルページの
階層 (hierarchy) とセクションである。デフォルトの階層は、 man_db の設
定ファイルで 
`global' 指定されているものである。デフォルトのセクションは、環境変数
.RB $ MANSECT
が与えられていれば、その内容をコロン区切りでパースしたものになり、
与えられていなければ
.B man
のコンパイル時に指定されている標準的なセットとなる。
.B catman
の実行時にセクションの名前をスペースで区切って与えれば、
これらの両方を上書きする。

.B catman
はそれぞれの階層における
.B index
データベースキャッシュを利用して、どのファイルをフォーマットすべきかを
決定する。
.SH オプション
.TP
.B \-d, \-\-debug
デバッグ情報を表示する。
.TP
.BI \-M\  path ,\ \-\-manpath= path
マニュアルページ階層のサーチパスとして用いるコロン区切りのリストを指定する。
デフォルトでは、 man_db 設定ファイルで `global' 指定されているすべてのパ
スを対象とする。
.TP
.B \-h, \-\-help
ヘルプメッセージを表示して終了する。
.TP
.B \-V, \-\-version
バージョンと著者に関する情報を表示する。
.SH 環境変数
.TP
.B MANSECT
.RB $ MANSECT
が設定されていると、その値はセクションのリスト (コロン区切り) として扱われ、
マニュアルのどのセクションを検索するかを決定する際に用いられる。セクショ
ンは指定された順序で検索される。
.TP
.B MANPATH
.RB $ MANPATH
が設定されていると、その内容は検索対象とするマニュアルの階層を
コロンで区切ったリストとみなされる。
.SH ファイル
.TP
.I /etc/manpath.config
man_db の設定ファイル。
.TP
.I /usr/man/index.(bt|db|dir|pag)
従来形式の、 global なデータベースキャッシュの
インデックス。
.TP
.I /var/catman/index.(bt|db|dir|pag)
新しい (FSSTND 準拠の)、 global なデータベースキャッシュの
インデックス。
.SH 関連項目
.BR man (1),
.BR manpath (5), 
.BR mandb (8)
.SH 著者
Wilf. (G.Wilford@ee.surrey.ac.uk)