1TEX4HT(1) General Commands Manual TEX4HT(1)
2
6 TeX4ht - a system for authoring hypertext with TeX and friends
7
9 mk4ht command file [ options1 ] [ options2 ] [ options3 ]
10 httex|htlatex|httexi file [ options1 ] [ options2 ] [ options3 ]
12 ht tex|latex file [ t4ht options ]
14 tex4ht [ -fdir-char ] file[.dvi] [ -ctag-name ] [ -eenv-file ] [
16 -gbitmap-file-ext ] [ -h(e|f|F|g|s|v|V) ] [ -ihtf-font-dir ] [ -lbook‐
17 keeping-file ] [ -P(*|filter) ] [ -ttfm-font-dir ] [ -u10 ] [ -utf8 ] [
18 -xs ]
19 t4ht [ -fdir-char ] file[.lg] [ -ctag-name ] [ -dout-dir ] [ -eenv-file
21 ] [ -i ] [ -mmode ] [ -Mmode ] [ -p ] [ -r ] [ -S(*|filter) ] [
22 -Xfield-content ] [ -.field-content ]
23
25 (This manual page was written for the Debian GNU/Linux distribution
26 because the original program does not have a manual page. Instead, it
27 is documented in detail at the author's website; see below. Please
28 refer to that documentation for more details or up to date informa‐
29 tion.)
30 This page documents briefly the portmanteau perl script mk4ht, the more
32 specific shell scripts httex, htlatex, httexi, and others like them,
33 the lower level shell script interface ht, and the commands tex4ht and
34 t4ht that all these scripts invoke. Together these programs constitute
35 TeX4ht; a highly configurable TeX-based authoring system for producing
36 hypertext.
37 TeX4ht interacts with TeX-based applications through a style file
39 tex4ht.sty and other files which are loaded by this style file, leaving
40 the processing of the source files to the native TeX compiler. The out‐
41 put of the TeX compiler is then post-processed by tex4ht and t4ht.
42 Consequently, TeX4ht can handle most features of TeX-based systems in
43 general, and of LaTeX in particular.
44 The shell scripts httex , htlatex and httexi convert TeX (respectively
46 LaTeX and texinfo) into HTML. Typical user requirements should be sat‐
47 isfied by these scripts which can generally convert typical TeX source
48 without requiring any modifications.
49 The perl script mk4ht is provided to convert numerous dialects of TeX
51 into numerous variants of hypertext (HTML, XML, XHTML, MathML and so
52 on). Most common usage of the system can be covered by the appropriate
53 use of this command with its options.
54 The shell script ht is a much more elementary script which is provided
56 for more complicated needs. Its correct use depends on a better under‐
57 standing of the system.
58 All these scripts begin with suitable invocations of tex(1) or latex(1)
60 or other dialects of TeX as required. The post-processing of the .dvi
61 output is handled by tex4ht. Anything that cannot be rendered using
62 HTML (or its chosen hypertext variant), such as the creation of bitmap
63 images or CSS (Cascade Style Sheet) files is handled by the auxiliary
64 program t4ht. The method used for generating the images can be config‐
65 ured.
66
68 The following is only a very brief summary of the main program options.
69 For more details of the command-line and configuration options, see the
70 HTML documentation (see below).
71 Options for httex, htlatex and httexi
73 httex, htlatex and httexi are shell scripts that can be used to convert
74 a file in the TeX/LaTeX/texinfo format into HTML. This TeX source file
75 should be like any other TeX source file normally used to produce a
76 .dvi file by processing with TeX and friends. The name of such a file
77 is the mandatory file argument for each script. This is followed by up
78 to three optional arguments (delimited with quotation marks). These
79 arguments, which are not required for typical usage, are as follows:
80 1. The first argument is a list of options for the tex4ht.sty style
82 file (used with tex or latex), separated with commas. See the
83 HTML documentation for the list of options available. The .log
84 file generated by tex/latex also includes summaries of some of
85 the options available. If not empty, this argument must start
86 with html or xhtml. Additional options could be mathml or doc‐
87 book to indicate appropriate style of output.
88 2. This argument is used to select tagged sections of tex4ht.env
90 that specifies the font files (*.htf) to use. This corresponds
91 to the -c option for the command tex4ht as explained below.
92 Examples include unicode or mozilla.
93 3. This argument lists options for the t4ht program as explained
95 below.
96 See the HTML documentation for more details and examples.
98 Similar scripts are available within the directory /usr/share/tex4ht
100 for generating other kinds of hypertext output. It is also possible to
101 use the perl script mk4ht as explained below.
102 Options for mk4ht
104 mk4ht is a perl script that can be used to convert TeX source files
105 from numerous dialects of TeX into different hypertext variants. This
106 script takes two mandatory arguments: the name of the command to run
107 and the file to run it on. Each possible command is of the form "<vari‐
108 ant><dialect>": so for example xhmlatex denotes a LaTeX source that
109 needs to be converted to XHTML with MathML extensions. The possible
110 names for commands can be found by listing the directory
111 /usr/share/tex4ht. The three optional arguments to mk4ht are identical
112 to those outlined above for httex, htlatex and httexi. In fact, the
113 command htlatex foo is identical to mk4ht htlatex foo except that the
114 former is shorter to type! However, mk4ht can be configured to shorten
115 the command line as follows.
116 Each user can create the configuration file mk4ht.cfg or .mk4ht in the
118 home or working directory to configure commonly used options for mk4ht;
119 in addition options to clean up temporary files can also be added to
120 this configuration file. Running the command mk4ht without any argu‐
121 ments will summarise the use of this user configuration file.
122 Options for ht
124 ht is a small shell script that is used to run the tex4ht programs. It
125 has two compulsory arguments, as follows:
126 1. The TeX command name to run, usually either tex or latex.
128 2. The input file name (with or without extension).
130 It may take any additional options, which will be passed on to the call
132 to t4ht.
133 General directory/file search options
135 Several of the options detailed below relate to setting directory paths
136 to find particular kinds of files. Note the following when specifying
137 directories for the programs:
138 1. There must be no space between the option letter (eg, -t) and
140 the directory/file name.
141 2. The directory name must end with a trailing slash (/, or /! -
143 see below).
144 3. You can add an exclamation mark (!) to the end of the directory
146 name, to enable sub-directory searching.
147 4. Only one directory can be specified at a time. To search multi‐
149 ple directories, either use the sub-directory searching facility
150 or repeat the option. (The directory search options can be
151 repeated as often as required.)
152 5. When compiled with kpathsea (as in the Debian package), the
154 path-searching is in part taken over by kpathsea. On a Debian
155 system see /usr/share/doc/tex4ht/README.kpathsea for more infor‐
156 mation on path-searching in a kpathsea-enabled tex4ht.
157 As well as command-line options, most of these options can (and nor‐
159 mally should) be set in the configuration file tex4ht.env. The format
160 within this file is similar, but without using a hyphen before the
161 option letter. See the HTML documentation for more details on the con‐
162 figuration options available. The file tex4ht.env can be superseded on
163 a per-directory and/or a per-user basis as explained in the HTML docu‐
164 mentation. On a Debian system see /usr/share/doc/tex4ht/README.Debian
165 as well.
166 Options for tex4ht
168 -ctag-name
169 Certain lines within the tex4ht.env configuration file can be
170 marked with tags. These lines (typically htf-font-dir search
171 lines) will be omitted unless specifically requested by specify‐
172 ing the tag name on the tex4ht command line. If not used, a
173 command-line option of -cdefault is assumed. (See the supplied
174 tex4ht.env file for examples of tagged sections.)
175 -eenv-file
177 Specify address of the tex4ht configuration file tex4ht.env.
178 -gbitmap-file-ext
180 Set the extension of bitmap images to bitmap-file-ext instead of
181 the default .png. Note that the extension should begin with a
182 dot (.). Note also that this option only affects images gener‐
183 ated automatically for symbol fonts, and not images generated
184 with the \Picture macro of tex4ht.
185 -he Trace errors and warnings (produces verbose output).
187 -hg Trace groups
189 -hs Trace \specials.
191 -hV Trace search path for tex4ht.env configuration file
193 -hF Trace search path for .htf font files
195 -hv Dump contents of found tex4ht.env configuration file to stderr
197 (for debugging)
198 -hf Dump contents of each .htf font file found to stderr (for debug‐
200 ging)
201 -ihtf-font-dir
203 Set directory for HTF font files (used by tex4ht) to htf-font-
204 dir.
205 -lbookkeeping-file
207 Specify name of the file listing cache used to speed up filename
208 lookups (ignored if compiled with kpathsea support)
209 -Pfilter
211 Restrict system calls requested in the source (La)TeX files to
212 utilities whose names have filter as a prefix. Use a single
213 asterisk as filter to allow any system calls.
214 -ttfm-font-dir
216 Set directory for TFM font files to tfm-font-dir (ignored if
217 compiled with kpathsea support).
218 -u10 Use base 10 encoding for unicode characters.
220 -utf8 Use utf-8 encoding for unicode characters.
222 -xs Use 8.3 (MSDOS style) file names for the generated PNG files.
224 Options for t4ht
226 -ctag-name
227 Certain lines within the tex4ht.env configuration file can be
228 marked with tags. These lines (typically scripts for post-pro‐
229 cessing files) will be omitted unless specifically requested by
230 specifying the tag name on the tex4ht command line. If not
231 used, a command-line option of -cdefault is assumed. (See the
232 supplied tex4ht.env file for examples of tagged sections.)
233 -dout-dir
235 Output files to directory out-dir, instead of to the current
236 directory.
237 -eenv-file
239 Specify address of the tex4ht configuration file tex4ht.env.
240 -i Generate verbose debugging output.
242 -mmode Create any new output files with access mode as indicated by
244 mode. The mode should be a numeric mode, as used by the
245 chmod(1) command.
246 -Mmode As -m but change all mode of all output files (including reused
248 bitmaps).
249 -p Do not convert pictures (ie, images generated with macros like
251 \Picture, not characters in symbol fonts that will be automati‐
252 cally converted into a graphic file).
253 -r Do not resuse existing bitmaps of glyphs (for characters in sym‐
255 bol fonts etc), but instead generate all bitmaps anew.
256 -Sfilter
258 Restrict system calls requested in the source (La)TeX files to
259 utilities whose names have filter as a prefix. Use a single
260 asterisk as filter to allow any system calls.
261 -Xfield-content
263 Scripts for post-processing of files can be specified in
264 tex4ht.env. If these scripts refer to a field %%3, content for
265 that field can be set with this command-line option.
266 -.field-content
268 Scripts for post-processing of groups of files with a particular
269 extension can be specified in tex4ht.env. If these scripts
270 refer to a field %%2, content for that field can be set with
271 this command-line option.
272
274 /usr/share/texmf/tex4ht/base/unix/tex4ht.env
275 Configuration file for tex4ht. This file is commented within
276 the file, and some additional notes are in
277 /usr/share/doc/tex4ht/README.kpathsea on a Debian system. Fur‐
278 ther explanation is available in the HTML documentation.
279 /usr/share/texmf/web2c/texmf.cnf
281 Global configuration file for all TeX-related programs using the
282 kpathsea path searching library. The variables TEX4HTINPUTS,
283 T4HTINPUTS and TEX4HTFONTSET within this file relate to file
284 searching within tex4ht and t4ht. These variables may also be
285 set in the environment, outwith
286 /usr/share/texmf/web2c/texmf.cnf.
287 /usr/share/texmf/tex4ht/ht-fonts/*.htf
289 Hypertext font files used by tex4ht.
290 /usr/share/texmf/tex/generic/tex4ht/tex4ht.sty and
292 /usr/share/texmf/tex/generic/tex4ht/*.4ht
293 Macro files used by tex or latex when using tex4ht to generate
294 HTML output.
295 /usr/share/tex4ht/*
297 Shell scripts for generating different kinds of hypertext output
298 from tex or latex sources.
299
301 The use of the tex4ht macros is documented in the HTML documentation at
302 the web site given below.
303 tex(1), latex(1), amstex(1), kpsewhich(1), http://www.cse.ohio-
305 state.edu/~gurari/TeX4ht/mn.html
306
308 This manual page is not complete. Users should refer to the HTML docu‐
309 mentation for fuller details of the configuration options and for
310 details of the use of the tex4ht style files. tex4ht is still a work
311 in progress, so bug reports and requests are very welcome: contact
312 Eitan Gurari <gurari@cis.ohio-state.edu>.
313
315 This manual page was originally written by Andrew Gray
316 <ajpg@debian.org> (and then modified by Kapil Paranjape), for the
317 Debian GNU/Linux system (but it may be used by others).
318 The tex4ht programs and macro files were written by Eitan Gurari
320 <gurari@cis.ohio-state.edu>. The author maintains a home page at
321 http://www.cse.ohio-state.edu/~gurari/TeX4ht/
322 5 Apr 2005 TEX4HT(1)