Debian Codegraph @

texmf-dist/doc/man/man1/hitex.1

raw
1 .TH HITEX 1 "11 November 2021" "Version 1.0"
2 .\"=====================================================================
3 .if n .ds MF Metafont
4 .if t .ds MF Metafont
5 .if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
6 .if n .ds TX TeX
7 .ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP
8 .el .ds OX TeX
9 .\" BX definition must follow TX so BX can use TX
10 .if t .ds BX \fRB\s-2IB\s0\fP\*(TX
11 .if n .ds BX BibTeX
12 .\" LX definition must follow TX so LX can use TX
13 .if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
14 .if n .ds LX LaTeX
15 .if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX
16 .if n .ds AX AmSTeX
17 .if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX
18 .if n .ds AY AmSLaTeX
19 .if n .ds WB Web
20 .if t .ds WB W\s-2EB\s0
21 .\"=====================================================================
22 .SH NAME
23 hitex \- HINT output from TeX
24 .SH SYNOPSIS
25 .B hitex
26 .RI [ options ]
27 .RI [ \fB&\fPformat ]
28 .RI [ file | \fB\e\fPcommands ]
29 .\"=====================================================================
30 .SH DESCRIPTION
31 Run the Hi\*(TX typesetter on
32 .IR file ,
33 usually creating
34 .IR file.hnt .
35 If the file argument has no extension, ".tex" will be appended to it.
36 Instead of a file name, a set of Hi\*(TX commands can be given, the first
37 of which must start with a backslash.
38 With a
39 .BI & format
40 argument Hi\*(TX uses a different set of precompiled commands,
41 contained in
42 .IR format\fB.fmt\fP ;
43 it is usually better to use the
44 .B -fmt
45 .I format
46 option instead.
47 .PP
48 Hi\*(TX is a version of \*(TX that creates HINT files. The HINT file
49 format is designed for on-screen reading of documents. Using a HINT
50 viewer (see
51 .BR https://hint.userweb.mwn.de )
52 to display a HINT file its content will dynamically adapt to the
53 available display area.
54 .PP
55 The typical use of Hi\*(TX is with pre generated formats.
56 The
57 .B hitex
58 command uses the equivalent of the plain \*(TX format, and the
59 .B hilatex
60 command uses the equivalent of the \*(LX format.
61 To generate formats, use the
62 .B -ini
63 switch.
64 .PP
65 Hi\*(TX's handling of its command-line arguments is similar to that of
66 of the other \*(TX programs in the
67 .I web2c
68 implementation.
69 .PP
70 Hi\*(TX incorporates the e-\*(TX
71 extensions (see
72 .BR etex (1))
73 if used with the
74 .B -etex
75 switch.
76 .PP
77 Hi\*(TX incorporates the extensions needed for \*(LX
78 (see
79 .BR latex (1))
80 if used with the
81 .B -ltx
82 switch.
83 .\"=====================================================================
84 .SH OPTIONS
85 This version of Hi\*(TX understands the following command line options.
86 .TP
87 .BI -cnf-line \ string
88 Parse
89 .I string
90 as a
91 .I texmf.cnf
92 configuration line. See the Kpathsea manual.
93 .TP
94 .B -compress
95 Enable the use of compression for the HINT file. Compressed files are
96 smaller but require decompression when viewing. Use only for large
97 files if the file size matters.
98 .TP
99 .B -empty-page
100 When writing books, often empty pages are inserted - for example to
101 begin chapters on a right hand side page. These empty pages are
102 a nuisance for on-screen reading where there are no left or right
103 hand side pages. This option keeps empty pages in the output.
104 .TP
105 .B -no-empty-page
106 This option tries to eliminate empty pages in the output. It is set as a default.
107 .TP
108 .B -etex
109 Enable the e-\*(TX extensions. This option is only effective in
110 combination with
111 .BR -ini .
112 See
113 .BR etex (1).
114 .TP
115 .B -file-line-error
116 Print error messages in the form
117 .I file:line:error
118 which is similar to the way many compilers format them.
119 .TP
120 .B -no-file-line-error
121 Disable printing error messages in the
122 .I file:line:error
123 style.
124 .TP
125 .BI -fmt \ format
126 Use
127 .I format
128 as the name of the format to be used, instead of the name by which
129 Hi\*(TX was called or a
130 .I %&
131 line.
132 .TP
133 .B -help
134 Print help message and exit.
135 .TP
136 .BI -hint-debug \ bitmask
137 Sets HINT file debugging flags according to the
138 .IR bitmask .
139 See the
140 .B -hint-debug-help
141 option for details.
142 .TP
143 .B -hint-debug-help
144 Print an explanation of the HINT debugging flags and exit.
145 .TP
146 .B -hyphenate-first-word
147 \*(TX will usually not attempt to insert hyphenation points into the first
148 word of a paragraph. If a HINT file must be displayed on a very small device
149 such hyphenation points might prove necessary. This option is set by default
150 and enables the generation of these hyphenation points.
151 .TP
152 .B -no-hyphenate-first-word
153 Disable the automatic insertion of hyphenation points in the first word
154 of a paragraph. Needed only if complete compatibility with \*(TX is required.
155 .TP
156 .B -ini
157 Start in
158 .I INI
159 mode, which is used to dump formats. The
160 .I INI
161 mode can be used for typesetting, but no format is preloaded, and
162 basic initializations like setting catcodes may be required.
163 .TP
164 .BI -interaction \ mode
165 Sets the interaction mode. The mode can be either
166 .IR batchmode ,
167 .IR nonstopmode ,
168 .IR scrollmode ,
169 and
170 .IR errorstopmode .
171 The meaning of these modes is the same as that of the corresponding
172 \ecommands.
173 .TP
174 .BI -jobname \ name
175 Use
176 .I name
177 for the job name, instead of deriving it from the name of the input file.
178 .TP
179 .BI -kpathsea-debug \ bitmask
180 Sets path searching debugging flags according to the bitmask. See the
181 .I Kpathsea
182 manual for details.
183 .TP
184 .B -ltx
185 Enable the \*(LX extensions. This option is only effective in
186 combination with
187 .BR -ini .
188 See
189 .BR latex (1).
190 .TP
191 .BI -mfmode \ mode
192 Use
193 .I mode
194 as the \*(MF
195 .I mode
196 when generating missing fonts. See
197 .BR mf (1)
198 for details.
199 .TP
200 .BI -mktex \ fmt
201 Enable
202 .RI mktex fmt ,
203 where
204 .I fmt
205 must be either
206 .IR tex ,
207 .IR tfm ,
208 .IR fmt ,
209 or
210 .IR pk .
211 .TP
212 .BI -no-mktex \ fmt
213 Disable
214 .RI mktex fmt ,
215 where
216 .I fmt
217 must be either
218 .IR tex ,
219 .IR tfm ,
220 .IR fmt ,
221 or
222 .IR pk .
223 .TP
224 .BI -output-directory \ directory
225 Write output files in
226 .I directory
227 instead of the current directory. Look up input files in
228 .I directory
229 first, then along the normal search path.
230 .TP
231 .B -parse-first-line
232 If the first line of the main input file begins with
233 .I %&
234 parse it to look for a dump name.
235 .TP
236 .B -no-parse-first-line
237 Disable parsing of the first line of the main input file.
238 .TP
239 .BI -progname \ name
240 Pretend to be program
241 .IR name .
242 This affects both the format used and the search paths.
243 .TP
244 .BI -resolution \ number
245 When using \*(MF to generate missing pk fonts, use a resolution of
246 .I number
247 DPI. See
248 .BR mf (1)
249 for details.
250 .TP
251 .B -version
252 Print version information and exit.
253 .\"=====================================================================
254 .SH ENVIRONMENT
255 See the Kpathsea library documentation (e.g., the `Path specifications'
256 node) for precise details of how the environment variables are used.
257 The
258 .B kpsewhich
259 utility can be used to query the values of the variables.
260 .PP
261 One caveat: In most Hi\*(TX formats, you cannot use ~ in a file name you
262 give directly to Hi\*(TX, because ~ is an active character in \*(TX,
263 and hence is expanded, not taken as part of the file name. Other
264 programs, such as \*(MF, do not have this problem.
265 .PP
266 .TP
267 .B TEXMFOUTPUT
268 Normally, Hi\*(TX puts its output files in the current directory. If
269 any output file cannot be opened there, it tries to open it in the
270 directory specified in the environment variable TEXMFOUTPUT.
271 There is no default value for that variable. For example, if you say
272 .I hitex paper
273 and the current directory is not writable and TEXMFOUTPUT has
274 the value
275 .IR /tmp ,
276 Hi\*(TX attempts to create
277 .I /tmp/paper.log
278 (and
279 .IR /tmp/paper.hnt ,
280 if any output is produced.) TEXMFOUTPUT is also checked for input
281 files, as \*(TX often generates files that need to be subsequently
282 read; for input, no suffixes (such as ``.tex'') are added by default,
283 the input name is simply checked as given.
284 .TP
285 .B TEXINPUTS
286 Search path for
287 .I \einput
288 and
289 .I \eopenin
290 files.
291 This normally starts with ``.'', so
292 that user files are found before system files. An empty path
293 component will be replaced with the paths defined in the
294 .I texmf.cnf
295 file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the
296 current directory and ``/home/user/tex'' to the standard search path.
297 .TP
298 .B TEXFORMATS
299 Search path for format files.
300 .TP
301 .B TFMFONTS
302 Search path for font metric
303 .RI ( .tfm )
304 files.
305 .TP
306 .B SOURCE_DATE_EPOCH
307 If set, its value, taken to be in epoch-seconds, will be used for the
308 creation date and as the reference moment for the time related
309 primitives of \*(LX. This is useful for making reproducible builds.
310 .TP
311 .B FORCE_SOURCE_DATE
312 If set to the value "1", the time-related \*(TX primitives
313 .RI ( \eyear ,
314 .IR \emonth ,
315 .IR \eday ,
316 .IR \etime )
317 are also initialized from the value of SOURCE_DATE_EPOCH. This is not
318 recommended if there is any viable alternative.
319 .PP
320 Many, many more environment variables may be consulted related to path
321 searching. See the Kpathsea manual.
322 .\"=====================================================================
323 .SH FILES
324 The location of the files mentioned below varies from system to
325 system. Use the
326 .B kpsewhich
327 utility to find their locations.
328 .TP
329 .I *.tfm
330 Metric files for Hi\*(TX's fonts.
331 .TP
332 .I *.fmt
333 Predigested Hi\*(TX format files.
334 .TP
335 .I *.pk *.pfb
336 Font files used by Hi\*(TX.
337 .\"=====================================================================
338 .SH NOTES
339 This manual page is not meant to be exhaustive. The complete
340 documentation for Hi\*(TX can be found in the
341 .IR "Hi\*(TX user manual"
342 Further information can be found in the manual of the
343 .I "Kpathsea library"
344 and in
345 .I "HINT: The file format"
346 which is available as a book or in electronic form from the
347 HINT project home page at
348 .BR https://hint.userweb.mwn.de .
349 .\"=====================================================================
350 .SH BUGS
351 This version of Hi\*(TX fails to handle correctly glues and kerns with a
352 width that depends on \ehsize or \evsize. Similarly, when
353 the layout of table entries or mathematical formulas depends on \ehsize
354 or \evsize their output might be distorted.
355 .\"=====================================================================
356 .SH AVAILABILITY
357 Hi\*(TX should compile on a large variety of machine architectures
358 and operating systems.
359 Hi\*(TX is part of the \*(TX Live distribution.
360 .PP
361 The Hi\*(TX home page is at
362 .BR https://hint.userweb.mwn.de .
363 There you find additional software, most importantly viewers for HINT files,
364 and further information.
365 .\"=====================================================================
366 .SH "SEE ALSO"
367 .BR histretch (1),
368 .BR hishrink (1),
369 .BR latex (1),
370 .BR tex (1),
371 .BR kpsewhich (1),
372 .\"=====================================================================
373 .SH AUTHORS
374 The primary author of Hi\*(TX is Martin Ruckert,
375 with e\*(TX extensions by Peter Breitenlohner,
376 \*(LX extensions by Thierry Laronde, and
377 the kpathsearch library by Karl Berry.
378 .PP
379 \*(TX was designed by Donald E. Knuth,
380 who implemented it using his \*(WB system for Pascal programs.
381 .PP
382 Many, many more contributed to the typesetting system now known as \*(TX;
383 far too many to name all of them here.
384 .\" vim: syntax=nroff