[subversion-commit] SVN tetex-bin commit + diffs: r1804 -
tetex-bin/trunk/debian
Frank Küster
frank at costa.debian.org
Thu Oct 12 18:19:33 UTC 2006
Author: frank
Date: 2006-10-12 18:19:32 +0000 (Thu, 12 Oct 2006)
New Revision: 1804
Modified:
tetex-bin/trunk/debian/README.Debian.sgml
Log:
make README.Debian up-to-date and prepare its move to tex-common
Modified: tetex-bin/trunk/debian/README.Debian.sgml
===================================================================
--- tetex-bin/trunk/debian/README.Debian.sgml 2006-10-12 17:06:51 UTC (rev 1803)
+++ tetex-bin/trunk/debian/README.Debian.sgml 2006-10-12 18:19:32 UTC (rev 1804)
@@ -3,10 +3,10 @@
<book>
<titlepag>
- <title>Debian-specific information about the teTeX packages</title>
+ <title>Debian-specific information about TeX packages</title>
<author>
- <name>The Debian teTeX mailing List</name>
- <email>debian-tetex-maint at lists.debian.org</email>
+ <name>The Debian TeX mailing List</name>
+ <email>debian-tex-maint at lists.debian.org</email>
</author>
<version>generated from $Id$</version>
@@ -112,15 +112,129 @@
<chapt>
<heading>Changing your configuration, file placement</heading>
+ <sect id="sec-texmf-trees">
+ <heading>
+ Available <var>TEXMF</var> trees for users and system administrators
+ </heading>
+ <p>
+ The following <var>TEXMF</var> trees are available. They
+ are displayed below in the order they are searched, where
+ earlier ones override later ones.
+ <taglist>
+ <tag><var>TEXMFCONFIG</var></tag>
+ <item>
+ <p>
+ Default location: <file>$HOME/.texmf-config/</file>
+ </p>
+ <p>
+ Contains user-specific configuration
+ </p>
+ </item>
+
+ <tag><var>TEXMFVAR</var></tag>
+ <item>
+ <p>
+ Default location: <file>$HOME/.texmf-var/</file>
+ </p>
+ <p>
+ Contains user-specific generated files
+ </p>
+ </item>
+
+ <tag><var>TEXMFHOME</var></tag>
+ <item>
+ <p>
+ Default location: <file>$HOME/texmf/</file>
+ </p>
+ <p>
+ Contains user-specific static input files, e.g. new
+ LaTeX packages.
+ </p>
+ </item>
+
+ <tag><var>TEXMFSYSCONFIG</var></tag>
+ <item>
+ <p>
+ Default location: <file>/etc/texmf</file>
+ </p>
+ <p>
+ Contains system-wide configuration
+ </p>
+ </item>
+
+ <tag><var>TEXMFSYSVAR</var></tag>
+ <item>
+ <p>
+ Default location: <file>/var/lib/texmf/</file>
+ </p>
+ <p>
+ Contains system-wide generated files
+ </p>
+ </item>
+
+ <tag><var>TEXMFLOCAL</var></tag>
+ <item>
+ <p>
+ Default location: <file>/usr/local/share/texmf/</file>
+ </p>
+ <p>
+ Contains system-wide input files
+ </p>
+ </item>
+
+ <tag><var>TEXMFMAIN</var></tag>
+ <item>
+ <p>
+ Default location: <file>/usr/share/texmf/</file>
+ </p>
+ <p>
+ Contains system-wide, <prgn>dpkg</prgn>-managed input files
+ (TeX add-on packages)
+ </p>
+ </item>
+
+ <tag><var>TEXMFDIST</var></tag>
+ <item>
+ <p>
+ Default location: <file>/usr/share/texmf-{tetex,texlive}</file>
+ </p>
+ <p>
+ Contains system-wide, <prgn>dpkg</prgn>-managed input files
+ (basic TeX packages)
+ </p>
+ </item>
+ </taglist>
+ </p>
+
+ <p>
+ If you want to add files, you should usually use
+ <var>TEXMFLOCAL</var> or <var>TEXMFHOME</var>, depending on whether
+ you are the system administrator or a user. If needed, a system
+ administrator can add additional trees to the <var>TEXMF</var>
+ variable in <file>/etc/texmf/texmf.d/05TeXMF.cnf</file> (earlier
+ entries take precedence). <var>TEXMFCONFIG</var> and
+ <var>TEXMFVAR</var> are used by the user-specific
+ <prgn>texconfig</prgn>, <prgn>updmap</prgn>, and
+ <prgn>fmtutil</prgn> commands. Note
+ that <prgn>texconfig</prgn> creates a copy of configuration
+ files from <var>TEXMFMAIN</var> (or <file>/etc/texmf</file>)
+ at the time it is first invoked, and does not track later
+ system-wide changes, and it does not know
+ about <prgn>update-*</prgn> programs (see
+ below <ref id="sec-core-config-files">
+ </p>
+ </sect>
+
<sect>
<heading>General hints</heading>
<sect1>
<heading>System-wide versus user-specific configuration</heading>
<p>
- Since version 3.0, teTeX supports a complete user-specific
- configuration setup in the user's home directory. System
- administrators must use the commands <prgn>texconfig-sys</prgn>,
+ TeXLive as well as, since version 3.0, teTeX supports a
+ complete user-specific configuration setup in the user's
+ home directory. System administrators must use the
+ commands <prgn>texconfig-sys</prgn>,
<prgn>fmtutil-sys</prgn> and <prgn>updmap-sys</prgn> which act on
the system-wide configuration files. Users can invoke their user
counterparts <prgn>texconfig</prgn>, <prgn>fmtutil</prgn> and
@@ -134,21 +248,29 @@
<heading>Configuration file placement</heading>
<p>
On a TeX system, in principle every TeX input file can be used to
- <em>change the behavior of the system</em> and hence could be
- treated as a configuration file. To avoid an inflation of
- configuration files, teTeX does not ship any TeX input files as
- configuration files. Instead, local admins can take any file they
- want from the <var>TEXMFDIST</var>
- (<file>/usr/share/texmf-tetex</file>) or <var>TEXMFMAIN</var>
- (<file>/usr/share/texmf</file>) trees and put changed copies into
- the respective directories below <file>/etc/texmf</file>.
+ <em>change the behavior of the system</em> and hence could
+ be treated as a configuration file. To avoid an inflation
+ of configuration files, those that are used to control the
+ typeset output - the appearance of documents - are not
+ installed as configuration files. It makes more sense to
+ keep changed versions in the current directory for a
+ certain project, or in <var>TEXMFHOME</var>
+ or <var>TEXMFCONFIG</var> of a particular user. However,
+ local admins can take any file they want from
+ the <var>TEXMFDIST</var>
+ (<file>/usr/share/texmf-tetex</file>)
+ or <var>TEXMFMAIN</var> (<file>/usr/share/texmf</file>)
+ trees and put changed copies into the respective
+ directories below <file>/etc/texmf</file>
+ (<var>TEXMFSYSCONFIG</var> which sorts before all other
+ trees).
</p>
<p>
Since the package management system does not know whether a file
is treated as a configuration file on a specific system, it is up
to the site admin or local user to check whether one of their
- configuration files has changed in <var>TEXMFMAIN</var> or
+ changed files has changed in <var>TEXMFMAIN</var> or
<var>TEXMFDIST</var>.
</p>
@@ -161,8 +283,9 @@
available TeX formats), <file>updmap.cfg</file> (font
configuration) and <file>language.dat</file> (hyphenation patterns
for many formats) are handled through a Debian-specific mechanism
- that allows the teTeX packages, add-on packages and local
- administrators to combine their changes (see below).
+ that allows the basic TeX packages, add-on packages and local
+ administrators to combine their changes
+ (see <ref id="sec-core-config-files"> below).
</p>
<p>
@@ -175,8 +298,9 @@
<sect>
<heading>Hyphenation</heading>
<p>
- Hyphenation should pretty much work out of the box. There have been
- some changes in the past — see <file>NEWS.Debian</file> and
+ Hyphenation should pretty much work out of the box. In
+ teTeX, there have been some changes in the past —
+ see <file>NEWS.Debian</file> and
<file>changelog.Debian</file> — but currently (nearly) all
available patterns are enabled. If you want to use a reduced set of
hyphenation patterns (which might gain you a trifle more speed), you
@@ -216,24 +340,41 @@
<file>updmap.cfg</file> and <file>language.dat</file>
</heading>
<p>
- These files contain configuration options from teTeX itself,
- possibly from you, and from other TeX-related packages. They are
- generated by scripts and should not be edited directly. Rather, you
- should edit the source files, or add new ones. Note that this only
- applies to the system-wide versions of these files; currently,
- changes to existing items made by teTeX updates or add-on packages
- will not be propagated to the user's files. Since all
- <file>texmf.cnf</file> files are read, with earlier definitions
- taking precedence over later ones, it is best to keep only a minimal
- set of definitions in the user-specific file.
+ These files contain configuration options from teTeX and/or
+ TeXLive, possibly from you, and from other TeX-related
+ packages. They are generated by scripts and should not
+ &mdash in fact, except <file>texmf.cnf</file> may not &mdash
+ be edited directly. Rather, you should edit the source
+ files, or better add new ones.
</p>
<p>
- In order to make updates smooth, you should <em>avoid editing</em>
- these files as far as possible, and instead <em>add new files</em>
- to change settings. For <file>texmf.cnf</file> snippets, this is
- particularly easy, since earlier entries override any later entries.
- Only for removing settings completely from <file>fmtutil.cnf</file>,
+ <prgn>update-texmf</prgn> is only available for root; if a
+ user wants to maintain their own <file>texmf.cnf</file>,
+ they can put it into <var>TEXMFCONFIG</var> and must
+ manually edit it. Since all <file>texmf.cnf</file> files
+ are read, with earlier definitions taking precedence over
+ later ones, it is best to keep only a minimal set of
+ definitions in the user-specific file. The other
+ configuration update programs also work with files
+ in <tt><var>TEXMFCONFIG</var>/updmap.d</tt>, <tt><var>TEXMFCONFIG</var>/fmt.d</tt>
+ or <tt><var>TEXMFCONFIG</var>/language.d</tt>, combining
+ files in these directories with the files in the system-wide
+ directories &mdash naturally the user-specific ones take
+ precedence if the names are equal
+ (see <ref id="sec-user-specific-installation">). Note that
+ changes to existing files made by packages updates will not
+ be propagated to the user's files.
+ </p>
+
+ <p>
+ In order to make updates smooth, you should <em>avoid
+ editing</em> system-wide files as far as possible, and
+ instead <em>add new files</em> to change
+ settings. For <file>texmf.cnf</file> snippets, this is
+ particularly easy, since earlier entries override any later
+ entries. Only for removing settings
+ from <file>fmtutil.cnf</file>,
<file>updmap.cfg</file> or <file>language.dat</file> is it necessary
to edit existing files.
</p>
@@ -253,19 +394,20 @@
under <file>/etc/texmf/texmf.d/</file>. To customize
<file>texmf.cnf</file> while retaining the Debian-supplied
configuration, create an appropriate file (or files) in
- <file>/etc/texmf/texmf.d/</file>, or change the files supplied by
- teTeX, and then run <prgn>update-texmf</prgn>. This will generate
- the desired <file>texmf.cnf</file> for you.
+ <file>/etc/texmf/texmf.d/</file>, or change existing
+ files, and then run <prgn>update-texmf</prgn>. This will
+ generate the desired <file>texmf.cnf</file> for you.
</p>
<p>
- You should not edit this file directly! While changes made by the
- local administrator will not be overwritten, they will cause you
- trouble once the teTeX packages or some other TeX-related package
- is updated. You will be shown the differences between the edited
- and the newly generated file. We will try to merge our and your
- changes, but that might not always work, and you will probably
- have to edit again.
+ You should not edit this file directly! While changes made
+ by the local administrator will not be overwritten, they
+ will cause you trouble once a package is updated and
+ brings in a configuration change. You will be shown the
+ differences between the edited and the newly generated
+ file. We will try to merge our and your changes, but that
+ might not always work, and you will probably have to edit
+ again.
</p>
<p>
@@ -298,10 +440,12 @@
<p>
These files are also generated files, just as it has been
explained above for <file>texmf.cnf</file>. The difference to
- <file>texmf.cnf</file> is that these files will be put into
- <file>/var/lib/texmf/web2c</file>, and any change made in these
- files will be <strong>unconditionally overwritten</strong> by
- <prgn>update-fmtutil</prgn>, <prgn>update-language</prgn> and
+ <file>texmf.cnf</file> is that the system-wide files will
+ be put into <file>/var/lib/texmf/web2c</file>, and any
+ change made in these files will be <strong>unconditionally
+ overwritten</strong>
+ by <prgn>update-fmtutil</prgn>, <prgn>update-language</prgn>
+ and
<prgn>update-updmap</prgn>, respectively. Only the files in
<file>/etc/texmf/updmap.d/</file>, <file>/etc/texmf/fmt.d/</file>
and <file>/etc/texmf/language.d/</file> will be treated as
@@ -319,112 +463,19 @@
<file>.cfg</file>, not <file>.cnf</file>.
</p>
- <sect id="sec-texmf-trees">
- <heading>
- Available <var>TEXMF</var> trees for users and system administrators
- </heading>
- <p>
- The following <var>TEXMF</var> trees are available:
- <taglist>
- <tag><var>TEXMFCONFIG</var></tag>
- <item>
- <p>
- Default location: <file>$HOME/.texmf-config/</file>
- </p>
- <p>
- Contains user-specific configuration
- </p>
- </item>
+ <p>
+ <prgn>updmap(1)</prgn> and <prgn>updmap-sys</prgn> provide
+ options for enabling or disabling font map files. When
+ enabling a new map file that is not
+ mentioned, <prgn>updmap</prgn> will first create or
+ edit <file>10local.cfg</file> in the site-wide or
+ user-specific <file>updmap.d</file> directory, as
+ appropriate, and then call <prgn>update-updmap</prgn>.
+ Note that <prgn>updmap</prgn>'s <tt>--edit</tt>
+ and <tt>--syncwithtrees</tt> options cannot be used on a
+ Debian system.
+ </p>
- <tag><var>TEXMFVAR</var></tag>
- <item>
- <p>
- Default location: <file>$HOME/.texmf-var/</file>
- </p>
- <p>
- Contains user-specific generated files
- </p>
- </item>
-
- <tag><var>TEXMFHOME</var></tag>
- <item>
- <p>
- Default location: <file>$HOME/texmf/</file>
- </p>
- <p>
- Contains user-specific static input files
- </p>
- </item>
-
- <tag><var>TEXMFSYSCONFIG</var></tag>
- <item>
- <p>
- Default location: <file>/etc/texmf</file>
- </p>
- <p>
- Contains system-wide configuration
- </p>
- </item>
-
- <tag><var>TEXMFSYSVAR</var></tag>
- <item>
- <p>
- Default location: <file>/var/lib/texmf/</file>
- </p>
- <p>
- Contains system-wide generated files
- </p>
- </item>
-
- <tag><var>TEXMFLOCAL</var></tag>
- <item>
- <p>
- Default location: <file>/usr/local/share/texmf/</file>
- </p>
- <p>
- Contains system-wide input files
- </p>
- </item>
-
- <tag><var>TEXMFMAIN</var></tag>
- <item>
- <p>
- Default location: <file>/usr/share/texmf/</file>
- </p>
- <p>
- Contains system-wide, <prgn>dpkg</prgn>-managed input files
- (TeX add-on packages)
- </p>
- </item>
-
- <tag><var>TEXMFDIST</var></tag>
- <item>
- <p>
- Default location: <file>/usr/share/texmf-{tetex,texlive}</file>
- </p>
- <p>
- Contains system-wide, <prgn>dpkg</prgn>-managed input files
- (basic TeX packages)
- </p>
- </item>
- </taglist>
- </p>
-
- <p>
- If you want to add files, you should usually use
- <var>TEXMFLOCAL</var> or <var>TEXMFHOME</var>, depending on whether
- you are the system administrator or a user. If needed, a system
- administrator can add additional trees to the <var>TEXMF</var>
- variable in <file>/etc/texmf/texmf.d/05TeXMF.cnf</file> (earlier
- entries take precedence). <var>TEXMFCONFIG</var> and
- <var>TEXMFVAR</var> are used by the user-specific
- <prgn>texconfig</prgn>, <prgn>updmap</prgn>, and
- <prgn>fmtutil</prgn> commands. Note that these commands create a
- copy of the configuration files in <var>TEXMFMAIN</var> (or rather
- <file>/etc/texmf</file>) at the time they are first invoked, and do
- not track later system-wide changes!
- </p>
- </sect>
</chapt>
<chapt>
@@ -658,6 +709,11 @@
the manual pages for <prgn>update-updmap</prgn> and
<prgn>updmap-sys</prgn> for details.
</p>
+ <p>
+ You can also use <tt>updmap-sys --enable
+ Map <var>foo</var>.map</tt>, it will create
+ the <file>10local.cfg</file> file for you.
+ </p>
</item>
<item>
@@ -725,33 +781,20 @@
</item>
<item>
- The configuration file created in step 2 should be placed in
- <var>TEXMFCONFIG</var> (<file>$HOME/.texmf-config</file> by
- default). An appropriate place would be
- <file><var>TEXMFCONFIG</var>/updmap.d/</file>. Note that most
- likely you will have to create this directory first.
+ <p>
+ The configuration file created in step 2 should be placed in
+ <var>TEXMFCONFIG</var> (<file>$HOME/.texmf-config</file> by
+ default). An appropriate place would be
+ <file><var>TEXMFCONFIG</var>/updmap.d/</file>. Note that most
+ likely you will have to create this directory first.
+ </p>
+ <p>
+ As for the site-wide installation, you can also
+ use <tt>updmap --enable Map <var>foo</var>.map</tt>
+ </p>
</item>
<item>
- In step 3, one then calls <prgn>update-updmap</prgn> to create
- <file>updmap.cfg</file> in
- <file><var>TEXMFVAR</var>/web2c</file>
- (<file>$HOME/.texmf-var/web2c</file> by default):
-
-<example>
-$ update-updmap --conf-dir $HOME/.texmf-config/updmap.d \
- --output-file $HOME/.texmf-var/web2c/updmap.cfg
-</example>
-
- This creates <file>$HOME/.texmf-var/web2c/updmap.cfg</file>
- based on the configuration files in
- <file>$HOME/.texmf-config/updmap.d</file> <strong>and</strong>
- in <file>/etc/texmf/updmap.d</file>. If a file exists in both
- directories, the version in <var>TEXMFCONFIG</var> takes
- precedence.
- </item>
-
- <item>
After updating the <file>ls-R</file> files with
<prgn>mktexlsr</prgn> or <prgn>texhash</prgn> (step 4), one has
to generate the map files in step 5. This is done by running the
@@ -799,7 +842,7 @@
<item>
Is there any privately-compiled TeX system besides the Debian
- teTeX packages?
+ packages?
</item>
<item>
@@ -855,7 +898,8 @@
</item>
<item>
- Please mention the version of teTeX you used.
+ Please use <prgn>reportbug</prgn> and include all
+ information it gathers
</item>
<item>
@@ -864,7 +908,8 @@
</item>
<item>
- Please respond to our questions.
+ Be prepared that we will have to ask more questions: You
+ should have time to exchange a couple of e-mails with us
</item>
<item>
@@ -886,9 +931,10 @@
of <package>tetex-base</package>.
<item>
- Note, basically, that we Debian teTeX maintainers do not add extra
- components which are not included in the upstream teTeX
- distribution.
+ Note that teTeX is not further developed upstream, and new
+ features will only be integrated in TeXlive. The Debian
+ maintainers will not include anything in the TeXlive
+ packages that is not already in TeXlive upstream.
</item>
</list>
</p>
More information about the Pkg-tetex-commits
mailing list