r1864: releasing version 5.0.19

[debhelper.git] / doc / PROGRAMMING

diff --git a/doc/PROGRAMMING b/doc/PROGRAMMING
index 239f53e757e6d122b162ac0150b72a1477b08eb9..bcdaef0c1a0b15aaad5c711443fb5f911952950e 100644 (file)
--- a/doc/PROGRAMMING
+++ b/doc/PROGRAMMING
@@ -40,7 +40,7 @@ merge these modifications into the actual postinst scripts.
 
 In general, files named debian/*.debhelper are internal to debhelper, and
 their existence or use should not be relied on by external programs such as
-the build process of a package.
+the build process of a package. These files will be deleted by dh_clean.
 
 Debhelper programs should default to doing exactly what policy says to do.
 
@@ -93,13 +93,18 @@ switch              variable        description
                                packages
 -n             NOSCRIPTS       if set, do not make any modifications to the 
                                package's postinst, postrm, etc scripts.
+-o             ONLYSCRIPTS     if set, only make modifications to the
+                               package's scripts, but don't look for or
+                               install associated files.
 -X             EXCLUDE         exclude a something from processing (you
                                decide what this means for your program)
                                (This is an array)
                 EXCLUDE_FIND   same as DH_EXCLUDE, except all items are put
                                into a string in a way that they will make
                                find find them. (Use ! in front to negate
-                               that, of course)
+                               that, of course) Note that this should
+                               only be used inside complex_doit(), not in
+                               doit().
 -x             INCLUDE_CONFFILES
                                include conffiles. It's -x for obscure
                                historical reasons.
@@ -138,6 +143,8 @@ switch              variable        description
 --priority     PRIORITY        will be set to a number
 --name         NAME            a name to use for installed files, instead of
                                the package name
+--error-handler        ERROR_HANDLER   a function to call on error
+--language     LANGUAGE        specify what language a file is in
 
 Any additional command line parameters that do not start with "-" will be 
 ignored, and you can access them later just as you normally would.
@@ -237,5 +244,17 @@ delsubstvar($package, $substvar)
 excludefile($filename)
        This function returns true if -X has been used to ask for the file
        to be excluded.
+is_udeb($package)
+       Returns true if the package is marked as a udeb in the control
+       file.
+udeb_filename($package)
+       Returns the filename of the udeb package.
+getpackages($type)
+       Returns a list of packages in the control file.
+       Must pass "arch" or "indep" or "same" to specify arch-dependent or
+       -independent or same arch packages. If nothing is specified, returns all
+       packages.
+       As a side effect, populates %package_arches and %package_types with
+       the types of all packages (not only those returned).
 
 -- Joey Hess <joeyh@debian.org>