r432: more podization, will it ever end?

[debhelper.git] / dh_installxaw

diff --git a/dh_installxaw b/dh_installxaw
index e5ecf93d5c1b63276b5f302221babaf9e33ad3ac..3bda1fa0589f88306629f22832fec3ea946c7699 100755 (executable)
--- a/dh_installxaw
+++ b/dh_installxaw
@@ -1,14 +1,48 @@
 #!/usr/bin/perl -w
-#
-# Integration with xaw-wrappers
-#
-# If debian/xaw-wrappers file exists, save it to 
-# $tmp/usr/share/xaw-wrappers/config/$package
-#
-# Also, add calls to postinst and postrm.
+
+=head1 NAME
+
+dh_installxaw - install xaw wrappers config files into package build directories
+
+=cut
 
 use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+  dh_installxaw [debhelper options] [-n]
+
+=head1 DESCRIPTION
+
+dh_installxaw is a debhelper program that is responsible for installing
+xaw wrappers config files into package build directories.
+
+It also automatically generates the postinst, prerm, and postrm commands
+needed to interface with the debian xaw-wrappers package. See
+L<dh_installdeb(1)> for an explanation of how this works.
+
+If a file named debian/package.xaw exists, then it is installed into
+usr/lib/xaw-wrappers/config/package in the package build directory.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-n>, B<--noscripts>
+
+Do not modify postinst/prerm/postrm scripts.
+
+=back
+
+=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.
+
+=cut
+
 init();
 
 foreach my $package (@{$dh{DOPACKAGES}}) {
@@ -63,3 +97,15 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                }
        }
 }
+
+=head1 SEE ALSO
+
+L<debhelper(1)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut