doc/PROGRAMMING

   1 This file documents things you should know to write a new debhelper program.
   2 Any program with a name that begins with dh_ should conform to these
   3 guidelines (with the historical exception of dh_make).
   4
   5 Standardization:
   6 ---------------
   7
   8 There are lots of debhelper commands. To make the learning curve shallower,
   9 I want them all to behave in a standard manner:
  10
  11 All debhelper programs have names beginning with "dh_". This is so we don't
  12 pollute the name space too much.
  13
  14 Debhelper programs should never output anything to standard output except
  15 error messages, important warnings, and the actual commands they run that
  16 modify files under debian/ (this last only if they are passed -v, and if you
  17 output the commands, you should indent them with 1 tab). This is so we don't
  18 have a lot of noise output when all the debhelper commands in a debian/rules
  19 are run, so the important stuff is clearly visible.
  20
  21 Debhelper programs should accept all options listed in the "SHARED
  22 DEBHELPER OPTIONS" section of debhelper(7), including any long forms of
  23 these options, like --verbose . If necessary, the options may be ignored.
  24
  25 If debhelper commands need config files, they should use
  26 debian/package.filename as the name of the config file (replace filename
  27 with whatever your command wants), and debian/filename should also be
  28 checked for config information for the first binary package in
  29 debian/control. Also, debhelper commands should accept the same sort of
  30 information that appears in the config files, on their command lines, if
  31 possible, and apply that information to the first package they act on.
  32 The config file format should be as simple as possible, generally just a
  33 list of files to act on.
  34
  35 Debhelper programs should never modify the debian/postinst, debian/prerm,
  36 etc scripts. Instead, they can add lines to debian/postinst.debhelper, etc.
  37 The autoscript() function (see below) is one easy way to do this.
  38 dh_installdeb is an exception, it will run after the other commands and
  39 merge these modifications into the actual postinst scripts.
  40
  41 In general, files named debian/*.debhelper are internal to debhelper, and
  42 their existence or use should not be relied on by external programs such as
  43 the build process of a package. These files will be deleted by dh_clean.
  44
  45 Debhelper programs should default to doing exactly what policy says to do.
  46
  47 There are always exceptions. Just ask me.
  48
  49 Introducing Dh_Lib.pm:
  50 ---------------------
  51
  52 Dh_Lib.pm is the library used by all debhelper programs to parse their
  53 arguments and set some useful variables. It's not mandatory that your
  54 program use Dh_Lib.pm, but it will make it a lot easier to keep it in sync
  55 with the rest of debhelper if it does, so this is highly encouraged.
  56
  57 (There used to be a version of Dh_lib.pm that was a library of functions for
  58 shell scripts. If you want to write a debhelper command that is a shell
  59 script, I can dig up that old library for you. Only the perl one is
  60 supported now, though.)
  61
  62 Use Dh_Lib.pm like this:
  63
  64 use Debian::Debhelper::Dh_Lib
  65 init();
  66
  67 The BEGIN block is there to make perl look for the module in all the right
  68 places.
  69
  70 The init() function causes Dh_lib to parse the command line and do some other
  71 initialization tasks.
  72
  73 Argument processing:
  74 -------------------
  75
  76 All debhelper programs should respond to certain arguments, such as -v, -i,
  77 -a, and -p. To help you make this work right, Dh_Lib.pm handles argument
  78 processing. Just call init().
  79
  80 You can add support for additional options to your command by passing an
  81 options hash to init(). The hash is then passed on the Getopt::Long to
  82 parse the command line options. For example, to add a --foo option, which
  83 sets $dh{FOO}:
  84
  85 init(options => { foo => \$dh{FOO} });
  86
  87 After argument processing, some global variables are used to hold the
  88 results; programs can use them later. These variables are elements of the
  89 %dh hash.
  90
  91 switch          variable        description
  92 -v              VERBOSE         should the program verbosely output what it is
  93                                 doing?
  94 --no-act        NO_ACT          should the program not actually do anything?
  95 -i,-a,-p,-N     DOPACKAGES      a space delimited list of the binary packages
  96                                 to act on (in Dh_Lib.pm, this is an array)
  97 -i              DOINDEP         set if we're acting on binary independent
  98                                 packages
  99 -a              DOARCH          set if we're acting on binary dependent
 100                                 packages
 101 -n              NOSCRIPTS       if set, do not make any modifications to the
 102                                 package's postinst, postrm, etc scripts.
 103 -o              ONLYSCRIPTS     if set, only make modifications to the
 104                                 package's scripts, but don't look for or
 105                                 install associated files.
 106 -X              EXCLUDE         exclude a something from processing (you
 107                                 decide what this means for your program)
 108                                 (This is an array)
 109                 EXCLUDE_FIND    same as DH_EXCLUDE, except all items are put
 110                                 into a string in a way that they will make
 111                                 find find them. (Use ! in front to negate
 112                                 that, of course) Note that this should
 113                                 only be used inside complex_doit(), not in
 114                                 doit().
 115 -x              INCLUDE_CONFFILES
 116                                 include conffiles. It's -x for obscure
 117                                 historical reasons.
 118 -d              D_FLAG          you decide what this means to your program
 119 -r              R_FLAG          you decide what this means to your program
 120 -k              K_FLAG          you decide what this means to your program
 121 -P              TMPDIR          package build directory (implies only one
 122                                 package is being acted on)
 123 -u              U_PARAMS        will be set to a string, that is typically
 124                                 parameters your program passes on to some
 125                                 other program. (This is an array)
 126 -m              M_PARAMS        will be set to a string, you decide what it
 127                                 means to your program
 128 -l              L_PARAMS        will be set to a string, you decide what it
 129                                 means to your program
 130 -V              V_FLAG          will be set to a string, you decide what it
 131                                 means to your program
 132 -V              V_FLAG_SET      will be 1 if -V was specified, even if no
 133                                 parameters were passed along with the -V
 134 -A              PARAMS_ALL      generally means that additional command line
 135                                 parameters passed to the program (other than
 136                                 those processed here), will apply to all
 137                                 binary packages the program acts on, not just
 138                                 the first
 139 --init-script   INIT_SCRIPT     will be set to a string, which specifies an
 140                                 init script name (probably only
 141                                 dh_installinit will ever use this)
 142 --sourcedir     SOURCEDIR       will be set to a string (probably only
 143                                 dh_movefiles will ever use this)
 144 --destdir       DESTDIR         will be set to a string (probably only
 145                                 dh_builddeb will ever use this)
 146 --filename      FILENAME        will be set to a string
 147 --flavor        FLAVOR          will be set to a string (probably only
 148                                 dh_installemacsen will ever use this)
 149 --number        PRIORITY        will be set to a number (deprecated)
 150 --priority      PRIORITY        will be set to a number
 151 --name          NAME            a name to use for installed files, instead of
 152                                 the package name
 153 --error-handler ERROR_HANDLER   a function to call on error
 154 --language      LANGUAGE        specify what language a file is in
 155 --add-udeb      SHLIBS_UDEB     used by dh_makeshlibs
 156
 157 Any additional command line parameters that do not start with "-" will be
 158 ignored, and you can access them later just as you normally would.
 159
 160 Global variables:
 161 ----------------
 162
 163 The following keys are also set in the %dh hash when you call init():
 164
 165 MAINPACKAGE     the name of the first binary package listed in
 166                 debian/control
 167 FIRSTPACKAGE    the first package we were instructed to act on. This package
 168                 typically gets special treatment; additional arguments
 169                 specified on the command line may effect it.
 170
 171 Functions:
 172 ---------
 173
 174 Dh_Lib.pm also contains a number of functions you may find useful.
 175
 176 doit(@command)
 177         Pass this function an array that is a
 178         shell command. It will run the command (unless $dh{NO_ACT} is set), and
 179         if $dh{VERBOSE} is set, it will also output the command to stdout. You
 180         should use this function for almost all commands your program performs
 181         that manipulate files in the package build directories.
 182 complex_doit($command)
 183         Pass this function a string that is a shell command, it will run it
 184         similarly to how doit() does. You can pass more complicated commands
 185         to this (ie, commands involving piping redirection), however, you
 186         have to worry about things like escaping shell metacharacters.
 187 verbose_print($message)
 188         Pass this command a string, and it will echo it if $dh{VERBOSE} is set.
 189 error($errormsg)
 190         Pass this command a string, it will output it to standard error and
 191         exit.
 192 warning($message)
 193         Pass this command a string, and it will output it to standard error
 194         as a warning message.
 195 tmpdir($dir)
 196         Pass this command the name of a binary package, it will return the
 197         name of the tmp directory that will be used as this package's
 198         package build directory. Typically, this will be "debian/package".
 199 compat($num)
 200         Pass this command a number, and if the current compatibility level
 201         is less than or equal to that number, it will return true.
 202         Looks at DH_COMPAT to get the compatibility level.
 203 pkgfile($package, $basename)
 204         Pass this command the name of a binary package, and the base name of a
 205         file, and it will return the actual filename to use. This is used
 206         for allowing debhelper programs to have configuration files in the
 207         debian/ directory, so there can be one config file per binary
 208         package. The convention is that the files are named
 209         debian/package.filename, and debian/filename is also allowable for
 210         the $dh{MAINPACKAGE}. If the file does not exist, nothing is returned.
 211 pkgext($package)
 212         Pass this command the name of a binary package, and it will return
 213         the name to prefix to files in debian/ for this package. For the
 214         $dh{MAINPACKAGE}, it returns nothing (there is no prefix), for the other
 215         packages, it returns "package.".
 216 isnative($package)
 217         Pass this command the name of a package, it returns 1 if the package
 218         is a native debian package.
 219         As a side effect, $dh{VERSION} is set to the version number of the
 220         package.
 221 autoscript($package, $scriptname, $snippetname, $sedcommands)
 222         Pass parameters:
 223          - binary package to be affected
 224          - script to add to
 225          - filename of snippet
 226          - sed commands to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
 227            (optional)
 228         This command automatically adds shell script snippets to a debian
 229         maintainer script (like the postinst or prerm).
 230         Note that in v6 mode and up, the snippets are added in reverse
 231         order for the removal scripts.
 232 dirname($pathname)
 233         Return directory part of pathname.
 234 basename($pathname)
 235         Return base of pathname,
 236 addsubstvar($package, $substvar, $deppackage, $verinfo, $remove)
 237         This function adds a dependency on some package to the specified
 238         substvar in a package's substvar's file. It needs all these
 239         parameters:
 240         - binary package that gets the item
 241         - name of the substvar to add the item to
 242         - the package that will be depended on
 243         - version info for the package (optional) (ie: ">= 1.1")
 244         - if this last parameter is passed, the thing that would be added
 245           is removed instead. This can be useful to ensure that a debhelper
 246           command is idempotent. Note that without this parameter, if you
 247           call the function twice with the same values it will only add one
 248           item to the substvars file.
 249 delsubstvar($package, $substvar)
 250         This function removes the entire line for the substvar from the
 251         package's shlibs file.
 252 excludefile($filename)
 253         This function returns true if -X has been used to ask for the file
 254         to be excluded.
 255 is_udeb($package)
 256         Returns true if the package is marked as a udeb in the control
 257         file.
 258 udeb_filename($package)
 259         Returns the filename of the udeb package.
 260 getpackages($type)
 261         Returns a list of packages in the control file.
 262         Must pass "arch" or "indep" or "same" to specify arch-dependent or
 263         -independent or same arch packages. If nothing is specified, returns all
 264         packages.
 265         As a side effect, populates %package_arches and %package_types with
 266         the types of all packages (not only those returned).
 267 inhibit_log()
 268         Prevent logging the program's successful finish to
 269         debian/*debhelper.log
 270
 271 -- Joey Hess <joeyh@debian.org>