/usr/share/doc/developers-reference/apa.html is in developers-reference 3.4.17.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Appendix A. Overview of Debian Maintainer Tools</title>
<link rel="stylesheet" type="text/css" href="developers-reference.css"/>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<link rel="home" href="index.html" title="Debian Developer's Reference"/>
<link rel="up" href="index.html" title="Debian Developer's Reference"/>
<link rel="prev" href="ch08.html" title="Chapter 8. Internationalization and Translations"/>
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Appendix A. Overview of Debian Maintainer Tools</th>
</tr>
<tr>
<td align="left"><a accesskey="p" href="ch08.html"><img src="images/prev.png" alt="Prev"/></a> </td>
<th width="60%" align="center"> </th>
<td align="right"> </td>
</tr>
</table>
<hr/>
</div>
<div class="appendix">
<div class="titlepage">
<div>
<div>
<h1 class="title"><a id="tools"/>Appendix A. Overview of Debian Maintainer Tools</h1>
</div>
</div>
</div>
<div class="toc">
<p>
<strong>Table of Contents</strong>
</p>
<dl class="toc">
<dt>
<span class="section">
<a href="apa.html#tools-core">A.1. Core tools</a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="section">
<a href="apa.html#dpkg-dev">A.1.1. <code class="systemitem">dpkg-dev</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#debconf">A.1.2. <code class="systemitem">debconf</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#fakeroot">A.1.3. <code class="systemitem">fakeroot</code></a>
</span>
</dt>
</dl>
</dd>
<dt>
<span class="section">
<a href="apa.html#tools-lint">A.2. Package lint tools</a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="section">
<a href="apa.html#lintian">A.2.1. <code class="systemitem">lintian</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#debdiff">A.2.2. <span class="command"><strong>debdiff</strong></span></a>
</span>
</dt>
</dl>
</dd>
<dt>
<span class="section">
<a href="apa.html#tools-helpers">A.3. Helpers for <code class="filename">debian/rules</code></a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="section">
<a href="apa.html#debhelper">A.3.1. <code class="systemitem">debhelper</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#dh-make">A.3.2. <code class="systemitem">dh-make</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#equivs">A.3.3. <code class="systemitem">equivs</code></a>
</span>
</dt>
</dl>
</dd>
<dt>
<span class="section">
<a href="apa.html#tools-builders">A.4. Package builders</a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="section">
<a href="apa.html#git-buildpackage">A.4.1. <code class="systemitem">git-buildpackage</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#debootstrap">A.4.2. <code class="systemitem">debootstrap</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#pbuilder">A.4.3. <code class="systemitem">pbuilder</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#sbuild">A.4.4. <code class="systemitem">sbuild</code></a>
</span>
</dt>
</dl>
</dd>
<dt>
<span class="section">
<a href="apa.html#uploaders">A.5. Package uploaders</a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="section">
<a href="apa.html#dupload">A.5.1. <code class="systemitem">dupload</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#dput">A.5.2. <code class="systemitem">dput</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#dcut">A.5.3. <span class="command"><strong>dcut</strong></span></a>
</span>
</dt>
</dl>
</dd>
<dt>
<span class="section">
<a href="apa.html#tools-maint-automate">A.6. Maintenance automation</a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="section">
<a href="apa.html#devscripts">A.6.1. <code class="systemitem">devscripts</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#autotools-dev">A.6.2. <code class="systemitem">autotools-dev</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#dpkg-repack">A.6.3. <code class="systemitem">dpkg-repack</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#alien">A.6.4. <code class="systemitem">alien</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#dpkg-dev-el">A.6.5. <code class="systemitem">dpkg-dev-el</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#dpkg-depcheck">A.6.6. <span class="command"><strong>dpkg-depcheck</strong></span></a>
</span>
</dt>
</dl>
</dd>
<dt>
<span class="section">
<a href="apa.html#tools-porting">A.7. Porting tools</a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="section">
<a href="apa.html#dpkg-cross">A.7.1. <code class="systemitem">dpkg-cross</code></a>
</span>
</dt>
</dl>
</dd>
<dt>
<span class="section">
<a href="apa.html#tools-doc">A.8. Documentation and information</a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="section">
<a href="apa.html#docbook-xml">A.8.1. <code class="systemitem">docbook-xml</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#debiandoc-sgml">A.8.2. <code class="systemitem">debiandoc-sgml</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#debian-keyring">A.8.3. <code class="systemitem">debian-keyring</code></a>
</span>
</dt>
<dt>
<span class="section">
<a href="apa.html#debian-el">A.8.4. <code class="systemitem">debian-el</code></a>
</span>
</dt>
</dl>
</dd>
</dl>
</div>
<p>
This section contains a rough overview of the tools available to maintainers.
The following is by no means complete or definitive, but just a guide to some
of the more popular tools.
</p>
<p>
Debian maintainer tools are meant to aid developers and free their time for
critical tasks. As Larry Wall says, there's more than one way to do it.
</p>
<p>
Some people prefer to use high-level package maintenance tools and some do not.
Debian is officially agnostic on this issue; any tool which gets the job done
is fine. Therefore, this section is not meant to stipulate to anyone which
tools they should use or how they should go about their duties of
maintainership. Nor is it meant to endorse any particular tool to the
exclusion of a competing tool.
</p>
<p>
Most of the descriptions of these packages come from the actual package
descriptions themselves. Further information can be found in the package
documentation itself. You can also see more info with the command
<span class="command"><strong>apt-cache show <em class="replaceable"><code>package-name</code></em></strong></span>.
</p>
<div class="section">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="tools-core"/>A.1. Core tools</h2>
</div>
</div>
</div>
<p>
The following tools are pretty much required for any maintainer.
</p>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="dpkg-dev"/>A.1.1. <code class="systemitem">dpkg-dev</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">dpkg-dev</code> contains the tools (including
<span class="command"><strong>dpkg-source</strong></span>) required to unpack, build, and upload Debian
source packages. These utilities contain the fundamental, low-level
functionality required to create and manipulate packages; as such, they are
essential for any Debian maintainer.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="debconf"/>A.1.2. <code class="systemitem">debconf</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">debconf</code> provides a consistent interface
to configuring packages interactively. It is user interface independent,
allowing end-users to configure packages with a text-only interface, an HTML
interface, or a dialog interface. New interfaces can be added as modules.
</p>
<p>
You can find documentation for this package in the <code class="systemitem">debconf-doc</code> package.
</p>
<p>
Many feel that this system should be used for all packages which require
interactive configuration; see <a class="xref" href="ch06.html#bpp-config-mgmt" title="6.5. Configuration management with debconf">Section 6.5, “Configuration management with <code class="systemitem">debconf</code>”</a>. <code class="systemitem">debconf</code> is not currently required by Debian Policy,
but that may change in the future.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="fakeroot"/>A.1.3. <code class="systemitem">fakeroot</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">fakeroot</code> simulates root privileges.
This enables you to build packages without being root (packages usually want to
install files with root ownership). If you have <code class="systemitem">fakeroot</code> installed,
<span class="command"><strong>dpkg-buildpackage</strong></span> will use it automatically.
</p>
</div>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="tools-lint"/>A.2. Package lint tools</h2>
</div>
</div>
</div>
<p>
According to the Free On-line Dictionary of Computing (FOLDOC), `lint' is a
Unix C language processor which carries out more thorough checks on the code
than is usual with C compilers. Package lint tools help package maintainers by
automatically finding common problems and policy violations in their packages.
</p>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="lintian"/>A.2.1. <code class="systemitem">lintian</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">lintian</code> dissects Debian packages and
emits information about bugs and policy violations. It contains automated
checks for many aspects of Debian policy as well as some checks for common
errors.
</p>
<p>
You should periodically get the newest <code class="systemitem">lintian</code> from <code class="literal">unstable</code> and check
over all your packages. Notice that the <code class="literal">-i</code> option provides
detailed explanations of what each error or warning means, what its basis in
Policy is, and commonly how you can fix the problem.
</p>
<p>
Refer to <a class="xref" href="ch05.html#sanitycheck" title="5.3. Testing the package">Section 5.3, “Testing the package”</a> for more information on how and when to
use Lintian.
</p>
<p>
You can also see a summary of all problems reported by Lintian on your packages
at <a class="ulink" href="https://lintian.debian.org/">https://lintian.debian.org/</a>. These reports contain the
latest <span class="command"><strong>lintian</strong></span> output for the whole development distribution
(<code class="literal">unstable</code>).
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="debdiff"/>A.2.2. <span class="command"><strong>debdiff</strong></span></h3>
</div>
</div>
</div>
<p>
<span class="command"><strong>debdiff</strong></span> (from the <code class="systemitem">devscripts</code> package, <a class="xref" href="apa.html#devscripts" title="A.6.1. devscripts">Section A.6.1, “<code class="systemitem">devscripts</code>”</a>)
compares file lists and control files of two packages. It is a simple
regression test, as it will help you notice if the number of binary packages
has changed since the last upload, or if something has changed in the control
file. Of course, some of the changes it reports will be all right, but it can
help you prevent various accidents.
</p>
<p>
You can run it over a pair of binary packages:
</p>
<pre class="screen">
debdiff package_1-1_arch.deb package_2-1_arch.deb
</pre>
<p>
Or even a pair of changes files:
</p>
<pre class="screen">
debdiff package_1-1_arch.changes package_2-1_arch.changes
</pre>
<p>
For more information please see <span class="citerefentry"><span class="refentrytitle">debdiff</span>(1)</span>.
</p>
</div>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="tools-helpers"/>A.3. Helpers for <code class="filename">debian/rules</code></h2>
</div>
</div>
</div>
<p>
Package building tools make the process of writing
<code class="filename">debian/rules</code> files easier. See <a class="xref" href="ch06.html#helper-scripts" title="6.1.1. Helper scripts">Section 6.1.1, “Helper scripts”</a> for more information about why these might or might
not be desired.
</p>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="debhelper"/>A.3.1. <code class="systemitem">debhelper</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">debhelper</code> is a collection of programs
which can be used in <code class="filename">debian/rules</code> to automate common tasks
related to building binary Debian packages. <code class="systemitem">debhelper</code> includes programs to install various
files into your package, compress files, fix file permissions, and integrate
your package with the Debian menu system.
</p>
<p>
Unlike some approaches, <code class="systemitem">debhelper</code> is
broken into several small, simple commands which act in a consistent manner.
As such, it allows more fine-grained control than some of the other
debian/rules tools.
</p>
<p>
There are a number of little <code class="systemitem">debhelper</code>
add-on packages, too transient to document. You can see the list of most of
them by doing <code class="literal">apt-cache search ^dh-</code>.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="dh-make"/>A.3.2. <code class="systemitem">dh-make</code></h3>
</div>
</div>
</div>
<p>
The <code class="systemitem">dh-make</code> package contains
<span class="command"><strong>dh_make</strong></span>, a program that creates a skeleton of files
necessary to build a Debian package out of a source tree. As the name
suggests, <span class="command"><strong>dh_make</strong></span> is a rewrite of <code class="systemitem">debmake</code> and its template files use <span class="command"><strong>dh_*</strong></span> programs
from <code class="systemitem">debhelper</code>.
</p>
<p>
While the rules files generated by <span class="command"><strong>dh_make</strong></span> are in general a
sufficient basis for a working package, they are still just the groundwork: the
burden still lies on the maintainer to finely tune the generated files and make
the package entirely functional and Policy-compliant.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="equivs"/>A.3.3. <code class="systemitem">equivs</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">equivs</code> is another package for making
packages. It is often suggested for local use if you need to make a package
simply to fulfill dependencies. It is also sometimes used when making
``meta-packages'', which are packages whose only purpose is to depend on other
packages.
</p>
</div>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="tools-builders"/>A.4. Package builders</h2>
</div>
</div>
</div>
<p>
The following packages help with the package building process, general driving
<span class="command"><strong>dpkg-buildpackage</strong></span> as well as handling supporting tasks.
</p>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="git-buildpackage"/>A.4.1. <code class="systemitem">git-buildpackage</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">git-buildpackage</code> provides the
capability to inject or import Debian source packages into a Git repository,
build a Debian package from the Git repository, and helps in integrating
upstream changes into the repository.
</p>
<p>
These utilities provide an infrastructure to facilitate the use of Git by
Debian maintainers. This allows one to keep separate Git branches of a package
for <code class="literal">stable</code>, <code class="literal">unstable</code> and possibly
<code class="literal">experimental</code> distributions, along with the other benefits
of a version control system.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="debootstrap"/>A.4.2. <code class="systemitem">debootstrap</code></h3>
</div>
</div>
</div>
<p>
The <code class="systemitem">debootstrap</code> package and script
allows you to bootstrap a Debian base system into any part of your filesystem.
By base system, we mean the bare minimum of packages required to operate and
install the rest of the system.
</p>
<p>
Having a system like this can be useful in many ways. For instance, you can
<span class="command"><strong>chroot</strong></span> into it if you want to test your build dependencies.
Or you can test how your package behaves when installed into a bare base
system. Chroot builders use this package; see below.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="pbuilder"/>A.4.3. <code class="systemitem">pbuilder</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">pbuilder</code> constructs a chrooted system,
and builds a package inside the chroot. It is very useful to check that a
package's build-dependencies are correct, and to be sure that unnecessary and
wrong build dependencies will not exist in the resulting package.
</p>
<p>
A related package is <code class="systemitem">cowbuilder</code>,
which speeds up the build process using COW filesystem on any standard Linux filesystem.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="sbuild"/>A.4.4. <code class="systemitem">sbuild</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">sbuild</code> is another automated builder.
It can use chrooted environments as well. It can be used stand-alone, or as
part of a networked, distributed build environment. As the latter, it is part
of the system used by porters to build binary packages for all the available
architectures. See <a class="xref" href="ch05.html#wanna-build" title="5.10.3.3. wanna-build">Section 5.10.3.3, “<code class="systemitem">wanna-build</code>”</a> for more information, and
<a class="ulink" href="https://buildd.debian.org/">https://buildd.debian.org/</a> to see the system in action.
</p>
</div>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="uploaders"/>A.5. Package uploaders</h2>
</div>
</div>
</div>
<p>
The following packages help automate or simplify the process of uploading
packages into the official archive.
</p>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="dupload"/>A.5.1. <code class="systemitem">dupload</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">dupload</code> is a package and a script to
automatically upload Debian packages to the Debian archive, to log the upload,
and to send mail about the upload of a package. You can configure it for new
upload locations or methods.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="dput"/>A.5.2. <code class="systemitem">dput</code></h3>
</div>
</div>
</div>
<p>
The <code class="systemitem">dput</code> package and script does much
the same thing as <code class="systemitem">dupload</code>, but in a
different way. It has some features over <code class="systemitem">dupload</code>, such as the ability to check the GnuPG
signature and checksums before uploading, and the possibility of running
<span class="command"><strong>dinstall</strong></span> in dry-run mode after the upload.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="dcut"/>A.5.3. <span class="command"><strong>dcut</strong></span></h3>
</div>
</div>
</div>
<p>
The <span class="command"><strong>dcut</strong></span> script (part of the package <code class="systemitem">dput</code>,
<a class="xref" href="apa.html#dput" title="A.5.2. dput">Section A.5.2, “<code class="systemitem">dput</code>”</a>) helps in removing files from the ftp upload directory.
</p>
</div>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="tools-maint-automate"/>A.6. Maintenance automation</h2>
</div>
</div>
</div>
<p>
The following tools help automate different maintenance tasks, from adding
changelog entries or signature lines and looking up bugs in Emacs to making use
of the newest and official <code class="filename">config.sub</code>.
</p>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="devscripts"/>A.6.1. <code class="systemitem">devscripts</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">devscripts</code> is a package containing
wrappers and tools which are very helpful for maintaining your Debian packages.
Example scripts include <span class="command"><strong>debchange</strong></span> and
<span class="command"><strong>dch</strong></span>, which manipulate your
<code class="filename">debian/changelog</code> file from the command-line, and
<span class="command"><strong>debuild</strong></span>, which is a wrapper around
<span class="command"><strong>dpkg-buildpackage</strong></span>. The <span class="command"><strong>bts</strong></span> utility is
also very helpful to update the state of bug reports on the command line.
<span class="command"><strong>uscan</strong></span> can be used to watch for new upstream versions of your
packages. <span class="command"><strong>debrsign</strong></span> can be used to remotely sign a package
prior to upload, which is nice when the machine you build the package on is
different from where your GPG keys are.
</p>
<p>
See the <span class="citerefentry"><span class="refentrytitle">devscripts</span>(1)</span> manual page for a complete list of
available scripts.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="autotools-dev"/>A.6.2. <code class="systemitem">autotools-dev</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">autotools-dev</code> contains best practices
for people who maintain packages which use <span class="command"><strong>autoconf</strong></span> and/or
<span class="command"><strong>automake</strong></span>. Also contains canonical
<code class="filename">config.sub</code> and <code class="filename">config.guess</code> files
which are known to work on all Debian ports.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="dpkg-repack"/>A.6.3. <code class="systemitem">dpkg-repack</code></h3>
</div>
</div>
</div>
<p>
<span class="command"><strong>dpkg-repack</strong></span> creates Debian package file out of a package
that has already been installed. If any changes have been made to the package
while it was unpacked (e.g., files in <code class="filename">/etc</code> were modified),
the new package will inherit the changes.
</p>
<p>
This utility can make it easy to copy packages from one computer to another, or
to recreate packages which are installed on your system but no longer available
elsewhere, or to save the current state of a package before you upgrade it.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="alien"/>A.6.4. <code class="systemitem">alien</code></h3>
</div>
</div>
</div>
<p>
<span class="command"><strong>alien</strong></span> converts binary packages between various packaging
formats, including Debian, RPM (RedHat), LSB (Linux Standard Base), Solaris,
and Slackware packages.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="dpkg-dev-el"/>A.6.5. <code class="systemitem">dpkg-dev-el</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">dpkg-dev-el</code> is an Emacs lisp package
which provides assistance when editing some of the files in the
<code class="filename">debian</code> directory of your package. For instance, there are
handy functions for listing a package's current bugs, and for finalizing the
latest entry in a <code class="filename">debian/changelog</code> file.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="dpkg-depcheck"/>A.6.6. <span class="command"><strong>dpkg-depcheck</strong></span></h3>
</div>
</div>
</div>
<p>
<span class="command"><strong>dpkg-depcheck</strong></span> (from the <code class="systemitem">devscripts</code> package, <a class="xref" href="apa.html#devscripts" title="A.6.1. devscripts">Section A.6.1, “<code class="systemitem">devscripts</code>”</a>)
runs a command under <span class="command"><strong>strace</strong></span> to determine all the packages
that were used by the said command.
</p>
<p>
For Debian packages, this is useful when you have to compose a
<code class="literal">Build-Depends</code> line for your new package: running the build
process through <span class="command"><strong>dpkg-depcheck</strong></span> will provide you with a good
first approximation of the build-dependencies. For example:
</p>
<pre class="screen">
dpkg-depcheck -b debian/rules build
</pre>
<p>
<span class="command"><strong>dpkg-depcheck</strong></span> can also be used to check for run-time
dependencies, especially if your package uses <span class="citerefentry"><span class="refentrytitle">exec</span>(2)</span>
to run other programs.
</p>
<p>
For more information please see <span class="citerefentry"><span class="refentrytitle">dpkg-depcheck</span>(1)</span>.
</p>
</div>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="tools-porting"/>A.7. Porting tools</h2>
</div>
</div>
</div>
<p>
The following tools are helpful for porters and for cross-compilation.
</p>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="dpkg-cross"/>A.7.1. <code class="systemitem">dpkg-cross</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">dpkg-cross</code> is a tool for installing
libraries and headers for cross-compiling in a way similar to <code class="systemitem">dpkg</code>. Furthermore, the functionality of
<span class="command"><strong>dpkg-buildpackage</strong></span> and <span class="command"><strong>dpkg-shlibdeps</strong></span> is
enhanced to support cross-compiling.
</p>
</div>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="tools-doc"/>A.8. Documentation and information</h2>
</div>
</div>
</div>
<p>
The following packages provide information for maintainers or help with
building documentation.
</p>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="docbook-xml"/>A.8.1. <code class="systemitem">docbook-xml</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">docbook-xml</code> provides the
DocBook XML DTDs, which are commonly used for Debian documentation (as
is the older debiandoc SGML DTD). This manual, for instance, is
written in DocBook XML.
</p>
<p>
The <code class="systemitem">docbook-xsl</code> package
provides the XSL files for building and styling the source to various
output formats. You will need an XSLT processor, such as <code class="systemitem">xsltproc</code>, to use the XSL stylesheets.
Documentation for the stylesheets can be found in the various
<code class="systemitem">docbook-xsl-doc-*</code> packages.
</p>
<p>
To produce PDF from FO, you need an FO processor, such as <code class="systemitem">xmlroff</code> or <code class="systemitem">fop</code>. Another tool to generate PDF from
DocBook XML is <code class="systemitem">dblatex</code>.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="debiandoc-sgml"/>A.8.2. <code class="systemitem">debiandoc-sgml</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">debiandoc-sgml</code> provides the DebianDoc
SGML DTD, which is commonly used for Debian documentation,
but is now deprecated
(<code class="systemitem">docbook-xml</code>
should be used instead).
It also provides scripts for building and
styling the source to various output formats.
</p>
<p>
Documentation for the DTD can be found in the <code class="systemitem">debiandoc-sgml-doc</code> package.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="debian-keyring"/>A.8.3. <code class="systemitem">debian-keyring</code></h3>
</div>
</div>
</div>
<p>
Contains the public GPG keys of Debian Developers and Maintainers.
See <a class="xref" href="ch03.html#key-maint" title="3.2.2. Maintaining your public key">Section 3.2.2, “Maintaining your public key”</a> and the package documentation for more
information.
</p>
</div>
<div class="section">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="debian-el"/>A.8.4. <code class="systemitem">debian-el</code></h3>
</div>
</div>
</div>
<p>
<code class="systemitem">debian-el</code> provides an Emacs mode for
viewing Debian binary packages. This lets you examine a package without
unpacking it.
</p>
</div>
</div>
</div>
<div class="navfooter">
<hr/>
<table width="100%" summary="Navigation footer">
<tr>
<td align="left"><a accesskey="p" href="ch08.html"><img src="images/prev.png" alt="Prev"/></a> </td>
<td align="center"> </td>
<td align="right"> </td>
</tr>
<tr>
<td align="left" valign="top">Chapter 8. Internationalization and Translations </td>
<td align="center">
<a accesskey="h" href="index.html">
<img src="images/home.png" alt="Home"/>
</a>
</td>
<td align="right" valign="top"> </td>
</tr>
</table>
</div>
</body>
</html>
|