Import translated manuals from JM CVS Repository.

[linuxjm/jm.git] / manual / man / draft / man1 / man2html.1

'\" t
.\" Man page for man2html
.\" aeb, 980101
.\"
.\" 
.\" Japanese Version Copyright (c) 1998 NAKANO Takeo all rights reserved.
.\" Translated Thu Mar 5 1998 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\"
.TH man2html 1 "1 January 1998"
.LO 1
.\"O .SH NAME
.\"O man2html \- format a manual page in html
.SH ̾Á°
man2html \- ¥Þ¥Ë¥å¥¢¥ë¥Ú¡¼¥¸¤òÀ°·Á¤·¤Æ html ¤Ë¤¹¤ë
.\"O .SH SYNOPSIS
.SH ½ñ¼°
man2html [options] [file]
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O .B man2html
.\"O converts a manual page as found in
.\"O .I file
.\"O (or stdin, in case no file argument, or the argument "-", is given)
.\"O from man-style nroff into html, and prints the result on stdout.
.\"O It does support tbl but does not know about eqn.
.\"O The exit status is 0. If something goes wrong,
.\"O an error page is printed on stdout.
.B man2html
¤Ï
.I file
¤È¤·¤Æ»ØÄꤵ¤ì¤¿¥Õ¥¡¥¤¥ë (¥Õ¥¡¥¤¥ë°ú¤­¿ô¤¬¤Ê¤«¤Ã¤¿¤ê¡¢ "-" ¤¬»ØÄꤵ¤ì
¤¿¾ì¹ç¤Ïɸ½àÆþÎÏ) ¤òÊÑ´¹¤·¤Æ¡¢ man ¥¹¥¿¥¤¥ë¤Î nroff ¤«¤é html ¤òÀ¸À®¤·¡¢
·ë²Ì¤òɸ½à½ÐÎϤËɽ¼¨¤·¤Þ¤¹¡£ tbl ¤Ï¥µ¥Ý¡¼¥È¤·¤Æ¤¤¤Þ¤¹¤¬ eqn ¤Ï¤·¤Æ¤¤¤Þ
¤»¤ó¡£ÊÖ¤êÃͤϾï¤Ë 0 ¤Ç¤¹¡£¤Ê¤Ë¤«ÌäÂ꤬µ¯¤³¤Ã¤¿¾ì¹ç¤Ï¡¢¥¨¥é¡¼¥Ú¡¼¥¸¤¬
ɸ½à½ÐÎϤËɽ¼¨¤µ¤ì¤Þ¤¹¡£
 
.\"O This can be used as a stand-alone utility, but is mainly intended
.\"O as an auxiliary, to enable users to browse their man pages using
.\"O a html browser like
.\"O .BR lynx (1),
.\"O .BR xmosaic (1)
.\"O or
.\"O .BR netscape (1).
¤³¤ì¤Ï¥¹¥¿¥ó¥É¥¢¥í¡¼¥ó¤Î¥æ¡¼¥Æ¥£¥ê¥Æ¥£¤È¤·¤Æ¤â»È¤¨¤Þ¤¹¤¬¡¢¼ç¤ÊÌÜŪ¤Ï¡¢
¥æ¡¼¥¶¡¼¤¬ man ¥Ú¡¼¥¸¤ò
.BR lynx (1),
.BR xmosaic (1),
.BR netscape (1)
¤Ê¤É¤Î html ¥Ö¥é¥¦¥¶¤òÍѤ¤¤Æ¸«¤ë¤³¤È¤¬¤Ç¤­¤ë¤è¤¦¤Ë¤¹¤ë¤¿¤á¤ÎÊä½õ¤ò¤¹¤ë
¤³¤È¤Ç¤¹¡£
./" (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.)

