.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "DH_INSTALL 1" .TH DH_INSTALL 1 "2022-11-26" "13.11.1~bpo11+1" "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 does not 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. .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. .Sp Supports substitution variables in compat 13 and later as documented in \fBdebhelper\fR\|(7). .IP "debian/not\-installed" 4 .IX Item "debian/not-installed" Used with the deprecated \fB\-\-list\-missing\fR and \fB\-\-fail\-missing\fR options. Please refer to \fBdh_missing\fR\|(1) for the documentation of this file. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-list\-missing\fR" 4 .IX Item "--list-missing" \&\fBDeprecated\fR: Please use \fBdh_missing \-\-list\-missing\fR instead. If you use this option, \fBdh_install\fR will call \fBdh_missing\fR with that option after it has processed all the files. Please see \fBdh_missing\fR\|(1) for the documentation of this option. .Sp This option is removed in compat 12. .IP "\fB\-\-fail\-missing\fR" 4 .IX Item "--fail-missing" \&\fBDeprecated\fR: Please use \fBdh_missing \-\-fail\-missing\fR instead. If you use this option, \fBdh_install\fR will call \fBdh_missing\fR with that option after it has processed all the files. Please see \fBdh_missing\fR\|(1) for the documentation of this option. .Sp This option is removed in compat 12. .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 "EXAMPLES" .IX Header "EXAMPLES" Here are some small examples of configuration files for dh_install. .PP .Vb 2 \& # Install my\-prog into usr/bin (as "usr/bin/my\-prog") \& my\-prog usr/bin \& \& # Install a plugins directory into usr/share/my\-prog \& # (as "usr/share/my\-prog/plugins/") \& plugins usr/share/my\-prog \& \& # Install a file with spaces in into usr/share/my\-prog/data \& # (as "usr/share/my\-prog/data/my datafile with spaces.txt") \& # ASSUMES COMPAT 13, where substitution patterns are available \& my${Space}datafile${Space}with${Space}spaces.txt usr/share/my\-prog/data \& \& # Install a library into the multi\-arch lib directory \& # ASSUMES COMPAT 13, where substitution patterns are available \& build/output/libfrop*.so.* usr/lib/${DEB_HOST_MULTIARCH} .Ve .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 \fBdebhelper\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" \&\fBdebhelper\fR\|(7) .PP This program is a part of debhelper. .SH "AUTHOR" .IX Header "AUTHOR" Joey Hess