doc/PROGRAMMING

   1 This file documents things you should know to write a new debhelper program.
   2
   3 Standardization:
   4 ---------------
   5
   6 There are lots of debhelper commands. To make the learning curve shallower,
   7 I want them all to behave in a standard manner:
   8
   9 All debhelper programs have names beginning with "dh_". This is so we don't
  10 pollute the name space too much.
  11
  12 Debhelper programs should never output anything to standard output except
  13 error messages, important warnings, and the actual commands they run that
  14 modify files under debian/ (this last only if they are passed -v, and if you
  15 output the commands, you should indent them with 1 tab). This is so we don't
  16 have a lot of noise output when all the debhelper commands in a debian/rules
  17 are run, so the important stuff is clearly visible.
  18
  19 Debhelper programs should accept all options listed in the "SHARED
  20 DEBHELPER OPTIONS" section of debhelper(1), including and any long forms of
  21 these options, like --verbose . If necessary, the options may be ignored.
  22
  23 If debhelper commands need config files, they should use
  24 debian/package.filename as the name of the config file (replace filename
  25 with whatever your command wants), and debian/filename should also be
  26 checked for config information for the first binary package in
  27 debian/control. Also, debhelper commands should accept the same sort of
  28 information that appears in the config files, on their command lines, if
  29 possible, and apply that information to the first package they act on.
  30
  31 Debhelper programs should never modify the debian/postinst, debian/prerm,
  32 etc scripts, instead, they can add lines to debian/postinst.debhelper, etc.
  33 The autoscript() function (see below) is one easy way to do this.
  34 dh_installdeb is an exception, it will run after the other commands and
  35 merge these modifications into the actual postinst scripts.
  36
  37 Debhelper programs should default to doing exactly what policy says to do.
  38
  39 There are always exceptions. Just ask me.
  40
  41 Introducing Dh_Lib.pm:
  42 ---------------------
  43
  44 Dh_Lib.pm is the library used by all debhelper programs to parse their
  45 arguments and set some useful variables. It's not mandatory that your
  46 program use Dh_Lib.pm, but it will make it a lot easier to keep it in sync
  47 with the rest of debhelper if it does, so this is highly encouraged.
  48
  49 (There used to be a version of Dh_lib.pm that was a library of functions for
  50 shell scripts. If you want to write a debhelper command that is a shell
  51 script, I can dig up that old library for you. Only the perl one is
  52 supported now, though.)
  53
  54 Use Dh_Lib.pm like this:
  55
  56 use Debian::Debhelper::Dh_Lib
  57 init();
  58
  59 The BEGIN block is there to make perl look for the module in all the right
  60 places.
  61
  62 The init() function causes Dh_lib to parse the command line and do some other
  63 initialization tasks.
  64
  65 Argument processing:
  66 -------------------
  67
  68 All debhelper programs should respond to certain arguments, such as -v, -i,
  69 -a, and -p. To help you make this work right, Dh_Lib.pm handles argument
  70 processing. Just call init().
  71
  72 After argument processing, some global variables are used to hold the
  73 results; programs can use them later. These variables are elements of the
  74 %dh hash.
  75
  76 switch          variable        description
  77 -v              VERBOSE         should the program verbosely output what it is
  78                                 doing?
  79 --no-act        NO_ACT          should the program not actually do anything?
  80 -i,-a,-p,-N     DOPACKAGES      a space delimited list of the binary packages
  81                                 to act on (in Dh_Lib.pm, this is an array)
  82 -i,-p,-N        DOINDEP         a space delimited list of the binary independent
  83                                 packages to act on
  84 -a,-p,-N        DOARCH          a space delimited list of the binary dependent
  85                                 packages to act on
  86 -n              NOSCRIPTS       if set, do not make any modifications to the
  87                                 package's postinst, postrm, etc scripts.
  88 -X              EXCLUDE         exclude a something from processing (you
  89                                 decide what this means for your program)
  90                                 (This is an array)
  91                 EXCLUDE_FIND    same as DH_EXCLUDE, except all items are put
  92                                 into a string in a way that they will make
  93                                 find find them. (Use ! in front to negate
  94                                 that, of course)
  95 -x              INCLUDE_CONFFILES
  96                                 include conffiles. It's -x for obscure
  97                                 historical reasons.
  98 -d              D_FLAG          you decide what this means to your program
  99 -r              R_FLAG          you decide what this means to your program
 100 -k              K_FLAG          you decide what this means to your program
 101 -P              TMPDIR          package build directory (implies only one
 102                                 package is being acted on)
 103 -u              U_PARAMS        will be set to a string, that is typically
 104                                 parameters your program passes on to some
 105                                 other program. (This is an array)
 106 -m              M_PARAMS        will be set to a string, you decide what it
 107                                 means to your program
 108 -l              L_PARAMS        will be set to a string, you decide what it
 109                                 means to your program
 110 -V              V_FLAG          will be set to a string, you decide what it
 111                                 means to your program
 112 -V              V_FLAG_SET      will be 1 if -V was specified, even if no
 113                                 parameters were passed along with the -V
 114 -A              PARAMS_ALL      generally means that additional command line
 115                                 parameters passed to the program (other than
 116                                 those processed here), will apply to all
 117                                 binary packages the program acts on, not just
 118                                 the first
 119 --init-script   INIT_SCRIPT     will be set to a string, which specifies an
 120                                 init script name (probably only
 121                                 dh_installinit will ever use this)
 122 --sourcedir     SOURCEDIR       will be set to a string (probably only
 123                                 dh_movefiles will ever use this)
 124 --destdir       DESTDIR         will be set to a string (probably only
 125                                 dh_builddeb will ever use this)
 126 --filename      FILENAME        will be set to a string
 127 --flavor        FLAVOR          will be set to a string (probably only
 128                                 dh_installemacsen will ever use this)
 129 --number        PRIORITY        will be set to a number (deprecated)
 130 --priority      PRIORITY        will be set to a number
 131
 132 Any additional command line parameters that do not start with "-" will be
 133 ignored, and you can access them later just as you normally would.
 134
 135 If you need a new command line option, just ask me, and I will add it.
 136
 137 Global variables:
 138 ----------------
 139
 140 The following keys are also set in the %dh hash when you call init():
 141
 142 MAINPACKAGE     the name of the first binary package listed in
 143                 debian/control
 144 FIRSTPACKAGE    the first package we were instructed to act on. This package
 145                 typically gets special treatment, additional arguments
 146                 specified on the command line may effect it.
 147
 148 Functions:
 149 ---------
 150
 151 Dh_Lib.pm also contains a number of functions you may find useful.
 152
 153 doit()
 154         Pass this function an array that is a
 155         shell command. It will run the command (unless $dh{NO_ACT} is set), and
 156         if $dh{VERBOSE} is set, it will also output the command to stdout. You
 157         should use this function for almost all commands your program performs
 158         that manipulate files in the package build directories.
 159 complex_doit()
 160         Pass this function a string that is a shell command, it will run it
 161         similarly to how doit() does. You can pass more complicated commands
 162         to this (ie, commands involving piping redirection), however, you
 163         have to worry about things like escaping shell metacharacters.
 164 verbose_print()
 165         Pass this command a string, and it will echo it if $dh{VERBOSE} is set.
 166 error()
 167         Pass this command a string, it will output it to standard error and
 168         exit.
 169 warning()
 170         Pass this command a string, and it will output it to standard error
 171         as a warning message.
 172 tmpdir()
 173         Pass this command the name of a binary package, it will return the
 174         name of the tmp directory that will be used as this package's
 175         package build directory. Typically, this will be "debian/package".
 176 compat()
 177         Pass this command a number, and if the current compatability level
 178         equals that number, it will return true. Looks at DH_COMPAT to get
 179         the compatability level.
 180 pkgfile()
 181         Pass this command the name of a binary package, and the base name of a
 182         file, and it will return the actual filename to use. This is used
 183         for allowing debhelper programs to have configuration files in the
 184         debian/ directory, so there can be one config file per binary
 185         package. The convention is that the files are named
 186         debian/package.filename, and debian/filename is also allowable for
 187         the $dh{MAINPACKAGE}. If the file does not exist, nothing is returned.
 188 pkgext()
 189         Pass this command the name of a binary package, and it will return
 190         the name to prefix to files in debian/ for this package. For the
 191         $dh{MAINPACKAGE}, it returns nothing (there is no prefix), for the other
 192         packages, it returns "package.".
 193 isnative()
 194         Pass this command the name of a package, it returns 1 if the package
 195         is a native debian package.
 196         As a side effect, $dh{VERSION} is set to the version number of the
 197         package.
 198 autoscript()
 199         Pass parameters:
 200          - binary package to be affected
 201          - script to add to
 202          - filename of snippet
 203          - sed commands to run on the snippet. Ie, s/#PACKAGE#/$PACKAGE/
 204            (optional)
 205         This command automatically adds shell script snippets to a debian
 206         maintainer script (like the postinst or prerm).
 207
 208 -- Joey Hess <joeyh@debian.org>
 209