dh_installdocs.1

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