source/texk/texlive/tl_scripts/fmtutil.1

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