r433: this is getting *so* boring.

[debhelper.git] / dh_installxfonts

diff --git a/dh_installxfonts b/dh_installxfonts
index 83f38c0ae2e5767d4c48be9926ece8de4a04bb4e..bf0ec0fee552ed9c720c74b4ad74b2b794ee11a1 100755 (executable)
--- a/dh_installxfonts
+++ b/dh_installxfonts
@@ -1,13 +1,45 @@
 #!/usr/bin/perl -w
-#
-# Integration with the Debian X11 font policy.
 
+=head1 NAME
+
+dh_installxfonts - register X fonts
+
+=cut
+
+use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+  dh_installxfonts [debhelper options]
+
+=head1 DESCRIPTION
+
+dh_installxfonts is a debhelper program that is responsible for
+registering X fonts, so their corresponding fonts.dir, fonts.alias,
+and fonts.scale be rebuilt properly at install time.
+
+Before calling this program, you should have installed any X fonts
+provided by your package into the appropriate location in the package build
+directory. Also, your package should depend on xbase-clients (>=
+3.3.3.1-5).
+
+It automatically generates the postinst and postrm commands needed to
+register X fonts.  See L<dh_installdeb(1)> for an explanation of how this
+works.
+
+=head1 NOTES
+
+See L<update-fonts-alias(8)>, L<update-fonts-scale(8)>, and L<mkfontdir(1x)>
+for more information about X font installation.
+
+=cut
+
 init();
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-       $TMP=tmpdir($PACKAGE);
-       my $XFONTDIR="$TMP/usr/X11R6/lib/X11/fonts/";
+foreach my $package (@{$dh{DOPACKAGES}}) {
+       my $tmp=tmpdir($package);
+       my $XFONTDIR="$tmp/usr/X11R6/lib/X11/fonts/";
 
        # Find all fint directories in the package build directory.
        opendir DIR, $XFONTDIR || next;
@@ -19,17 +51,29 @@ foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
                my @updatecmds=('/usr/bin/X11/mkfontdir');
                foreach my $f (@fontdirs) {
                        push @updatecmds, '/usr/sbin/update-fonts-alias'
-                               if -f "$TMP/etc/X11/fonts/$f/$PACKAGE.alias";
+                               if -f "$tmp/etc/X11/fonts/$f/$package.alias";
                        # This must come _before_ mkfontdir, thus the unshift.
                        unshift @updatecmds, '/usr/sbin/update-fonts-scale'
-                               if -f "$TMP/etc/X11/fonts/$f/$PACKAGE.scale";
+                               if -f "$tmp/etc/X11/fonts/$f/$package.scale";
                }
 
-               autoscript($PACKAGE, "postinst", "postinst-xfonts",
+               autoscript($package, "postinst", "postinst-xfonts",
                        "s:#FONTDIRS#:".join(' ', @fontdirs).
                        ":;s:#UPDATECMDS#:".join(' ', @updatecmds).":");
-               autoscript($PACKAGE, "postrm", "postrm-xfonts",
+               autoscript($package, "postrm", "postrm-xfonts",
                        "s:#FONTDIRS#:".join(' ', @fontdirs).
                        ":;s:#UPDATECMDS#:".join(' ', @updatecmds).":");
        }
 }
+
+=head1 SEE ALSO
+
+L<debhelper(1)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut