summaryrefslogtreecommitdiff
path: root/dh_installdebconf
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2009-09-04 16:50:49 -0400
committerJoey Hess <joey@gnu.kitenet.net>2009-09-04 16:50:49 -0400
commita243946176b92b5fafd84f43d5a455551cf27210 (patch)
tree843f96a23362676a098a5b06584c3525ecea383a /dh_installdebconf
parent6951ac79834dc1fe44b235d0863e282af2e08db0 (diff)
Add FILES sections to man pages. Closes: #545041
Diffstat (limited to 'dh_installdebconf')
-rwxr-xr-xdh_installdebconf45
1 files changed, 28 insertions, 17 deletions
diff --git a/dh_installdebconf b/dh_installdebconf
index f12c7da..ff49f8e 100755
--- a/dh_installdebconf
+++ b/dh_installdebconf
@@ -16,36 +16,47 @@ B<dh_installdebconf> [S<I<debhelper options>>] [B<-n>] [S<B<--> I<params>>]
=head1 DESCRIPTION
dh_installdebconf is a debhelper program that is responsible for installing
-files used by the debconf package into package build directories.
+files used by debconf into package build directories.
It also automatically generates the postrm commands needed to interface
with debconf. The commands are added to the maintainer scripts by
dh_installdeb. See L<dh_installdeb(1)> for an explanation of how that
works.
-Files named debian/package.config and debian/package.templates are
-installed into the DEBIAN directory in the package build directory.
-If a file named debian/package.config.debhelper exists, the contents
-of that file are merged into the config script as follows: If the script
-exists, then anywhere in it that "#DEBHELPER#" appears, the text of the
-.debhelper file is inserted. If the script does not exist, then a script
-is generated from the .debhelper file. The .debhelper files may be created
-by other debhelper programs, and are shell script fragments.
-
Note that if you use debconf, your package probably needs to depend on it
(it will be added to ${misc:Depends} by this program).
Note that for your config script to be called by dpkg, your postinst
needs to source debconf's confmodule. dh_installdebconf does not
-install this statement into postinst automatically as it it too hard to
-do it right.
+install this statement into the postinst automatically as it it too
+hard to do it right.
+
+=head1 FILES
+
+=over 4
+
+=item debian/I<package>.config
+
+This is the debconf config script, and is installed into the DEBIAN
+directory in the package build directory.
-=head1 LOCALIZED TEMPLATE FILES
+Inside the script, the token B<#DEBHELPER#> is replaced with
+shell script snippets generated by other debhelper commands.
-This program will look to see if you have a debian/po directory and if so
-will automatically call L<po2debconf(1)> to generate a merged templates
-file containing the translations. For this to work, your package should
-build-depend on po-debconf.
+=item debian/I<package>.templates
+
+This is the debconf templates file, and is installed into the DEBIAN
+directory in the package build directory.
+
+=item debian/po/
+
+If this directory is present, this program will automatically use
+L<po2debconf(1)> to generate merged templates
+files that include the translations from there.
+
+For this to work, your package should build-depend on po-debconf.
+
+=back
=head1 OPTIONS