1GROHTML(1)                  General Commands Manual                 GROHTML(1)
2
3
4

NAME

6       grohtml - html driver for groff
7

SYNOPSIS

9       grohtml [ -bhlnprv ] [ -aaa-text-bits ] [ -Ddir ] [ -Fdir ]
10               [ -gaa-graphic-bits ] [ -iresolution ] [ -Iimage-stem ]
11               [ -jfilename ] [ -oimage-vertical-offset ] [ -ssize ]
12               [ -Slevel ] [ -xhtml-dialect ] [ files... ]
13

DESCRIPTION

15       The grohtml front end (which consists of a  preprocessor,  pre-grohtml,
16       and  a  device driver, post-grohtml) translates the output of GNU troff
17       to html.  Users should always invoke grohtml via the groff command with
18       a -Thtml option.  If no files are given, grohtml will read the standard
19       input.  A filename of - will also cause grohtml to  read  the  standard
20       input.  Html output is written to the standard output.  When grohtml is
21       run by groff options can be passed to grohtml using groff's -P option.
22

OPTIONS

24       -aaa-text-bits
25              Number of bits of antialiasing information to be  used  by  text
26              when  generating  png images.  The default is 4 but valid values
27              are 0, 1, 2, and 4.  Note your version of gs  needs  to  support
28              the  -dTextAlphaBits  and -dGraphicAlphaBits options in order to
29              exploit antialiasing.  A value of 0 stops grohtml  from  issuing
30              antialiasing commands to gs.
31
32       -b     Initialize the background color to white.
33
34       -Ddir  Inform grohtml to place all image files into directory dir.
35
36       -e     This  option should not be directly invoked by the user as it is
37              an internal option utilized by groff when -Thtml or  -Txhtml  is
38              specified.   It is used by the grohtml preprocessor to determine
39              whether eqn should attempt to  produce  MathML  (if  -Txhtml  is
40              specified).
41
42       -Fdir  Prepend  directory  dir/devname  to the search path for font and
43              device description files; name is the name of the  device,  usu‐
44              ally html.
45
46       -gaa-graphic-bits
47              Number  of bits of antialiasing information to be used by graph‐
48              ics when generating png images.  The default is 4 but valid val‐
49              ues  are  0, 1, 2, and 4.  Note your version of gs needs to sup‐
50              port the -dTextAlphaBits and -dGraphicAlphaBits options in order
51              to  exploit antialiasing.  A value of 0 stops grohtml from issu‐
52              ing antialiasing commands to gs.
53
54       -h     Generate section and number headings  by  using  <B>...</B>  and
55              increasing  the  font  size,  rather than using the <Hn>...</Hn>
56              tags.
57
58       -iresolution
59              Select the resolution for all images.  By default  this  is  100
60              pixels per inch.  Example: -i200 indicates 200 pixels per inch.
61
62       -Istem Determine   the  image  stem  name.   If  omitted  grohtml  uses
63              grohtml-XXX (XXX is the process ID).
64
65       -jfilename
66              Inform grohtml to split the html  output  into  multiple  files.
67              The filename is the stem and specified section headings (default
68              is level one) start a new file, named filename-n.html.
69
70       -l     Turn off the production of automatic section links at the top of
71              the document.
72
73       -n     Generate  simple heading anchors whenever a section/number head‐
74              ing is found.  Without the option the anchor value is  the  tex‐
75              tual heading.  This can cause problems when a heading contains a
76              `?' on older versions of some browsers (Netscape).  This flag is
77              automatically turned on if a heading contains an image.
78
79       -overtical-offset
80              Specify the vertical offset of images in points.
81
82       -p     Display  page  rendering  progress to stderr.  grohtml only dis‐
83              plays a page number when an image is required.
84
85       -r     Turn off the automatic header and footer line (html rule).
86
87       -s size
88              Set the base point size of the  source  file.   Thereafter  when
89              this  point size is used in the source it will correspond to the
90              html base size.  Every increase of two points in the source will
91              yield  a <big> tag, and conversely when a decrease of two points
92              is seen a <small> tag is emitted.
93
94       -Slevel
95              When splitting html output,  split  at  the  heading  level  (or
96              higher) defined by level.
97
98       -v     Print the version number.
99
100       -V     Create  an  XHTML or HTML validator button at the bottom of each
101              page of the document.
102
103       -xdialect
104              Select HTML dialect.  Currently, dialect should  be  either  the
105              digit  4  or the letter x which indicates whether grohtml should
106              generate HTML 4 or XHTML, respectively.  This option should  not
107              be directly invoked by the user as it is an internal option uti‐
108              lized by groff when -Thtml or -Txhtml is specified.
109
110       -y     Produce a right-justified groff signature at the end of the doc‐
111              ument.  This is only generated if the -V flag is also specified.
112

USAGE

114       There  are  styles  called  R, I, B, and BI mounted at font positions 1
115       to 4.
116

DEPENDENCIES

118       grohtml is dependent upon the png utilities (pnmcut, pnmcrop, pnmtopng)
119       and  GhostScript (gs).  pnmtopng (version 2.37.6 or greater) and pnmcut
120       from the netpbm package (version 9.16 or greater) will work  also.   It
121       is  also  dependent upon psselect from the PSUtils package.  Images are
122       generated whenever a table, picture, equation or line is encountered.
123

ENVIRONMENT

125       GROFF_FONT_PATH
126              A list of directories in which to search for the devname  direc‐
127              tory  in  addition  to  the  default  ones.   See  troff(1)  and
128              groff_font(5) for more details.
129

BUGS

131       Grohtml has been completely redesigned and rewritten.  It is still beta
132       code.
133

SEE ALSO

135       afmtodit(1),  groff(1), troff(1), psbb(1), groff_out(5), groff_font(5),
136       groff_char(7)
137
138
139
140Groff Version 1.20.1            9 January 2009                      GROHTML(1)
Impressum