r1010: This commit was manufactured by cvs2svn to create tag

[debhelper.git] / dh_installchangelogs.1

diff --git a/dh_installchangelogs.1 b/dh_installchangelogs.1
index 2371af17a847b79ecf5e1659379e5f94f5fc669b..b346eef703238e5df78c7a78ee2c9ee38cf4f010 100644 (file)
--- a/dh_installchangelogs.1
+++ b/dh_installchangelogs.1
@@ -1,9 +1,9 @@
-.TH DH_INSTALLCHANGELOGS 1
+.TH DH_INSTALLCHANGELOGS 1 "" "Debhelper Commands" "Debhelper Commands"
 .SH NAME
 dh_installchangelogs \- install changelogs into package build directories
 .SH SYNOPSIS
 .B dh_installchangelogs
-.I "[-v] [-a] [-i] [-ppackage] upstream"
+.I "[debhelper options] [-k] [upstream]"
 .SH "DESCRIPTION"
 dh_installchangelogs is a debhelper program that is responsible for installing
 changelogs into package build directories.
@@ -11,42 +11,42 @@ changelogs into package build directories.
 dh_installchangelogs determines if the package is a debian native package,
 and if so, it installs debian/changelog into usr/doc/package/changelog in
 the package build directory. Otherwise, it installs debian/changelog into
-usr/doc/package/changelog.Debian in the package build directory.
+usr/doc/package/changelog.Debian in the package build directory. (If files
+named debian/package.changelog exist, they will be used in preference to
+debian/changelog.)
 .P
 If an upstream changelog file is specified as an option, and the package is
 not a native debian package, then this upstream changelog will be installed
-as usr/doc/package/changelog in the package build directory.
+as usr/doc/package/changelog in the package build directory. If the
+changelog is a html file (determined by file extention), it will be
+installed as usr/doc/package/changelog.html instead (with a link to
+usr/doc/package/changelog).
 .SH OPTIONS
 .TP
-.B \-v
-Verbose mode; show all commands that modify the package build directory.
+.B debhelper options
+See
+.BR debhelper (1)
+for a list of options common to all debhelper commands.
 .TP
-.B \-a
-Install changelogs for all architecture dependent packages.
+.B \-k, \--keep
+Keep the original name of the upstream changelog. This will be accomplished
+by installing the upstream changelog as "changelog", and making a symlink from
+that to the original name of the changelog file. This can be useful if the
+upstream changelog has an unusual name, or if other documentation in the
+package refers to the changelog file.
 .TP
-.B \-i
-Install changelogs for all architecture independent packages.
-.TP
-.B \-ppackage
-Install changelogs for the package named "package".
+.B upstream
+Install this file as the upstream changelog.
 .SH NOTES
-The
-.B \-a
-.B \-i
-and
-.B \-p
-arguments are cumulative. If none are specified, then all packages listed in
-the control file will have the changelogs installed into them.
-.P
 It is an error to specify an upstream changelog file for a debian native
 package.
 .SH ENVIRONMENT
-.TP
-.I DH_VERBOSE
-Enables verbose mode
+See
+.BR debhelper (1)
+for a list of environment variables that affect all debhelper commands.
 .SH "SEE ALSO"
-.BR /usr/doc/debhelper/README
+.BR debhelper (1)
 .SH "CONFORMS TO"
-Debian policy, version 2.3.0.0
+Debian policy, version 2.5.0.0
 .SH AUTHOR
 Joey Hess <joeyh@master.debian.org>