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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
.\" t
.\" Man page for man2html
.\" aeb, 980101
.\"
.\"*******************************************************************
.\"
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.\"
.\" Japanese Version Copyright (c) 1997 NAKANO Takeo all rights reserved.
.\" Translated Thu Mar 5 1998 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\"
.\"
.\" Updated Fri Aug 19 02:54:00 JST 2011
.\" by TACHIBANA Akira <tati@kc5.so-net.ne.jp>
.\"
.TH man2html 1 "1 January 1998"
.LO 1
.SH 名前
man2html \- マニュアルページを整形して html にする
.SH 書式
man2html [options] [file]
.SH 説明
\fBman2html\fP は \fIfile\fP として指定されたファイル (ファイル引き数がなかったり、 "\-" が指定され た場合は標準入力)
を変換して、 man スタイルの nroff から html を生成し、 結果を標準出力に表示します。 tbl はサポートしていますが eqn
はしていま せん。返り値は常に 0 です。なにか問題が起こった場合は、エラーページが 標準出力に表示されます。
.\" (See
.\" .BR man (1)
.\" for info on how to browse man pages via
.\" .BR man2html .
.\" Usually it would suffice to put "MANHTMLPAGER=/usr/bin/lynx"
.\" in the environment.)
これはスタンドアローンのユーティリティとしても使えますが、主な目的は、 ユーザーが man ページを \fBlynx\fP(1),
\fBxmosaic\fP(1), \fBnetscape\fP(1) などの html ブラウザを用いて見ることができるようにするための補助をする ことです。
\fBman2html\fP の主要部は Richard Verhoeven (rcb5@win.tue.nl) によって書かれた troff\-to\-html
エンジンです。これは以下のような形式のハイパーリンクを付 加します。
.LP
.TS
l l.
foo(3x) "http://localhost/cgi\-bin/man/man2html?3x+foo"
method://string "method://string"
www.host.name "http://www.host.name"
ftp.host.name "ftp://ftp.host.name"
name@host "mailto:name@host"
<string.h> "file:/usr/include/string.h"
.TE
.LP
(上に列挙したものの内、最初のものについてはオプションによって調整できます \- 以下の記述を参照のこと)
リンク先の確認は行われず、リンク先が存在していなくてもリンク行が生成 されます。文書内部での、セクションなどへのハイパーリンクも生成されます。
したがって \fBbash\fP(1) などの大きな man ページで必要な部分を探すのが楽になります。
.SH オプション
標準入力から読み込む場合は、.so の展開をどうするかが必ずしも 明白ではありません。そういうときでも、\-D オプションを使えば、
スクリプトの方でワーキングディレクトリの位置を明示することが できます。
.LP
.TP
\fB\-\^D pathname\fP
pathname の最後の二つ分を取り除き、変換を行う前にそこに \fIchdir\fP(\fIdir\fP) します。
.LP
\-E オプションを用いると cgi スクリプトから簡単にエラーメッセージを生 成することができます。
.LP
.TP
\fB\-\^E string\fP
与えられたエラーメッセージを含むエラーページを出力します。
.LP
参照先が man ページであるハイパーリンクは、一般に以下のような形式で生成 されます。 (訳注: method は、URL
スキームを指します。以下ではメソッドと呼びます。)
.IP
<method:cgipath><man2htmlpath><separator><manpage>
.LP
デフォルトは上記 foo(3x) で示した通りですが、ハイパーリンクの各部は 各種オプションを用いることでいろいろ設定できます。
.TP
\fB\-\^h\fP
method:cgipath を http://localhost にします。デフォルトです。
.TP
\fB\-\^H\fP\fI host[.domain][:port]\fP
method:cgipath を http://\fIhost.domain:port\fP に設定します。
.TP
\fB\-\^l\fP
method:cgipath を lynxcgi:\fI/home/httpd\fP に設定します。
.TP
\fB\-\^L\fP\fI dir\fP
method:cgipath を lynxcgi:\fIdir\fP に設定します。
.TP
\fB\-\^M\fP\fI man2htmlpath\fP
man2htmlpath を設定します。デフォルトは \fI/cgi\-bin/man/man2html\fP です。
.TP
\fB\-\^p\fP
セパレーターを '/' に設定します。
.TP
\fB\-\^q\fP
セパレーターを '?' に設定します。デフォルトです。
.TP
\fB\-\^r\fP
cgi\-bin path の代わりに、相対 html path を使用します。
.LP
\fBhttpd\fP が稼働していないマシンでは、lynxcgi メソッドを使用すると、 \fBlynx\fP で man ページを閲覧することができます。
http デーモンが稼動している場合は、http メソッドを使えば、 \fBlynx\fP でも他のブラウザでも man ページの閲覧が可能です。 オプション
\-l (`lynxcgi' の意味) は前者の動作を選択します。 その場合、デフォルトの cgipath は \fI/home/httpd\fP になります。
一般には cgi スクリプトは
.IP
<path_to_script>/<more_path>?<query>
.LP
のようなかたちで呼ぶことができます。 環境変数 PATH_INFO と QUERY_STRING がそれぞれ <more_path> と
<query> に設定されます。 lynxcgi は PATH_INFO 部分を扱うことができないので、デ フォルトでは `?'
をセパレーターとするハイパーリンクを生成することにし ました。オプション `\-p' (`path' の意味) は '/' をセパレーターにします。 一方
`\-q' (`query' の意味) は '?' をセパレーターにします。
オプション \-H \fIhost\fP は (\fIlocalhost\fP の代わりに) 用いるホスト を指定します。環境変数 SERVER_NAME
が設定されていれば、 cgi スクリプ トから
.IP
man2html \-H $SERVER_NAME
.LP
のように用いることができます。これによって、お使いのマシンを、man ページを 提供するサーバーのように動作させることができます。
.SH バグ
多くの発見的手法 (heuristic) が用いられています。出力は常に完全である とは限りません。 lynxcgi
メソッドは、これをサポートするように選択して \fBlynx\fP をコンパイルしなければ動作しません。 セキュリティ上の問題があるかもしれません。
.SH 作者
\fBman2html\fP の原作者は Richard Verhoeven です。 Michael Hamilton と Andries Brouwer
がその後の改良を行いました。 現在のメンテナーは Federico Lucifredi <flucifredi@acm.org> です。
.SH 関連項目
\fBlynx\fP(1), \fBman\fP(1)
|
