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

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