-dh_installdocs is a debhelper program that is responsible for installing
-documentation into usr/share/doc/package in package build directories.
+B<dh_installdocs> is a debhelper program that is responsible for installing
+documentation into F<usr/share/doc/package> in package build directories.
-Each of these files is automatically installed if present. Use the package
-specific name if I<package> needs a different version of the file.
+Each of these files is automatically installed if present for a
+I<package>.
+
+=item F<debian/README.Debian>
+
+=item F<debian/TODO>
+
+These files are installed into the first binary package listed in
+debian/control.
-Note that debian/README.debian is also installed as README.Debian,
-and debian/TODO will be installed as TODO.Debian in non-native packages.
+Note that F<README.debian> files are also installed as F<README.Debian>,
+and F<TODO> files will be installed as F<TODO.Debian> in non-native packages.
debhelper will try to avoid installing files into linked documentation
directories that would cause conflicts with the linked package. The B<-A>
option will have no effect on packages with linked documentation
debhelper will try to avoid installing files into linked documentation
directories that would cause conflicts with the linked package. The B<-A>
option will have no effect on packages with linked documentation
-directories, and copyright, changelog, README.Debian, and TODO files will
+directories, and F<copyright>, F<changelog>, F<README.Debian>, and F<TODO> files will
not be installed.
(An older method to accomplish the same thing, which is still supported,
is to make the documentation directory of a package be a dangling symlink,
not be installed.
(An older method to accomplish the same thing, which is still supported,
is to make the documentation directory of a package be a dangling symlink,
Install these files as documentation into the first package acted on. (Or
in all packages if B<-A> is specified).
Install these files as documentation into the first package acted on. (Or
in all packages if B<-A> is specified).
-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
+Note that B<dh_installdocs> will happily copy entire directory hierarchies if
+you ask it to (similar to B<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. L<dh_prep(1)> should be called
directory, it will install the complete contents of the directory.
Note that this command is not idempotent. L<dh_prep(1)> should be called