src/devices/grohtml/grohtml.man

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