/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
- .ig
- Copyright (C) 1999-2000, 2001, 2002, 2003, 2004 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
- .nr a \n(.j
- .ad l
- .nr i \n(.i
- .in +\w'\fBgrohtml 'u
- .ti \niu
- .B grohtml
- .
- .de OP
- . ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
- . el .RB "[\ " "\\$1" "\ ]"
- ..
- .
- .OP \-bhlnprv
- .OP \-a \%aa-text-bits
- .OP \-D dir
- .OP \-F dir
- .OP \-g \%aa-graphic-bits
- .OP \-i \%resolution
- .OP \-I \%image-stem
- .OP \-j \%filename
- .OP \-o \%image-vertical-offset
- .OP \-s size
- .OP \-S level
- .RI "[\ " files\|.\|.\|. "\ ]"
- .br
- .ad \na
- .
- .
- .SH DESCRIPTION
- The
- .B grohtml
- front end (which consists of a preprocessor,
- .BR pre-grohtml ,
- and a device driver,
- .BR post-grohtml )
- translates the output of GNU
- .B troff
- to html.
- Users should always invoke
- .B grohtml
- via 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
- .BR groff 's
- .B \-P
- option.
- .
- .
- .SH OPTIONS
- .TP
- .BI \-a aa-text-bits
- Number of bits of antialiasing information to be used by
- .I text
- when generating png images.
- The default is\~4 but valid values are 0, 1, 2, and\~4.
- Note your version of
- .B gs
- needs to support the
- .B \%\-dTextAlphaBits
- and
- .B \%\-dGraphicAlphaBits
- options in order to exploit antialiasing.
- A value of\~0 stops
- .B grohtml
- from issuing antialiasing commands to
- .BR gs .
- .
- .TP
- .B \-b
- Initialize the background color to white.
- .
- .TP
- .BI \-D dir
- Inform
- .B grohtml
- to place all image files into directory
- .IR dir .
- .
- .TP
- .BI \-F dir
- Prepend directory
- .IB dir /dev name
- to the search path for font and device description files;
- .I name
- is the name of the device, usually
- .BR html .
- .
- .TP
- .BI \-g aa-graphic-bits
- Number of bits of antialiasing information to be used by
- .I graphics
- when generating png images.
- The default is\~4 but valid values are 0, 1, 2, and\~4.
- Note your version of
- .B gs
- needs to support the
- .B \%\-dTextAlphaBits
- and
- .B \%\-dGraphicAlphaBits
- options in order to exploit antialiasing.
- A value of\~0 stops
- .B grohtml
- from issuing antialiasing commands to
- .BR gs .
- .
- .TP
- .B \-h
- Generate section and number headings by using
- .BR <B> .\|.\|. </B>
- and increasing the font size, rather than using the
- .BI <H n >\c
- \&.\|.\|.\c
- .BI </H n >
- tags.
- .
- .TP
- .BI \-i resolution
- Select the resolution for all images.
- By default this is 100 pixels per inch.
- Example:
- .B \-i200
- indicates 200 pixels per inch.
- .
- .TP
- .BI \-I stem
- Determine the image stem name.
- If omitted grohtml uses
- .BI \%grohtml- XXX
- .RI ( XXX
- is the process ID).
- .
- .TP
- .BI \-j filename
- Inform
- .B grohtml
- to split the html output into multiple files.
- The
- .I filename
- is the stem and specified section headings
- (default is level one) start a new file, named
- .IR filename-n.html .
- .
- .TP
- .B \-l
- Turn off the production of automatic section links at the top of the
- document.
- .
- .TP
- .B \-n
- Generate simple heading anchors whenever a section/number heading is found.
- Without the option the anchor value is the textual heading.
- This can cause problems when a heading contains a `?' on older versions of
- some browsers (Netscape).
- This flag is automatically turned on if a heading contains an image.
- .
- .TP
- .BI \-o vertical-offset
- Specify the vertical offset of images in points.
- .
- .TP
- .B \-p
- Display page rendering progress to stderr.
- .B grohtml
- only displays a page number when an image is required.
- .
- .TP
- .B \-r
- Turn off the automatic header and footer line (html rule).
- .
- .TP
- .B \-s size
- Set the base point size of the source file.
- Thereafter when this point size is used in the source it will correspond
- to the html base size.
- Every increase of two points in the source will yield a
- .B <big>
- tag, and conversely when a decrease of two points is seen a
- .B <small>
- tag is emitted.
- .
- .TP
- .BI \-S level
- When splitting html output,
- split at the heading level (or higher) defined by
- .IR level .
- .
- .TP
- .B \-v
- Print the version number.
- .
- .
- .SH USAGE
- There are styles called
- .BR R ,
- .BR I ,
- .BR B ,
- and
- .B BI
- mounted at font positions 1 to\~4.
- .
- .
- .SH DEPENDENCIES
- .B grohtml
- is dependent upon the png utilities
- .RB ( \%pnmcut ,
- .BR \%pnmcrop ,
- .BR \%pnmtopng )
- and GhostScript
- .RB ( gs ).
- .B \%pnmtopng
- (version 2.37.6 or greater)
- and
- .B \%pnmcut
- from the netpbm package (version 9.16 or greater) will work also.
- It is also dependent upon
- .B \%psselect
- from the
- .B PSUtils
- package.
- Images are generated whenever a table, picture, equation or line is
- encountered.
- .
- .
- .SH BUGS
- .B Grohtml
- has been completely redesigned and rewritten.
- It is still beta code.
- .
- .
- .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@)
- .
- .\" Local Variables:
- .\" mode: nroff
- .\" End: