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           If upstream provides an examples directory, you will often want to
27           use examples/* rather than examples in this file.  The latter would
28           create /usr/share/doc/package/examples/examples, which is rarely
29           what you want.
30
31           Supports substitution variables in compat 13 and later as
32           documented in debhelper(7).
33

OPTIONS

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

NOTES

74       Note that dh_installexamples will happily copy entire directory
75       hierarchies if you ask it to (similar to cp -a). If it is asked to
76       install a directory, it will install the complete contents of the
77       directory.
78

AUTHOR

85       Joey Hess <joeyh@debian.org>
86
87
88
8913.11.4                           2023-01-22             DH_INSTALLEXAMPLES(1)