.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "DH_INSTALL 1" .TH DH_INSTALL 1 "2017-01-25" "10.2.5" "Debhelper" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" dh_install \- install files into package build directories .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBdh_install\fR [\fB\-X\fR\fIitem\fR] [\fB\-\-autodest\fR] [\fB\-\-sourcedir=\fR\fIdir\fR] [\fIdebhelper options\fR] [\fIfile|dir\fR ... \fIdestdir\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBdh_install\fR is a debhelper program that handles installing files into package build directories. There are many \fBdh_install\fR\fI*\fR commands that handle installing specific types of files such as documentation, examples, man pages, and so on, and they should be used when possible as they often have extra intelligence for those particular tasks. \fBdh_install\fR, then, is useful for installing everything else, for which no particular intelligence is needed. It is a replacement for the old \fBdh_movefiles\fR command. .PP This program may be used in one of two ways. If you just have a file or two that the upstream Makefile does not install for you, you can run \fBdh_install\fR on them to move them into place. On the other hand, maybe you have a large package that builds multiple binary packages. You can use the upstream \&\fIMakefile\fR to install it all into \fIdebian/tmp\fR, and then use \fBdh_install\fR to copy directories and files from there into the proper package build directories. .PP From debhelper compatibility level 7 on, \fBdh_install\fR will fall back to looking in \fIdebian/tmp\fR for files, if it doesn't find them in the current directory (or wherever you've told it to look using \fB\-\-sourcedir\fR). .SH "FILES" .IX Header "FILES" .IP "debian/\fIpackage\fR.install" 4 .IX Item "debian/package.install" List the files to install into each package and the directory they should be installed to. The format is a set of lines, where each line lists a file or files to install, and at the end of the line tells the directory it should be installed in. The name of the files (or directories) to install should be given relative to the current directory, while the installation directory is given relative to the package build directory. You may use wildcards in the names of the files to install (in v3 mode and above). .Sp Note that if you list exactly one filename or wildcard-pattern on a line by itself, with no explicit destination, then \fBdh_install\fR will automatically guess the destination to use, the same as if the \&\-\-autodest option were used. .IP "debian/not\-installed" 4 .IX Item "debian/not-installed" List the files that are deliberately not installed in \fIany\fR binary package. Paths listed in this file are (\fIonly\fR) ignored by the check done via \fB\-\-list\-missing\fR (or \fB\-\-fail\-missing\fR). However, it is \&\fBnot\fR a method to exclude files from being installed. Please use \&\fB\-\-exclude\fR for that. .Sp Please keep in mind that dh_install will \fBnot\fR expand wildcards in this file. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-list\-missing\fR" 4 .IX Item "--list-missing" This option makes \fBdh_install\fR keep track of the files it installs, and then at the end, compare that list with the files in the source directory. If any of the files (and symlinks) in the source directory were not installed to somewhere, it will warn on stderr about that. .Sp This may be useful if you have a large package and want to make sure that you don't miss installing newly added files in new upstream releases. .Sp Note that files that are excluded from being moved via the \fB\-X\fR option are not warned about. .IP "\fB\-\-fail\-missing\fR" 4 .IX Item "--fail-missing" This option is like \fB\-\-list\-missing\fR, except if a file was missed, it will not only list the missing files, but also fail with a nonzero exit code. .IP "\fB\-X\fR\fIitem\fR, \fB\-\-exclude=\fR\fIitem\fR" 4 .IX Item "-Xitem, --exclude=item" Exclude files that contain \fIitem\fR anywhere in their filename from being installed. .IP "\fB\-\-sourcedir=\fR\fIdir\fR" 4 .IX Item "--sourcedir=dir" Look in the specified directory for files to be installed. .Sp Note that this is not the same as the \fB\-\-sourcedirectory\fR option used by the \fBdh_auto_\fR\fI*\fR commands. You rarely need to use this option, since \&\fBdh_install\fR automatically looks for files in \fIdebian/tmp\fR in debhelper compatibility level 7 and above. .IP "\fB\-\-autodest\fR" 4 .IX Item "--autodest" Guess as the destination directory to install things to. If this is specified, you should not list destination directories in \&\fIdebian/package.install\fR files or on the command line. Instead, \fBdh_install\fR will guess as follows: .Sp Strip off \fIdebian/tmp\fR (or the sourcedir if one is given) from the front of the filename, if it is present, and install into the dirname of the filename. So if the filename is \fIdebian/tmp/usr/bin\fR, then that directory will be copied to \fIdebian/package/usr/\fR. If the filename is \&\fIdebian/tmp/etc/passwd\fR, it will be copied to \fIdebian/package/etc/\fR. .IP "\fIfile|dir\fR ... \fIdestdir\fR" 4 .IX Item "file|dir ... destdir" Lists files (or directories) to install and where to install them to. The files will be installed into the first package \fIdh_install\fR acts on. .SH "LIMITATIONS" .IX Header "LIMITATIONS" \&\fBdh_install\fR cannot rename files or directories, it can only install them with the names they already have into wherever you want in the package build tree. .PP However, renaming can be achieved by using \fBdh-exec\fR with compatibility level 9 or later. An example debian/\fIpackage\fR.install file using \fBdh-exec\fR could look like: .PP .Vb 2 \& #!/usr/bin/dh\-exec \& debian/default.conf => /etc/my\-package/start.conf .Ve .PP Please remember the following three things: .IP "\(bu" 4 The package must be using compatibility level 9 or later (see \fIdebhelper\fR\|(7)) .IP "\(bu" 4 The package will need a build-dependency on dh-exec. .IP "\(bu" 4 The install file must be marked as executable. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIdebhelper\fR\|(7) .PP This program is a part of debhelper. .SH "AUTHOR" .IX Header "AUTHOR" Joey Hess