]> git.donarmstrong.com Git - debhelper.git/blob - dh_installexamples.1
r36: Initial Import
[debhelper.git] / dh_installexamples.1
1 .TH DH_INSTALLEXAMPLES 1
2 .SH NAME
3 dh_installexamples \- install example files into package build directories
4 .SH SYNOPSIS
5 .B dh_installexamples
6 .I "[-v] [-a] [-i] [-ppackage] [-Ptmpdir] [file ...]"
7 .SH "DESCRIPTION"
8 dh_installexamples is a debhelper program that is responsible for installing
9 examples into usr/doc/package/examples in package build directories.
10 .P
11 Any filenames specified as parameters will be installed into the first
12 binary package listed in debian/control, if dh_installexamples is acting on
13 that package.
14 .P
15 A file named debian/examples (for the first binary package in debian/control),
16 or debian/package.examples (for each additional package in debian/control) can
17 list other files to be installed.
18 .SH OPTIONS
19 .TP
20 .B \-v
21 Verbose mode; show all commands that modify the package build directory.
22 .TP
23 .B \-a
24 Install files for all architecture dependent packages.
25 .TP
26 .B \-i
27 Install files for all architecture independent packages.
28 .TP
29 .B \-ppackage
30 Install files for the package named "package".
31 .TP
32 .B \-Ptmpdir
33 Use "tmpdir" for package build directory. 
34 .TP
35 .B file ...
36 Install these files as documentation into the first binary package listed in
37 debian/control, if we are acting on that package.
38 .SH NOTES
39 The
40 .B \-a
41 .B \-i
42 and
43 .B \-p
44 arguments are cumulative. If none are specified, then all packages listed in
45 the control file will be effected.
46 .P
47 Note that dh_examples will happily copy entire directory hierarchies if
48 you ask it to (it uses cp -a internally). If it is asked to install a
49 directory, it will install the complete contents of the directory.
50 .SH ENVIRONMENT
51 .TP
52 .I DH_VERBOSE
53 Enables verbose mode
54 .SH "SEE ALSO"
55 .BR /usr/doc/debhelper/README
56 .SH BUGS
57 Filenames with spaces in them will not currently be installed.
58 .SH "CONFORMS TO"
59 Debian policy, version 2.3.0.0
60 .SH AUTHOR
61 Joey Hess <joeyh@master.debian.org>