PageRenderTime 28ms CodeModel.GetById 15ms app.highlight 8ms RepoModel.GetById 2ms app.codeStats 0ms

/contrib/groff/src/devices/grohtml/grohtml.man

https://bitbucket.org/freebsd/freebsd-head/
Unknown | 293 lines | 290 code | 3 blank | 0 comment | 0 complexity | a90b574a59cce4e70e52c71877bcc8f9 MD5 | raw file
  1.ig
  2Copyright (C) 1999-2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
  3
  4Permission is granted to make and distribute verbatim copies of this
  5manual provided the copyright notice and this permission notice are
  6preserved on all copies.
  7
  8Permission is granted to copy and distribute modified versions of this
  9manual under the conditions for verbatim copying, provided that the
 10entire resulting derived work is distributed under the terms of a
 11permission notice identical to this one.
 12
 13Permission is granted to copy and distribute translations of this
 14manual into another language, under the above conditions for modified
 15versions, except that this permission notice may be included in
 16translations approved by the Free Software Foundation instead of in
 17the original English.
 18..
 19.
 20.
 21.\" Like TP, but if specified indent is more than half
 22.\" the current line-length - indent, use the default indent.
 23.de Tp
 24.  ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
 25.  el .TP "\\$1"
 26..
 27.
 28.
 29.TH GROHTML @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
 30.
 31.
 32.SH NAME
 33grohtml \- html driver for groff
 34.
 35.
 36.SH SYNOPSIS
 37.nr a \n(.j
 38.ad l
 39.nr i \n(.i
 40.in +\w'\fBgrohtml 'u
 41.ti \niu
 42.B grohtml
 43.
 44.de OP
 45.  ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
 46.  el .RB "[\ " "\\$1" "\ ]"
 47..
 48.
 49.OP \-bhlnprv
 50.OP \-a \%aa-text-bits
 51.OP \-D dir
 52.OP \-F dir
 53.OP \-g \%aa-graphic-bits
 54.OP \-i \%resolution
 55.OP \-I \%image-stem
 56.OP \-j \%filename
 57.OP \-o \%image-vertical-offset
 58.OP \-s size
 59.OP \-S level
 60.RI "[\ " files\|.\|.\|. "\ ]"
 61.br
 62.ad \na
 63.
 64.
 65.SH DESCRIPTION
 66The
 67.B grohtml
 68front end (which consists of a preprocessor,
 69.BR pre-grohtml ,
 70and a device driver,
 71.BR post-grohtml )
 72translates the output of GNU
 73.B troff
 74to html.
 75Users should always invoke
 76.B grohtml
 77via the groff command with a
 78.B \-Thtml
 79option.
 80If no files are given,
 81.B grohtml
 82will read the standard input.
 83A filename of
 84.B \-
 85will also cause
 86.B grohtml
 87to read the standard input.
 88Html output is written to the standard output.
 89When
 90.B grohtml
 91is run by
 92.B groff
 93options can be passed to
 94.B grohtml
 95using
 96.BR groff 's
 97.B \-P
 98option.
 99.
100.
101.SH OPTIONS
102.TP
103.BI \-a aa-text-bits
104Number of bits of antialiasing information to be used by
105.I text
106when generating png images.
107The default is\~4 but valid values are 0, 1, 2, and\~4.
108Note your version of
109.B gs
110needs to support the
111.B \%\-dTextAlphaBits
112and
113.B \%\-dGraphicAlphaBits
114options in order to exploit antialiasing.
115A value of\~0 stops
116.B grohtml
117from issuing antialiasing commands to
118.BR gs .
119.
120.TP
121.B \-b
122Initialize the background color to white.
123.
124.TP
125.BI \-D dir
126Inform
127.B grohtml
128to place all image files into directory
129.IR dir .
130.
131.TP
132.BI \-F dir
133Prepend directory
134.IB dir /dev name
135to the search path for font and device description files;
136.I name
137is the name of the device, usually
138.BR html .
139.
140.TP
141.BI \-g aa-graphic-bits
142Number of bits of antialiasing information to be used by
143.I graphics
144when generating png images.
145The default is\~4 but valid values are 0, 1, 2, and\~4.
146Note your version of
147.B gs
148needs to support the
149.B \%\-dTextAlphaBits
150and
151.B \%\-dGraphicAlphaBits
152options in order to exploit antialiasing.
153A value of\~0 stops
154.B grohtml
155from issuing antialiasing commands to
156.BR gs .
157.
158.TP
159.B \-h
160Generate section and number headings by using
161.BR <B> .\|.\|. </B>
162and increasing the font size, rather than using the
163.BI <H n >\c
164\&.\|.\|.\c
165.BI </H n >
166tags.
167.
168.TP
169.BI \-i resolution
170Select the resolution for all images.
171By default this is 100 pixels per inch.
172Example:
173.B \-i200
174indicates 200 pixels per inch.
175.
176.TP
177.BI \-I stem
178Determine the image stem name.
179If omitted grohtml uses
180.BI \%grohtml- XXX
181.RI ( XXX
182is the process ID).
183.
184.TP
185.BI \-j filename
186Inform
187.B grohtml
188to split the html output into multiple files.
189The
190.I filename
191is the stem and specified section headings
192(default is level one) start a new file, named
193.IR filename-n.html .
194.
195.TP
196.B \-l
197Turn off the production of automatic section links at the top of the
198document.
199.
200.TP
201.B \-n
202Generate simple heading anchors whenever a section/number heading is found.
203Without the option the anchor value is the textual heading.
204This can cause problems when a heading contains a `?' on older versions of
205some browsers (Netscape).
206This flag is automatically turned on if a heading contains an image.
207.
208.TP
209.BI \-o vertical-offset
210Specify the vertical offset of images in points.
211.
212.TP
213.B \-p
214Display page rendering progress to stderr.
215.B grohtml
216only displays a page number when an image is required.
217.
218.TP
219.B \-r
220Turn off the automatic header and footer line (html rule).
221.
222.TP
223.B \-s size
224Set the base point size of the source file.
225Thereafter when this point size is used in the source it will correspond
226to the html base size.
227Every increase of two points in the source will yield a
228.B <big>
229tag, and conversely when a decrease of two points is seen a
230.B <small>
231tag is emitted.
232.
233.TP
234.BI \-S level
235When splitting html output,
236split at the heading level (or higher) defined by
237.IR level .
238.
239.TP
240.B \-v
241Print the version number.
242.
243.
244.SH USAGE
245There are styles called
246.BR R ,
247.BR I ,
248.BR B ,
249and
250.B BI
251mounted at font positions 1 to\~4.
252.
253.
254.SH DEPENDENCIES
255.B grohtml
256is dependent upon the png utilities
257.RB ( \%pnmcut ,
258.BR \%pnmcrop ,
259.BR \%pnmtopng )
260and GhostScript
261.RB ( gs ).
262.B \%pnmtopng
263(version 2.37.6 or greater)
264and
265.B \%pnmcut
266from the netpbm package (version 9.16 or greater) will work also.
267It is also dependent upon
268.B \%psselect
269from the
270.B PSUtils
271package.
272Images are generated whenever a table, picture, equation or line is
273encountered.
274.
275.
276.SH BUGS
277.B Grohtml
278has been completely redesigned and rewritten.
279It is still beta code.
280.
281.
282.SH "SEE ALSO"
283.BR afmtodit (@MAN1EXT@),
284.BR groff (@MAN1EXT@),
285.BR @g@troff (@MAN1EXT@),
286.BR psbb (@MAN1EXT@),
287.BR groff_out (@MAN5EXT@),
288.BR groff_font (@MAN5EXT@),
289.BR groff_char (@MAN7EXT@)
290.
291.\" Local Variables:
292.\" mode: nroff
293.\" End: