.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "DH_INSTALLMAN 1" .TH DH_INSTALLMAN 1 "2022-11-26" "13.11.1~bpo11+1" "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_installman \- install man pages into package build directories .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBdh_installman\fR [\fIdebhelper options\fR] [\fImanpage\fR ...] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBdh_installman\fR is a debhelper program that handles installing man pages into the correct locations in package build directories. .PP In compat 10 and earlier, this program was primarily for when upstream's build system does not properly install them as a part of its install step (or it does not have an install step). In compat 11 and later, it also supports the default searchdir plus \-\-sourcedir like \fBdh_install\fR\|(1) and has the advantage that it respects the nodoc build profile (unlike \fBdh_install\fR\|(1)). .PP Even if you prefer to use \fBdh_install\fR\|(1) for installing the manpages, \&\fBdh_installman\fR can still be useful for converting the manpage encoding to \s-1UTF\-8\s0 and for converting \fI.so\fR links (as described below). However, that part happens automatically without any explicit configuration. .PP You tell \fBdh_installman\fR what man pages go in your packages, and it figures out where to install them based on the section field in their \fB.TH\fR or \&\fB.Dt\fR line. If you have a properly formatted \fB.TH\fR or \fB.Dt\fR line, your man page will be installed into the right directory, with the right name (this includes proper handling of pages with a subsection, like \fB3perl\fR, which are placed in \fIman3\fR, and given an extension of \&\fI.3perl\fR). If your \fB.TH\fR or \fB.Dt\fR line is incorrect or missing, the program may guess wrong based on the file extension. .PP It also supports translated man pages, by looking for extensions like \fI.ll.8\fR and \fI.ll_LL.8\fR, or by use of the \fB\-\-language\fR switch. .PP If \fBdh_installman\fR seems to install a man page into the wrong section or with the wrong extension, this is because the man page has the wrong section listed in its \fB.TH\fR or \fB.Dt\fR line. Edit the man page and correct the section, and \fBdh_installman\fR will follow suit. See \fBman\fR\|(7) for details about the \fB.TH\fR section, and \fBmdoc\fR\|(7) for the \fB.Dt\fR section. If \&\fBdh_installman\fR seems to install a man page into a directory like \fI/usr/share/man/pl/man1/\fR, that is because your program has a name like \fIfoo.pl\fR, and \fBdh_installman\fR assumes that means it is translated into Polish. Use \fB\-\-language=C\fR to avoid this. .PP After the man page installation step, \fBdh_installman\fR will check to see if any of the man pages in the temporary directories of any of the packages it is acting on contain \fI.so\fR links. If so, it changes them to symlinks. .PP Also, \fBdh_installman\fR will use man to guess the character encoding of each manual page and convert it to \s-1UTF\-8.\s0 If the guesswork fails for some reason, you can override it using an encoding declaration. See \&\fBmanconv\fR\|(1) for details. .PP From debhelper compatibility level 11 on, \fBdh_install\fR will fall back to looking in \fIdebian/tmp\fR for files, if it does not find them in the current directory (or wherever you've told it to look using \fB\-\-sourcedir\fR). .SH "FILES" .IX Header "FILES" .IP "debian/\fIpackage\fR.manpages" 4 .IX Item "debian/package.manpages" Lists man pages to be installed. .Sp Supports substitution variables in compat 13 and later as documented in \fBdebhelper\fR\|(7). .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\-\-language=\fR\fIll\fR" 4 .IX Item "--language=ll" Use this to specify that the man pages being acted on are written in the specified language. .IP "\fB\-\-sourcedir=\fR\fIdir\fR" 4 .IX Item "--sourcedir=dir" Look in the specified directory for files to be installed. This option requires compat 11 or later (it is silently ignored in compat 10 or earlier). .Sp Note that this is not the same as the \fB\-\-sourcedirectory\fR option used by the \fBdh_auto_\fR\fI*\fR commands. You rarely need to use this option, since \&\fBdh_installman\fR automatically looks for files in \fIdebian/tmp\fR in debhelper compatibility level 11 and above. .IP "\fImanpage\fR ..." 4 .IX Item "manpage ..." Install these man pages into the first package acted on. (Or in all packages if \fB\-A\fR is specified). .SH "EXAMPLES" .IX Header "EXAMPLES" An example \fIdebian/manpages\fR file could look like this: .PP .Vb 9 \& doc/man/foo.1 \& # Translations \& doc/man/foo.da.1 \& doc/man/foo.de.1 \& doc/man/foo.fr.1 \& # NB: The following line is considered a polish translation \& # of "foo.1" (and not a manpage written in perl called "foo.pl") \& doc/man/foo.pl.1 \& # ... .Ve .SH "NOTES" .IX Header "NOTES" An older version of this program, \fBdh_installmanpages\fR\|(1), is still used by some packages, and so is still included in debhelper. It is, however, deprecated, due to its counterintuitive and inconsistent interface. Use this program instead. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBdebhelper\fR\|(7) .PP This program is a part of debhelper. .SH "AUTHOR" .IX Header "AUTHOR" Joey Hess