first check-in of t2p code after svn

svn: r6566
This commit is contained in:
Dorai Sitaram 2007-06-10 20:34:24 +00:00
parent 00c4b1c83d
commit 16b7d4195d

View File

@ -1,4 +1,4 @@
.TH TEX2PAGE 1 "2005-04-29" \"last change
.TH TEX2PAGE 1 "2007-02-21" \"last change
.SH NAME
tex2page \- makes Web pages from LaTeX and plain-TeX documents
@ -18,42 +18,52 @@ The command
converts the TeX source file <pathname> to the HTML file
<jobname>.html, where <jobname> is the basename of <pathname>.
Some auxiliary HTML files and some image files may also be
created. The argument <pathname> can be a full or relative
pathname. If the latter, it is reckoned relative to the
current directory. The extension may be omitted if it is .tex.
created.
The argument <pathname> can be a full or relative pathname. If
the latter, it is reckoned relative to the current directory.
The extension may be omitted if it is .tex.
In order to resolve cross-references, it may be necessary to
invoke tex2page a couple of times. The log displayed on the
console will inform you if such is the case. This log is also
saved in the file <jobname>.hlog.
If tex2page is called without an argument, or if the file named
by the argument doesn't exist, tex2page prints a brief help
message and exits. If you repeatedly (i.e., >= 5 times) call
it faultily despite its helpful advice, tex2page will visibly
lose its patience.
If tex2page is called with the option `--help', it prints a help
message and exits.
If tex2page is called with the option `--version', it prints
version information and exits.
If tex2page is called without an argument, or if the argument is
neither a valid option nor an existing file, then tex2page prints
a brief help message and exits. If you repeatedly (i.e., five or
more times) call it faultily despite its helpful advice, tex2page
will visibly lose its patience.
The complete documentation for tex2page is included in the
tex2page distribution, and may also be viewed on the Web at
http://www.ccs.neu.edu/~dorai/tex2page/tex2page-doc.html
.SH OPTIONS
.SH SEARCH PATH FOR TeX FILES
tex2page can be called with the following options instead of an
argument filename.
tex2page uses the same search path as TeX to search for
\einput and \eopenin files. The default search path is
implementation-dependent but can be changed by setting the
environment variable TEXINPUTS to a list of colon-separated
directories. (If you wish to merely prepend your list to the
default list, end your list with a colon.)
.TP
--help
.
Print help message and exit.
Add two trailing forward slashes to any directory in TEXINPUTS
that you want to recursively search all subdirectories of.
.TP
--version
.
Print version information and exit.
If the environment variable TIIPINPUTS is set, tex2page will
use the TIIPINPUTS value as its search path instead of
TEXINPUTS. TIIPINPUTS does not support the double-slash
mechanism of TEXINPUTS.
.SH DIAGNOSTICS
.SH EDITING ON ERROR
If tex2page encounters a fatal error in the document, it
displays the prompt
@ -61,64 +71,34 @@ displays the prompt
Type e to edit file at point of error; x to quit
?
If you now type e, a text editor is fired up, showing the
offending file -- which may or may not be the main input file
-- at the line containing the error. The particular editor
chosen and the arguments with which it is called depends on the
environment variables TEXEDIT or EDITOR (see the ENVIRONMENT
section).
If you type x, tex2page immediately exits.
If you type x, the editor is not called, and tex2page
immediately exits.
.SH ENVIRONMENT
.SS * TEXINPUTS
tex2page uses the same search path as TeX to search for
\einput and \eopenin files. The default search path is
implementation-dependent but can be changed by setting the
environment variable TEXINPUTS to a list of colon-separated
directories. (If you wish to merely prepend your list to the
default list, end your list with a colon.) Add two trailing
forward slashes to any directory in TEXINPUTS that you want
to recursively search all subdirectories of.
.SS * TIIPINPUTS
If the environment variable TIIPINPUTS is set, tex2page will
use the TIIPINPUTS value as its search path instead of
TEXINPUTS. TIIPINPUTS does not support the double-slash
mechanism of TEXINPUTS.
.SS * TEXEDIT
If however you type e, a text editor is fired up, showing the
offending file -- which may or may not be the main input file --
at the line containing the error. The particular editor chosen
and the arguments with which it is called depends on the
environment variables TEXEDIT or EDITOR.
If the environment variable TEXEDIT is set, tex2page uses its
string value as the editor call to use when it encounters a
fatal error (see the DIAGNOSTICS section). A possible value
for TEXEDIT is "vim +%d %s". This calls the editor vim
with %s replaced by the offending file's name, and %d
replaced by the number of the offending line.
.SS * EDITOR
string value as the editor call to use. A possible value for
TEXEDIT is "vim +%d %s". This calls the editor vim with %s
replaced by the offending file's name, and %d replaced by the
number of the offending line.
If TEXEDIT is not set, the value of the environment variable
EDITOR is chosen as the editor. Note that unlike TEXEDIT
EDITOR is chosen as the editor. Unlike TEXEDIT
which contains the editor call as a template, EDITOR contains
simply the editor's name. If EDITOR is also not set, vi is
chosen as the editor.
The editor is called with the arguments " +<n> <f>", where
<f> is the offending file's name and <n> is the offending
line number. It is not possible to alter the way the file
and line arguments are supplied, but fortunately this style
is accepted by vi, emacs, and all their clones. If you use
an editor that requires a different argument style, use
TEXEDIT.
The editor specified in EDITOR is called with the arguments
" +<n> <f>", where <f> is the offending file's name and <n> is the
offending line number. It is not possible to alter the way the
file and line arguments are supplied, but fortunately this style
is accepted by vi, emacs, and all their clones. If you use an
editor that requires a different argument style, use TEXEDIT.
.SH FILES
.SS * <jobname>.hdir, .tex2page.hdir, ~/.tex2page.hdir
.SH DIRECTORY FOR HTML PAGES
By default, tex2page generates its output HTML files in the
current directory. You can specify a different directory by
@ -135,7 +115,7 @@ The name in the .hdir file can be, or contain, the TeX
control-sequence \ejobname, which expands to <jobname>, the
basename of the input document.
.SS * <jobname>.t2p
.SH DOCUMENT-SPECIFIC MACROS
Before processing a TeX source file whose basename is
<jobname>, tex2page will automatically load the file
@ -143,7 +123,7 @@ Before processing a TeX source file whose basename is
to put macros that are specific to the HTML version of the
document.
.SS * tex2page.tex, tex2page.sty
.SH GENERAL MACROS
tex2page recognizes some commands that are not supplied in
the LaTeX or plain-TeX formats -- typically these are