← Back to branch summary

~bzr/ubuntu/lucid/debhelper/builddeps-ppa

« back to all changes in this revision

Viewing changes to debhelper.pod

  • Committer: Bazaar Package Importer
  • Author(s): أحمد المحمودي (Ahmed El-Mahmoudy)
  • Date: 2011-02-07 17:16:49 UTC
  • mfrom: (1.4.21 sid)
  • Revision ID: james.westby@ubuntu.com-20110207171649-v8k6uowavom83cxt
Tags: 8.1.0ubuntu1
https://launchpad.net/bugs/714705
* Merge with Debian (LP: #714705); remaining changes:
  - dh_installinit: Add --upstart-only and --onlyscripts-upstart modes.
  - Add various autoscripts for above: postinst-upstart,
    postinst-upstart-replace, postinst-upstart-restart,
    prerm-upstart, prerm-upstart-norestart, preinst-removeconffile.
  - dh_installudev: Change default init.d symlink priority to 40.
  - dh_installchangelogs: Do not install upstream changelog in compat level
    7. This floods packages with huge upstream changelogs which take
    precious CD space.
  - dh_strip, dh_makeshlibs: use triplet-objdump, triplet-objcopy and
    triplet-strip from cross-binutils when cross-compiling; Debian #412118.
  - add dh_apparmor and autoscripts
  - debian/rules: override build target to set executable bit for
    dh_apparmor before actually running dh build, that is in order to get
    the manpage built for dh_apparmor.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debhelper.pod
4
4
 
5
5
=head1 SYNOPSIS
6
6
 
7
 
B<dh_>I<*> [B<-v>] [B<-a>] [B<-i>] [B<-s>] [B<--no-act>] [B<-ppackage>] [B<-Npackage] [-Ptmpdir>]
 
7
B<dh_>I<*> [B<-v>] [B<-a>] [B<-i>] [B<-s>] [B<--no-act>] [B<-p>I<package>] [B<-N>I<package>] [B<-P>I<tmpdir>]
8
8
 
9
9
=head1 DESCRIPTION
10
10
 
11
 
Debhelper is used to help you build a debian package. The philosophy behind
 
11
Debhelper is used to help you build a Debian package. The philosophy behind
12
12
debhelper is to provide a collection of small, simple, and easily
13
 
understood tools that are used in debian/rules to automate various common
 
13
understood tools that are used in F<debian/rules> to automate various common
14
14
aspects of building a package. This means less work for you, the packager.
15
 
It also, to some degree means that these tools can be changed if debian
 
15
It also, to some degree means that these tools can be changed if Debian
16
16
policy changes, and packages that use them will require only a rebuild to
17
17
comply with the new policy.
18
18
 
19
 
A typical debian/rules file that uses debhelper will call several debhelper
 
19
A typical F<debian/rules> file that uses debhelper will call several debhelper
20
20
commands in sequence, or use L<dh(1)> to automate this process. Examples of
21
21
rules files that use debhelper are in F</usr/share/doc/debhelper/examples/>
22
22
 
23
 
To create a new debian package using debhelper, you can just copy one of
24
 
the sample rules files and edit it by hand. Or you can try the dh-make
 
23
To create a new Debian package using debhelper, you can just copy one of
 
24
the sample rules files and edit it by hand. Or you can try the B<dh-make>
25
25
package, which contains a L<dh_make|dh_make(1)> command that partially
26
 
automates the process. For a more gentle introduction, the maint-guide debian
 
26
automates the process. For a more gentle introduction, the B<maint-guide> Debian 
27
27
package contains a tutorial about making your first package using debhelper.
28
28
 
29
29
=head1 DEBHELPER COMMANDS
49
49
 
50
50
=head2 Other Commands
51
51
 
52
 
If a program's name starts with "dh_", and the program is not on the above
 
52
If a program's name starts with B<dh_>, and the program is not on the above
53
53
lists, then it is not part of the debhelper package, but it should still
54
54
work like the other programs described on this page.
55
55
 
59
59
do. Besides the common F<debian/changelog> and F<debian/control>, which are
60
60
in all packages, not just those using debhelper, some additional files can
61
61
be used to configure the behavior of specific debhelper commands. These
62
 
files are typically named debian/package.foo (where "package" of course,
 
62
files are typically named debian/I<package>.foo (where I<package> of course,
63
63
is replaced with the package that is being acted on).
64
64
 
65
 
For example, dh_installdocs uses files named debian/package.docs to list
 
65
For example, B<dh_installdocs> uses files named F<debian/package.docs> to list
66
66
the documentation files it will install. See the man pages of individual
67
67
commands for details about the names and formats of the files they use.
68
68
Generally, these files will list files to act on, one file per line. Some
70
70
complicated formats.
71
71
 
72
72
Note that if a package is the first (or only) binary package listed in
73
 
debian/control, debhelper will use debian/foo if no debian/package.foo
 
73
F<debian/control>, debhelper will use F<debian/foo> if no F<debian/package.foo>
74
74
file can be found.
75
75
 
76
76
In some rare cases, you may want to have different versions of these files
77
 
for different architectures or OSes. If files named debian/package.foo.ARCH
78
 
or debian/package.foo.OS exist, where "ARCH" and "OS" are the same as the
79
 
output of  "dpkg-architecture -qDEB_HOST_ARCH" /
80
 
"dpkg-architecture -qDEB_HOST_ARCH_OS",
 
77
for different architectures or OSes. If files named debian/I<package>.foo.I<ARCH>
 
78
or debian/I<package>.foo.I<OS> exist, where I<ARCH> and I<OS> are the same as the
 
79
output of "B<dpkg-architecture -qDEB_HOST_ARCH>" /
 
80
"B<dpkg-architecture -qDEB_HOST_ARCH_OS>",
81
81
then they will be used in preference to other, more general files.
82
82
 
83
83
In many cases, these config files are used to specify various types of
84
84
files. Documentation or example files to install, files to move, and so on.
85
85
When appropriate, in cases like these, you can use standard shell wildcard
86
 
characters ('?' and '*' and '[..]' character classes) in the files.
 
86
characters (B<?> and B<*> and B<[>I<..>B<]> character classes) in the files.
87
87
 
88
 
You can also put comments in these files; lines beginning with "#" are
 
88
You can also put comments in these files; lines beginning with B<#> are
89
89
ignored.
90
90
 
91
91
=head1 SHARED DEBHELPER OPTIONS
112
112
 
113
113
Act on all architecture independent packages.
114
114
 
115
 
=item B<->I<ppackage>, B<--package=>I<package>
 
115
=item B<-p>I<package>, B<--package=>I<package>
116
116
 
117
 
Act on the package named "package". This option may be specified multiple
 
117
Act on the package named I<package>. This option may be specified multiple
118
118
times to make debhelper operate on a given set of packages.
119
119
 
120
120
=item B<-s>, B<--same-arch>
121
121
 
122
 
This used to be a smarter version of the -a flag, but the -a flag is now
 
122
This used to be a smarter version of the B<-a> flag, but the B<-a> flag is now
123
123
equally smart.
124
124
 
125
125
=item B<-N>I<package>, B<--no-package=>I<package>
126
126
 
127
 
Do not act on the specified package even if an -a, -i, or -p option lists
 
127
Do not act on the specified package even if an B<-a>, B<-i>, or B<-p> option lists
128
128
the package as one that should be acted on.
129
129
 
130
130
=item B<--remaining-packages>
137
137
 
138
138
=item B<--ignore=>I<file>
139
139
 
140
 
Ignore the specified file. This can be used if debian/ contains a debhelper
 
140
Ignore the specified file. This can be used if F<debian/> contains a debhelper
141
141
config file that a debhelper command should not act on. Note that
142
 
debian/compat, debian/control, and debian/changelog can't be ignored, but
 
142
F<debian/compat>, F<debian/control>, and F<debian/changelog> can't be ignored, but
143
143
then, there should never be a reason to ignore those files.
144
144
 
145
 
For example, if upstream ships a debian/init that you don't want
146
 
dh_installinit to install, use --ignore=debian/init
 
145
For example, if upstream ships a F<debian/init> that you don't want
 
146
B<dh_installinit> to install, use B<--ignore=debian/init>
147
147
 
148
148
=item B<-P>I<tmpdir>, B<--tmpdir=>I<tmpdir>
149
149
 
150
 
Use "tmpdir" for package build directory. The default is debian/<package>
 
150
Use I<tmpdir> for package build directory. The default is debian/I<package>
151
151
 
152
152
=item B<--mainpackage=>I<package>
153
153
 
154
154
This little-used option changes the package which debhelper considers the
155
 
"main package", that is, the first one listed in debian/control, and the
156
 
one for which debian/foo files can be used instead of the usual
157
 
debian/package.foo files.
 
155
"main package", that is, the first one listed in F<debian/control>, and the
 
156
one for which F<debian/foo> files can be used instead of the usual
 
157
F<debian/package.foo> files.
158
158
 
159
 
=item B<-O=>I<option|bundle>
 
159
=item B<-O=>I<option>|I<bundle>
160
160
 
161
161
This is used by L<dh(1)> when passing user-specified options to all the
162
162
commands it runs. If the command supports the specified option or option
175
175
 
176
176
=item B<-n>
177
177
 
178
 
Do not modify postinst/postrm/etc scripts.
 
178
Do not modify F<postinst>, F<postrm>, etc. scripts.
179
179
 
180
180
=item B<-X>I<item>, B<--exclude=>I<item>
181
181
 
191
191
 
192
192
=head1 BUILD SYSTEM OPTIONS
193
193
 
194
 
The following command line options are supported by all of the dh_auto_*
 
194
The following command line options are supported by all of the B<dh_auto_>I<*>
195
195
debhelper programs. These programs support a variety of build systems,
196
196
and normally heuristically determine which to use, and how to use them.
197
197
You can use these command line options to override the default behavior.
209
209
I<directory> rather than the top level directory of the Debian
210
210
source package tree.
211
211
 
212
 
=item B<-B>[I<directory>], B<--builddirectory>=[I<directory>]
 
212
=item B<-B>[I<directory>], B<--builddirectory=>[I<directory>]
213
213
 
214
214
Enable out of source building and use the specified I<directory> as the build
215
215
directory. If I<directory> parameter is omitted, a default build directory
218
218
If this option is not specified, building will be done in source by default
219
219
unless the build system requires or prefers out of source tree building.
220
220
In such a case, the default build directory will be used even if
221
 
L<--builddirectory> is not specified.
 
221
B<--builddirectory> is not specified.
222
222
 
223
223
If the build system prefers out of source tree building but still
224
224
allows in source building, the latter can be re-enabled by passing a build
228
228
 
229
229
Enable parallel builds if underlying build system supports them.
230
230
The number of parallel jobs is controlled by the
231
 
DEB_BUILD_OPTIONS environment variable (L<Debian Policy, section 4.9.1>) at
 
231
B<DEB_BUILD_OPTIONS> environment variable (L<Debian Policy, section 4.9.1>) at
232
232
build time. It might also be subject to a build system specific limit.
233
233
 
234
234
If this option is not specified, debhelper currently defaults to not
235
235
allowing parallel package builds.
236
236
 
237
 
=item B<--max-parallel>I<=maximum>
 
237
=item B<--max-parallel=>I<maximum>
238
238
 
239
 
This option implies L<--parallel> and allows further limiting the number of
 
239
This option implies B<--parallel> and allows further limiting the number of
240
240
jobs that can be used in a parallel build. If the package build is known to
241
241
only work with certain levels of concurrency, you can set this to the maximum
242
242
level that is known to work, or that you wish to support.
246
246
List all build systems supported by debhelper on this system. The list
247
247
includes both default and third party build systems (marked as such). Also
248
248
shows which build system would be automatically selected, or which one
249
 
is manually specified with the I<--buildsystem> option.
 
249
is manually specified with the B<--buildsystem> option.
250
250
 
251
251
=back
252
252
 
259
259
source package happens to generate one architecture dependent package, and
260
260
another architecture independent package, this is not the correct behavior,
261
261
because you need to generate the architecture dependent packages in the
262
 
binary-arch debian/rules target, and the architecture independent packages
263
 
in the binary-indep debian/rules target.
 
262
binary-arch F<debian/rules> target, and the architecture independent packages
 
263
in the binary-indep F<debian/rules> target.
264
264
 
265
265
To facilitate this, as well as give you more control over which packages
266
266
are acted on by debhelper programs, all debhelper programs accept the
268
268
If none are given, debhelper programs default to acting on all packages listed
269
269
in the control file.
270
270
 
271
 
=head2 Automatic generation of debian install scripts
 
271
=head2 Automatic generation of Debian install scripts
272
272
 
273
 
Some debhelper commands will automatically generate parts of debian
 
273
Some debhelper commands will automatically generate parts of Debian
274
274
maintainer scripts. If you want these automatically generated things
275
 
included in your existing debian maintainer scripts, then you need to add
276
 
"#DEBHELPER#" to your scripts, in the place the code should be added.
277
 
"#DEBHELPER#" will be replaced by any auto-generated code when you run
278
 
dh_installdeb. 
 
275
included in your existing Debian maintainer scripts, then you need to add
 
276
B<#DEBHELPER#> to your scripts, in the place the code should be added.
 
277
B<#DEBHELPER#> will be replaced by any auto-generated code when you run
 
278
B<dh_installdeb>.
279
279
 
280
280
If a script does not exist at all and debhelper needs to add something to
281
281
it, then debhelper will create the complete script.
284
284
be disabled by the -n parameter (see above).
285
285
 
286
286
Note that the inserted code will be shell code, so you cannot directly use
287
 
it in a perl script. If you would like to embed it into a perl script, here
 
287
it in a Perl script. If you would like to embed it into a Perl script, here
288
288
is one way to do that (note that I made sure that $1, $2, etc are set with
289
289
the set command):
290
290
 
306
306
 
307
307
All commands of this type, besides documenting what dependencies may be
308
308
needed on their man pages, will automatically generate a substvar called
309
 
${misc:Depends}. If you put that token into your debian/control file, it
 
309
B<${misc:Depends}>. If you put that token into your F<debian/control> file, it
310
310
will be expanded to the dependencies debhelper figures you need. 
311
311
 
312
 
This is entirely independent of the standard ${shlibs:Depends} generated by
313
 
L<dh_makeshlibs(1)>, and the ${perl:Depends} generated by L<dh_perl(1)>.
 
312
This is entirely independent of the standard B<${shlibs:Depends}> generated by
 
313
L<dh_makeshlibs(1)>, and the B<${perl:Depends}> generated by L<dh_perl(1)>.
314
314
You can choose not to use any of these, if debhelper's guesses don't match
315
315
reality.
316
316
 
317
317
=head2 Package build directories
318
318
 
319
319
By default, all debhelper programs assume that the temporary directory used
320
 
for assembling the tree of files in a package is debian/<package>.
 
320
for assembling the tree of files in a package is debian/I<package>.
321
321
 
322
322
Sometimes, you might want to use some other temporary directory. This is
323
 
supported by the -P flag. For example, "dh_installdocs -Pdebian/tmp", will
324
 
use debian/tmp as the temporary directory. Note that if you use -P, the 
 
323
supported by the B<-P> flag. For example, "B<dh_installdocs -Pdebian/tmp>", will
 
324
use B<debian/tmp> as the temporary directory. Note that if you use B<-P>, the 
325
325
debhelper programs can only be acting on a single package at a time. So if 
326
326
you have a package that builds many binary packages, you will need to also 
327
 
use the -p flag to specify which binary package the debhelper program will
 
327
use the B<-p> flag to specify which binary package the debhelper program will
328
328
act on.
329
329
 
330
330
=head2 Debhelper compatibility levels
337
337
it modifies its behavior in various ways.
338
338
 
339
339
Tell debhelper what compatibility level to use by writing a number to
340
 
debian/compat. For example, to turn on v8 mode:
 
340
F<debian/compat>. For example, to turn on v8 mode:
341
341
 
342
342
  % echo 8 > debian/compat
343
343
 
355
355
=item v1
356
356
 
357
357
This is the original debhelper compatibility level, and so it is the default
358
 
one. In this mode, debhelper will use debian/tmp as the package tree
 
358
one. In this mode, debhelper will use F<debian/tmp> as the package tree
359
359
directory for the first binary package listed in the control file, while using
360
 
debian/<package> for all other packages listed in the control file.
 
360
debian/I<package> for all other packages listed in the F<control> file.
361
361
 
362
362
This mode is deprecated.
363
363
 
364
364
=item v2
365
365
 
366
 
In this mode, debhelper will consistently use debian/<package>
 
366
In this mode, debhelper will consistently use debian/I<package>
367
367
as the package tree directory for every package that is built.
368
368
 
369
369
This mode is deprecated.
376
376
 
377
377
=item -
378
378
 
379
 
Debhelper config files support globbing via * and ?, when appropriate. To
 
379
Debhelper config files support globbing via B<*> and B<?>, when appropriate. To
380
380
turn this off and use those characters raw, just prefix with a backslash.
381
381
 
382
382
=item -
383
383
 
384
 
dh_makeshlibs makes the postinst and postrm scripts call ldconfig.
 
384
B<dh_makeshlibs> makes the F<postinst> and F<postrm> scripts call B<ldconfig>.
385
385
 
386
386
=item -
387
387
 
388
 
Every file in etc/ is automatically flagged as a conffile by dh_installdeb.
 
388
Every file in F<etc/> is automatically flagged as a conffile by B<dh_installdeb>.
389
389
 
390
390
=back
391
391
 
399
399
 
400
400
=item -
401
401
 
402
 
dh_makeshlibs -V will not include the debian part of the version number in
 
402
B<dh_makeshlibs -V> will not include the Debian part of the version number in
403
403
the generated dependency line in the shlibs file.
404
404
 
405
405
=item -
406
406
 
407
 
You are encouraged to put the new ${misc:Depends} into debian/control to
408
 
supplement the ${shlibs:Depends} field.
 
407
You are encouraged to put the new B<${misc:Depends}> into F<debian/control> to
 
408
supplement the B<${shlibs:Depends}> field.
409
409
 
410
410
=item -
411
411
 
412
 
dh_fixperms will make all files in bin/ directories and in etc/init.d 
 
412
B<dh_fixperms> will make all files in F<bin/> directories and in F<etc/init.d>
413
413
executable.
414
414
 
415
415
=item -
416
416
 
417
 
dh_link will correct existing links to conform with policy.
 
417
B<dh_link> will correct existing links to conform with policy.
418
418
 
419
419
=back
420
420
 
432
432
 
433
433
=item -
434
434
 
435
 
dh_strip --dbg-package now specifies the name of a package to put debugging
 
435
B<dh_strip --dbg-package> now specifies the name of a package to put debugging
436
436
symbols in, not the packages to take the symbols from.
437
437
 
438
438
=item -
439
439
 
440
 
dh_installdocs skips installing empty files.
 
440
B<dh_installdocs> skips installing empty files.
441
441
 
442
442
=item -
443
443
 
444
 
dh_install errors out if wildcards expand to nothing.
 
444
B<dh_install> errors out if wildcards expand to nothing.
445
445
 
446
446
=back
447
447
 
454
454
=item -
455
455
 
456
456
Commands that generate maintainer script fragments will order the
457
 
fragments in reverse order for the prerm and postrm scripts.
 
457
fragments in reverse order for the F<prerm> and F<postrm> scripts.
458
458
 
459
459
=item -
460
460
 
461
 
dh_installwm will install a slave manpage link for x-window-manager.1.gz,
462
 
if it sees the man page in usr/share/man/man1 in the package build
 
461
B<dh_installwm> will install a slave manpage link for F<x-window-manager.1.gz>,
 
462
if it sees the man page in F<usr/share/man/man1> in the package build
463
463
directory.
464
464
 
465
465
=item -
466
466
 
467
 
dh_builddeb did not previously delete everything matching
468
 
DH_ALWAYS_EXCLUDE, if it was set to a list of things to exclude, such as
469
 
"CVS:.svn:.git". Now it does.
 
467
B<dh_builddeb> did not previously delete everything matching
 
468
B<DH_ALWAYS_EXCLUDE>, if it was set to a list of things to exclude, such as
 
469
B<CVS:.svn:.git>. Now it does.
470
470
 
471
471
=item -
472
472
 
473
 
dh_installman allows overwriting existing man pages in the package build
 
473
B<dh_installman> allows overwriting existing man pages in the package build
474
474
directory. In previous compatibility levels it silently refuses to do this.
475
475
 
476
476
=back
483
483
 
484
484
=item -
485
485
 
486
 
dh_install, will fall back to looking for files in debian/tmp if it doesn't
 
486
B<dh_install>, will fall back to looking for files in F<debian/tmp> if it doesn't
487
487
find them in the current directory (or wherever you tell it look using
488
 
--sourcedir). This allows dh_install to interoperate with dh_auto_install,
489
 
which installs to debian/tmp, without needing any special parameters.
490
 
 
491
 
=item -
492
 
 
493
 
dh_clean will read debian/clean and delete files listed there.
494
 
 
495
 
=item -
496
 
 
497
 
dh_clean will delete toplevel *-stamp files.
498
 
 
499
 
=item -
500
 
 
501
 
dh_installchangelogs will guess at what file is the upstream changelog if
 
488
B<--sourcedir>). This allows B<dh_install> to interoperate with B<dh_auto_install>,
 
489
which installs to F<debian/tmp>, without needing any special parameters.
 
490
 
 
491
=item -
 
492
 
 
493
B<dh_clean> will read F<debian/clean> and delete files listed there.
 
494
 
 
495
=item -
 
496
 
 
497
B<dh_clean> will delete toplevel F<*-stamp> files.
 
498
 
 
499
=item -
 
500
 
 
501
B<dh_installchangelogs> will guess at what file is the upstream changelog if
502
502
none is specified.
503
503
 
504
504
=back
517
517
 
518
518
=item -
519
519
 
520
 
dh_makeshlibs will run dpkg-gensymbols on all shared libraries that it
521
 
generates shlibs files for. So -X can be used to exclude libraries.
522
 
Also, libraries in unusual locations that dpkg-gensymbols would not
 
520
B<dh_makeshlibs> will run B<dpkg-gensymbols> on all shared libraries that it
 
521
generates shlibs files for. So B<-X> can be used to exclude libraries.
 
522
Also, libraries in unusual locations that B<dpkg-gensymbols> would not
523
523
have processed before will be passed to it, a behavior change that 
524
524
can cause some packages to fail to build.
525
525
 
526
526
=item -
527
527
 
528
 
dh requires the sequence to run be specified as the first parameter, and
529
 
any switches come after it. Ie, use "dh $@ --foo", not "dh --foo $@"
 
528
B<dh> requires the sequence to run be specified as the first parameter, and
 
529
any switches come after it. Ie, use "B<dh $@ --foo>", not "B<dh --foo $@>".
530
530
 
531
531
=item
532
532
 
533
 
dh_auto_* prefer to use perl's Module::Build in preference to Makefile.PL.
 
533
B<dh_auto_>I<*> prefer to use Perl's B<Module::Build> in preference to F<Makefile.PL>.
534
534
 
535
535
=back
536
536
 
539
539
=head2 udebs
540
540
 
541
541
Debhelper includes support for udebs. To create a udeb with debhelper,
542
 
add "Package-Type: udeb" to the package's stanza in debian/control, and
 
542
add "B<Package-Type: udeb>" to the package's stanza in F<debian/control>, and
543
543
build-depend on debhelper (>= 4.2). Debhelper will try to create udebs that
544
544
comply with debian-installer policy, by making the generated package files
545
 
end in ".udeb", not installing any documentation into a udeb, skipping over
546
 
preinst, postrm, prerm, and config scripts, etc.
 
545
end in F<.udeb>, not installing any documentation into a udeb, skipping over
 
546
F<preinst>, F<postrm>, F<prerm>, and F<config> scripts, etc.
547
547
 
548
548
=head2 Other notes
549
549
 
550
550
In general, if any debhelper program needs a directory to exist under
551
 
debian/, it will create it. I haven't bothered to document this in all the
552
 
man pages, but for example, dh_installdeb knows to make debian/<package>/DEBIAN/
553
 
before trying to put files there, dh_installmenu knows you need a
554
 
debian/<package>/usr/share/menu/ before installing the menu files, etc.
 
551
B<debian/>, it will create it. I haven't bothered to document this in all the
 
552
man pages, but for example, B<dh_installdeb> knows to make debian/I<package>/DEBIAN/
 
553
before trying to put files there, B<dh_installmenu> knows you need a
 
554
debian/I<package>/usr/share/menu/ before installing the menu files, etc.
555
555
 
556
556
Once your package uses debhelper to build, be sure to add
557
 
debhelper to your Build-Depends line in debian/control. You should
 
557
debhelper to your Build-Depends line in F<debian/control>. You should
558
558
build-depend on a version of debhelper equal to (or greater than) the
559
559
debhelper compatibility level your package uses. So if your package used
560
560
compatibility level 7:
565
565
 
566
566
=over 4
567
567
 
568
 
=item DH_VERBOSE
 
568
=item B<DH_VERBOSE>
569
569
 
570
 
Set to 1 to enable verbose mode. Debhelper will output every command it runs
 
570
Set to B<1> to enable verbose mode. Debhelper will output every command it runs
571
571
that modifies files on the build system.
572
572
 
573
 
=item DH_COMPAT
 
573
=item B<DH_COMPAT>
574
574
 
575
575
Temporarily specifies what compatibility level debhelper should run at,
576
 
overriding any value in debian/compat.
577
 
 
578
 
=item DH_NO_ACT
579
 
 
580
 
Set to 1 to enable no-act mode.
581
 
 
582
 
=item DH_OPTIONS
 
576
overriding any value in F<debian/compat>.
 
577
 
 
578
=item B<DH_NO_ACT>
 
579
 
 
580
Set to B<1> to enable no-act mode.
 
581
 
 
582
=item B<DH_OPTIONS>
583
583
 
584
584
Anything in this variable will be prepended to the command line arguments
585
585
of all debhelper commands. Command-specific options will be ignored by 
586
586
commands that do not support them. 
587
587
 
588
 
This is useful in some situations, for example, if you need to pass -p to
589
 
all debhelper commands that will be run. One good way to set DH_OPTIONS is
590
 
by using "Target-specific Variable Values" in your debian/rules file. See
 
588
This is useful in some situations, for example, if you need to pass B<-p> to
 
589
all debhelper commands that will be run. One good way to set B<DH_OPTIONS> is
 
590
by using "Target-specific Variable Values" in your F<debian/rules> file. See
591
591
the make documentation for details on doing this.
592
592
 
593
 
=item DH_ALWAYS_EXCLUDE
 
593
=item B<DH_ALWAYS_EXCLUDE>
594
594
 
595
 
If set, this adds the value the variable is set to to the -X options of all
596
 
commands that support the -X option. Moreover, dh_builddeb will rm -rf
 
595
If set, this adds the value the variable is set to to the B<-X> options of all
 
596
commands that support the B<-X> option. Moreover, B<dh_builddeb> will B<rm -rf>
597
597
anything that matches the value in your package build tree.
598
598
 
599
599
This can be useful if you are doing a build from a CVS source tree, in
600
 
which case setting DH_ALWAYS_EXCLUDE=CVS will prevent any CVS directories
 
600
which case setting B<DH_ALWAYS_EXCLUDE=CVS> will prevent any CVS directories
601
601
from sneaking into the package you build. Or, if a package has a source
602
602
tarball that (unwisely) includes CVS directories, you might want to export
603
 
DH_ALWAYS_EXCLUDE=CVS in debian/rules, to make it take effect wherever
 
603
B<DH_ALWAYS_EXCLUDE=CVS> in F<debian/rules>, to make it take effect wherever
604
604
your package is built.
605
605
 
606
606
Multiple things to exclude can be separated with colons, as in
607
 
DH_ALWAYS_EXCLUDE=CVS:.svn
 
607
B<DH_ALWAYS_EXCLUDE=CVS:.svn>
608
608
 
609
609
=back
610
610
 
614
614
 
615
615
=item F</usr/share/doc/debhelper/examples/>
616
616
 
617
 
A set of example debian/rules files that use debhelper.
 
617
A set of example F<debian/rules> files that use debhelper.
618
618
 
619
619
=item L<http://kitenet.net/~joey/code/debhelper/>
620
620