summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/fmtutil.1
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/fmtutil.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/fmtutil.1189
1 files changed, 63 insertions, 126 deletions
diff --git a/Master/texmf-dist/doc/man/man1/fmtutil.1 b/Master/texmf-dist/doc/man/man1/fmtutil.1
index 56f6f4eeac4..1b4357cdfa9 100644
--- a/Master/texmf-dist/doc/man/man1/fmtutil.1
+++ b/Master/texmf-dist/doc/man/man1/fmtutil.1
@@ -1,60 +1,42 @@
-.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.2.
-.TH FMTUTIL "1" "May 2021" "TeX Live" "User Commands"
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
+.TH FMTUTIL "1" "April 2015" "TeX Live" "User Commands"
.SH NAME
-fmtutil \- manage TeX formats and Metafont bases, per-user
+fmtutil \- manage TeX formats, Metafont bases and Metapost mems, per-user
.br
-fmtutil-sys \- manage TeX formats and Metafont bases, system-wide
+fmtutil-sys \- manage TeX formats, Metafont bases and Metapost mems, system-wide
.br
-mktexfmt \- create a TeX format or Metafont base
+mktexfmt \- create a TeX format, Metafont base, or Metapost mem
.SH SYNOPSIS
.B fmtutil
-[\fI\,-user|-sys\/\fR] [\fI\,OPTION\/\fR] ... [\fI\,COMMAND\/\fR]
-.br
-.B fmtutil-sys
[\fI\,OPTION\/\fR] ... [\fI\,COMMAND\/\fR]
.br
-.B fmtutil-user
+.B fmtutil-sys
[\fI\,OPTION\/\fR] ... [\fI\,COMMAND\/\fR]
.br
.B mktexfmt
-\fI\,FORMAT.fmt|BASE.base|FMTNAME\/\fR
+\fI\,FORMAT.fmt|BASE.base|MEM.mem|FMTNAME.EXT\/\fR
.SH DESCRIPTION
-fmtutil version r59143 (2021\-05\-09 04:23:44 +0200)
+fmtutil version svn36788 (2015\-04\-13 00:53:26 +0900)
.PP
-Rebuild and manage TeX fmts and Metafont bases, collectively called
-"formats" here. (MetaPost no longer uses the past\-equivalent "mems".)
-.PP
-If not operating in mktexfmt mode, exactly one command must be given,
-filename suffixes should generally not be specified, no non\-option
-arguments are allowed, and multiple formats can be generated.
+Rebuild and manage TeX formats, Metafont bases and MetaPost mems.
.PP
If the command name ends in mktexfmt, only one format can be created.
The only options supported are \fB\-\-help\fR and \fB\-\-version\fR, and the command
-line must be either a format name, with extension, or a plain name that
-is passed as the argument to \fB\-\-byfmt\fR (see below). The full name of the
-generated file (if any) is written to stdout, and nothing else. The
-system directories are used if they are writable, else the user directories.
+line must consist of either a format name, with its extension, or a
+plain name that is passed as the argument to \fB\-\-byfmt\fR (see below). The
+full name of the generated file (if any) is written to stdout, and
+nothing else.
.PP
-By default, the return status is zero if all formats requested are
-successfully built, else nonzero.
+If not operating in mktexfmt mode, the command line can be more general,
+and multiple formats can be generated, as follows.
.SH OPTIONS
.TP
-\fB\-\-sys\fR
-use TEXMFSYS{VAR,CONFIG}
-.TP
-\fB\-\-user\fR
-use TEXMF{VAR,CONFIG}
-.TP
\fB\-\-cnffile\fR FILE
read FILE instead of fmtutil.cnf
(can be given multiple times, in which case
all the files are used)
-.TP
-\fB\-\-dry\-run\fR, \fB\-n\fR
-don't actually build formts
-.TP
-\fB\-\-fmtdir\fR DIR
-write formats under DIR instead of TEXMF[SYS]VAR
+.HP
+\fB\-\-fmtdir\fR DIRECTORY
.TP
\fB\-\-no\-engine\-subdir\fR
don't use engine\-specific subdir of the fmtdir
@@ -63,39 +45,21 @@ don't use engine\-specific subdir of the fmtdir
exit successfully if no format is selected
.TP
\fB\-\-no\-error\-if\-no\-engine\fR=\fI\,ENGINE1\/\fR,ENGINE2,...
-exit successfully even if a required ENGINE
+exit successfully even if the required engine
.IP
is missing, if it is included in the list.
.TP
-\fB\-\-no\-strict\fR
-exit successfully even if a format fails to build
-.TP
-\fB\-\-nohash\fR
-don't update ls\-R files
-.TP
-\fB\-\-recorder\fR
-pass the \fB\-recorder\fR option and save .fls files
-.TP
-\fB\-\-refresh\fR
-recreate only existing format files
-.TP
-\fB\-\-status\-file\fR FILE
-append status information about built formats to FILE
-.TP
\fB\-\-quiet\fR
be silent
.TP
-\fB\-\-catcfg\fR
-(does nothing, exists for compatibility)
+\fB\-\-test\fR
+(not implemented, just for compatibility)
.TP
\fB\-\-dolinks\fR
-(does nothing, exists for compatibility)
+(not implemented, just for compatibility)
.TP
\fB\-\-force\fR
-(does nothing, exists for compatibility)
-.TP
-\fB\-\-test\fR
-(does nothing, exists for compatibility)
+(not implemented, just for compatibility)
.SS "Commands:"
.TP
\fB\-\-all\fR
@@ -104,30 +68,33 @@ recreate all format files
\fB\-\-missing\fR
create all missing format files
.TP
-\fB\-\-byengine\fR ENGINE
-(re)create formats built with ENGINE
+\fB\-\-refresh\fR
+recreate only existing format files
+.TP
+\fB\-\-byengine\fR ENGINENAME
+(re)create formats using ENGINENAME
.TP
-\fB\-\-byfmt\fR FORMAT
-(re)create format FORMAT
+\fB\-\-byfmt\fR FORMATNAME
+(re)create format for FORMATNAME
.TP
\fB\-\-byhyphen\fR HYPHENFILE
(re)create formats that depend on HYPHENFILE
.TP
-\fB\-\-enablefmt\fR
-FORMAT[/ENGINE] enable FORMAT, as built with ENGINE
+\fB\-\-enablefmt\fR FORMATNAME
+enable formatname in config file
.TP
-\fB\-\-disablefmt\fR FORMAT[/ENGINE]
-disable FORMAT, as built with ENGINE
-If multiple formats have the same name and
-.IP
-different engines, \fI\,/ENGINE\/\fP specifier is required.
+\fB\-\-disablefmt\fR FORMATNAME
+disable formatname in config file
.TP
\fB\-\-listcfg\fR
list (enabled and disabled) configurations,
filtered to available formats
.TP
-\fB\-\-showhyphen\fR FORMAT
-print name of hyphen file for FORMAT
+\fB\-\-catcfg\fR
+output the content of the config file
+.TP
+\fB\-\-showhyphen\fR FORMATNAME
+print name of hyphenfile for format FORMATNAME
.TP
\fB\-\-version\fR
show version information and exit
@@ -140,10 +107,8 @@ Explanation of trees and files normally used:
.IP
If \fB\-\-cnffile\fR is specified on the command line (possibly multiple
times), its value(s) are used. Otherwise, fmtutil reads all the
-fmtutil.cnf files found by running "kpsewhich \fB\-all\fR fmtutil.cnf", in the
-order returned by kpsewhich. Files specified via \fB\-\-cnffile\fR are
-first tried to be loaded directly, and if not found and the file names
-don't contain directory parts, are searched via kpsewhich.
+fmtutil.cnf files found by running `kpsewhich \fB\-all\fR fmtutil.cnf', in the
+order returned by kpsewhich.
.IP
In any case, if multiple fmtutil.cnf files are found, all the format
definitions found in all the fmtutil.cnf files are merged.
@@ -159,7 +124,7 @@ TEXMFSYSVAR \fI\,$TEXLIVE/YYYY/texmf\-var/web2c/fmtutil.cnf\/\fP
TEXMFLOCAL \fI\,$TEXLIVE/texmf\-local/web2c/fmtutil.cnf\/\fP
TEXMFDIST \fI\,$TEXLIVE/YYYY/texmf\-dist/web2c/fmtutil.cnf\/\fP
.IP
-For fmtutil\-user:
+For fmtutil:
TEXMFCONFIG $HOME/.texliveYYYY/texmf\-config/web2c/fmtutil.cnf
TEXMFVAR $HOME/.texliveYYYY/texmf\-var/web2c/fmtutil.cnf
TEXMFHOME \fI\,$HOME/texmf/web2c/fmtutil.cnf\/\fP
@@ -171,43 +136,28 @@ TEXMFDIST \fI\,$TEXLIVE/YYYY/texmf\-dist/web2c/fmtutil.cnf\/\fP
(where YYYY is the TeX Live release version).
.fi
.IP
-According to the actions, fmtutil might update one of the existing cnf
-files or create a new fmtutil.cnf, as described below.
+According to the actions, fmtutil might write to one of the given files
+or create a new fmtutil.cnf, described further below.
.PP
-Where format files are written:
-.IP
-By default, format files are (re)written in \fI\,$TEXMFSYSVAR/ENGINE\/\fP by
-fmtutil\-sys, and \fI\,$TEXMFVAR/ENGINE\/\fP by fmtutil\-user, where \fI\,/ENGINE\/\fP is
-a subdirectory named for the engine used, such as "pdftex".
-.IP
-For mktexfmt, TEXMFSYSVAR is used if it is writable, else TEXMFVAR.
-.IP
-If the \fB\-\-fmtdir\fR=\fI\,DIR\/\fR option is specified, DIR is used instead of
-TEXMF[SYS]VAR, but the \fI\,/ENGINE\/\fP subdir is still used by default.
-.IP
-In all cases, if the \fB\-\-no\-engine\-subdir\fR option is specified, the
-\fI\,/ENGINE\/\fP subdir is omitted.
-.PP
-Where configuration changes are saved:
+Where changes are saved:
.IP
If config files are given on the command line, then the first one
given will be used to save any changes from \fB\-\-enable\fR or \fB\-\-disable\fR.
-.IP
If the config files are taken from kpsewhich output, then the
-algorithm is more complicated:
+algorithm is more complex:
.IP
-1) If \fI\,$TEXMFCONFIG/web2c/fmtutil.cnf\/\fP or
-\fI\,$TEXMFHOME/web2c/fmtutil.cnf\/\fP appears in the list of used files,
-then the one listed first by kpsewhich \fB\-\-all\fR (equivalently, the one
-returned by "kpsewhich fmtutil.cnf"), is used.
+1) If \fI\,$TEXMFCONFIG/web2c/fmtutil.cnf\/\fP or \fI\,$TEXMFHOME/web2c/fmtutil.cnf\/\fP
+appears in the list of used files, then the one listed first by
+kpsewhich \fB\-\-all\fR (equivalently, the one returned by kpsewhich
+fmtutil.cnf), is used.
.IP
2) If neither of the above two are present and changes are made, a
new config file is created in \fI\,$TEXMFCONFIG/web2c/fmtutil.cnf\/\fP.
.IP
In general, the idea is that if a given config file is not writable, a
higher\-level one can be used. That way, the distribution's settings
-can be overridden system\-wide using TEXMFLOCAL, and system settings
-can be overridden again in a particular user's TEXMFHOME or TEXMFCONF.
+can be overridden for system\-wide using TEXMFLOCAL, and then system
+settings can be overridden again for a particular using using TEXMFHOME.
.PP
Resolving multiple definitions of a format:
.IP
@@ -217,43 +167,30 @@ coming from the first\-listed fmtutil.cnf is used.
Disabling formats:
.IP
fmtutil.cnf files with higher priority (listed earlier) can disable
-formats in lower priority (listed later) fmtutil.cnf files by
-writing a line like this in the higher\-priority fmtutil.cnf file:
+formats mentioned in lower priority (listed later) fmtutil.cnf files by
+writing, e.g.,
.IP
#! <fmtname> <enginename> <hyphen> <args>
.IP
-The #! must be at the beginning of the line, with at least one space
-or tab afterward, and there must be whitespace between each word on
-the list.
+in the higher\-priority fmtutil.cnf file.
.IP
-For example, you can disable the luajitlatex format by creating
-the file \fI\,$TEXMFCONFIG/web2c/fmtutil.cnf\/\fP with the line
+As an example, suppose you have want to disable the luajitlatex format.
+You can create the file \fI\,$TEXMFCONFIG/web2c/fmtutil.cnf\/\fP with the content
.IP
#! luajitlatex luajittex language.dat,language.dat.lua lualatex.ini
.IP
-(As it happens, the luajittex\-related formats are precisely why the
-\fB\-\-no\-error\-if\-no\-engine\fR option exists, since luajittex cannot be
-compiled on all platforms. So this is not needed.)
+and call fmtutil.
.PP
-fmtutil\-user (fmtutil \fB\-user\fR) vs. fmtutil\-sys (fmtutil \fB\-sys\fR):
+fmtutil vs. fmtutil\-sys (fmtutil \fB\-\-sys\fR):
.IP
-When fmtutil\-sys is run or the command line option \fB\-sys\fR is used,
+When fmtutil\-sys is run or the command line option \fB\-\-sys\fR is used,
TEXMFSYSCONFIG and TEXMFSYSVAR are used instead of TEXMFCONFIG and
-TEXMFVAR, respectively. This is the primary difference between
-fmtutil\-sys and fmtutil\-user.
-.IP
-See https://tug.org/texlive/scripts\-sys\-user.html for details.
+TEXMFVAR, respectively. This is the primary difference between
+fmtutil\-sys and fmtutil.
.IP
Other locations may be used if you give them on the command line, or
these trees don't exist, or you are not using the original TeX Live.
-.PP
-Supporting development binaries:
-.IP
-If an engine name ends with "\-dev", formats are created in
-the respective directory with the \fB\-dev\fR stripped. This allows for
-easily running development binaries in parallel with the released
-binaries.
.SH "REPORTING BUGS"
-Report bugs to: tex\-live@tug.org
+Report bugs to: tex\-k@tug.org
.br
-TeX Live home page: <https://tug.org/texlive/>
+TeX Live home page: <http://tug.org/texlive/>