1DH_INSTALLEXAMPLES(1) Debhelper DH_INSTALLEXAMPLES(1)
2
3
4
6 dh_installexamples - install example files into package build
7 directories
8
10 dh_installexamples [debhelper options] [-A] [-Xitem] [file ...]
11
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
23 debian/package.examples
24 Lists example files or directories to be installed.
25
27 -A, --all
28 Install any files specified by command line parameters in ALL
29 packages acted on.
30
31 --sourcedir=dir
32 Look in the specified directory for files to be installed. This
33 option requires compat 11 or later (it is silently ignored in
34 compat 10 or earlier).
35
36 Note that this is not the same as the --sourcedirectory option used
37 by the dh_auto_* commands. You rarely need to use this option,
38 since dh_installexamples automatically looks for files in
39 debian/tmp in debhelper compatibility level 11 and above.
40
41 --doc-main-package=main-package
42 Set the main package for a documentation package. This is used to
43 install the documentation of the documentation package in
44 /usr/share/doc/main-package as recommended by the Debian policy
45 manual 3.9.7 in §12.3.
46
47 In compat 11 (or later), this option is only useful if debhelper's
48 auto-detection of the main package is wrong. The option can also
49 be used to silence a warning from debhelper when the auto-detection
50 fails but the default happens to be correct.
51
52 This option cannot be used when dh_installexamples is instructed to
53 act on multiple packages. If you need this option, you will
54 generally need to combine it with -p to ensure exactly one package
55 is acted on.
56
57 -Xitem, --exclude=item
58 Exclude files that contain item anywhere in their filename from
59 being installed.
60
61 file ...
62 Install these files (or directories) as examples into the first
63 package acted on. (Or into all packages if -A is specified.)
64
66 Note that dh_installexamples will happily copy entire directory
67 hierarchies if you ask it to (similar to cp -a). If it is asked to
68 install a directory, it will install the complete contents of the
69 directory.
70
72 debhelper(7)
73
74 This program is a part of debhelper.
75
77 Joey Hess <joeyh@debian.org>
78
79
80
8111.4 2018-09-14 DH_INSTALLEXAMPLES(1)