dh_installexamples.1

   1 .TH DH_INSTALLEXAMPLES 1 "" "Debhelper Commands" "Debhelper Commands"
   2 .SH NAME
   3 dh_installexamples \- install example files into package build directories
   4 .SH SYNOPSIS
   5 .B dh_installexamples
   6 .I "[debhelper options] [-A] [file ...]"
   7 .SH "DESCRIPTION"
   8 dh_installexamples is a debhelper program that is responsible for installing
   9 examples into usr/share/doc/package/examples in package build directories.
  10 .P
  11 Any file names specified as parameters will be installed into the first
  12 package dh_installexamples is told to act on. By default, this is the first
  13 binary package in debian/control, but if you use -p, -i, or -a flags, it
  14 will be the first package specified by those flags.
  15 .P
  16 A file named debian/package.examples (debian/examples may be used for the
  17 first binary package in debian/control) can list other files to be installed.
  18 .SH OPTIONS
  19 .TP
  20 .B debhelper options
  21 See
  22 .BR debhelper (1)
  23 for a list of options common to all debhelper commands.
  24 .TP
  25 .B \-A, \--all
  26 Install any files specified by command line parameters in ALL packages
  27 acted on.
  28 .TP
  29 .B file ...
  30 Install these files as examples into the first package acted on. (Or into all
  31 packages if -A is specified.)
  32 .SH NOTES
  33 Note that dh_installexamples will happily copy entire directory hierarchies if
  34 you ask it to (it uses cp -a internally). If it is asked to install a
  35 directory, it will install the complete contents of the directory.
  36 .SH ENVIRONMENT
  37 See
  38 .BR debhelper (1)
  39 for a list of environment variables that affect all debhelper commands.
  40 .SH "SEE ALSO"
  41 .BR debhelper (1)
  42 .SH BUGS
  43 It's impossible to specify filenames with spaces or other whitespace in them
  44 in debian/examples file. This is more a historical design flaw than a bug.
  45 .SH "CONFORMS TO"
  46 Debian policy, version 3.0.1
  47 .SH AUTHOR
  48 Joey Hess <joeyh@master.debian.org>