src/devices/grohtml/grohtml.man

   1 .ig \"-*- nroff -*-
   2 Copyright (C) 1999-2000 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 .SH NAME
  27 grohtml \- html driver for groff
  28 .SH SYNOPSIS
  29 .nr a \n(.j
  30 .ad l
  31 .nr i \n(.i
  32 .in +\w'\fBgrohtml 'u
  33 .ti \niu
  34 .B grohtml
  35 .de OP
  36 .ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
  37 .el .RB "[\ " "\\$1" "\ ]"
  38 ..
  39 .OP \-atTvdgm?
  40 .OP \-F dir
  41 .OP \-I imagetype
  42 .OP \-r resolution
  43 .RI "[\ " files\|.\|.\|. "\ ]"
  44 .br
  45 .ad \na
  46 .PP
  47 It is possible to have whitespace between a command line option and its
  48 parameter.
  49 .SH DESCRIPTION
  50 .B grohtml
  51 translates the output of GNU
  52 .B troff
  53 to html.
  54 Normally
  55 .B grohtml
  56 should be invoked by using the groff command with a
  57 .B \-Thtml
  58 option.
  59 If no files are given,
  60 .B grohtml
  61 will read the standard input.
  62 A filename of
  63 .B \-
  64 will also cause
  65 .B grohtml
  66 to read the standard input.
  67 Html output is written to the standard output.
  68 When
  69 .B grohtml
  70 is run by
  71 .B groff
  72 options can be passed to
  73 .B grohtml
  74 using the
  75 .B groff
  76 .B \-P
  77 option.
  78 .SH OPTIONS
  79 .TP
  80 .B \-a
  81 force
  82 .B grohtml
  83 to generate html line breaks in the same position as troff dictates.
  84 Without this option
  85 .B grohtml
  86 generates text in paragraphs which is formatted by the html browser.
  87 .TP
  88 .B \-d
  89 turn on internal debugging.
  90 .TP
  91 .B \-g
  92 tell
  93 .B grohtml
  94 not to try and guess titles and headings.
  95 By using this flag together with the -m and -a flag
  96 .B grohtml
  97 will treat the html browser as a printer, not as a formatter.
  98 .TP
  99 .B \-m
 100 leave margins alone.
 101 .B grohtml
 102 will not remove left margins.
 103 .TP
 104 .B \-t
 105 forbids
 106 .B grohtml
 107 from generating html tables when implementing indentation and tabular text.
 108 .B grohtml
 109 can implement .IP by tables or html indents.
 110 However if .2C is used it can only be sensibly converted to html using a
 111 table structure.
 112 As a few known bugs still exist with the html table code this option is
 113 present to supress execution of this development code.
 114 The default in
 115 .B grohtml
 116 is that html tables are generated when appropriate.
 117 .TP
 118 .B \-T
 119 forbids
 120 .B grohtml
 121 from generating images when processing output from tbl.
 122 This is useful when simple textual tables are being produced.
 123 .TP
 124 .BI \-F dir
 125 Search the directory
 126 .IB dir /dev name
 127 for font and device description files;
 128 .I name
 129 is the name of the device, usually
 130 .BR html .
 131 .TP
 132 .BI \-I imagetype
 133 select the type of image generated when grohtml encounters an equation,
 134 table, or picture.
 135 By default this is png256.
 136 Legal image types are: gif and any of the png formats which are supported by
 137 ghostscript gs(1).
 138 .TP
 139 .BI \-r resolution
 140 select the resolution for all images.
 141 By default this is 80 pixels per inch.
 142 Example: -r100 indicates 100 pixels per inch.
 143 .TP
 144 .B \-v
 145 Print the version number.
 146 .TP
 147 .B \-?
 148 Display usage.
 149 .SH USAGE
 150 There are styles called
 151 .BR R ,
 152 .BR I ,
 153 .BR B ,
 154 and
 155 .B BI
 156 mounted at font positions 1 to 4.
 157 It is advisable to invoke groff with the -mhtml macro set, which turns off
 158 headers, footers, and hyphenation; additionally, it will right justify text.
 159 .SH DEPENDENCIES
 160 .B grohtml
 161 is dependent upon grops and gs.
 162 If
 163 .B grohtml
 164 has been configured to generate gif files then it is further dependent upon,
 165 ppmtogif, and ppmquant.
 166 However if it has been configured to generate png files (the default) then
 167 it is dependent upon gs having a png output device.
 168 Images are generated whenever a table, picture, equation or line is
 169 encountered.
 170 .SH BUGS
 171 This is still very alpha.
 172 At least three major bugs remain:
 173 Firstly,
 174 .B grohtml
 175 sometimes miscalculates the end of an html table resulting in text which
 176 appears twice.
 177 Secondly equation numbers are not handled correctly.
 178 Thirdly equation macros and pic macros can confuse
 179 .BR grohtml .
 180 .SH "SEE ALSO"
 181 .BR afmtodit (@MAN1EXT@),
 182 .BR groff (@MAN1EXT@),
 183 .BR @g@troff (@MAN1EXT@),
 184 .BR psbb (@MAN1EXT@),
 185 .BR groff_out (@MAN5EXT@),
 186 .BR groff_font (@MAN5EXT@),
 187 .BR groff_char (@MAN7EXT@)