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] [--no-act] [-ppackage] [-Ptmpdir] [-A] [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 file names specified as parameters will be installed into the first
  12 package dh_installdirs 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 \-v, \--verbose
  21 Verbose mode; show all commands that modify the package build directory.
  22 .TP
  23 .B \-a, \--arch
  24 Install files for all architecture dependent packages.
  25 .TP
  26 .B \-i, \--indep
  27 Install files for all architecture independent packages.
  28 .TP
  29 .B \--no-act
  30 Do not really do anything. If used with -v, the result is that this command
  31 will output a list of what it would have done.
  32 .TP
  33 .B \-ppackage, \--package=package
  34 Install files for the package named "package".
  35 .TP
  36 .B \-Ptmpdir, \--tmpdir=tmpdir
  37 Use "tmpdir" for package build directory.
  38 .TP
  39 .B \-A, \--all
  40 Install any files specified by command line parameters in ALL packages
  41 acted on.
  42 .TP
  43 .B file ...
  44 Install these files as examples into the first package acted on. (Or into all
  45 packages if -A is specified.)
  46 .SH NOTES
  47 The
  48 .B \-a
  49 .B \-i
  50 and
  51 .B \-p
  52 arguments are cumulative. If none are specified, then all packages listed in
  53 the control file will be effected.
  54 .P
  55 Note that dh_installexamples will happily copy entire directory hierarchies if
  56 you ask it to (it uses cp -a internally). If it is asked to install a
  57 directory, it will install the complete contents of the directory.
  58 .SH ENVIRONMENT
  59 .TP
  60 .I DH_VERBOSE
  61 Enables verbose mode
  62 .TP
  63 .I DH_NO_ACT
  64 Enables no-act mode (see above).
  65 .SH "SEE ALSO"
  66 .BR /usr/doc/debhelper/README
  67 .SH BUGS
  68 Filenames with spaces in them will not currently be installed.
  69 .SH "CONFORMS TO"
  70 Debian policy, version 2.3.0.0
  71 .SH AUTHOR
  72 Joey Hess <joeyh@master.debian.org>