summaryrefslogtreecommitdiff
path: root/dh_installexamples.1
blob: be0b4cc32d357e4d653844cb151204a9303b2bdd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
.TH DH_INSTALLEXAMPLES 1
.SH NAME
dh_installexamples \- install example files into package build directories
.SH SYNOPSIS
.B dh_installexamples
.I "[-v] [-a] [-i] [--no-act] [-ppackage] [-Ptmpdir] [-A] [file ...]"
.SH "DESCRIPTION"
dh_installexamples is a debhelper program that is responsible for installing
examples into usr/doc/package/examples in package build directories.
.P
Any file names specified as parameters will be installed into the first 
package dh_installdirs is told to act on. By default, this is the first 
binary package in debian/control, but if you use -p, -i, or -a flags, it
will be the first package specified by those flags.
.P
A file named debian/package.examples (debian/examples may be used for the
first binary package in debian/control) can list other files to be installed.
.SH OPTIONS
.TP
.B \-v, \--verbose
Verbose mode; show all commands that modify the package build directory.
.TP
.B \-a, \--arch
Install files for all architecture dependent packages.
.TP
.B \-i, \--indep
Install files for all architecture independent packages.
.TP
.B \--no-act
Do not really do anything. If used with -v, the result is that this command
will output a list of what it would have done.
.TP
.B \-ppackage, \--package=package
Install files for the package named "package".
.TP
.B \-Ptmpdir, \--tmpdir=tmpdir
Use "tmpdir" for package build directory. 
.TP
.B \-A, \--all
Install any files specified by command line parameters in ALL packages
acted on.
.TP
.B file ...
Install these files as examples into the first package acted on. (Or into all
packages if -A is specified.)
.SH NOTES
The
.B \-a
.B \-i
and
.B \-p
arguments are cumulative. If none are specified, then all packages listed in
the control file will be effected.
.P
Note that dh_installexamples will happily copy entire directory hierarchies if
you ask it to (it uses cp -a internally). If it is asked to install a
directory, it will install the complete contents of the directory.
.SH ENVIRONMENT
.TP
.I DH_VERBOSE
Enables verbose mode
.TP
.I DH_NO_ACT
Enables no-act mode (see above).
.SH "SEE ALSO"
.BR /usr/doc/debhelper/README
.SH BUGS
Filenames with spaces in them will not currently be installed.
.SH "CONFORMS TO"
Debian policy, version 2.3.0.0
.SH AUTHOR
Joey Hess <joeyh@master.debian.org>