Name
miktex-xetex — Unicode-based TeX engine
Synopsis
miktex-xetex [option...] [[file] | [\command...]]
Description
This man page is an adaption of the corresponding TeX Live man page.
Run the XeTeX typesetter on file,
usually creating file.pdf. If the file argument
has no extension, .tex will be appended to it.
Instead of a file name, a set of XeTeX commands can be given, the
first of which must start with a backslash.
XeTeX has simple font installation; it can use any installed fonts in the operating system without configuring TeX font metric. As a result, XeTeX can access font features such as special ligatures and variable font weights.
Options
--alias=namePretend to be program
name, i.e., set program (and memory dump) name toname. This may affect the search paths and other values used. Using this option is equivalent to copying the program file toand invokingname.name--aux-directory=dirSet
diras the directory to which auxiliary files are written. Also look for input files indirfirst, before along the normal search path.--buf-size=nSet the the maximum number of characters simultaneously present in current lines of open files and in control sequences between \csname and \endcsname. TeX uses the buffer to contain input lines, but macro expansion works by writing material into the buffer and reparsing the line. As a consequence, certain constructs require the buffer to be very large, even though most documents can be handled with a small value.
--c-style-errorsChange the way, error messages are printed. The alternate style looks like error messages from many compilers and is easier to parse for some editors.
--disable-8bit-charsMake only 7-bit characters printable.
--disable-installerDisable automatic installation of packages. Specifying this option overrules settings in the MiKTeX configuration data store.
--disable-write18Disable the \write18{
command} construct.--dont-parse-first-lineDisable checking whether the first line of the main input file starts with %&.
--enable-8bit-charsMake all characters printable.
--enable-etexEnable eTeX extensions.
--enable-installerEnable automatic installation of packages. Specifying this option overrules settings in the MiKTeX configuration data store.
--enable-mltexEnable MLTeX extensions such as \charsubdef.
--enable-write18Fully enable the \write18{
command} construct. It is only partially enabled by default to avoid security problems. When fully enabled, the command (which undergoes the usual TeX expansions) is passed to the command interpreter. The output of the command is not diverted anywhere, so it will not appear in the log file. The command execution either happens at \output time or right away, according to the absence or presence of the \immediate prefix.--error-line=n--extra-mem-bot=nSet the extra size (in memory words) for large data structures like boxes, glue, breakpoints, et al. Relevant only after the memory dump file has been read.
--extra-mem-top=nSet the extra size (in memory words) for chars, tokens, et al. Relevant only after the memory dump file has been read.
--font-max=n--font-mem-size=n--half-error-line=nSet the width of first lines of contexts in terminal error messages.
--halt-on-error--hash-extra=nSet the extra space for the hash table of control sequences (which allows 10K names as distributed).
--helpGive help and exit.
--hhelpThis option is only available on Windows systems: show the manual page in an HTML Help window and exit when the window is closed.
--include-directory=dirAdd the directory
dirto the head of the list of directories to be searched for input files.--initialize--interaction=modeSet the interaction mode. Must be one of
batchmode,nonstopmode,scrollmodeanderrorstopmode. The meaning of these modes is the same as the corresponding commands.--job-name=nameSet the name of the job (\jobname). This has an affect on the output file names.
--job-time=fileSet the time-stamp of all output files equal to
file's time-stamp.--main-memory=nChange the total size (in memory words) of the main memory array. Relevant only while creating memory dump files.
--max-in-open=nSet the maximum number of input files and error insertions that can be going on simultaneously.
--max-print-line=nSet the width of longest text lines output; should be at least
60.--max-strings=n--nest-size=nSet the maximum number of semantic levels simultaneously active.
--no-c-style-errors--no-pdfGenerate XDV (extended DVI) output rather than PDF.
--output-directory=dirWrite output files in
dir. instead of the current directory. Look up input files indirfirst, then along the normal search path.--output-driver=cmdUse
cmdas the XDV-to-PDF driver instead of xdvipdfmx.--papersize=stringSet PDF media size to
string.--param-size=nSet the the maximum number of simultaneous macro parameters.
--parse-first-lineCheck whether the first line of the main input file starts with %&, and parse if it does. This can be used to specify extra command-line options.
--pool-free=n--pool-size=nSet the maximum number of characters in strings, including all error messages and help texts, and the names of all fonts and control sequences.
--quietSuppress all output, except errors.
--record-package-usages=file--recorderEnable the file name recorder. This leaves a trace of the files opened for input and output in a file with the extension
.fls.--restrict-write18Partially enable the \write18{
command} construct.--save-size=nSet the the amount of space for saving values outside of current group.
--src-specialsEmbed source file information (source specials) in the DVI file.
--stack-size=n--string-vacancies=nSet the minimum number of characters that should be available for the user's control sequences and font names, after the compiler's own error messages are stored. Must be at least 25000 less than
pool_size, but doesn't need to be nearly that large.--synctex=nGenerate SyncTeX data for previewers. If
nis zero, no.synctexfile is created. Ifnis negative, the.synctexfile is a text file. Ifnis positive, the.synctexfile is compressed with gzip and the.gzfile name extension is added.Furthermore,
nis interpreted as a bit field:- Bit 1 (
nAND 2) Don't add the
.gzfile name extension.- Bit 2 (
nAND 4) Activate form support.
- Bit 3 (
nAND 8) Activate better compression.
- Bit 1 (
--time-statistics--trace[=tracestreams]Enable trace messages. The
tracestreamsargument, if specified, is a comma-separated list of trace stream names (Chapter 9, Trace Streams).--trie-size=n--undump=nameUse
nameas the name of the format to be used, instead of the name by which the program was called or a%&
line.
--versionShow version information and exit.
Environment
MIKTEX_EDITORThe editor to use when selecting
ein the error prompt menu.The value can contain these placesholder:
%fThe name of the file, which contains the erroneous line of TeX code.
%lThe line number.
MIKTEX_TRACEComma-separated list of trace stream names (see Chapter 9, Trace Streams). If this variable is set, then MiKTeX programs will write trace messages into the configured log sink.
TEXINPUTSExtra paths to locate TeX \input and \openin files.
TFMFONTSExtra paths to locate TeX font metric files