View Source: dh_installdocs(1) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages

DH_INSTALLDOCS
!!!DH_INSTALLDOCS
NAME
SYNOPSIS
DESCRIPTION
OPTIONS
NOTES
SEE ALSO
AUTHOR
----
!!NAME


dh_installdocs - install documentation into package build directories
!!SYNOPSIS


__dh_installdocs__ [[''debhelper options''] [[__-A__]
[[__-n__] [[__-X__''item''] [[''file
...'']
!!DESCRIPTION


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


dh_installdocs automatically installs debian/copyright if it
exists. If dh_installdocs is acting on multiple packages,
debian/copyright files will be installed into all packages.
However, if you need to have seperate copyright files for
different binary packages, you can use files named
debian/package.copyright.


Any filenames specified as parameters will be installed into
the first package dh_installdocs is told to act on. By
default, this is the first binary package in debian/control,
but if you use __-p__, __-i__, or __-a__ flags, it
will be the first package specified by those
flags.


Also, debian/README.Debian (or debian/README.debian) and
debian/TODO, if they exist, will be installed into the first
binary package listed in debian/control, if dh_installdocs
is acting on that package. Note that debian/TODO will be
installed named TODO .Debian, if the package
is not a debian native package. Also note that
README .debian is installed as
README .Debian, for consistency. Note that
debian/package.README.Debian and debian/package.TODO can be
used to specify files for subpackages.


Files named debian/package.docs can list other files to be
installed.


This program will automatically generate postinst and prerm
commands to maintain a compatibility symlink,
/usr/doc/package, to the documentation in
/usr/share/doc/package. See ''dh_installdeb''(1) for an
explanation of how this works.


Files named debian/package.doc-base, will be installed as
doc-base control files, and will make this program
automatically generate the postinst and prerm commands
needed to interface with the doc-base package. Note that the
doc-id will be determined from the ``Document:'' entry in
the doc-base control file in question.


If your package needs to register more than one document,
you need multiple files. To accomplish this, you can use
files named debian/package.doc-base.*
!!OPTIONS


__-A__, __--all__


Install all files specified by command line parameters in
ALL packages acted on.


__-n__, __--noscripts__


Do not modify postinst/prerm scripts.


__-Xitem__, __--exclude=item__


Exclude files that contain ``item'' anywhere in their
filename from being installed.


''file ...''


Install these files as documentation into the first package
acted on. (Or in all packages if __-A__ is
specified).
!!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.
-k__
__
!!SEE ALSO


debhelper(1)


This program is a part of debhelper.
!!AUTHOR


Joey Hess
----

2 pages link to dh_installdocs(1):

This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.

Last edited on Tuesday, June 4, 2002 12:21:54 am by "perry"

Edit PageHistory Diff Info LikePages