.\"O The main part of
.\"O .B man2html
.\"O is the troff-to-html engine written by Richard Verhoeven (rcb5@win.tue.nl).
.\"O It adds hyperlinks for the following constructs:
.B man2html
¤Î¼çÍ×Éô¤Ï 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
.\"O (The first of these can be tuned by options - see below.)
.\"O No lookup is done - the links generated need not exist.
.\"O Also an index with internal hyperlinks to the various sections
.\"O is generated, so that it is easier to find one's way
.\"O in large man pages like
.\"O .BR bash (1).
(ºÇ½é¤Î¥ê¥ó¥¯¤Ï¥ª¥×¥·¥ç¥ó¤Ë¤è¤Ã¤ÆÊѹ¹¤Ç¤­¤Þ¤¹ - °Ê²¼¤Îµ­½Ò¤ò»²¾È¤Î¤³¤È)
¥ê¥ó¥¯Àè¤Î³Îǧ¤Ï¹Ô¤ï¤ì¤º¡¢¥ê¥ó¥¯À褬¸ºß¤·¤Æ¤¤¤Ê¤¯¤Æ¤â¥ê¥ó¥¯¹Ô¤¬À¸À®
¤µ¤ì¤Þ¤¹¡£Ê¸½ñÆâÉô¤Ç¤Î¡¢¥»¥¯¥·¥ç¥ó¤Ê¤É¤Ø¤Î¥Ï¥¤¥Ñ¡¼¥ê¥ó¥¯¤âÀ¸À®¤µ¤ì¤Þ¤¹¡£
¤·¤¿¤¬¤Ã¤Æ
.BR bash (1)
¤Ê¤É¤ÎÂ礭¤Ê¥Þ¥ó¡¦¥Ú¡¼¥¸¤ÇɬÍפÊÉôʬ¤òõ¤¹¤Î¤¬³Ú¤Ë¤Ê¤ê¤Þ¤¹¡£

