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

NAME

6       tex2page - makes Web pages from LaTeX and plain-TeX documents
7
8

SYNOPSIS

10           tex2page --help
11           tex2page --version
12           tex2page <pathname>
13
14

DESCRIPTION

16       The command
17
18           tex2page <pathname>
19
20       converts  the  TeX  source  file  <pathname>  to  the  HTML  file <job‐
21       name>.html, where <jobname> is the basename of <pathname>.  Some auxil‐
22       iary HTML files and some image files may also be created.
23
24       The  argument  <pathname>  can  be a full or relative pathname.  If the
25       latter, it is reckoned relative to the current directory.   The  exten‐
26       sion may be omitted if it is .tex.
27
28       In  order  to  resolve  cross-references, it may be necessary to invoke
29       tex2page a couple of times.  The log  displayed  on  the  console  will
30       inform  you  if  such  is the case.  This log is also saved in the file
31       <jobname>.hlog.
32
33       If tex2page is called with the option `--help', it prints a  help  mes‐
34       sage and exits.
35
36       If  tex2page  is  called with the option `--version', it prints version
37       information and exits.
38
39       If tex2page is called without an argument, or if the argument  is  nei‐
40       ther  a valid option nor an existing file, then tex2page prints a brief
41       help message and exits.  If you repeatedly (i.e., five or  more  times)
42       call it faultily despite its helpful advice, tex2page will visibly lose
43       its patience.
44
45       The complete documentation for tex2page is  included  in  the  tex2page
46       distribution, and may also be viewed on the Web at
47
48            http://www.ccs.neu.edu/~dorai/tex2page/tex2page-doc.html
49
50

SEARCH PATH FOR TeX FILES

52       tex2page  uses  the  same  search  path as TeX to search for \input and
53       \openin files.  The default search path is implementation-dependent but
54       can  be changed by setting the environment variable TEXINPUTS to a list
55       of colon-separated directories.  (If you wish to  merely  prepend  your
56       list to the default list, end your list with a colon.)
57
58       Add two trailing forward slashes to any directory in TEXINPUTS that you
59       want to recursively search all subdirectories of.
60
61       If the environment variable TIIPINPUTS is set, tex2page  will  use  the
62       TIIPINPUTS  value  as its search path instead of TEXINPUTS.  TIIPINPUTS
63       does not support the double-slash mechanism of TEXINPUTS.
64
65

EDITING ON ERROR

67       If tex2page encounters a fatal error in the document, it  displays  the
68       prompt
69
70           Type e to edit file at point of error; x to quit
71           ?
72
73       If you type x, tex2page immediately exits.
74
75       If however you type e, a text editor is fired up, showing the offending
76       file -- which may or may not be the main input file -- at the line con‐
77       taining the error.  The particular editor chosen and the arguments with
78       which it is called depends on the environment variables TEXEDIT or EDI‐
79       TOR.
80
81       If  the  environment  variable TEXEDIT is set, tex2page uses its string
82       value as the editor call to use.  A possible value for TEXEDIT is  "vim
83       +%d  %s".   This calls the editor vim with %s replaced by the offending
84       file's name, and %d replaced by the number of the offending line.
85
86       If TEXEDIT is not set, the value of the environment variable EDITOR  is
87       chosen as the editor.  Unlike TEXEDIT which contains the editor call as
88       a template, EDITOR contains simply the editor's  name.   If  EDITOR  is
89       also not set, vi is chosen as the editor.
90
91       The  editor  specified  in  EDITOR  is called with the arguments " +<n>
92       <f>", where <f> is the offending file's name and <n> is  the  offending
93       line  number.   It  is  not possible to alter the way the file and line
94       arguments are supplied, but fortunately this style is accepted  by  vi,
95       emacs, and all their clones.  If you use an editor that requires a dif‐
96       ferent argument style, use TEXEDIT.
97
98

DIRECTORY FOR HTML PAGES

100       By default, tex2page generates its output HTML  files  in  the  current
101       directory.   You  can specify a different directory by naming it in one
102       of the following files:
103
104           <jobname>.hdir in the current directory, or
105           .tex2page.hdir in the current directory, or
106           .tex2page.hdir in your home directory;
107
108       where <jobname> is the basename of the input document.   The  first  of
109       these three files that exists overrides the rest.
110
111       The name in the .hdir file can be, or contain, the TeX control-sequence
112       \jobname, which expands to <jobname>, the basename of the  input  docu‐
113       ment.
114
115

DOCUMENT-SPECIFIC MACROS

117       Before  processing  a  TeX  source  file  whose  basename is <jobname>,
118       tex2page will automatically load the file <jobname>.t2p, if it  exists.
119       <jobname>.t2p  is  a  good place to put macros that are specific to the
120       HTML version of the document.
121
122

GENERAL MACROS

124       tex2page recognizes some commands that are not supplied in the LaTeX or
125       plain-TeX formats -- typically these are commands that add value to the
126       HTML output.  In order to keep an input document that uses these  extra
127       commands  processable  by  TeX, working TeX definitions are provided in
128       the TeX macro file  tex2page.tex  and  the  LaTeX  macro  package  file
129       tex2page.sty.  Copy these macro files from the tex2page distribution to
130       a directory in your TEXINPUTS.
131
132       Plain-TeX documents can use
133
134           \input tex2page
135
136       while LaTeX documents can use
137
138           \usepackage{tex2page}
139
140

SYSTEM REQUIREMENTS

142       tex2page runs on Scheme or Common Lisp.  It may also make  use  of  the
143       following  programs:  BibTeX,  MakeIndex, Ghostscript, Dvips, MetaPost,
144       and the NetPBM library.
145
146       Out of the  box,  tex2page  runs  in  MzScheme,  but  the  distribution
147       includes  configuration information to allow tex2page to run on a vari‐
148       ety of Scheme and Common Lisp implementations.  See file INSTALL.
149
150

BUGS

152       Email to dorai @ ccs.neu.edu.
153
154

SEE ALSO

156       tex(1), latex(1), mzscheme(1), bibtex(1), makeindex(1L), mpost(1).
157
158
160       Copyright 1997-2007 by Dorai Sitaram.
161
162       Permission to distribute and use this work for any  purpose  is  hereby
163       granted  provided  this copyright notice is included in the copy.  This
164       work is provided as is, with no warranty of any kind.
165
166
167
168
169                                  2007-02-21                       TEX2PAGE(1)
Impressum