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

   1 .ig
   2 Copyright (C) 1999-2000, 2001, 2002, 2003, 2004, 2006, 2007, 2009
   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 .OP \-x \%html-dialect
  62 .RI "[\ " files\|.\|.\|. "\ ]"
  63 .br
  64 .ad \na
  65 .
  66 .
  67 .SH DESCRIPTION
  68 The
  69 .B grohtml
  70 front end (which consists of a preprocessor,
  71 .BR pre-grohtml ,
  72 and a device driver,
  73 .BR post-grohtml )
  74 translates the output of GNU
  75 .B troff
  76 to html.
  77 Users should always invoke
  78 .B grohtml
  79 via the groff command with a
  80 .B \-Thtml
  81 option.
  82 If no files are given,
  83 .B grohtml
  84 will read the standard input.
  85 A filename of
  86 .B \-
  87 will also cause
  88 .B grohtml
  89 to read the standard input.
  90 Html output is written to the standard output.
  91 When
  92 .B grohtml
  93 is run by
  94 .B groff
  95 options can be passed to
  96 .B grohtml
  97 using
  98 .BR groff 's
  99 .B \-P
 100 option.
 101 .
 102 .
 103 .SH OPTIONS
 104 .TP
 105 .BI \-a aa-text-bits
 106 Number of bits of antialiasing information to be used by
 107 .I text
 108 when generating png images.
 109 The default is\~4 but valid values are 0, 1, 2, and\~4.
 110 Note your version of
 111 .B gs
 112 needs to support the
 113 .B \%\-dTextAlphaBits
 114 and
 115 .B \%\-dGraphicAlphaBits
 116 options in order to exploit antialiasing.
 117 A value of\~0 stops
 118 .B grohtml
 119 from issuing antialiasing commands to
 120 .BR gs .
 121 .
 122 .TP
 123 .B \-b
 124 Initialize the background color to white.
 125 .
 126 .TP
 127 .BI \-D dir
 128 Inform
 129 .B grohtml
 130 to place all image files into directory
 131 .IR dir .
 132 .
 133 .TP
 134 .B \-e
 135 This option should not be directly invoked by the user as it is
 136 an internal option utilized by
 137 .B groff
 138 when
 139 .B \-Thtml
 140 or
 141 .B \-Txhtml
 142 is specified.
 143 It is used by the
 144 .B grohtml
 145 preprocessor to determine whether
 146 .B eqn
 147 should attempt to produce MathML (if
 148 .B \-Txhtml
 149 is specified).
 150 .
 151 .TP
 152 .BI \-F dir
 153 Prepend directory
 154 .IB dir /dev name
 155 to the search path for font and device description files;
 156 .I name
 157 is the name of the device, usually
 158 .BR html .
 159 .
 160 .TP
 161 .BI \-g aa-graphic-bits
 162 Number of bits of antialiasing information to be used by
 163 .I graphics
 164 when generating png images.
 165 The default is\~4 but valid values are 0, 1, 2, and\~4.
 166 Note your version of
 167 .B gs
 168 needs to support the
 169 .B \%\-dTextAlphaBits
 170 and
 171 .B \%\-dGraphicAlphaBits
 172 options in order to exploit antialiasing.
 173 A value of\~0 stops
 174 .B grohtml
 175 from issuing antialiasing commands to
 176 .BR gs .
 177 .
 178 .TP
 179 .B \-h
 180 Generate section and number headings by using
 181 .BR <B> .\|.\|. </B>
 182 and increasing the font size, rather than using the
 183 .BI <H n >\c
 184 \&.\|.\|.\c
 185 .BI </H n >
 186 tags.
 187 .
 188 .TP
 189 .BI \-i resolution
 190 Select the resolution for all images.
 191 By default this is 100 pixels per inch.
 192 Example:
 193 .B \-i200
 194 indicates 200 pixels per inch.
 195 .
 196 .TP
 197 .BI \-I stem
 198 Determine the image stem name.
 199 If omitted grohtml uses
 200 .BI \%grohtml- XXX
 201 .RI ( XXX
 202 is the process ID).
 203 .
 204 .TP
 205 .BI \-j filename
 206 Inform
 207 .B grohtml
 208 to split the html output into multiple files.
 209 The
 210 .I filename
 211 is the stem and specified section headings
 212 (default is level one) start a new file, named
 213 .IR filename-n.html .
 214 .
 215 .TP
 216 .B \-l
 217 Turn off the production of automatic section links at the top of the
 218 document.
 219 .
 220 .TP
 221 .B \-n
 222 Generate simple heading anchors whenever a section/number heading is found.
 223 Without the option the anchor value is the textual heading.
 224 This can cause problems when a heading contains a `?' on older versions of
 225 some browsers (Netscape).
 226 This flag is automatically turned on if a heading contains an image.
 227 .
 228 .TP
 229 .BI \-o vertical-offset
 230 Specify the vertical offset of images in points.
 231 .
 232 .TP
 233 .B \-p
 234 Display page rendering progress to stderr.
 235 .B grohtml
 236 only displays a page number when an image is required.
 237 .
 238 .TP
 239 .B \-r
 240 Turn off the automatic header and footer line (html rule).
 241 .
 242 .TP
 243 .B \-s size
 244 Set the base point size of the source file.
 245 Thereafter when this point size is used in the source it will correspond
 246 to the html base size.
 247 Every increase of two points in the source will yield a
 248 .B <big>
 249 tag, and conversely when a decrease of two points is seen a
 250 .B <small>
 251 tag is emitted.
 252 .
 253 .TP
 254 .BI \-S level
 255 When splitting html output,
 256 split at the heading level (or higher) defined by
 257 .IR level .
 258 .
 259 .TP
 260 .B \-v
 261 Print the version number.
 262 .
 263 .TP
 264 .B \-V
 265 Create an XHTML or HTML validator button at the bottom of each page of
 266 the document.
 267 .
 268 .TP
 269 .BI \-x dialect
 270 Select HTML dialect.
 271 Currently,
 272 .I dialect
 273 should be either the digit\~\c
 274 .B 4
 275 or the letter\~\c
 276 .B x
 277 which indicates whether
 278 .B grohtml
 279 should generate HTML\~4 or XHTML, respectively.
 280 This option should not be directly invoked by the user as it is
 281 an internal option utilized by
 282 .B groff
 283 when
 284 .B \-Thtml
 285 or
 286 .B \-Txhtml
 287 is specified.
 288 .
 289 .TP
 290 .B \-y
 291 Produce a right-justified groff signature at the end of the document.
 292 This is only generated if the
 293 .B \-V
 294 flag is also specified.
 295 .
 296 .
 297 .SH USAGE
 298 There are styles called
 299 .BR R ,
 300 .BR I ,
 301 .BR B ,
 302 and
 303 .B BI
 304 mounted at font positions 1 to\~4.
 305 .
 306 .
 307 .SH DEPENDENCIES
 308 .B grohtml
 309 is dependent upon the png utilities
 310 .RB ( \%pnmcut ,
 311 .BR \%pnmcrop ,
 312 .BR \%pnmtopng )
 313 and GhostScript
 314 .RB ( gs ).
 315 .B \%pnmtopng
 316 (version 2.37.6 or greater)
 317 and
 318 .B \%pnmcut
 319 from the netpbm package (version 9.16 or greater) will work also.
 320 It is also dependent upon
 321 .B \%psselect
 322 from the
 323 .B PSUtils
 324 package.
 325 Images are generated whenever a table, picture, equation or line is
 326 encountered.
 327 .
 328 .
 329 .SH ENVIRONMENT
 330 .TP
 331 .SM
 332 .B GROFF_FONT_PATH
 333 A list of directories in which to search for the
 334 .BI dev name
 335 directory in addition to the default ones.
 336 .
 337 See
 338 .BR @g@troff (@MAN1EXT@)
 339 and
 340 .BR \%groff_font (@MAN5EXT@)
 341 for more details.
 342 .
 343 .
 344 .SH BUGS
 345 .B Grohtml
 346 has been completely redesigned and rewritten.
 347 It is still beta code.
 348 .
 349 .
 350 .SH "SEE ALSO"
 351 .BR afmtodit (@MAN1EXT@),
 352 .BR groff (@MAN1EXT@),
 353 .BR @g@troff (@MAN1EXT@),
 354 .BR psbb (@MAN1EXT@),
 355 .BR groff_out (@MAN5EXT@),
 356 .BR groff_font (@MAN5EXT@),
 357 .BR groff_char (@MAN7EXT@)
 358 .
 359 .\" Local Variables:
 360 .\" mode: nroff
 361 .\" End: