dh_installexamples(1)

1DH_INSTALLEXAMPLES(1)              Debhelper             DH_INSTALLEXAMPLES(1)
2
3
4

NAME

6       dh_installexamples - install example files into package build
7       directories
8

SYNOPSIS

10       dh_installexamples [debhelper options] [-A] [-Xitem] [file ...]
11

DESCRIPTION

13       dh_installexamples is a debhelper program that is responsible for
14       installing examples into usr/share/doc/package/examples in package
15       build directories.
16
17       From debhelper compatibility level 11 on, dh_install will fall back to
18       looking in debian/tmp for files, if it does not find them in the
19       current directory (or wherever you've told it to look using
20       --sourcedir).
21

FILES

23       debian/package.examples
24           Lists example files or directories to be installed.
25
26           Supports substitution variables in compat 13 and later as
27           documented in debhelper(7).
28

OPTIONS

30       -A, --all
31           Install any files specified by command line parameters in ALL
32           packages acted on.
33
34       --sourcedir=dir
35           Look in the specified directory for files to be installed.  This
36           option requires compat 11 or later (it is silently ignored in
37           compat 10 or earlier).
38
39           Note that this is not the same as the --sourcedirectory option used
40           by the dh_auto_* commands. You rarely need to use this option,
41           since dh_installexamples automatically looks for files in
42           debian/tmp in debhelper compatibility level 11 and above.
43
44       --doc-main-package=main-package
45           Set the main package for a documentation package.  This is used to
46           install the documentation of the documentation package in
47           /usr/share/doc/main-package as recommended by the Debian policy
48           manual 3.9.7 in §12.3.
49
50           In compat 11 (or later), this option is only useful if debhelper's
51           auto-detection of the main package is wrong.  The option can also
52           be used to silence a warning from debhelper when the auto-detection
53           fails but the default happens to be correct.
54
55           This option cannot be used when dh_installexamples is instructed to
56           act on multiple packages.  If you need this option, you will
57           generally need to combine it with -p to ensure exactly one package
58           is acted on.
59
60       -Xitem, --exclude=item
61           Exclude files that contain item anywhere in their filename from
62           being installed.
63
64       file ...
65           Install these files (or directories) as examples into the first
66           package acted on. (Or into all packages if -A is specified.)
67

NOTES

69       Note that dh_installexamples will happily copy entire directory
70       hierarchies if you ask it to (similar to cp -a). If it is asked to
71       install a directory, it will install the complete contents of the
72       directory.
73

AUTHOR

80       Joey Hess <joeyh@debian.org>
81
82
83
8413.7.1                            2022-04-22             DH_INSTALLEXAMPLES(1)