summaryrefslogtreecommitdiff
path: root/src/devices/grohtml/grohtml.man
blob: 1da666bcc58f714ef18aece099076b8b62277369 (plain)
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
.ig \"-*- nroff -*-
Copyright (C) 1999 Free Software Foundation, Inc.

Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be included in
translations approved by the Free Software Foundation instead of in
the original English.
..
.\" Like TP, but if specified indent is more than half
.\" the current line-length - indent, use the default indent.
.de Tp
.ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
.el .TP "\\$1"
..
.TH GROHTML @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
.SH NAME
grohtml \- html driver for groff
.SH SYNOPSIS
.B grohtml
[
.B \-atTvdgm?
] [
.BI \-F dir
] [
.BI \-I imagetype
] [
.BI \-r resolution
] [
.IR files \|.\|.\|.
]
.SH DESCRIPTION
.B grohtml
translates the output of GNU
.B troff
to html.
Normally
.B grohtml
should be invoked by using the groff command with a
.B \-Thtml
option.
If no files are given,
.B grohtml
will read the standard input.
A filename of
.B \-
will also cause
.B grohtml
to read the standard input.
Html output is written to the standard output.
When
.B grohtml
is run by
.B groff
options can be passed to
.B grohtml
using the
.B groff
.B \-P
option.
.SH OPTIONS
.TP
.B \-a
force
.B grohtml
to generate html line breaks in the same position as troff dictates.
Without this option
.B grohtml
generates text in paragraphs which is formatted by the html browser.
.TP
.B \-d
turn on internal debugging.
.TP
.B \-g
tell
.B grohtml
not to try and guess titles and headings.
By using this flag together with the -m and -a flag
.B grohtml
will treat the html browser as a printer, not as a formatter.
.TP
.B \-m
leave margins alone.
.B grohtml
will not remove left margins.
.TP
.B \-t
forbids
.B grohtml
from generating html tables when implementing indentation and tabular text.
.B grohtml
can implement .IP by tables or html indents.
However if .2C is used it can only be sensibly converted to html using a
table structure.
As a few known bugs still exist with the html table code this option is
present to supress execution of this development code.
The default in
.B grohtml
is that html tables are generated when appropriate.
.TP
.B \-T
forbids
.B grohtml
from generating images when processing output from tbl.
This is useful when simple textual tables are being produced.
.TP
.BI \-F dir
Search the directory
.IB dir /dev name
for font and device description files;
.I name
is the name of the device, usually
.BR html .
.TP
.BI \-I imagetype
select the type of image generated when grohtml encounters an equation,
table, or picture.
By default this is png256.
Legal image types are: gif and any of the png formats which are supported by
ghostscript gs(1).
.TP
.BI \-r resolution
select the resolution for all images.
By default this is 80 pixels per inch.
Example: -r100 indicates 100 pixels per inch.
.TP
.B \-v
Print the version number.
.TP
.B \-?
Display usage.
.SH USAGE
There are styles called
.BR R ,
.BR I ,
.BR B ,
and
.B BI
mounted at font positions 1 to 4.
It is advisable to invoke groff with the -mhtml macro set, which turns off
headers, footers, and hyphenation; additionally, it will right justify text.
.SH DEPENDENCIES
.B grohtml
is dependent upon grops and gs.
If
.B grohtml
has been configured to generate gif files then it is further dependent upon,
ppmtogif, and ppmquant.
However if it has been configured to generate png files (the default) then
it is dependent upon gs having a png output device.
Images are generated whenever a table, picture, equation or line is
encountered.
.SH BUGS
This is still very alpha.
At least three major bugs remain:
Firstly,
.B grohtml
sometimes miscalculates the end of an html table resulting in text which
appears twice.
Secondly equation numbers are not handled correctly.
Thirdly equation macros and pic macros can confuse
.BR grohtml .
.SH "SEE ALSO"
.BR afmtodit (@MAN1EXT@),
.BR groff (@MAN1EXT@),
.BR @g@troff (@MAN1EXT@),
.BR psbb (@MAN1EXT@),
.BR groff_out (@MAN5EXT@),
.BR groff_font (@MAN5EXT@),
.BR groff_char (@MAN7EXT@)