diff options
Diffstat (limited to 'dh_installexamples.1')
| -rw-r--r-- | dh_installexamples.1 | 62 |
1 files changed, 28 insertions, 34 deletions
diff --git a/dh_installexamples.1 b/dh_installexamples.1 index 1fb5c44a..d1b10ff0 100644 --- a/dh_installexamples.1 +++ b/dh_installexamples.1 @@ -1,54 +1,48 @@ -.TH DH_INSTALLEXAMPLES 1 +.TH DH_INSTALLEXAMPLES 1 "" "Debhelper Commands" "Debhelper Commands" .SH NAME dh_installexamples \- install example files into package build directories .SH SYNOPSIS .B dh_installexamples -.I "[-v] [-a] [-i] [-ppackage] [file ...]" +.I "[debhelper options] [-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. +examples into usr/share/doc/package/examples in package build directories. .P -Any filenames specified as parameters will be installed into the first -binary package listed in debian/control, if dh_installexamples is acting on -that package. +Any file names specified as parameters will be installed into the first +package dh_installexamples 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/examples (for the first binary package in debian/control), -or debian/package.exmaples (for each additional package in debian/control) can -list other files to be installed. +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 mode; show all commands that modify the package build directory. +.B debhelper options +See +.BR debhelper (1) +for a list of options common to all debhelper commands. .TP -.B \-a -Install files for all architecture dependent packages. -.TP -.B \-i -Install files for all architecture independent packages. -.TP -.B \-ppackage -Install files for the package named "package". +.B \-A, \--all +Install any files specified by command line parameters in ALL packages +acted on. .TP .B file ... -Install these files as documentation into the first binary package listed in -debian/control, if we are acting on that package. +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. +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 +See +.BR debhelper (1) +for a list of environment variables that affect all debhelper commands. .SH "SEE ALSO" -.BR /usr/doc/debhelper/README +.BR debhelper (1) .SH BUGS -Filenames with spaces in them will not currently be installed. +It's impossible to specify filenames with spaces or other whitespace in them +in debian/examples file. This is more a historical design flaw than a bug. .SH "CONFORMS TO" -Debian policy, version 2.3.0.0 +Debian policy, version 3.0.1 .SH AUTHOR Joey Hess <joeyh@master.debian.org> |