1FMTUTIL(1) User Commands FMTUTIL(1)
2
6 fmtutil - manage TeX formats, Metafont bases and Metapost mems, per-
7 user
8 fmtutil-sys - manage TeX formats, Metafont bases and Metapost mems,
9 system-wide
10 mktexfmt - create a TeX format, Metafont base, or Metapost mem
11
13 fmtutil [OPTION] ... [COMMAND]
14 fmtutil-sys [OPTION] ... [COMMAND]
15 mktexfmt FORMAT.fmt|BASE.base|MEM.mem|FMTNAME.EXT
16
18 fmtutil version svn36788 (2015-04-13 00:53:26 +0900)
19 Rebuild and manage TeX formats, Metafont bases and MetaPost mems.
21 If the command name ends in mktexfmt, only one format can be created.
23 The only options supported are --help and --version, and the command
24 line must consist of either a format name, with its extension, or a
25 plain name that is passed as the argument to --byfmt (see below). The
26 full name of the generated file (if any) is written to stdout, and
27 nothing else.
28 If not operating in mktexfmt mode, the command line can be more gen‐
30 eral, and multiple formats can be generated, as follows.
31
33 --cnffile FILE
34 read FILE instead of fmtutil.cnf (can be given multiple times,
35 in which case all the files are used)
36 --fmtdir DIRECTORY
38 --no-engine-subdir
40 don't use engine-specific subdir of the fmtdir
41 --no-error-if-no-format
43 exit successfully if no format is selected
44 --no-error-if-no-engine=ENGINE1,ENGINE2,...
46 exit successfully even if the required engine
47 is missing, if it is included in the list.
49 --quiet
51 be silent
52 --test (not implemented, just for compatibility)
54 --dolinks
56 (not implemented, just for compatibility)
57 --force
59 (not implemented, just for compatibility)
60 Commands:
62 --all recreate all format files
63 --missing
65 create all missing format files
66 --refresh
68 recreate only existing format files
69 --byengine ENGINENAME
71 (re)create formats using ENGINENAME
72 --byfmt FORMATNAME
74 (re)create format for FORMATNAME
75 --byhyphen HYPHENFILE
77 (re)create formats that depend on HYPHENFILE
78 --enablefmt FORMATNAME
80 enable formatname in config file
81 --disablefmt FORMATNAME
83 disable formatname in config file
84 --listcfg
86 list (enabled and disabled) configurations, filtered to avail‐
87 able formats
88 --catcfg
90 output the content of the config file
91 --showhyphen FORMATNAME
93 print name of hyphenfile for format FORMATNAME
94 --version
96 show version information and exit
97 --help show this message and exit
99
101 Explanation of trees and files normally used:
102 If --cnffile is specified on the command line (possibly multiple
104 times), its value(s) are used. Otherwise, fmtutil reads all the
105 fmtutil.cnf files found by running `kpsewhich -all fmtutil.cnf',
106 in the order returned by kpsewhich.
107 In any case, if multiple fmtutil.cnf files are found, all the
109 format definitions found in all the fmtutil.cnf files are
110 merged.
111 Thus, if fmtutil.cnf files are present in all trees, and the
113 default layout is used as shipped with TeX Live, the following
114 files are read, in the given order.
115 For fmtutil-sys:
117 TEXMFSYSCONFIG $TEXLIVE/YYYY/texmf-config/web2c/fmtutil.cnf
118 TEXMFSYSVAR $TEXLIVE/YYYY/texmf-var/web2c/fmtutil.cnf
119 TEXMFLOCAL $TEXLIVE/texmf-local/web2c/fmtutil.cnf
120 TEXMFDIST $TEXLIVE/YYYY/texmf-dist/web2c/fmtutil.cnf
121 For fmtutil:
123 TEXMFCONFIG $HOME/.texliveYYYY/texmf-config/web2c/fmtutil.cnf
124 TEXMFVAR $HOME/.texliveYYYY/texmf-var/web2c/fmtutil.cnf
125 TEXMFHOME $HOME/texmf/web2c/fmtutil.cnf
126 TEXMFSYSCONFIG $TEXLIVE/YYYY/texmf-config/web2c/fmtutil.cnf
127 TEXMFSYSVAR $TEXLIVE/YYYY/texmf-var/web2c/fmtutil.cnf
128 TEXMFLOCAL $TEXLIVE/texmf-local/web2c/fmtutil.cnf
129 TEXMFDIST $TEXLIVE/YYYY/texmf-dist/web2c/fmtutil.cnf
130 (where YYYY is the TeX Live release version).
132 According to the actions, fmtutil might write to one of the
134 given files or create a new fmtutil.cnf, described further
135 below.
136 Where changes are saved:
138 If config files are given on the command line, then the first
140 one given will be used to save any changes from --enable or
141 --disable. If the config files are taken from kpsewhich output,
142 then the algorithm is more complex:
143 1) If $TEXMFCONFIG/web2c/fmtutil.cnf or $TEXMFHOME/web2c/fmtu‐
145 til.cnf appears in the list of used files, then the one listed
146 first by kpsewhich --all (equivalently, the one returned by
147 kpsewhich fmtutil.cnf), is used.
148 2) If neither of the above two are present and changes are made,
150 a new config file is created in $TEXMFCONFIG/web2c/fmtutil.cnf.
151 In general, the idea is that if a given config file is not
153 writable, a higher-level one can be used. That way, the distri‐
154 bution's settings can be overridden for system-wide using TEXM‐
155 FLOCAL, and then system settings can be overridden again for a
156 particular using using TEXMFHOME.
157 Resolving multiple definitions of a format:
159 If a format is defined in more than one config file, then the
161 definition coming from the first-listed fmtutil.cnf is used.
162 Disabling formats:
164 fmtutil.cnf files with higher priority (listed earlier) can dis‐
166 able formats mentioned in lower priority (listed later) fmtu‐
167 til.cnf files by writing, e.g.,
168 #! <fmtname> <enginename> <hyphen> <args>
170 in the higher-priority fmtutil.cnf file.
172 As an example, suppose you have want to disable the luajitlatex
174 format. You can create the file $TEXMFCONFIG/web2c/fmtutil.cnf
175 with the content
176 #! luajitlatex luajittex language.dat,language.dat.lua luala‐
178 tex.ini
179 and call fmtutil.
181 fmtutil vs. fmtutil-sys (fmtutil --sys):
183 When fmtutil-sys is run or the command line option --sys is
185 used, TEXMFSYSCONFIG and TEXMFSYSVAR are used instead of TEXMF‐
186 CONFIG and TEXMFVAR, respectively. This is the primary differ‐
187 ence between fmtutil-sys and fmtutil.
188 Other locations may be used if you give them on the command
190 line, or these trees don't exist, or you are not using the orig‐
191 inal TeX Live.
192
194 Report bugs to: tex-k@tug.org
195 TeX Live home page: <http://tug.org/texlive/>
196TeX Live April 2015 FMTUTIL(1)