.\"O .SH OPTIONS
.SH ¥ª¥×¥·¥ç¥ó
.\"O When reading from stdin, it is not always clear how to
.\"O do .so expansion. The \-D option allows a script to define
.\"O the working directory.
ɸ½àÆþÎϤ«¤éÆɤ߹þ¤à¤È¤­¡¢ .so ¤ÎŸ³«¤Ë´Ø¤·¤Æ¤Ï¤Ã¤­¤ê¤·¤Ê¤¤¾ì¹ç¤â¤¢¤ê
¤Þ¤¹¡£ \-D ¥ª¥×¥·¥ç¥ó¤òÍѤ¤¤ì¤Ð¡¢¥¹¥¯¥ê¥×¥È¤«¤é¥ï¡¼¥­¥ó¥°¥Ç¥£¥ì¥¯¥È¥ê
¤ò»ØÄꤹ¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
.TP
.B \-\^D pathname
.\"O Strip the last two parts from the pathname, and do a
.\"O \fIchdir\fP(\fIdir\fP) before starting the conversion.
pathname ¤ÎºÇ¸å¤ÎÆó¤Äʬ¤ò¼è¤ê½ü¤­¡¢ÊÑ´¹¤ò¹Ô¤¦Á°¤Ë¤½¤³¤Ë 
\fIchdir\fP(\fIdir\fP) ¤·¤Þ¤¹¡£
.LP
.\"O The \-E option allows the easy generation of error messages
.\"O from a cgi script.
\-E ¥ª¥×¥·¥ç¥ó¤òÍѤ¤¤ë¤È cgi ¥¹¥¯¥ê¥×¥È¤«¤é´Êñ¤Ë¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸¤òÀ¸
À®¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
.TP
.B \-\^E string
.\"O Output an error page containing the given error message.
Í¿¤¨¤é¤ì¤¿¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸¤ò´Þ¤à¥¨¥é¡¼¥Ú¡¼¥¸¤ò½ÐÎϤ·¤Þ¤¹¡£
.LP
.\"O The general form of a hyperlink generated for a man page reference is
»²¾ÈÀ褬¥Þ¥ó¡¦¥Ú¡¼¥¸¤Ç¤¢¤ë¥Ï¥¤¥Ñ¡¼¥ê¥ó¥¯¡¢°ìÈ̤˰ʲ¼¤Î¤è¤¦¤Ê·Á¼°¤ÇÀ¸À®
¤µ¤ì¤Þ¤¹¡£
.IP
<method:cgipath><man2htmlpath><separator><manpage>
.LP
.\"O with a default as shown above. The parts of this hyperlink
.\"O are set using the various options.
¥Ç¥Õ¥©¥ë¥È¤Ï¾å¤ÎÄ̤ê¤Ç¤¹¤¬¡¢¥Ï¥¤¥Ñ¡¼¥ê¥ó¥¯¤Î³ÆÉô¤Ï³Æ¼ï¥ª¥×¥·¥ç¥ó
¤òÍѤ¤¤ë¤³¤È¤Ç¤¤¤í¤¤¤íÀßÄê¤Ç¤­¤Þ¤¹¡£
.TP
.B \-\^h
.\"O Set method:cgipath to http://localhost. This is the default.
method:cgipath ¤ò http://localhost ¤Ë¤·¤Þ¤¹¡£¥Ç¥Õ¥©¥ë¥È¤Ç¤¹¡£
.TP
.BI \-\^H " host[.domain][:port]"
.\"O Set method:cgipath to
.\"O .RI http:// host.domain:port .
method:cgipath ¤ò
.RI htttp:// host.domain:port
¤ËÀßÄꤷ¤Þ¤¹¡£
.TP
.B \-\^l
.\"O Set method:cgipath to
.\"O .RI lynxcgi: /home/httpd .
method:cgipath ¤ò
.RI lynxcgi: /home/httpd
¤ËÀßÄꤷ¤Þ¤¹¡£
.TP
.BI \-\^L " dir"
.\"O Set method:cgipath to
.\"O .RI lynxcgi: dir .
method:cgipath ¤ò
.RI lynxcgi: dir
¤ËÀßÄꤷ¤Þ¤¹¡£
.TP
.BI \-\^M " man2htmlpath"
.\"O Set the man2htmlpath to use. The default is
.\"O .IR /cgi-bin/man/man2html .
man2htmlpath ¤òÀßÄꤷ¤Þ¤¹¡£¥Ç¥Õ¥©¥ë¥È¤Ï
.I /cgi-bin/man/man2html
¤Ç¤¹¡£
.TP
.B \-\^p
.\"O Set separator to '/'.
¥»¥Ñ¥ì¡¼¥¿¡¼¤ò '/' ¤ËÀßÄꤷ¤Þ¤¹¡£
.TP
.B \-\^q
.\"O Set separator to '?'. This is the default.
¥»¥Ñ¥ì¡¼¥¿¡¼¤ò '?' ¤ËÀßÄꤷ¤Þ¤¹¡£¥Ç¥Õ¥©¥ë¥È¤Ç¤¹¡£
.LP
.\"O On a machine without running
.\"O .BR httpd ,
.\"O one can use
.\"O .B lynx
.\"O to browse the man pages, using the lynxcgi method.
.\"O When some http daemon is running, lynx, or any other browser,
.\"O can be used to browse the man pages, using the http method.
.\"O The option \-l (for `lynxcgi') selects the former behaviour.
.\"O With it, the default cgipath is \fI/home/httpd\fP.
.B httpd
¤¬²ÔÆ°¤·¤Æ¤¤¤Ê¤¤¥Þ¥·¥ó¤Ç¤Ï¡¢
.B lynx
¤Ç lynxcgi ¤òÍѤ¤¤ì¤Ð¥Þ¥ó¡¦¥Ú¡¼¥¸¤ò±ÜÍ÷¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
http ¥Ç¡¼¥â¥ó¤¬²ÔÆ°¤·¤Æ¤¤¤ë¾ì¹ç¤Ï¡¢ lynx ¤Ç¤â¾¤Î¥Ö¥é¥¦¥¶¤Ç¤â±ÜÍ÷¤Ç¤­
¤Þ¤¹¡£¥ª¥×¥·¥ç¥ó \-l (`lynxcgi' ¤Î°ÕÌ£) ¤ÏÁ°¼Ô¤òÁªÂò¤·¤Þ¤¹¡£¤³¤ì¤ò»ØÄê
¤¹¤ë¤È¡¢¥Ç¥Õ¥©¥ë¥È¤Î cgipath ¤Ï \fI/home/httpd/\fP ¤Ë¤Ê¤ê¤Þ¤¹¡£

.\"O In general, a cgi script can be called by
°ìÈÌ¤Ë¤Ï cgi ¥¹¥¯¥ê¥×¥È¤Ï
.IP
<path_to_script>/<more_path>?<query>
.LP
¤Î¤è¤¦¤Ê¤«¤¿¤Á¤Ç¸Æ¤Ö¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.\"O and the environment variables PATH_INFO and QUERY_STRING
.\"O will be set to <more_path> and <query>, respectively.
.\"O Since lynxcgi does not handle the PATH_INFO part, we generate
.\"O hyperlinks with `?' as a separator by default.
.\"O The option \-p (for `path') selects '/' as a separator, while
.\"O the option \-q (for `query') selects '?' as a separator.
´Ä¶­ÊÑ¿ô PATH_INFO ¤È QUERY_STRING ¤¬¤½¤ì¤¾¤ì <more_path> ¤È <query> 
¤ËÀßÄꤵ¤ì¤Þ¤¹¡£ lynxcgi ¤Ï PATH_INFO Éôʬ¤ò°·¤¦¤³¤È¤¬¤Ç¤­¤Ê¤¤¤Î¤Ç¡¢¥Ç
¥Õ¥©¥ë¥È¤Ç¤Ï `?' ¤ò¥»¥Ñ¥ì¡¼¥¿¡¼¤È¤¹¤ë¥Ï¥¤¥Ñ¡¼¥ê¥ó¥¯¤òÀ¸À®¤¹¤ë¤³¤È¤Ë¤·
¤Þ¤·¤¿¡£¥ª¥×¥·¥ç¥ó `\-p' (`path' ¤Î°ÕÌ£) ¤Ï '/' ¤ò¥»¥Ñ¥ì¡¼¥¿¡¼¤Ë¤·¤Þ¤¹¡£
°ìÊý `\-q' (`query' ¤Î°ÕÌ£) ¤Ï '?' ¤ò¥»¥Ñ¥ì¡¼¥¿¡¼¤Ë¤·¤Þ¤¹¡£

