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