.\" 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_INSTALLEXAMPLES 1"
.TH DH_INSTALLEXAMPLES 1 "2021-03-06" "13.3.4" "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_installexamples \- install example files into package build directories
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBdh_installexamples\fR [\fIdebhelper options\fR] [\fB\-A\fR] [\fB\-X\fR\fIitem\fR] [\fIfile\fR ...]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBdh_installexamples\fR is a debhelper program that is responsible for
installing examples into \fIusr/share/doc/package/examples\fR in package
build directories.
.PP
From debhelper compatibility level 11 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.examples" 4
.IX Item "debian/package.examples"
Lists example files or directories to be installed.
.Sp
Supports substitution variables in compat 13 and later as
documented in \fBdebhelper\fR\|(7).
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-A\fR, \fB\-\-all\fR" 4
.IX Item "-A, --all"
Install any files specified by command line parameters in \s-1ALL\s0 packages
acted on.
.IP "\fB\-\-sourcedir=\fR\fIdir\fR" 4
.IX Item "--sourcedir=dir"
Look in the specified directory for files to be installed.  This option
requires compat 11 or later (it is silently ignored in compat 10 or earlier).
.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_installexamples\fR automatically looks for files in \fIdebian/tmp\fR in debhelper
compatibility level 11 and above.
.IP "\fB\-\-doc\-main\-package=\fR\fImain-package\fR" 4
.IX Item "--doc-main-package=main-package"
Set the main package for a documentation package.  This is used to
install the documentation of the documentation package in \fI/usr/share/doc/\fImain-package\fI\fR as recommended by the Debian policy
manual 3.9.7 in §12.3.
.Sp
In compat 11 (or later), this option is only useful if debhelper's
auto-detection of the main package is wrong.  The option can also be
used to silence a warning from debhelper when the auto-detection fails
but the default happens to be correct.
.Sp
This option cannot be used when \fBdh_installexamples\fR is instructed to act
on multiple packages.  If you need this option, you will generally
need to combine it with \fB\-p\fR to ensure exactly one package is acted
on.
.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 "\fIfile\fR ..." 4
.IX Item "file ..."
Install these files (or directories) as examples into the first package
acted on. (Or into all packages if \fB\-A\fR is specified.)
.SH "NOTES"
.IX Header "NOTES"
Note that \fBdh_installexamples\fR will happily copy entire directory hierarchies
if you ask it to (similar to \fBcp \-a\fR). If it is asked to install a
directory, it will install the complete contents of the directory.
.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 <joeyh@debian.org>