.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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_INSTALLCHANGELOGS 1" .TH DH_INSTALLCHANGELOGS 1 2024-03-27 13.15.3 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_installchangelogs \- install changelogs into package build directories .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBdh_installchangelogs\fR [\fIdebhelper\ options\fR] [\fB\-k\fR] [\fB\-X\fR\fIitem\fR] [\fB\-\-no\-trim\fR] [\fIupstream\fR] .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBdh_installchangelogs\fR is a debhelper program that is responsible for installing changelogs into package build directories. .PP An upstream \fIchangelog\fR file may be specified as an option. If none is specified, \fBdh_installchangelogs\fR may look for files with names that seem likely to be changelogs as described in the next paragraphs. .PP In non-native packages, \fBdh_installchangelogs\fR will first look for changelog files installed by the upstream build system into \fIusr/share/doc/package\fR (of the package build directory) and rename the most likely candidate (if any) to \fIusr/share/doc/package/changelog\fR. Note that \&\fBdh_installchangelogs\fR does \fInot\fR look into any source directory (such as \fIdebian/tmp\fR). Otherwise, \fBdh_installchangelogs\fR (at compatibility level 7 or any later) will look for changelog files in the source directory (e.g. the root or the \fIdocs\fR subdirectory). It will look for \fIchangelog\fR, \fIchanges\fR and \fIhistory\fR optionally with common extensions (such as \fI.txt\fR, \fI.md\fR and \fI.rst\fR). .PP If a changelog file is specified and is an \fIhtml\fR file (determined by file extension), it will be installed as \fIusr/share/doc/package/changelog.html\fR instead. If the html changelog is converted to plain text, that variant can be specified as a second parameter. When no plain text variant is specified, a short \fIusr/share/doc/package/changelog\fR is generated, pointing readers at the html changelog file. .PP The \fBdebchange\fR\-style Debian changelogs are trimmed to include only entries more recent than the release date of \fIoldstable\fR. No trimming will be performed if the \fB\-\-no\-trim\fR option is passed or if the \fBDEB_BUILD_OPTIONS\fR environment variable contains \fBnotrimdch\fR. .SH FILES .IX Header "FILES" .IP \fIdebian/changelog\fR 4 .IX Item "debian/changelog" .PD 0 .IP \fIdebian/NEWS\fR 4 .IX Item "debian/NEWS" .IP debian/\fIpackage\fR.changelog 4 .IX Item "debian/package.changelog" .IP debian/\fIpackage\fR.NEWS 4 .IX Item "debian/package.NEWS" .PD Automatically installed into usr/share/doc/\fIpackage\fR/ in the package build directory. .Sp Use the package specific name if \fIpackage\fR needs a different \&\fINEWS\fR or \fIchangelog\fR file. .Sp The \fIchangelog\fR file is installed with a name of changelog for native packages, and \fIchangelog.Debian\fR for non-native packages. The \fINEWS\fR file is always installed with a name of \fINEWS.Debian\fR. .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-k\fR, \fB\-\-keep\fR" 4 .IX Item "-k, --keep" Keep the original name of the upstream changelog. This will be accomplished by installing the upstream changelog as \fIchangelog\fR, and making a symlink from that to the original name of the \fIchangelog\fR file. This can be useful if the upstream changelog has an unusual name, or if other documentation in the package refers to the \fIchangelog\fR file. .IP "\fB\-X\fR\fIitem\fR, \fB\-\-exclude=\fR\fIitem\fR" 4 .IX Item "-Xitem, --exclude=item" Exclude upstream \fIchangelog\fR files that contain \fIitem\fR anywhere in their filename from being installed. .Sp Note that directory name of the changelog is also part of the match. .IP \fB\-\-no\-trim\fR 4 .IX Item "--no-trim" Install the full changelog, not its trimmed version that includes only recent entries. .IP \fIupstream\fR 4 .IX Item "upstream" Install this file as the upstream changelog. .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