.\"O The option \-H \fIhost\fP will specify the host to use
.\"O (instead of \fIlocalhost\fP).  A cgi script could use
¥ª¥×¥·¥ç¥ó \-H \fIhost\fP ¤Ï (\fIlocalhost\fP ¤ÎÂå¤ï¤ê¤Ë) ÍѤ¤¤ë¥Û¥¹¥È
¤ò»ØÄꤷ¤Þ¤¹¡£´Ä¶­ÊÑ¿ô SERVER_NAME ¤¬ÀßÄꤵ¤ì¤Æ¤¤¤ì¤Ð¡¢  cgi ¥¹¥¯¥ê¥×
¥È¤«¤é
.IP
man2html -H $SERVER_NAME
.LP
.\"O if the variable SERVER_NAME is set.  This would allow your machine
.\"O to act as a server and export man pages.
¤Î¤è¤¦¤ËÍѤ¤¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£¤³¤ì¤Ë¤è¤Ã¤Æ¡¢¤ª»È¤¤¤Î¥Þ¥·¥ó¤ò¡¢¥Þ¥ó¡¦¥Ú¡¼
¥¸¤òÄ󶡤¹¤ë¥µ¡¼¥Ð¡¼¤Î¤è¤¦¤ËÆ°ºî¤µ¤»¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£

.\"O .SH BUGS
.SH ¥Ð¥°
.\"O There are many heuristics.  The output will not always be perfect.
.\"O The lynxcgi method will not work if lynx was compiled without
.\"O selecting support for it.  There may be problems with security.
¿¤¯¤Îȯ¸«Åª¼êË¡ (heuristic) ¤¬ÍѤ¤¤é¤ì¤Æ¤¤¤Þ¤¹¡£½ÐÎϤϾï¤Ë´°Á´¤Ç¤¢¤ë
¤È¤Ï¸Â¤ê¤Þ¤»¤ó¡£ lynxcgi ¤Ï¡¢¤³¤ì¤ò¥µ¥Ý¡¼¥È¤¹¤ë¤è¤¦¤ËÁªÂò¤·¤Æ lynx ¤ò
¥³¥ó¥Ñ¥¤¥ë¤·¤Ê¤±¤ì¤ÐÆ°ºî¤·¤Þ¤»¤ó¡£¥»¥­¥å¥ê¥Æ¥£¾å¤ÎÌäÂ꤬¤¢¤ë¤«¤â¤·¤ì¤Þ
¤»¤ó¡£

.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.BR lynx (1),
.BR man (1)