dh_installdocs.1

   1 .TH DH_INSTALLDOCS 1 "" "Debhelper Commands" "Debhelper Commands"
   2 .SH NAME
   3 dh_installdocs \- install documentation into package build directories
   4 .SH SYNOPSIS
   5 .B dh_installdocs
   6 .I "[debhelper options] [-A] [-n] [file ...]"
   7 .SH "DESCRIPTION"
   8 dh_installdocs is a debhelper program that is responsible for installing
   9 documentation into usr/share/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. However, if you need to have seperate copyright
  14 files for different binary packages, you can use files named
  15 debian/package.copyright.
  16 .P
  17 Any filenames specified as parameters will be installed into the first
  18 package dh_installdocs is told to act on. By default, this is the first
  19 binary package in debian/control, but if you use -p, -i, or -a flags, it
  20 will be the first package specified by those flags.
  21 .P
  22 Also, debian/README.Debian (or debian/README.debian) and debian/TODO, if
  23 they exist, will be installed into the first binary package listed in
  24 debian/control, if dh_installdocs is acting on that package. Note that
  25 debian/TODO will be installed named TODO.Debian, if the package is not a
  26 debian native package. Also note that README.debian is installed as
  27 README.Debian, for consitency. Note that debian/package.README.Debian and
  28 debian/package.TODO can be used to specify files for subpackages.
  29 .P
  30 Files named debian/package.docs can list other files to be installed.
  31 .P
  32 This program will automatically generate postinst and prerm commands to
  33 maintain a compatibility symlink, /usr/doc/package, to the documentation in
  34 /usr/share/doc/package. See
  35 .BR dh_installdeb (1)
  36 for an explanation of how this works.
  37 .P
  38 Files named debian/package.doc-base, will be installed as doc-base control
  39 files, and will make this program automatically generate the postinst and
  40 prerm commands needed to interface with the doc-base package. See
  41 .BR dh_installdeb (1)
  42 for an explanation of how this works.
  43 Note that the doc-id will be determined from the "Document:" entry in the
  44 doc-base control file in question.
  45 .PP
  46 If your package needs to register more
  47 than one document, you need multiple files. To accomplish this, you can use
  48 files named debian/package.doc-base.*
  49 .SH OPTIONS
  50 .TP
  51 .B debhelper options
  52 See
  53 .BR debhelper (1)
  54 for a list of options common to all debhelper commands.
  55 .TP
  56 .B \-A, \--all
  57 Install all files specified by command line parameters in ALL packages
  58 acted on.
  59 .TP
  60 .B \-n, \--noscripts
  61 Do not modify postinst/prerm scripts.
  62 .TP
  63 .B file ...
  64 Install these files as documentation into the first package acted on. (Or in
  65 all packages if -A is specified).
  66 .SH NOTES
  67 Note that dh_installdocs will happily copy entire directory hierarchies if
  68 you ask it to (it uses cp -a internally). If it is asked to install a
  69 directory, it will install the complete contents of the directory.
  70 .P
  71 Note that this command is not idempotent. "dh_clean -k" should be called
  72 between invocations of this command. Otherwise, it may cause multiple
  73 instances of the same text to be added to maintainer scripts.
  74 .SH ENVIRONMENT
  75 See
  76 .BR debhelper (1)
  77 for a list of environment variables that affect all debhelper commands.
  78 .SH "SEE ALSO"
  79 .BR debhelper (1)
  80 .TP
  81 .BR install-docs (8)
  82 .SH BUGS
  83 It's impossible to specify filenames with spaces or other whitespace in them
  84 in debian/package.docs file. This is more a historical design flaw than a bug.
  85 .SH "CONFORMS TO"
  86 Debian policy, version 3.0.1
  87 .SH AUTHOR
  88 Joey Hess <joeyh@debian.org>