5 dh_install - install files into package build directories
11 use Debian::Debhelper::Dh_Lib;
15 B<dh_install> [B<-X>I<item>] [B<--autodest>] [B<--list-missing>] [B<--sourcedir=>I<dir>] [S<I<debhelper options>>] [S<I<file [...] dest>>]
19 dh_install is a debhelper program that handles installing files into package
20 build directories. There are many dh_install* commands that handle installing
21 specific types of files such as documentation, examples, man pages, and so on,
22 and they should be used when possible as they often have extra intelligence for
23 those particular tasks. dh_install, then, is useful for installing everything
24 else, for which no particular intelligence is needed. It is a replacement for
25 the old dh_movefiles command.
27 Files named debian/package.install list the files to install into each
28 package and where they should be installed to. The format is a set of
29 lines, where each line lists a file or files to install, and at the end of
30 the line tells the directory it should be installed in. The name of the
31 files (or directories) to install should be given relative to the current
32 directory, while the installation directory is given relative to the
33 package build directory. You may use wildcards in the names of the files to
34 install (in v3 mode and above).
36 This program may be used in one of two ways. If you just have a file or two
37 that the upstream Makefile does not install for you, you can run dh_install
38 on them to move them into place. On the other hand, maybe you have a large
39 package that builds multiple binary packages. You can use the upstream Makefile
40 to install it all into debian/tmp, and then use dh_install to copy
41 directories and files from there into the proper package build directories.
47 =item B<-Xitem>, B<--exclude=item>
49 Exclude files that contain "item" anywhere in their filename from
54 Guess as the destination directory to install things to. If this is
55 specified, you should not list destination directories in
56 debian/package.install files or on the command line. Instead, dh_install
57 will guess as follows:
59 Strip off debian/tmp from the front of the filename, if it is present, and
60 install into the dirname of the filename. So if the filename is
61 debian/tmp/usr/bin, then that directory will be copied to
62 debian/package/usr/. If the filename is debian/tmp/etc/passwd, it will be
63 copied to debian/package/etc/.
65 Note that if you list only a filename on a line by itself in a
66 debian/package.install file, with no explicit destination, then dh_install
67 will automatically guess the destination even if this flag is not set.
69 =item B<--list-missing>
71 This option makes dh_install keep track of the files it installs, and then at
72 the end, compare that list with the files in the source directory. If any of
73 the files (and symlinks) in the source directory were not installed to
74 somewhere, it will warn on stderr about that.
76 This may be useful if you have a large package and want to make sure that
77 you don't miss installing newly added files in new upstream releases.
79 Note that files that are excluded from being moved via the -X option are not
82 You need to use the --sourcedir parameter for this one to be of much use.
84 =item B<--sourcedir=dir>
86 Makes all source files be found under dir. If this is specified, it is
87 akin to all the source filenames having "dir/" prepended to them.
89 To make dh_install behave like the old dh_movefiles, move your
90 package.files file to package.install and call dh_install with
91 "--sourcedir=debian/tmp" appended to the command. This will
92 approximate dh_movefiles behaviour, except it will copy files instead
95 =item I<file [...] dest>
97 Lists files (or directories) to install and where to install them to.
98 The files will be installed into the first package dh_install acts on.
109 $srcdir = $dh{SOURCEDIR}."/" if defined $dh{SOURCEDIR};
111 foreach my $package (@{$dh{DOPACKAGES}}) {
112 my $tmp=tmpdir($package);
113 my $file=pkgfile($package,"install");
117 @install=filedoublearray($file); # no globbing yet
120 if (($package eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
121 push @install, [@ARGV];
124 # Support for -X flag.
126 if ($dh{EXCLUDE_FIND}) {
127 $exclude = '-and ! \( '.$dh{EXCLUDE_FIND}.' \)';
130 foreach my $set (@install) {
133 if (! defined $dh{AUTODEST} && @$set > 1) {
136 # glob now, relative to srcdir
137 foreach my $src (map { glob "$srcdir/$_" } @$set) {
138 next if excludefile($src);
140 if (! defined $dest) {
141 # Guess at destination directory.
143 $dest=~s/^(.*\/)?debian\/tmp//;
144 $dest=dirname($dest);
147 # Make sure the destination directory exists.
148 if (! -e "$tmp/$dest") {
149 doit("install","-d","$tmp/$dest");
152 # Keep track of what's installed.
153 if ($dh{LIST_MISSING}) {
154 # Kill any extra slashes. Makes the
155 # @installed stuff more robust.
158 push @installed, "\Q$src\E\/.*|\Q$src\E";
161 if (-d $src && $exclude) {
162 my ($dir_basename) = basename($src);
163 # Pity there's no cp --exclude ..
166 complex_doit("cd $src/.. && find $dir_basename \\( -type f -or -type l \\) $exclude -exec cp --parents -dp {} $pwd/$tmp/$dest/ \\;");
169 doit("cp", "-a", $src, "$tmp/$dest/");
175 if ($dh{LIST_MISSING}) {
177 my $installed=join("|", @installed);
178 $installed=qr{^$installed$};
181 $_="$File::Find::dir/$_";
182 push @missing, $_ unless /$installed/ || excludefile($_);
185 warning "$_ not installed" foreach @missing;
191 Suppose your package's upstream Makefile installs a binary, a man page, and
192 a library into appropriate subdirectories of debian/tmp. You want to put
193 the library into package libfoo, and the rest into package foo. Your rules
194 file will run "dh_install --sourcedir=debian/tmp". Make debian/foo.install
200 While debian/libfoo.install contains:
204 If you want a libfoo-dev package too, debian/libfoo-dev.install might contain:
214 This program is a part of debhelper.
218 Joey Hess <joeyh@debian.org>