dh: Remove duplicate dh_installcatalogs list. Closes: #545483 (It was only run once...

[debhelper.git] / debhelper.pod

diff --git a/debhelper.pod b/debhelper.pod
index b67ec950f77ddb3eb3980ffec03e644cb968f58a..a903620ce94311adb4528d375a41cba0490928b3 100644 (file)
--- a/debhelper.pod
+++ b/debhelper.pod
@@ -17,9 +17,8 @@ policy changes, and packages that use them will require only a rebuild to
 comply with the new policy.
 
 A typical debian/rules file that uses debhelper will call several debhelper
 comply with the new policy.
 
 A typical debian/rules file that uses debhelper will call several debhelper

-commands in sequence. Debhelper commands are all named with a "dh_" prefix.
-Examples of rules files that use debhelper are in
-F</usr/share/doc/debhelper/examples/>
+commands in sequence, or use L<dh(1)> to automate this process. Examples of
+rules files that use debhelper are in F</usr/share/doc/debhelper/examples/>

 
 To create a new debian package using debhelper, you can just copy one of
 the sample rules files and edit it by hand. Or you can try the dh-make
 
 To create a new debian package using debhelper, you can just copy one of
 the sample rules files and edit it by hand. Or you can try the dh-make


@@ -63,9 +62,10 @@ debian/control, debhelper will use debian/foo if no debian/package.foo
 file can be found.
 
 In some rare cases, you may want to have different versions of these files
 file can be found.
 
 In some rare cases, you may want to have different versions of these files

-for different architectures. If files named debian/package.foo.arch
-exist, where "arch" is the same as the output of 
-"dpkg-architecture -qDEB_HOST_ARCH",
+for different architectures or OSes. If files named debian/package.foo.ARCH
+or debian/package.foo.OS exist, where "ARCH" and "OS" are the same as the
+output of  "dpkg-architecture -qDEB_HOST_ARCH" /
+"dpkg-architecture -qDEB_HOST_ARCH_OS",

 then they will be used in preference to other, more general files.
 
 In many cases, these config files are used to specify various types of
 then they will be used in preference to other, more general files.
 
 In many cases, these config files are used to specify various types of


@@ -93,7 +93,8 @@ will output what it would have done.
 
 =item B<-a>, B<--arch>
 
 
 =item B<-a>, B<--arch>
 

-Act on all architecture dependent packages.
+Act on architecture dependent packages that should be built for the
+build architecture.

 
 =item B<-i>, B<--indep>
 
 
 =item B<-i>, B<--indep>
 


@@ -106,19 +107,22 @@ times to make debhelper operate on a given set of packages.
 
 =item B<-s>, B<--same-arch>
 
 
 =item B<-s>, B<--same-arch>
 

-This is a smarter version of the -a flag, that is used in some rare
-circumstances. It understands that if the control file lists "Architecture: i386"
-for the package, the package should not be acted on on other architectures. So
-this flag makes the command act on all "Architecture: any" packages, as well
-as on any packages that have the current architecture explicitly specified.
-Contrast to the -a flag, which makes the command work on all packages that
-are not architecture independent.
+This used to be a smarter version of the -a flag, but the -a flag is now
+equally smart.

 
 =item B<-N>I<package>, B<--no-package=>I<package>
 
 Do not act on the specified package even if an -a, -i, or -p option lists
 the package as one that should be acted on.
 
 
 =item B<-N>I<package>, B<--no-package=>I<package>
 
 Do not act on the specified package even if an -a, -i, or -p option lists
 the package as one that should be acted on.
 

+=item B<--remaining-packages>
+
+Do not act on the packages which have already been acted on by this debhelper
+command earlier (i.e. if the command is present in the package debhelper log).
+For example, if you need to call the command with special options only for a
+couple of binary packages, pass this option to the last call of the command to
+process the rest of packages with default settings. 
+

 =item B<--ignore=>I<file>
 
 Ignore the specified file. This can be used if debian/ contains a debhelper
 =item B<--ignore=>I<file>
 
 Ignore the specified file. This can be used if debian/ contains a debhelper


@@ -166,6 +170,50 @@ in ALL packages acted on, not just the first.
 
 =back
 
 
 =back
 

+=head1 BUILD SYSTEM OPTIONS
+
+The following command line options are supported by all of the dh_auto_*
+debhelper programs. These programs support a variety of build systems,
+and normally heuristically determine which to use, and how to use them.
+You can use these command line options to override the default behavior.
+
+=over 4
+
+=item B<-S>I<buildsystem>, B<--buildsystem=>I<buildsystem>
+
+Force use of the specified I<buildsystem>, instead of trying to auto-select
+one which might be applicable for the package.
+
+=item B<-D>I<directory>, B<--sourcedirectory=>I<directory>
+
+Assume that the original package source tree is at the specified
+I<directory> rather than the top level directory of the Debian
+source package tree.
+
+=item B<-B>[I<directory>], B<--builddirectory>=[I<directory>]
+
+Enable out of source building and use the specified I<directory> as the build
+directory. If I<directory> parameter is omitted, a default build directory
+will chosen.
+
+If this option is not specified, building will be done in source by default
+unless the build system requires or prefers out of source tree building.
+In such a case, the default build directory will be used even if
+L<--builddirectory> is not specified.
+
+If the build system prefers out of source tree building but still
+allows in source building, the latter can be re-enabled by passing a build
+directory path that is the same as the source directory path.
+
+=item B<--list>, B<-l>
+
+List all build systems supported by debhelper on this system. The list
+includes both default and third party build systems (marked as such). Also
+shows which build system would be automatically selected, or which one
+is manually specified with the I<--buildsystem> option.
+
+=back
+

 =head1 NOTES
 
 =head2 Multiple binary package support
 =head1 NOTES
 
 =head2 Multiple binary package support


