.\" Written by Andrew Gray <ajpg@debian.org>, 12 March 1999
.\" Revised Tue, 22 Jun 1999 09:53:47 +0100
.\" Revised Sun, 16 Jul 2000 14:08:07 +0100
.TH TEX4HT 1 "16 July 2000"
.SH NAME
tex4ht \- for authoring hypertext with tex/latex
.SH SYNOPSIS
.B tex4ht
.I file[.dvi]
[
.BI \-t tfm-font-dir
] [
.BI \-i htf-font-dir
] [
.BI \-e env-file
] [
.BI \-d out-dir
] [
.BI \-g bitmap-file-ext
] [
.BR \-h ( e|g|s )
] [
.BR \-P ( * | \fIfilter\fP )
]
.LP
.B t4ht
.I file[.lg]
[
.BI \-d out-dir
] [
.BI \-m mode
] [
.BI \-e env-file
] [
.BI \-h htf-conf-file
] [
.B \-p
] [
.B \-i
] [
.BR \-S ( * | \fIfilter\fP )
]
.LP
.B ht
tex | latex
.IR file " [ " "t4ht options" " ]"
.LP
.BR httex | htlatex | httexi
.I file
.RI "[ " "options1" " ]"
.RI "[ " "options2" " ]"
.RI "[ " "options3" " ]"
.SH "DESCRIPTION"
This manual page documents briefly the
.BR tex4ht " and " t4ht
commands, and related scripts,
.BR ht ", " httex ", " htlatex " and " httexi .
This manual page was written for the Debian GNU/Linux distribution because the
original program does not have a manual page.  Instead, it has documentation
in HTML (hypertext) format; see below.  Please refer to the HTML documentation
for more details or up to date information.
.LP
.B tex4ht
is a highly configurable TeX-based authoring system for producing hypertext.
It interacts with TeX-based applications through style files and
postprocessors, leaving the processing of the source files to the native TeX
compiler. Consequently, tex4ht can handle the features of TeX-based systems in
general, and of LaTeX in particular.  
.PP
The auxiliary program, 
.BR t4ht ,
is used to generate images as required by the HTML file, for anything that
cannot be rendered using simple HTML text and coding.  (The method and
programs used for generating the images are configurable.)  In addition, it
puts together the CSS (Cascade Style Sheet) files, and issues system calls for
services requested in the source (La)TeX files.
.PP
The shell scripts 
.BR ht ", " httex ", " htlatex " and " httexi
are wrappers round the other programs, also running 
.BR tex (1)
or
.BR latex (1)
as required.
.SH OPTIONS
The following is only a very brief summary of the main program options.
For more details of the command-line and configuration options, see the HTML
manual pages (see below).
.SS General directory/file search options
Several of the options detailed below relate to setting directory paths to
find particular kinds of files.  Note the following when specifying
directories for the programs:
.IP 1.
There must be no space between the option letter (eg,
.BR \-t )
and the directory/file name.
.IP 2.
The directory name must end with a trailing slash
.RB ( / ,
or
.B /!
\- see below).
.IP 3.
You can add an exclamation mark
.RB ( ! )
to the end of the directory name, to enable sub-directory searching.
.IP 4.
Only one directory can be specified at a time.  To search multiple
directories, either use the sub-directory searching facility or repeat the
option.  (The directory search options can be repeated as often as required.)
.LP
As well as command-line options, most of these options can (and normally
should) be set in the configuration file,
.IR tex4ht.env .
The format within this file is similar, but without using a hyphen before the
option letter.  See the HTML manual pages for more details on the
configuration options available.
.LP
In addition, if tex4ht has been compiled with support for the
.B kpathsea
search library, some options (eg, directories for font files) can be set in
the global configuration file used by all the TeX-related programs that make
use of the library.
.SS Options for tex4ht
.TP
.BI \-t tfm-font-dir
Set directory for TFM font files to
.IR tfm-font-dir .
.TP
.BI \-i htf-font-dir
Set directory for HTF font files (used by tex4ht) to
.IR htf-font-dir .
.TP
.BI \-e env-file
Specify address of the tex4ht configuration file
.IR tex4ht.env .
.TP
.BI \-d out-dir
Set the directory for outputting files 
.RI ( .html ", " .css )
to
.IR out-dir .
Note that tex4ht-specific files 
.RI ( .idv ", " .lg )
will still be output to the current directory.
.TP
.BI \-g bitmap-file-ext
Set the extension of bitmap images to
.I bitmap-file-ext
instead of the default
.IR .gif .
Note that the extension should begin with a dot
.RB ( . ).
Note also that this option only affects images generated automatically for
symbol fonts, and not images generated with the 
.B \(rsPicture
macro of tex4ht.
.TP
.B \-he
Trace errors and warnings (produces verbose output).
.TP
.B \-hg
Trace groups
.TP
.B \-hs
Trace 
.BR \(rsspecial s.
.TP
.BI \-P filter
Restrict system calls requested in the source (La)TeX files to utilities whose
names have
.I filter
as a prefix.  Use a single asterisk as
.I filter
to allow any system calls.
.SS Options for t4ht
.TP
.BI \-d out-dir
Output files to directory
.IR out-dir ,
instead of to the current directory.
.TP
.BI \-m mode
Create files with access mode as indicated by
.IR mode .
The 
.I mode
should be a numeric mode, as used by the
.BR chmod (1)
command.
.TP
.BI \-e env-file
Specify address of the tex4ht configuration file
.IR tex4ht.env .
.TP
.BI \-h htf-conf-file
Set the font configuration file to
.IR htf-conf-file .
The default is
.IR htfcss.env .
.TP
.B \-p
Do not convert pictures (ie, images generated with macros like
.BR \(rsPicture ,
not characters in symbol fonts that will be automatically converted into a
graphic file).
.TP
.B \-i
Generate verbose debugging output.
.TP
.BI \-S filter
Restrict system calls requested in the source (La)TeX files to utilities whose
names have
.I filter
as a prefix.  Use a single asterisk as
.I filter
to allow any system calls.
.SS Options for ht
.B ht
is a small shell script that is used to run the tex4ht programs.  It has two
compulsory arguments, as follows:
.IP 1.
The TeX command name to run, usually either
.B tex
or
.BR latex .
.IP 2.
The input file name, without any extension.
.PP
It may take any additional options, which will be passed on to the call to
.BR t4ht .
.SS Options for httex, htlatex and httexi
.BR httex ", " htlatex " and " httexi
are shell scripts that can be used for files that do not explicitly load the
configuration files.  Each script takes one mandatory file argument, followed
by up to three optional arguments, as follows:
.IP 1.
Options for the tex4ht macros (used with tex or latex).
.IP 2.
Directory for tex4ht font files (*.htf).
.IP 3.
Options for the t4ht program.
.LP
See the HTML documentation for more details and examples.
.SH FILES
.TP
.I @TEX4HTDIR@/tex4ht.env
Configuration file for tex4ht.
.TP
.I @TEXMFCNF@
Global configuration file for all TeX-related programs using the kpathsea path
searching library.
.TP
.I @HTFDIR@/*.htf
Hypertext font files used by tex4ht.
.TP
.IR @TEXDIR@/tex4ht.sty " and " @TEXEXTRADIR@/*.4ht
Macro files used by tex or latex when using tex4ht to generate HTML output.
.TP
.I @DOCDIR@/mn.html
top-level HTML file for the manual
.SH "SEE ALSO"
The use of the tex4ht macros is documented in the HTML manuals (see file name
above).
.PP
.BR tex (1),
.BR latex (1),
.BR amstex (1),
.BR kpsewhich (1)
.SH BUGS
This manual page is not complete.  Users should refer to the HTML manuals that
form part of the system for fuller details of the configuration options and
for details of the use of the tex4ht style files.
.B tex4ht
is still a work in progress, so bug reports
and requests are very welcome:  contact Eitan Gurari
<gurari@cis.ohio-state.edu>.
.SH AUTHOR
This manual page was written by Andrew Gray <ajpg@debian.org>,
for the Debian GNU/Linux system (but may be used by others).
.PP
The 
.B tex4ht
programs and macro files were written by Eitan Gurari
<gurari@cis.ohio-state.edu>.