[subversion-commit] SVN tetex commit + diffs: r280 - tex-common/trunk/scripts

[Norbert Preining]

Author: preining-guest
Date: 2005-10-18 20:49:40 +0000 (Tue, 18 Oct 2005)
New Revision: 280

Modified:
   tex-common/trunk/scripts/dh_installtexfonts
Log:
improved the documentation, thanks Florent for checking


Modified: tex-common/trunk/scripts/dh_installtexfonts
===================================================================
--- tex-common/trunk/scripts/dh_installtexfonts	2005-10-18 20:31:25 UTC (rev 279)
+++ tex-common/trunk/scripts/dh_installtexfonts	2005-10-18 20:49:40 UTC (rev 280)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-dh_installtexfonts - register TeX type1 fonts
+dh_installtexfonts - register Type 1 fonts with TeX
 
 =cut
 
@@ -16,46 +16,73 @@
 =head1 DESCRIPTION
 
 dh_installtexfonts is a debhelper program that is responsible for
-registering type1 fonts for TeX.
+registering Type 1 fonts with TeX.
 
 Your package should depend on tex-common so that the
 update-* commands are available. (This program adds that dependency to
 ${misc:Depends}.)
 
 Registering map files for TeX can be done in the following ways:
+
 1) You can specify cfg files on the cmd line, optionally providing a 
 priority by affixing =n to it. These cfg files will be 
-installed into etc/texmf/updmap.d/ with the specified priority, if present,
-or with the standard priority 10 (but see below) and their original name 
-(foo.cfg installs into 10foo.cfg, bar.cfg=42 installs into 42bar.cfg).
+installed into /etc/texmf/updmap.d/ with the specified priority, if present,
+or with the default priority and their original name.
 
+Example:
+
+	dh_installtexfonts foo.cfg dvips/bar.cfg=42
+
+would install foo.cfg as /etc/texmf/updmap.d/10foo.cfg, and dvips/bar.cfg
+as /etc/texmf/updmap.d/42bar.cfg.
+
 2) You can specify map lines on the cmdline, where the map type and the
 map files is connected with =. These map lines are stored in a cfg file
 10package.cfg.
 
+Example:
+
+	dh_installtexfonts Map=foo.map MixedMap=bar.map
+
+would install a file /etc/texmf/updmap.d/10package.cfg containing the lines
+
+	Map foo.map
+	MixedMap bar.map
+
 3) You create a file debian/package.maps or debian/maps. These files are
-installed with default priority and the name of the package (i.e.
-debian/package.maps is installed as 10package.cfg). The file debian/maps
-will be installed into the first package dh_installtexfonts is told to
-act on. By default this is the first binary package in debian/control, but
-if you use -p, -i, or -a flags, it will be the first package specified
-by those flags.
+installed with default priority and the name of the package The file 
+debian/maps will be installed into the first package dh_installtexfonts 
+is told to act on. By default this is the first binary package in 
+debian/control, but if you use -p, -i, or -a flags, it will be the first
+package specified by those flags.
 
+Example:
+
+	dh_installtexfonts
+
+would install a present debian/package.maps file as 
+/etc/texmf/updmap.d/10package.cfg.
+
+=head2 Mixing the different variants
+
 The command line maps (Variant 2) are merged into the debian/package.maps 
 file and the merged file is installed as 10package.cfg. If you specify 
-an additional package.cfg (Variant 1) without a different priority then
-the standard one on the cmd line, this will raise
-an error since both files would be installed as 10package.cfg. You can
-only specify package.cfg on the cmd line if no debian/package.maps nor any
-cmd line Map files are present.
+an additional package.cfg (Variant 1) without a different priority than
+the default one on the cmd line, this will raise an error since both files 
+would be installed as 10package.cfg. You can only specify package.cfg without
+a different priority than the default one if no debian/package.maps nor
+any command line Map files are present.
 
-If the cfg files created do not contain the magic comment, an additional
-header is added with explanation, warning and the magic comment.
-Please see the TeX Policy for more information on this magic comment.
+=head2 The pseudo-comment
 
+If the provided cfg files do not contain the pseudo-comment as described
+in the Debian TeX Policy, Font configuration, an additional header with
+explanation, warning and the pseudo-comment is added.
+
+
 This program automatically generates the postinst and postrm commands needed
-to register TeX fonts.  See L<dh_installdeb(1)> for an explanation of how this
-works.
+to register the fonts with TeX.  See L<dh_installdeb(1)> for an explanation 
+of how this works.
 
 =head1 OPTIONS
 
@@ -67,17 +94,17 @@
 
 =item B<--priority=>I<n>
 
-Instead of using the default priority of 10 for the updmap-config file,
-use the priority specified by the --priority parameter.
+Set the default priority to I<n> instead of 10.
 
 =head1 NOTES
 
 Note that this command is not idempotent. "dh_clean -k" should be called
-between invocations of this command. Otherwise, it may cause multiple
-instances of the same text to be added to maintainer scripts.
+between invocations of this command, unless using the B<-n> option. 
+Otherwise, it may cause multiple instances of the same text to be added 
+to maintainer scripts.
 
-See Debian TeX policy, section 4.1.1. for details about doing fonts for TeX 
-the Debian way.
+Please refer to the Debian TeX policy for details about fonts configuration
+for TeX by Debian packages.
 
 =cut