[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#396826: tex-common: Please make section 2.4 of TeX-on-Debian more precise about user settings



Frank Küster <frank@debian.org> wrote:

> I'd rather read this in the context, and in html instead of sgml-diff,

I have applied your patch in the repository, and here's my suggestion
for further improvement:

--- TeX-on-Debian.sgml	(Revision 1924)
+++ TeX-on-Debian.sgml	(Arbeitskopie)
@@ -417,24 +417,17 @@
 	  <ref id="sec-user-config-files"> we describe a per-user
 	  configuration.
         <p>
-          These files contain configuration options from teTeX and/or
-          TeX Live, 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. 
+          The files <file>texmf.cnf</file>, <file>fmtutil.cnf</file>,
+          <file>updmap.cfg</file> and <file>language.dat</file>
+          contain configuration options from teTeX and/or TeX Live,
+          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 work with the source files in the
+          respective directories below <file>/etc/texmf/</file>.
         </p>

Explanation:  

With the "see later for per-user stuff" paragraph added,
"These files" is not completely clear any more.  With the removal of the
following paragraph, the "don't edit, add" is redundant, because it's
treated at lenght in the following paragraph.
 
         <p>
-	  <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 <tt><var>TEXMFCONFIG</var>/web2c</tt> 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.
-	</p>

Explanation:  

Moved to per-user.

@@ -513,13 +506,13 @@
             overwritten</strong>
             by <prgn>update-fmtutil</prgn>, <prgn>update-language</prgn>
             and
-            <prgn>update-updmap</prgn>, respectively. Furthermore, there is
-	    no built-in merge mechanism, these files are used on a 
-	    first-found-first-used basis.
-	    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
-            configuration files.
+            <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
+	    configuration files.  Furthermore, there is no built-in
+	    merge mechanism at runtime, the files <file>fmtutil.cnf</file>,
+	    <file>updmap.cfg</file> and <file>language.dat</file> are
+	    used on a first-found-first-used basis.
           </p>

Explanation:  

The changed order is clearer IMHO, although it needs one more instance
of listing all three files.
 
-	    <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>
+	    <prgn>updmap-sys(8)</prgn> provides options for enabling
+	    or disabling font map files.  When enabling a new map file
+	    that is not mentioned, <prgn>updmap-sys</prgn> will first
+	    create or edit <file>10local.cfg</file> in
+	    the <file>/etc/texmf/updmap.d</file> directory and then
+	    call <prgn>update-updmap</prgn>.  Note
+	    that <prgn>updmap-sys</prgn>'s <tt>--edit</tt>
 	    and <tt>--syncwithtrees</tt> options cannot be used on a
 	    Debian system.

Explanation:  

Just remove everything that refers to user stuff.
       
@@ -551,33 +543,37 @@
           <heading>
 	    Per user configuration changes
           </heading>
-	  <p>
-	    To override entries in the system wide configuration file 
-	    <file>texmf.cnf</file>, a user only needs to add lines to 
-	    <tt><var>HOME</var>/.texmf-config/web2c/texmf.cnf</tt>.
-	    Please only add those lines which are absolutely necessary.
+          <p>
+	    <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 <tt><var>TEXMFCONFIG</var>/web2c</tt> 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.
 	  </p>

Explanation:  

The paragraph moved here from earlier sounds better to me than the one I
removed. 

In the following, I have just split the very long sentence in two, and
refined the wording in 4.4.  Ah, I see, we still need to mention updmap
--enable in the per-user section.

Regards, Frank
-- 
Dr. Frank Küster
Single Molecule Spectroscopy, Protein Folding @ Inst. f. Biochemie, Univ. Zürich
Debian Developer (teTeX/TeXLive)



Reply to: