.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "DH_INSTALLDOCS 1" .TH DH_INSTALLDOCS 1 "2017-01-25" "10.2.5" "Debhelper" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" dh_installdocs \- install documentation into package build directories .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBdh_installdocs\fR [\fIdebhelper options\fR] [\fB\-A\fR] [\fB\-X\fR\fIitem\fR] [\fIfile\fR ...] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBdh_installdocs\fR is a debhelper program that is responsible for installing documentation into \fIusr/share/doc/package\fR in package build directories. .SH "FILES" .IX Header "FILES" .IP "debian/\fIpackage\fR.docs" 4 .IX Item "debian/package.docs" List documentation files to be installed into \fIpackage\fR. .Sp In compat 11 (or later), these will be installed into \&\fI/usr/share/doc/mainpackage\fR. Previously it would be \&\fI/usr/share/doc/package\fR. .IP "\fIdebian/copyright\fR" 4 .IX Item "debian/copyright" The copyright file is installed into all packages, unless a more specific copyright file is available. .IP "debian/\fIpackage\fR.copyright" 4 .IX Item "debian/package.copyright" .PD 0 .IP "debian/\fIpackage\fR.README.Debian" 4 .IX Item "debian/package.README.Debian" .IP "debian/\fIpackage\fR.TODO" 4 .IX Item "debian/package.TODO" .PD Each of these files is automatically installed if present for a \&\fIpackage\fR. .IP "\fIdebian/README.Debian\fR" 4 .IX Item "debian/README.Debian" .PD 0 .IP "\fIdebian/TODO\fR" 4 .IX Item "debian/TODO" .PD These files are installed into the first binary package listed in debian/control. .Sp Note that \fI\s-1README\s0.debian\fR files are also installed as \fI\s-1README\s0.Debian\fR, and \fI\s-1TODO\s0\fR files will be installed as \fI\s-1TODO\s0.Debian\fR in non-native packages. .IP "debian/\fIpackage\fR.doc\-base" 4 .IX Item "debian/package.doc-base" Installed as doc-base control files. Note that the doc-id will be determined from the \fBDocument:\fR entry in the doc-base control file in question. In the event that multiple doc-base files in a single source package share the same doc-id, they will be installed to usr/share/doc\-base/package instead of usr/share/doc\-base/doc\-id. .IP "debian/\fIpackage\fR.doc\-base.*" 4 .IX Item "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. In the event that multiple doc-base files of this style in a single source package share the same doc-id, they will be installed to usr/share/doc\-base/package\-* instead of usr/share/doc\-base/doc\-id. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-A\fR, \fB\-\-all\fR" 4 .IX Item "-A, --all" Install all files specified by command line parameters in \s-1ALL\s0 packages acted on. .IP "\fB\-X\fR\fIitem\fR, \fB\-\-exclude=\fR\fIitem\fR" 4 .IX Item "-Xitem, --exclude=item" Exclude files that contain \fIitem\fR anywhere in their filename from being installed. Note that this includes doc-base files. .IP "\fB\-\-link\-doc=\fR\fIpackage\fR" 4 .IX Item "--link-doc=package" Make the documentation directory of all packages acted on be a symlink to the documentation directory of \fIpackage\fR. This has no effect when acting on \&\fIpackage\fR itself, or if the documentation directory to be created already exists when \fBdh_installdocs\fR is run. To comply with policy, \fIpackage\fR must be a binary package that comes from the same source package. .Sp debhelper will try to avoid installing files into linked documentation directories that would cause conflicts with the linked package. The \fB\-A\fR option will have no effect on packages with linked documentation directories, and \fIcopyright\fR, \fIchangelog\fR, \fI\s-1README\s0.Debian\fR, and \fI\s-1TODO\s0\fR files will not be installed. .Sp (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, before calling \fBdh_installdocs\fR.) .Sp \&\fB\s-1CAVEAT\s0\fR: If a previous version of the package was built without this option and is now built with it (or vice-versa), it requires a \*(L"dir to symlink\*(R" (or \*(L"symlink to dir\*(R") migration. Since debhelper has no knowledge of previous versions, you have to enable this migration itself. .Sp This can be done by providing a "debian/\fIpackage\fR.maintscript" file and using \fIdh_installdeb\fR\|(1) to provide the relevant maintainer script snippets. .IP "\fIfile\fR ..." 4 .IX Item "file ..." Install these files as documentation into the first package acted on. (Or in all packages if \fB\-A\fR is specified). .SH "EXAMPLES" .IX Header "EXAMPLES" This is an example of a \fIdebian/package.docs\fR file: .PP .Vb 6 \& README \& TODO \& debian/notes\-for\-maintainers.txt \& docs/manual.txt \& docs/manual.pdf \& docs/manual\-html/ .Ve .SH "NOTES" .IX Header "NOTES" Note that \fBdh_installdocs\fR will happily copy entire directory hierarchies if you ask it to (similar to \fBcp \-a\fR). If it is asked to install a directory, it will install the complete contents of the directory. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIdebhelper\fR\|(7) .PP This program is a part of debhelper. .SH "AUTHOR" .IX Header "AUTHOR" Joey Hess