PREV UP NEXT texi2www user's guide

Chapter 2: Invocation

Synopsys

texi2www [options] texinfo-file

Options

-dir path
Specifies the path to the directory where the generated files get placed. If not specified, the current directory is assumed.
-footer file
Specifies a file whose contents get appended at the bottom of each generated HTML file. Typically looks something like:
<HR>
<P>Back to our <A HREF="../../homepage.html">home page</A>.</P>
-icons path
Specifies the path (relative to the directory where the generated files get placed) to the arrow files. If not specified, `..' is assumed. The names of the arrow files are `up_arrow.gif', `left_arrow.gif', `right_arrow.gif', and `missing_arrow.gif'

Directory structure

Texi2www will generate a set of HTML files from each texinfo document; each set of HTML files must go in a seperate directory (why? one reason is because each set includes a file named Top.html!).

These directories should be subdirectories of the same base directory. Assume the base directory is $TEXIBASE. Then HTML files for emacs go in directory $TEXIBASE/emacs, HTML files for texinfo go in $TEXIBASE/texinfo, etc, where the name of the subdirectory is the same as the name of the info file (so cross references between documents will work).

In addition to the subdirectories of HTML files, $TEXIBASE contains a file dir.html and the four arrow gif files up_arrow.gif, left_arrow.gif, right_arrow.gif, and missing_arrow.gif.

$TEXIBASE/dir.html is typically just a menu of links to the subdirectories and can be as simple as

<HTML><HEAD><TITLE>dir</TITLE></HEAD>
<BODY>
<MENU>
<LI><A HREF="emacs/Top.html">emacs</A>
<LI><A HREF="texinfo/Top.html">texinfo</A>
</MENU>
</BODY></HTML>

($TEXIBASE/dir.html is not generated via texi2www and must be created by hand).