File: update-fmtlang.8

package info (click to toggle)
tex-common 5.03
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,540 kB
  • ctags: 160
  • sloc: sh: 1,244; perl: 379; lisp: 276; python: 272; makefile: 160; sed: 4
file content (177 lines) | stat: -rw-r--r-- 6,855 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
.TH update-fontlang 8 "2006-12-11" "Debian" "Debian User's Manual"

.SH NAME
update-language, update-fmtutil, update-fmtlang \- update
various TeX-related configuration files

.SH SYNOPSIS
.B update-language
.RI [ options ]
.br
.B update-fmtutil
.RI [ options ]
.br

.SH DESCRIPTION
This manual page explains briefly the usage of the three TeX configuration
update programs
.B update-language
and \fBupdate-fmtutil\fP.
.PP
The
.B update-fontlang
script should not be called directly, but only via the two described links.
For a more in-depth description, please see the document \fITeX on Debian\fP in
.I /usr/share/doc/tex-common/TeX-on-Debian.txt.gz
(also available as HTML and PDF).

The programs \fBupdate-language\fP and
\fBupdate-fmtutil\fP create or update the configuration files
\fIlanguage.dat\fP and \fIfmtutil.cnf\fP, respectively.
These files define 
the hyphenation patterns to be loaded into LaTeX-related
TeX formats (\fIlanguage.dat\fP), and the list of formats to be created
(\fIfmtutil.cnf\fP).

These programs can be used either in system-wide mode if called by root, or
in a user-specific mode if called by a user without super-user privileges.
.SH OPTIONS
.TP
.BI \-c\  DIR ,\ \-\-conf-dir= DIR
directory where the user-specific configuration files are looked for in
user-specific mode (default 
\fITEXMFCONFIG/language.d\fP for \fBupdate-language\fP
and \fITEXMFCONFIG/fmt.d\fP for \fBupdate-fmtutil\fP, where \fITEXMFCONFIG\fP
is usually \fI$HOME/.texmf-config\fP).
.TP
.BI \-o\  FILE ,\ \-\-output-file= FILE
file to write the output to. Per default, in system-wide mode,
\fBupdate-language\fP writes to 
\fI/var/lib/texmf/tex/generic/config/language.dat\fP
and
\fBupdate-fmtutil\fP writes to
\fI/var/lib/texmf/web2c/fmtutil.cnf\fP.
.TP
.B \-\-checks
perform sanity checks on the generated config file. Don't use this
in maintainer scripts.
.TP
.B \-\-quiet
don't write anything to the standard output during normal operation
.TP
.B \-\-help
print a summary of the command-line usage and exit
.TP
.B \-\-version
output version information and exit

.SH USAGE

In system-wide mode, both programs merge those files
("configuration snippets") with a specific extension in the respective
configuration directories to produce the final file. These
configuration directories and extensions are \fIlanguage.d\fP and
\fB.cnf\fP for \fBupdate-language\fP, 
and \fIfmt.d\fP and \fB.cnf\fP for \fBupdate-fmtutil\fP.
In system-wide mode, these directories are those under \fI/etc/texmf/\fP. Both
TeX add-on packages and local administrators can add files to these
directories.

If a package that provides such snippets is removed but not purged,
including the snippet will likely break the system.  To prevent the
inclusion in these cases, snippets installed by \fIpackages\fP have to
contain a magic header:

# -_- DebPkgProvidedMaps -_-

which local administrators should \fInot\fP remove.  From the files
with a magic header, only those files which are also listed in one of
the files in
.I /var/lib/tex-common/language-cnf/
for \fBupdate-language\fP, and
.I /var/lib/tex-common/fmtutil-cnf/
for \fBupdate-fmtutil\fP, are actually included into the final output
file. This way, local changes to the configuration can be preserved
while the package is in state 'rc' (that is, the package is removed, but its
configuration files are still present).  For details about this mechanism,
package maintainers should consult the Debian TeX Policy.  As a
special case, the files for JadeTeX and xmlTeX are only included if
there is already a file for the LaTeX format (see \fITeX on Debian\fP
for details).

The user-specific mode provides a way for a non-admin user to override
system-wide settings.  In this mode,
\fBupdate-language\fP writes to 
\fITEXMFVAR/tex/generic/config/language.dat\fP, and
\fBupdate-fmtutil\fP writes to
\fITEXMFVAR/web2c/fmtutil.cnf\fP, where \fITEXMFVAR\fP is usually
\fI$HOME/.texmf-var\fP. 
Furthermore, files present within the user-specific configuration
directories are included \fIin addition\fP to the files present in the
system-wide configuration directories.  In case the same filename
exists in the system-wide configuration directory and the
user-specific configuration directory, the user-specific file is used
instead of the system-wide one. The user-specific configuration directories
are
\fITEXMFCONFIG/language.d\fP for \fBupdate-language\fP and
\fITEXMFCONFIG/fmt.d\fP
for \fBupdate-fmtutil\fP, where \fITEXMFCONFIG\fP is usually
\fI$HOME/.texmf-config\fP. The system-wide configuration directories have the
same names, but are located in \fI/etc/texmf/\fP instead of \fITEXMFCONFIG\fP.

Note that changes introduced by updates of packages are \fInot\fP
propagated to the user's configuration files. This has to be done by hand.

.SH FILES
.TP
.B /var/lib/texmf/tex/generic/config/language.dat
This file is generated or updated by \fBupdate-language\fP in system-wide
mode and contains a list of the hyphenation patterns loaded into
LaTeX-based formats by \fBfmtutil-sys\fP.
.TP
.B /var/lib/texmf/web2c/fmtutil.cnf
This file is generated or updated by \fBupdate-fmtutil\fP in system-wide
mode and contains a list of formats to be generated by \fBfmtutil-sys\fP.
.TP
.B /etc/texmf/language.d/\fIname\fP.cnf
Input files for \fBupdate-language\fP
.TP
.B /etc/texmf/fmt.d/\fIname\fP.cnf
Input files for \fBupdate-fmtutil\fP
.TP
.B /var/lib/tex-common/language-cnf/\fIpackage\fP.list
Lists the file(s) installed by \fIpackage\fP in \fI/etc/texmf/language.d/\fP.
.TP
.B /var/lib/tex-common/fmtutil-cnf/\fIpackage\fP.list
Lists the file(s) installed by \fIpackage\fP in \fI/etc/texmf/fmt.d/\fP.

.SH SEE ALSO

.TP
.B fmtutil(1), fmtutil-sys(1)
The programs actually using the generated configuration files
(\fIlanguage.dat\fP and \fIfmtutil.cnf\fP).
.TP
.B TeX on Debian Documentation
to be found in \fI/usr/share/doc/tex-common/TeX-on-Debian.txt.gz\fP (also
available as HTML and PDF), describing in more detail how to setup
and maintain a TeX system in Debian. It also includes details on user-specific
configuration.
.TP
.B Debian TeX Policy
to be found in \fI/usr/share/doc/tex-common/Debian-TeX-Policy.txt.gz\fP (also
available as HTML and PDF), describing the internals and the TeX Policy
established on the Debian TeX mailing-list
(debian-tex-maint@lists.debian.org). Intended audience is mainly developers
packaging TeX-related resources for Debian.
.TP
.B dh_installtex(1)
a debhelper-like script for managing the installation of files into the
system-wide configuration directories; this script helps to write Debian
packages containing TeX-related resources that conform to the Debian TeX
Policy.

.SH AUTHOR
This manual page was written by Norbert Preining <preining@debian.org>
for the Debian distribution (and may be used by others). It was later updated
by Florent Rougon <f.rougon@free.fr>.