@@ -184,9 +232,6 @@ B<-a>, B<-i>, B<-p>, and B<-s> parameters. These parameters are cumulative.
 If none are given, debhelper programs default to acting on all packages listed
 in the control file.
 
 If none are given, debhelper programs default to acting on all packages listed
 in the control file.
 

-See F</usr/share/doc/debhelper/examples/rules.multi> for an example of how to
-use this in a package that generates multiple binary packages.
-

 =head2 Automatic generation of debian install scripts
 
 Some debhelper commands will automatically generate parts of debian
 =head2 Automatic generation of debian install scripts
 
 Some debhelper commands will automatically generate parts of debian


@@ -256,9 +301,9 @@ introduced. You tell debhelper which compatibility level it should use, and
 it modifies its behavior in various ways.
 
 Tell debhelper what compatibility level to use by writing a number to
 it modifies its behavior in various ways.
 
 Tell debhelper what compatibility level to use by writing a number to

-debian/compat. For example, to turn on V5 mode:
+debian/compat. For example, to turn on V7 mode:

 
 

-  % echo 5 > debian/compat
+  % echo 7 > debian/compat

 
 Unless otherwise indicated, all debhelper documentation assumes that you
 are using the most recent compatibility level, and in most cases does not
 
 Unless otherwise indicated, all debhelper documentation assumes that you
 are using the most recent compatibility level, and in most cases does not


@@ -337,6 +382,8 @@ dh_link will correct existing links to conform with policy.
 
 =back
 
 
 =back
 

+This mode is deprecated.
+

 =item V5
 
 Changes from V4 are:
 =item V5
 
 Changes from V4 are:


@@ -370,8 +417,8 @@ Changes from V5 are:
 
 =item -
 
 
 =item -
 

-Commands that generate maintainer script fragements will order the
-fragements in reverse order for the prerm and postrm scripts.
+Commands that generate maintainer script fragments will order the
+fragments in reverse order for the prerm and postrm scripts.

 
 =item -
 
 
 =item -
 


@@ -388,7 +435,7 @@ DH_ALWAYS_EXCLUDE, if it was set to a list of things to exclude, such as
 =item -
 
 dh_installman allows overwriting existing man pages in the package build
 =item -
 
 dh_installman allows overwriting existing man pages in the package build

-directory. In previous compatability levels it silently refuses to do this.
+directory. In previous compatibility levels it silently refuses to do this.

 
 =back
 
 
 =back
 


@@ -402,10 +449,23 @@ Changes from V6 are:
 
 =item -
 
 
 =item -
 

-dh_install, if --sourcedir is not specified, will first look for files in
-debian/tmp, and then will look in the current directory. This allows
-dh_install to interoperate with dh_auto_install without needing any special
-parameters.
+dh_install, will fall back to looking for files in debian/tmp if it doesn't
+find them in the current directory (or wherever you tell it look using
+--sourcedir). This allows dh_install to interoperate with dh_auto_install,
+which installs to debian/tmp, without needing any special parameters.
+
+=item -
+
+dh_clean will read debian/clean and delete files listed there.
+
+=item -
+
+dh_clean will delete toplevel *-stamp files.
+
+=item -
+
+dh_installchangelogs will guess at what file is the upstream changelog if
+none is specified.

 
 =back
 
 
 =back
 


@@ -443,9 +503,9 @@ Once your package uses debhelper to build, be sure to add
 debhelper to your Build-Depends line in debian/control. You should
 build-depend on a version of debhelper equal to (or greater than) the
 debhelper compatibility level your package uses. So if your package used
 debhelper to your Build-Depends line in debian/control. You should
 build-depend on a version of debhelper equal to (or greater than) the
 debhelper compatibility level your package uses. So if your package used

-compatibility level 6:
+compatibility level 7:

 
 

-  Build-Depends: debhelper (>= 6)
+  Build-Depends: debhelper (>= 7)

 
 =head1 ENVIRONMENT
 
 
 =head1 ENVIRONMENT
 


@@ -468,10 +528,13 @@ Set to 1 to enable no-act mode.
 =item DH_OPTIONS
 
 Anything in this variable will be prepended to the command line arguments
 =item DH_OPTIONS
 
 Anything in this variable will be prepended to the command line arguments

-of all debhelper commands. This is useful in some situations, for example,
-if you need to pass -p to all debhelper commands that will be run. One good
-way to set DH_OPTIONS is by using "Target-specific Variable Values" in your
-debian/rules file. See the make documentation for details on doing this.
+of all debhelper commands. Command-specific options will be ignored by 
+commands that do not support them. 
+
+This is useful in some situations, for example, if you need to pass -p to
+all debhelper commands that will be run. One good way to set DH_OPTIONS is
+by using "Target-specific Variable Values" in your debian/rules file. See
+the make documentation for details on doing this.

 
 =item DH_ALWAYS_EXCLUDE
 
 
 =item DH_ALWAYS_EXCLUDE