Allow individual debhelper programs to define their own special options by passing...

[debhelper.git] / doc / PROGRAMMING

diff --git a/doc/PROGRAMMING b/doc/PROGRAMMING
index 97f85650f5c6bb2e420ac4cdc644f389e894cc0c..0d96457fff6cc4114d5726affe4082eef778ca0a 100644 (file)
--- a/doc/PROGRAMMING
+++ b/doc/PROGRAMMING
@@ -77,6 +77,13 @@ All debhelper programs should respond to certain arguments, such as -v, -i,
 -a, and -p. To help you make this work right, Dh_Lib.pm handles argument
 processing. Just call init().
 
+You can add support for additional options to your command by passing an
+options hash to init(). The hash is then passed on the Getopt::Long to
+parse the command line options. For example, to add a --foo option, which
+sets $dh{FOO}:
+
+init(options => { foo => \$dh{FOO} });
+
 After argument processing, some global variables are used to hold the
 results; programs can use them later. These variables are elements of the
 %dh hash.
@@ -150,8 +157,6 @@ switch              variable        description
 Any additional command line parameters that do not start with "-" will be 
 ignored, and you can access them later just as you normally would.
 
-If you need a new command line option, just ask me, and I will add it.
-
 Global variables:
 ----------------
 
@@ -259,5 +264,8 @@ getpackages($type)
        packages.
        As a side effect, populates %package_arches and %package_types with
        the types of all packages (not only those returned).
+inhibit_log()
+       Prevent logging the program's successful finish to
+       debian/*debhelper.log
 
 -- Joey Hess <joeyh@debian.org>