| blob | 0e89c08e44cf5eb30a1c744684fce900f819c010 |
1 .TH ALEPH 1 "16 June 2015" "Web2C @VERSION@"
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 .\"=====================================================================
20 .SH NAME
21 aleph \- extended Unicode TeX
22 .SH SYNOPSIS
23 .B aleph
24 .RI [ options ]
25 .RI [ \fB&\fPformat ]
26 .RI [ file | \fB\e\fPcommands ]
27 .\"=====================================================================
28 .SH DESCRIPTION
29 Run the Aleph typesetter on
30 .IR file ,
31 usually creating
32 .IR file.dvi .
33 If the file argument has no extension, ".tex" will be appended to it.
34 Instead of a filename, a set of Aleph commands can be given, the first
35 of which must start with a backslash.
36 With a
37 .BI & format
38 argument Aleph uses a different set of precompiled commands,
39 contained in
40 .IR format\fB.fmt\fP ;
41 it is usually better to use the
42 .B -fmt
43 .I format
44 option instead.
45 .PP
46 Aleph is a version of the \*(TX program modified for multilingual
47 typesetting. It uses Unicode, and has additional primitives for
48 (among other things) bidirectional typesetting.
49 .PP
50 Aleph's command line options are similar to those of \*(TX.
51 .PP
52 Aleph is no longer being actively developed; see LuaTeX for current
53 activity.
54 .\"=====================================================================
55 .SH OPTIONS
56 Run aleph --help to see the complete list of options; this is not
57 exhaustive.
58 .TP
59 .BI --fmt \ format
60 Use
61 .I format
62 as the name of the format to be used, instead of the name by which
63 Aleph was called or a
64 .I %&
65 line.
66 .TP
67 .B --halt-on-error
68 Exit with an error code when an error is encountered during processing.
69 .TP
70 .B --help
71 Print help message and exit.
72 .TP
73 .B --ini
74 Be `initial' Aleph for dumping formats; this is implicitly true if the
75 program is called as
76 .BR inialeph .
77 .TP
78 .BI --interaction \ mode
79 Sets the interaction mode. The mode can be one of
80 .IR batchmode ,
81 .IR nonstopmode ,
82 .IR scrollmode ,
83 and
84 .IR errorstopmode .
85 The meaning of these modes is the same as that of the corresponding
86 \ecommands.
87 .TP
88 .B --ipc
89 Send DVI output to a socket as well as the usual output file. Whether
90 this option is available is the choice of the installer.
91 .TP
92 .B --ipc-start
93 As
94 .BR --ipc ,
95 and starts the server at the other end as well. Whether this option
96 is available is the choice of the installer.
97 .TP
98 .BI --kpathsea-debug \ bitmask
99 Sets path searching debugging flags according to the bitmask. See the
100 .I Kpathsea
101 manual for details.
102 .TP
103 .BI --maketex \ fmt
104 Enable
105 .RI mktex fmt ,
106 where
107 .I fmt
108 must be one of
109 .I tex
110 or
111 .IR tfm .
112 .TP
113 .BI --no-maketex \ fmt
114 Disable
115 .RI mktex fmt ,
116 where
117 .I fmt
118 must be one of
119 .I tex
120 or
121 .IR tfm .
122 .TP
123 .BI --output-comment \ string
124 Use
125 .I string
126 for the DVI file comment instead of the date.
127 .TP
128 .BI --output-directory \ directory
129 Write output files in
130 .I directory
131 instead of the current directory. Look up input files in
132 .I directory
133 first, the along the normal search path.
134 .TP
135 .B --parse-first-line
136 If the first line of the main input file begins with
137 .I %&
138 parse it to look for a dump name.
139 .TP
140 .BI --progname \ name
141 Pretend to be program
142 .IR name .
143 This affects both the format used and the search paths.
144 .TP
145 .B --recorder
146 Enable the filename recorder. This leaves a trace of the files opened
147 for input and output in a file with extension
148 .IR .ofl .
149 (This option is always on.)
150 .TP
151 .B --shell-escape
152 Enable the
153 .BI \ewrite18{ command }
154 construct. The
155 .I command
156 can be any Bourne shell command. By default, this construct is
157 enabled in a restricted mode, for security reasons.
158 .TP
159 .B --version
160 Print version information and exit.
161 .\"=====================================================================
162 .SH ENVIRONMENT
163 See the Kpathsearch library documentation (the `Path specifications'
164 node) for precise details of how the environment variables are used.
165 The
166 .B kpsewhich
167 utility can be used to query the values of the variables.
168 .PP
169 One caveat: In most Aleph formats, you cannot use ~ in a filename you
170 give directly to Aleph, because ~ is an active character, and hence is
171 expanded, not taken as part of the filename. Other programs, such as
172 \*(MF, do not have this problem.
173 .PP
174 .TP
175 .B TEXMFOUTPUT
176 Normally, Aleph puts its output files in the current directory. If
177 any output file cannot be opened there, it tries to open it in the
178 directory specified in the environment variable TEXMFOUTPUT.
179 There is no default value for that variable. For example, if you say
180 .I tex paper
181 and the current directory is not writable, if TEXMFOUTPUT has
182 the value
183 .IR /tmp ,
184 Aleph attempts to create
185 .I /tmp/paper.log
186 (and
187 .IR /tmp/paper.dvi ,
188 if any output is produced.) TEXMFOUTPUT is also checked for input
189 files, as \*(TX often generates files that need to be subsequently
190 read; for input, no suffixes (such as ``.tex'') are added by default,
191 the input name is simply checked as given.
192 .TP
193 .B TEXINPUTS
194 Search path for
195 .I \einput
196 and
197 .I \eopenin
198 files.
199 This should start with ``.'', so
200 that user files are found before system files. An empty path
201 component will be replaced with the paths defined in the
202 .I texmf.cnf
203 file. For example, set TEXINPUTS to ".:/home/user/tex:" to prepend the
204 current direcory and ``/home/user/tex'' to the standard search path.
205 .TP
206 .B TEXEDIT
207 Command template for switching to editor. The default, usually
208 .BR vi ,
209 is set when Aleph is compiled.
210 .\"=====================================================================
211 .SH NOTES
212 This manual page is not meant to be exhaustive. The complete
213 documentation for this version of Aleph can be found in the info
214 manual
215 .IR "Web2C: A TeX implementation" .
216 See http://tug/org/web2c.
217 .\"=====================================================================
218 .SH BUGS
219 This version of Aleph implements a number of optional extensions.
220 In fact, many of these extensions conflict to a greater or lesser
221 extent with the definition of Aleph. When such extensions are
222 enabled, the banner printed when Aleph starts is changed to print
223 .B Alephk
224 instead of
225 .BR Aleph .
226 .PP
227 This version of Aleph fails to trap arithmetic overflow when
228 dimensions are added or subtracted. Cases where this occurs are rare,
229 but when it does the generated
230 .I DVI
231 file will be invalid.
232 .\"=====================================================================
233 .SH "SEE ALSO"
234 .BR tex (1),
235 .BR mf (1)
236 .\"=====================================================================
237 .SH AUTHORS
238 The primary authors of Aleph are John Plaice and Yannis Haralambous.