1 78e51a8c 2005-01-14 devnull .TH TROFF2HTML 1
3 78e51a8c 2005-01-14 devnull troff2html \- convert troff output into HTML
4 78e51a8c 2005-01-14 devnull .SH SYNOPSIS
5 78e51a8c 2005-01-14 devnull .B troff2html
13 78e51a8c 2005-01-14 devnull .SH DESCRIPTION
14 78e51a8c 2005-01-14 devnull .I Troff2html
15 78e51a8c 2005-01-14 devnull reads the
16 78e51a8c 2005-01-14 devnull .IR troff (1)
17 78e51a8c 2005-01-14 devnull output in the named
18 78e51a8c 2005-01-14 devnull .IR files ,
19 78e51a8c 2005-01-14 devnull default standard input,
20 78e51a8c 2005-01-14 devnull and converts them into HTML.
22 78e51a8c 2005-01-14 devnull .I Troff2html
23 78e51a8c 2005-01-14 devnull does a tolerable job with straight
25 78e51a8c 2005-01-14 devnull output, but it is helped by annotations, described below.
26 78e51a8c 2005-01-14 devnull Its main use is for
27 78e51a8c 2005-01-14 devnull .B man2html
28 78e51a8c 2005-01-14 devnull (see Plan 9's \fIhttpd\fR(8)),
29 78e51a8c 2005-01-14 devnull which converts
30 78e51a8c 2005-01-14 devnull .IR man (1)
31 78e51a8c 2005-01-14 devnull pages into HTML
32 78e51a8c 2005-01-14 devnull and depends on a specially annotated set of
33 adc93f60 2005-01-14 devnull .IR man (7)
34 78e51a8c 2005-01-14 devnull macros, invoked by
36 78e51a8c 2005-01-14 devnull .BR -manhtml .
39 78e51a8c 2005-01-14 devnull output lines beginning
42 78e51a8c 2005-01-14 devnull x X html \f1...
45 78e51a8c 2005-01-14 devnull which are introduced by placing
46 78e51a8c 2005-01-14 devnull .B \eX'html\ \f1...\fP'
48 78e51a8c 2005-01-14 devnull .IR input ,
49 78e51a8c 2005-01-14 devnull cause the rest of the line to be interpolated into the HTML produced.
50 78e51a8c 2005-01-14 devnull Several such lines are recognized specially by
51 78e51a8c 2005-01-14 devnull .IR troff2html .
52 78e51a8c 2005-01-14 devnull The most important are the pair
55 78e51a8c 2005-01-14 devnull x X html manref start cp 1
56 78e51a8c 2005-01-14 devnull x X html manref end cp 1
59 78e51a8c 2005-01-14 devnull which are used to create HTML hyperlinks around text of the form
60 78e51a8c 2005-01-14 devnull .IR cp (1)
61 78e51a8c 2005-01-14 devnull pointing to
62 78e51a8c 2005-01-14 devnull .BR /magic/man2html/1/cp .
64 78e51a8c 2005-01-14 devnull .I Troff2html
65 78e51a8c 2005-01-14 devnull is new and experimental; in time, it may improve and subsume
67 adc93f60 2005-01-14 devnull \fIms2html\fR(1).
68 78e51a8c 2005-01-14 devnull On the one hand, because it uses the input,
69 78e51a8c 2005-01-14 devnull .B ms2html
70 78e51a8c 2005-01-14 devnull can handle
71 78e51a8c 2005-01-14 devnull .IR pic (1),
72 78e51a8c 2005-01-14 devnull .IR eqn (1),
73 78e51a8c 2005-01-14 devnull etc., which
74 78e51a8c 2005-01-14 devnull .I troff2html
75 78e51a8c 2005-01-14 devnull does not handle at all; on the other hand,
76 78e51a8c 2005-01-14 devnull .B ms2html
77 78e51a8c 2005-01-14 devnull understands only
78 adc93f60 2005-01-14 devnull .IR ms (7)
79 78e51a8c 2005-01-14 devnull documents and is easily confused by complex
81 78e51a8c 2005-01-14 devnull constructions.
82 78e51a8c 2005-01-14 devnull .I Troff2html
83 78e51a8c 2005-01-14 devnull has the reverse properties: it does not handle the preprocessors but its output
84 78e51a8c 2005-01-14 devnull is reliable and (modulo helper annotations) is independent of macro package.
85 78e51a8c 2005-01-14 devnull .SH SEE ALSO
86 78e51a8c 2005-01-14 devnull .IR troff (1),
88 adc93f60 2005-01-14 devnull \fIms2html\fR(1),
89 adc93f60 2005-01-14 devnull .I man2html
92 adc93f60 2005-01-14 devnull \fIhttpd\fR(8).
95 78e51a8c 2005-01-14 devnull and HTML have different models, and they don't mesh well in all cases.
96 78e51a8c 2005-01-14 devnull .BR Troff 's
97 78e51a8c 2005-01-14 devnull indented paragraphs are not well served in HTML, and the output of
98 78e51a8c 2005-01-14 devnull .I troff2html
99 78e51a8c 2005-01-14 devnull shows this.
