summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/fmtutil.1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2020-03-13 17:30:40 +0000
committerKarl Berry <karl@freefriends.org>2020-03-13 17:30:40 +0000
commit3166b3e1095114d49cbef65216417c43bcd932d7 (patch)
tree4820c86c7887bd36bbba7ea3ad9ace67fee5ff11 /Master/texmf-dist/doc/man/man1/fmtutil.1
parent174147dcdbfb24f62966d39bb4f196d9b38895e4 (diff)
fmtutil/updmap/etc. man page updates for 2020
git-svn-id: svn://tug.org/texlive/trunk@54278 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/fmtutil.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/fmtutil.1159
1 files changed, 106 insertions, 53 deletions
diff --git a/Master/texmf-dist/doc/man/man1/fmtutil.1 b/Master/texmf-dist/doc/man/man1/fmtutil.1
index 1b4357cdfa9..d2df1924d5c 100644
--- a/Master/texmf-dist/doc/man/man1/fmtutil.1
+++ b/Master/texmf-dist/doc/man/man1/fmtutil.1
@@ -1,65 +1,90 @@
-.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
-.TH FMTUTIL "1" "April 2015" "TeX Live" "User Commands"
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.11.
+.TH FMTUTIL "1" "March 2020" "TeX Live" "User Commands"
.SH NAME
-fmtutil \- manage TeX formats, Metafont bases and Metapost mems, per-user
+fmtutil \- manage TeX formats and Metafont bases, per-user
.br
-fmtutil-sys \- manage TeX formats, Metafont bases and Metapost mems, system-wide
+fmtutil-sys \- manage TeX formats and Metafont bases, system-wide
.br
-mktexfmt \- create a TeX format, Metafont base, or Metapost mem
+mktexfmt \- create a TeX format or Metafont base
.SH SYNOPSIS
.B fmtutil
-[\fI\,OPTION\/\fR] ... [\fI\,COMMAND\/\fR]
+[\fI\,-user|-sys\/\fR] [\fI\,OPTION\/\fR] ... [\fI\,COMMAND\/\fR]
.br
.B fmtutil-sys
[\fI\,OPTION\/\fR] ... [\fI\,COMMAND\/\fR]
.br
+.B fmtutil-user
+[\fI\,OPTION\/\fR] ... [\fI\,COMMAND\/\fR]
+.br
.B mktexfmt
-\fI\,FORMAT.fmt|BASE.base|MEM.mem|FMTNAME.EXT\/\fR
+\fI\,FORMAT.fmt|BASE.base|FMTNAME.EXT\/\fR
.SH DESCRIPTION
-fmtutil version svn36788 (2015\-04\-13 00:53:26 +0900)
+fmtutil version r53340 (2020\-01\-07 00:55:32 +0100)
.PP
-Rebuild and manage TeX formats, Metafont bases and MetaPost mems.
+Rebuild and manage TeX fmts and Metafont bases, collectively called
+"formats" here. (MetaPost no longer uses the past\-equivalent "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 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.
+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.
+.PP
+If not operating in mktexfmt mode, exactly one command must be given,
+extensions should generally not be specified, no non\-option arguments
+are allowed, and multiple formats can be generated, as follows.
.PP
-If not operating in mktexfmt mode, the command line can be more general,
-and multiple formats can be generated, as follows.
+By default, the return status is zero if all formats requested are
+successfully built, else nonzero.
.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)
-.HP
-\fB\-\-fmtdir\fR DIRECTORY
+.TP
+\fB\-\-fmtdir\fR DIR
+write formats under DIR instead of TEXMF[SYS]VAR
.TP
\fB\-\-no\-engine\-subdir\fR
don't use engine\-specific subdir of the fmtdir
-.TP
-\fB\-\-no\-error\-if\-no\-format\fR
-exit successfully if no format is selected
+.HP
+\fB\-\-no\-error\-if\-no\-format\fR exit successfully if no format is selected
.TP
\fB\-\-no\-error\-if\-no\-engine\fR=\fI\,ENGINE1\/\fR,ENGINE2,...
-exit successfully even if the required engine
+exit successfully even if a 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\-\-quiet\fR
be silent
.TP
-\fB\-\-test\fR
-(not implemented, just for compatibility)
+\fB\-\-catcfg\fR
+(does nothing, exists for compatibility)
.TP
\fB\-\-dolinks\fR
-(not implemented, just for compatibility)
+(does nothing, exists for compatibility)
.TP
\fB\-\-force\fR
-(not implemented, just for compatibility)
+(does nothing, exists for compatibility)
+.TP
+\fB\-\-test\fR
+(does nothing, exists for compatibility)
.SS "Commands:"
.TP
\fB\-\-all\fR
@@ -71,30 +96,29 @@ create all missing format files
\fB\-\-refresh\fR
recreate only existing format files
.TP
-\fB\-\-byengine\fR ENGINENAME
-(re)create formats using ENGINENAME
+\fB\-\-byengine\fR ENGINE
+(re)create formats built with ENGINE
.TP
-\fB\-\-byfmt\fR FORMATNAME
-(re)create format for FORMATNAME
+\fB\-\-byfmt\fR FORMAT
+(re)create format FORMAT
.TP
\fB\-\-byhyphen\fR HYPHENFILE
(re)create formats that depend on HYPHENFILE
.TP
-\fB\-\-enablefmt\fR FORMATNAME
-enable formatname in config file
+\fB\-\-enablefmt\fR
+FORMAT[/ENGINE] enable FORMAT, as built with ENGINE
.TP
-\fB\-\-disablefmt\fR FORMATNAME
-disable formatname in config file
+\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.
.TP
\fB\-\-listcfg\fR
list (enabled and disabled) configurations,
filtered to available formats
.TP
-\fB\-\-catcfg\fR
-output the content of the config file
-.TP
-\fB\-\-showhyphen\fR FORMATNAME
-print name of hyphenfile for format FORMATNAME
+\fB\-\-showhyphen\fR FORMAT
+print name of hyphen file for FORMAT
.TP
\fB\-\-version\fR
show version information and exit
@@ -108,7 +132,9 @@ Explanation of trees and files normally used:
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.
+order returned by kpsewhich. Files passed in 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.
.IP
In any case, if multiple fmtutil.cnf files are found, all the format
definitions found in all the fmtutil.cnf files are merged.
@@ -124,7 +150,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:
+For fmtutil\-user:
TEXMFCONFIG $HOME/.texliveYYYY/texmf\-config/web2c/fmtutil.cnf
TEXMFVAR $HOME/.texliveYYYY/texmf\-var/web2c/fmtutil.cnf
TEXMFHOME \fI\,$HOME/texmf/web2c/fmtutil.cnf\/\fP
@@ -139,7 +165,19 @@ TEXMFDIST \fI\,$TEXLIVE/YYYY/texmf\-dist/web2c/fmtutil.cnf\/\fP
According to the actions, fmtutil might write to one of the given files
or create a new fmtutil.cnf, described further below.
.PP
-Where changes are saved:
+Where formats are written:
+.IP
+By default, format files are (re)written in TEXMFSYSVAR/ENGINE by
+fmtutil\-sys, and TEXMFVAR/ENGINE by fmtutil, where \fI\,/ENGINE\/\fP is a
+subdirectory named for the engine used, such as "pdftex".
+.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 any case, if the \fB\-\-no\-engine\-subdir\fR option is specified, the
+\fI\,/ENGINE\/\fP subdir is omitted.
+.PP
+Where configuration 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.
@@ -156,8 +194,8 @@ 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 for system\-wide using TEXMFLOCAL, and then system
-settings can be overridden again for a particular using using TEXMFHOME.
+can be overridden system\-wide using TEXMFLOCAL, and system settings
+can be overridden again in a particular user's TEXMFHOME.
.PP
Resolving multiple definitions of a format:
.IP
@@ -167,30 +205,45 @@ coming from the first\-listed fmtutil.cnf is used.
Disabling formats:
.IP
fmtutil.cnf files with higher priority (listed earlier) can disable
-formats mentioned in lower priority (listed later) fmtutil.cnf files by
-writing, e.g.,
+formats in lower priority (listed later) fmtutil.cnf files by
+writing a line like
.IP
#! <fmtname> <enginename> <hyphen> <args>
-.IP
+.TP
in the higher\-priority fmtutil.cnf file.
+The #! must be at the
+.IP
+beginning of the line, with at least one space or tab afterward, and
+there must be whitespace between each word on the list.
.IP
-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
+For example, you can disable the luajitlatex format by creating
+the file \fI\,$TEXMFCONFIG/web2c/fmtutil.cnf\/\fP with the line
.IP
#! luajitlatex luajittex language.dat,language.dat.lua lualatex.ini
.IP
-and call fmtutil.
+(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.)
.PP
-fmtutil vs. fmtutil\-sys (fmtutil \fB\-\-sys\fR):
+fmtutil\-user (fmtutil \fB\-user\fR) 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.
+fmtutil\-sys and fmtutil\-user.
+.IP
+See http://tug.org/texlive/scripts\-sys\-user.html for details.
.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\-k@tug.org
+Report bugs to: tex\-live@tug.org
.br
TeX Live home page: <http://tug.org/texlive/>