Blob


1 .TH MHTML 7
2 .SH NAME
3 mhtml \- macros for formatting HTML
4 .SH SYNOPSIS
5 .B pic
6 .B |
7 .B tbl
8 .B |
9 .B eqn
10 .B |
11 .B htmlroff
12 [
13 .B -man
14 |
15 .B -ms
16 ]
17 .B -mhtml
18 .I file
19 \&...
20 .SH DESCRIPTION
21 This package of
22 .MR htmlroff (1)
23 macro definitions provides convenient macros for formatting HTML.
24 It is usually used along with
25 .MR troff (1)
26 macro packages such as
27 .MR man (7)
28 and
29 .MR ms (7) .
30 .I Mhtml
31 replaces some macros defined in the other packages,
32 so it should be listed after them on the
33 .I htmlroff
34 command line.
35 .PP
36 The following macros are defined:
37 .TP
38 .B .HTML \fItitle
39 Print an HTML header marking the output as
40 HTML 4.01 loose transitional encoded in UTF.
41 If given, the
42 .I title
43 is printed inside
44 .B <title>
45 tags.
46 This macro opens the
47 .B <html>
48 tag, opens and closes the
49 .B <head>
50 section, and opens
51 .B <body> .
52 It invokes the
53 .B .HEAD
54 macro inside the
55 .B <head>
56 section.
57 To add arbitrary lines to the header,
58 append to
59 .B .HEAD
60 before invoking
61 .BR .HTML .
62 .TP
63 .B .FS\fR, \fP.FE
64 Accumulate footnotes and print them at the end of the
65 document under a \fBNotes\fP heading.
66 These replace the macros in
67 .MR ms (7) .
68 To emit the notes accumulated so far, invoke
69 .BR .NOTES .
70 .TP
71 .B .PS\fR, \fP.PE
72 Replace input bracketed
73 .B .PS
74 and
75 .B .PE
76 with a PNG image corresponding to the output of
77 running
78 .MR troff (1)
79 on the input.
80 .TP
81 .B .TS\fR, \fP.TE
82 Identical to
83 .B .PS
84 and
85 .BR .PE .
86 .TP
87 .B .B1 \fImargin\fP \fIwidth\fR, \fL.B2
88 Format the input between
89 .B .B1
90 and
91 .B .B2
92 inside a box, with
93 .I margin
94 (default 10)
95 pixels between the box and the text.
96 The box is set to be
97 .I width
98 (default 60)
99 percent of the current output width.
100 .SH FILES
101 .B \*9/tmac/tmac.html
102 .SH SEE ALSO
103 .MR htmlroff (1) ,
104 .MR htmlroff (7) ,
105 .MR ms (7)