diff options
Diffstat (limited to 'dh_installexamples')
-rwxr-xr-x | dh_installexamples | 63 |
1 files changed, 60 insertions, 3 deletions
diff --git a/dh_installexamples b/dh_installexamples index 9fdbdf7c..7c004265 100755 --- a/dh_installexamples +++ b/dh_installexamples @@ -1,10 +1,55 @@ #!/usr/bin/perl -w -# -# Reads debian/examples, installs all files listed there into -# /usr/share/doc/$package/examples + +=head1 NAME + +dh_installexamples - install example files into package build directories + +=cut use strict; use Debian::Debhelper::Dh_Lib; + +=head1 SYNOPSIS + + dh_installexamples [debhelper options] [-A] [file ...] + +=head1 DESCRIPTION + +dh_installexamples is a debhelper program that is responsible for +installing examples into usr/share/doc/package/examples in package +build directories. + +Any file names specified as parameters will be installed into the first +package dh_installexamples 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. + +Files named debian/package.examples can list other files to be installed. + +=head1 OPTIONS + +=over 4 + +=item B<-A>, B<--all> + +Install any files specified by command line parameters in ALL packages +acted on. + +=item I<file ...> + +Install these files as examples into the first package acted on. (Or into +all packages if -A is specified.) + +=back + +=head1 NOTES + +Note that dh_installexamples will happily copy entire directory hierarchies +if you ask it to (it uses cp -a internally). If it is asked to install a +directory, it will install the complete contents of the directory. + +=cut + init(); foreach my $package (@{$dh{DOPACKAGES}}) { @@ -29,3 +74,15 @@ foreach my $package (@{$dh{DOPACKAGES}}) { doit("cp","-a",@examples,"$tmp/usr/share/doc/$package/examples"); } } + +=head1 SEE ALSO + +L<debhelper(1)> + +This program is a part of debhelper. + +=head1 AUTHOR + +Joey Hess <joeyh@debian.org> + +=cut |