dh_installdocs


SYNOPSIS
       dh_installdocs [debhelperoptions] [-A] [-Xitem] [file...]

DESCRIPTION
       dh_installdocs is a debhelper program that is responsible for
       installing documentation into usr/share/doc/package in package build
       directories.

FILES
       debian/package.docs
           List documentation files to be installed into package.

       debian/copyright
           The copyright file is installed into all packages, unless a more
           specific copyright file is available.

       debian/package.copyright
       debian/package.README.Debian
       debian/package.TODO
           Each of these files is automatically installed if present for a
           package.

       debian/README.Debian
       debian/TODO
           These files are installed into the first binary package listed in
           debian/control.

           Note that README.debian files are also installed as README.Debian,
           and TODO files will be installed as TODO.Debian in non-native
           packages.

       debian/package.doc-base
           Installed as doc-base control files. Note that the doc-id will be
           determined from the Document: entry in the doc-base control file in
           question.

       debian/package.doc-base.*
           If your package needs to register more than one document, you need
           multiple doc-base files, and can name them like this.

OPTIONS
       -A, --all
           Install all files specified by command line parameters in ALL
           packages acted on.

       -Xitem, --exclude=item
           Exclude files that contain item anywhere in their filename from
           being installed. Note that this includes doc-base files.

       --link-doc=package
           Make the documentation directory of all packages acted on be a
           symlink to the documentation directory of package. This has no
           effect when acting on package itself, or if the documentation
           dangling symlink, before calling dh_installdocs.)

       file ...
           Install these files as documentation into the first package acted
           on. (Or in all packages if -A is specified).

EXAMPLES
       This is an example of a debian/package.docs file:

         README
         TODO
         debian/notes-for-maintainers.txt
         docs/manual.txt
         docs/manual.pdf
         docs/manual-html/

NOTES
       Note that dh_installdocs will happily copy entire directory hierarchies
       if you ask it to (similar to cp -a). If it is asked to install a
       directory, it will install the complete contents of the directory.

       Note that this command is not idempotent. dh_prep(1) should be called
       between invocations of this command. Otherwise, it may cause multiple
       instances of the same text to be added to maintainer scripts.

SEE ALSO
       debhelper(7)

       This program is a part of debhelper.

AUTHOR
       Joey Hess <joeyh@debian.org>



9.20120115ubuntu3                 2011-09-12                 DH_INSTALLDOCS(1)
Man Pages Copyright Respective Owners. Site Copyright (C) 1994 - 2017 Hurricane Electric. All Rights Reserved.