1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2011-03-03 11:18-0400\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
19 #. type: Content of: <appendix><title>
21 msgid "Overview of Debian Maintainer Tools"
24 #. type: Content of: <appendix><para>
27 "This section contains a rough overview of the tools available to "
28 "maintainers. The following is by no means complete or definitive, but just "
29 "a guide to some of the more popular tools."
32 #. type: Content of: <appendix><para>
35 "Debian maintainer tools are meant to aid developers and free their time for "
36 "critical tasks. As Larry Wall says, there's more than one way to do it."
39 #. type: Content of: <appendix><para>
42 "Some people prefer to use high-level package maintenance tools and some do "
43 "not. Debian is officially agnostic on this issue; any tool which gets the "
44 "job done is fine. Therefore, this section is not meant to stipulate to "
45 "anyone which tools they should use or how they should go about their duties "
46 "of maintainership. Nor is it meant to endorse any particular tool to the "
47 "exclusion of a competing tool."
50 #. type: Content of: <appendix><para>
53 "Most of the descriptions of these packages come from the actual package "
54 "descriptions themselves. Further information can be found in the package "
55 "documentation itself. You can also see more info with the command "
56 "<command>apt-cache show <replaceable>package-name</replaceable></command>."
59 #. type: Content of: <appendix><section><title>
64 #. type: Content of: <appendix><section><para>
66 msgid "The following tools are pretty much required for any maintainer."
69 #. type: Content of: <appendix><section><section><title>
71 msgid "<systemitem role=\"package\">dpkg-dev</systemitem>"
74 #. type: Content of: <appendix><section><section><para>
77 "<systemitem role=\"package\">dpkg-dev</systemitem> contains the tools "
78 "(including <command>dpkg-source</command>) required to unpack, build, and "
79 "upload Debian source packages. These utilities contain the fundamental, "
80 "low-level functionality required to create and manipulate packages; as such, "
81 "they are essential for any Debian maintainer."
84 #. type: Content of: <appendix><section><section><title>
86 msgid "<systemitem role=\"package\">debconf</systemitem>"
89 #. type: Content of: <appendix><section><section><para>
92 "<systemitem role=\"package\">debconf</systemitem> provides a consistent "
93 "interface to configuring packages interactively. It is user interface "
94 "independent, allowing end-users to configure packages with a text-only "
95 "interface, an HTML interface, or a dialog interface. New interfaces can be "
99 #. type: Content of: <appendix><section><section><para>
102 "You can find documentation for this package in the <systemitem "
103 "role=\"package\">debconf-doc</systemitem> package."
106 #. type: Content of: <appendix><section><section><para>
109 "Many feel that this system should be used for all packages which require "
110 "interactive configuration; see <xref linkend=\"bpp-config-mgmt\"/>. "
111 "<systemitem role=\"package\">debconf</systemitem> is not currently required "
112 "by Debian Policy, but that may change in the future."
115 #. type: Content of: <appendix><section><section><title>
117 msgid "<systemitem role=\"package\">fakeroot</systemitem>"
120 #. type: Content of: <appendix><section><section><para>
123 "<systemitem role=\"package\">fakeroot</systemitem> simulates root "
124 "privileges. This enables you to build packages without being root (packages "
125 "usually want to install files with root ownership). If you have <systemitem "
126 "role=\"package\">fakeroot</systemitem> installed, you can build packages as "
127 "a regular user: <literal>dpkg-buildpackage -rfakeroot</literal>."
130 #. type: Content of: <appendix><section><title>
132 msgid "Package lint tools"
135 #. type: Content of: <appendix><section><para>
138 "According to the Free On-line Dictionary of Computing (FOLDOC), `lint' is a "
139 "Unix C language processor which carries out more thorough checks on the code "
140 "than is usual with C compilers. Package lint tools help package maintainers "
141 "by automatically finding common problems and policy violations in their "
145 #. type: Content of: <appendix><section><section><title>
147 msgid "<systemitem role=\"package\">lintian</systemitem>"
150 #. type: Content of: <appendix><section><section><para>
153 "<systemitem role=\"package\">lintian</systemitem> dissects Debian packages "
154 "and emits information about bugs and policy violations. It contains "
155 "automated checks for many aspects of Debian policy as well as some checks "
159 #. type: Content of: <appendix><section><section><para>
162 "You should periodically get the newest <systemitem "
163 "role=\"package\">lintian</systemitem> from <literal>unstable</literal> and "
164 "check over all your packages. Notice that the <literal>-i</literal> option "
165 "provides detailed explanations of what each error or warning means, what its "
166 "basis in Policy is, and commonly how you can fix the problem."
169 #. type: Content of: <appendix><section><section><para>
172 "Refer to <xref linkend=\"sanitycheck\"/> for more information on how and "
173 "when to use Lintian."
176 #. type: Content of: <appendix><section><section><para>
179 "You can also see a summary of all problems reported by Lintian on your "
180 "packages at <ulink url=\"&url-lintian;\"></ulink>. These reports contain "
181 "the latest <command>lintian</command> output for the whole development "
182 "distribution (<literal>unstable</literal>)."
185 #. type: Content of: <appendix><section><section><title>
187 msgid "<command>debdiff</command>"
190 #. type: Content of: <appendix><section><section><para>
193 "<command>debdiff</command> (from the <systemitem "
194 "role=\"package\">devscripts</systemitem> package, <xref "
195 "linkend=\"devscripts\"/>) compares file lists and control files of two "
196 "packages. It is a simple regression test, as it will help you notice if the "
197 "number of binary packages has changed since the last upload, or if something "
198 "has changed in the control file. Of course, some of the changes it reports "
199 "will be all right, but it can help you prevent various accidents."
202 #. type: Content of: <appendix><section><section><para>
204 msgid "You can run it over a pair of binary packages:"
207 #. type: Content of: <appendix><section><section><screen>
210 msgid "debdiff package_1-1_arch.deb package_2-1_arch.deb\n"
213 #. type: Content of: <appendix><section><section><para>
215 msgid "Or even a pair of changes files:"
218 #. type: Content of: <appendix><section><section><screen>
221 msgid "debdiff package_1-1_arch.changes package_2-1_arch.changes\n"
224 #. type: Content of: <appendix><section><section><para>
227 "For more information please see <citerefentry> "
228 "<refentrytitle>debdiff</refentrytitle> <manvolnum>1</manvolnum> "
232 #. type: Content of: <appendix><section><title>
234 msgid "Helpers for <filename>debian/rules</filename>"
237 #. type: Content of: <appendix><section><para>
240 "Package building tools make the process of writing "
241 "<filename>debian/rules</filename> files easier. See <xref "
242 "linkend=\"helper-scripts\"/> for more information about why these might or "
243 "might not be desired."
246 #. type: Content of: <appendix><section><section><title>
248 msgid "<systemitem role=\"package\">debhelper</systemitem>"
251 #. type: Content of: <appendix><section><section><para>
254 "<systemitem role=\"package\">debhelper</systemitem> is a collection of "
255 "programs which can be used in <filename>debian/rules</filename> to automate "
256 "common tasks related to building binary Debian packages. <systemitem "
257 "role=\"package\">debhelper</systemitem> includes programs to install various "
258 "files into your package, compress files, fix file permissions, and integrate "
259 "your package with the Debian menu system."
262 #. type: Content of: <appendix><section><section><para>
265 "Unlike some approaches, <systemitem role=\"package\">debhelper</systemitem> "
266 "is broken into several small, simple commands which act in a consistent "
267 "manner. As such, it allows more fine-grained control than some of the other "
268 "debian/rules tools."
271 #. type: Content of: <appendix><section><section><para>
274 "There are a number of little <systemitem "
275 "role=\"package\">debhelper</systemitem> add-on packages, too transient to "
276 "document. You can see the list of most of them by doing <literal>apt-cache "
277 "search ^dh-</literal>."
280 #. type: Content of: <appendix><section><section><title>
282 msgid "<systemitem role=\"package\">dh-make</systemitem>"
285 #. type: Content of: <appendix><section><section><para>
288 "The <systemitem role=\"package\">dh-make</systemitem> package contains "
289 "<command>dh_make</command>, a program that creates a skeleton of files "
290 "necessary to build a Debian package out of a source tree. As the name "
291 "suggests, <command>dh_make</command> is a rewrite of <systemitem "
292 "role=\"package\">debmake</systemitem> and its template files use "
293 "<command>dh_*</command> programs from <systemitem "
294 "role=\"package\">debhelper</systemitem>."
297 #. type: Content of: <appendix><section><section><para>
300 "While the rules files generated by <command>dh_make</command> are in general "
301 "a sufficient basis for a working package, they are still just the "
302 "groundwork: the burden still lies on the maintainer to finely tune the "
303 "generated files and make the package entirely functional and "
307 #. type: Content of: <appendix><section><section><title>
309 msgid "<systemitem role=\"package\">yada</systemitem>"
312 #. type: Content of: <appendix><section><section><para>
315 "<systemitem role=\"package\">yada</systemitem> is another packaging helper "
316 "tool. It uses a <filename>debian/packages</filename> file to auto-generate "
317 "<filename>debian/rules</filename> and other necessary files in the "
318 "<filename>debian/</filename> subdirectory. The "
319 "<filename>debian/packages</filename> file contains instruction to build "
320 "packages and there is no need to create any <filename>Makefile</filename> "
321 "files. There is possibility to use macro engine similar to the one used in "
322 "SPECS files from RPM source packages."
325 #. type: Content of: <appendix><section><section><para>
328 "For more informations see <ulink "
329 "url=\"http://yada.alioth.debian.org/\"><literal>YADA</literal> site</ulink>."
332 #. type: Content of: <appendix><section><section><title>
334 msgid "<systemitem role=\"package\">equivs</systemitem>"
337 #. type: Content of: <appendix><section><section><para>
340 "<systemitem role=\"package\">equivs</systemitem> is another package for "
341 "making packages. It is often suggested for local use if you need to make a "
342 "package simply to fulfill dependencies. It is also sometimes used when "
343 "making ``meta-packages'', which are packages whose only purpose is to depend "
347 #. type: Content of: <appendix><section><title>
349 msgid "Package builders"
352 #. type: Content of: <appendix><section><para>
355 "The following packages help with the package building process, general "
356 "driving <command>dpkg-buildpackage</command> as well as handling supporting "
360 #. type: Content of: <appendix><section><section><title>
362 msgid "<systemitem role=\"package\">cvs-buildpackage</systemitem>"
365 #. type: Content of: <appendix><section><section><para>
368 "<systemitem role=\"package\">cvs-buildpackage</systemitem> provides the "
369 "capability to inject or import Debian source packages into a CVS repository, "
370 "build a Debian package from the CVS repository, and helps in integrating "
371 "upstream changes into the repository."
374 #. type: Content of: <appendix><section><section><para>
377 "These utilities provide an infrastructure to facilitate the use of CVS by "
378 "Debian maintainers. This allows one to keep separate CVS branches of a "
379 "package for <literal>stable</literal>, <literal>unstable</literal> and "
380 "possibly <literal>experimental</literal> distributions, along with the other "
381 "benefits of a version control system."
384 #. type: Content of: <appendix><section><section><title>
386 msgid "<systemitem role=\"package\">debootstrap</systemitem>"
389 #. type: Content of: <appendix><section><section><para>
392 "The <systemitem role=\"package\">debootstrap</systemitem> package and script "
393 "allows you to bootstrap a Debian base system into any part of your "
394 "filesystem. By base system, we mean the bare minimum of packages required "
395 "to operate and install the rest of the system."
398 #. type: Content of: <appendix><section><section><para>
401 "Having a system like this can be useful in many ways. For instance, you can "
402 "<command>chroot</command> into it if you want to test your build "
403 "dependencies. Or you can test how your package behaves when installed into "
404 "a bare base system. Chroot builders use this package; see below."
407 #. type: Content of: <appendix><section><section><title>
409 msgid "<systemitem role=\"package\">pbuilder</systemitem>"
412 #. type: Content of: <appendix><section><section><para>
415 "<systemitem role=\"package\">pbuilder</systemitem> constructs a chrooted "
416 "system, and builds a package inside the chroot. It is very useful to check "
417 "that a package's build-dependencies are correct, and to be sure that "
418 "unnecessary and wrong build dependencies will not exist in the resulting "
422 #. type: Content of: <appendix><section><section><para>
425 "A related package is <systemitem role=\"package\">pbuilder-uml</systemitem>, "
426 "which goes even further by doing the build within a User Mode Linux "
430 #. type: Content of: <appendix><section><section><title>
432 msgid "<systemitem role=\"package\">sbuild</systemitem>"
435 #. type: Content of: <appendix><section><section><para>
438 "<systemitem role=\"package\">sbuild</systemitem> is another automated "
439 "builder. It can use chrooted environments as well. It can be used "
440 "stand-alone, or as part of a networked, distributed build environment. As "
441 "the latter, it is part of the system used by porters to build binary "
442 "packages for all the available architectures. See <xref "
443 "linkend=\"wanna-build\"/> for more information, and <ulink "
444 "url=\"&url-buildd;\"></ulink> to see the system in action."
447 #. type: Content of: <appendix><section><title>
449 msgid "Package uploaders"
452 #. type: Content of: <appendix><section><para>
455 "The following packages help automate or simplify the process of uploading "
456 "packages into the official archive."
459 #. type: Content of: <appendix><section><section><title>
461 msgid "<systemitem role=\"package\">dupload</systemitem>"
464 #. type: Content of: <appendix><section><section><para>
467 "<systemitem role=\"package\">dupload</systemitem> is a package and a script "
468 "to automatically upload Debian packages to the Debian archive, to log the "
469 "upload, and to send mail about the upload of a package. You can configure "
470 "it for new upload locations or methods."
473 #. type: Content of: <appendix><section><section><title>
475 msgid "<systemitem role=\"package\">dput</systemitem>"
478 #. type: Content of: <appendix><section><section><para>
481 "The <systemitem role=\"package\">dput</systemitem> package and script does "
482 "much the same thing as <systemitem role=\"package\">dupload</systemitem>, "
483 "but in a different way. It has some features over <systemitem "
484 "role=\"package\">dupload</systemitem>, such as the ability to check the "
485 "GnuPG signature and checksums before uploading, and the possibility of "
486 "running <command>dinstall</command> in dry-run mode after the upload."
489 #. type: Content of: <appendix><section><section><title>
491 msgid "<command>dcut</command>"
494 #. type: Content of: <appendix><section><section><para>
497 "The <command>dcut</command> script (part of the package <systemitem "
498 "role=\"package\">dput</systemitem>, <xref linkend=\"dput\"/>) helps in "
499 "removing files from the ftp upload directory."
502 #. type: Content of: <appendix><section><title>
504 msgid "Maintenance automation"
507 #. type: Content of: <appendix><section><para>
510 "The following tools help automate different maintenance tasks, from adding "
511 "changelog entries or signature lines and looking up bugs in Emacs to making "
512 "use of the newest and official <filename>config.sub</filename>."
515 #. type: Content of: <appendix><section><section><title>
517 msgid "<systemitem role=\"package\">devscripts</systemitem>"
520 #. type: Content of: <appendix><section><section><para>
523 "<systemitem role=\"package\">devscripts</systemitem> is a package containing "
524 "wrappers and tools which are very helpful for maintaining your Debian "
525 "packages. Example scripts include <command>debchange</command> and "
526 "<command>dch</command>, which manipulate your "
527 "<filename>debian/changelog</filename> file from the command-line, and "
528 "<command>debuild</command>, which is a wrapper around "
529 "<command>dpkg-buildpackage</command>. The <command>bts</command> utility is "
530 "also very helpful to update the state of bug reports on the command line. "
531 "<command>uscan</command> can be used to watch for new upstream versions of "
532 "your packages. <command>debrsign</command> can be used to remotely sign a "
533 "package prior to upload, which is nice when the machine you build the "
534 "package on is different from where your GPG keys are."
537 #. type: Content of: <appendix><section><section><para>
540 "See the <citerefentry> <refentrytitle>devscripts</refentrytitle> "
541 "<manvolnum>1</manvolnum> </citerefentry> manual page for a complete list of "
545 #. type: Content of: <appendix><section><section><title>
547 msgid "<systemitem role=\"package\">autotools-dev</systemitem>"
550 #. type: Content of: <appendix><section><section><para>
553 "<systemitem role=\"package\">autotools-dev</systemitem> contains best "
554 "practices for people who maintain packages which use "
555 "<command>autoconf</command> and/or <command>automake</command>. Also "
556 "contains canonical <filename>config.sub</filename> and "
557 "<filename>config.guess</filename> files which are known to work on all "
561 #. type: Content of: <appendix><section><section><title>
563 msgid "<systemitem role=\"package\">dpkg-repack</systemitem>"
566 #. type: Content of: <appendix><section><section><para>
569 "<command>dpkg-repack</command> creates Debian package file out of a package "
570 "that has already been installed. If any changes have been made to the "
571 "package while it was unpacked (e.g., files in <filename>/etc</filename> were "
572 "modified), the new package will inherit the changes."
575 #. type: Content of: <appendix><section><section><para>
578 "This utility can make it easy to copy packages from one computer to another, "
579 "or to recreate packages which are installed on your system but no longer "
580 "available elsewhere, or to save the current state of a package before you "
584 #. type: Content of: <appendix><section><section><title>
586 msgid "<systemitem role=\"package\">alien</systemitem>"
589 #. type: Content of: <appendix><section><section><para>
592 "<command>alien</command> converts binary packages between various packaging "
593 "formats, including Debian, RPM (RedHat), LSB (Linux Standard Base), Solaris, "
594 "and Slackware packages."
597 #. type: Content of: <appendix><section><section><title>
599 msgid "<systemitem role=\"package\">debsums</systemitem>"
602 #. type: Content of: <appendix><section><section><para>
605 "<command>debsums</command> checks installed packages against their MD5 "
606 "sums. Note that not all packages have MD5 sums, since they aren't required "
610 #. type: Content of: <appendix><section><section><title>
612 msgid "<systemitem role=\"package\">dpkg-dev-el</systemitem>"
615 #. type: Content of: <appendix><section><section><para>
618 "<systemitem role=\"package\">dpkg-dev-el</systemitem> is an Emacs lisp "
619 "package which provides assistance when editing some of the files in the "
620 "<filename>debian</filename> directory of your package. For instance, there "
621 "are handy functions for listing a package's current bugs, and for finalizing "
622 "the latest entry in a <filename>debian/changelog</filename> file."
625 #. type: Content of: <appendix><section><section><title>
627 msgid "<command>dpkg-depcheck</command>"
630 #. type: Content of: <appendix><section><section><para>
633 "<command>dpkg-depcheck</command> (from the <systemitem "
634 "role=\"package\">devscripts</systemitem> package, <xref "
635 "linkend=\"devscripts\"/>) runs a command under <command>strace</command> to "
636 "determine all the packages that were used by the said command."
639 #. type: Content of: <appendix><section><section><para>
642 "For Debian packages, this is useful when you have to compose a "
643 "<literal>Build-Depends</literal> line for your new package: running the "
644 "build process through <command>dpkg-depcheck</command> will provide you with "
645 "a good first approximation of the build-dependencies. For example:"
648 #. type: Content of: <appendix><section><section><screen>
651 msgid "dpkg-depcheck -b debian/rules build\n"
654 #. type: Content of: <appendix><section><section><para>
657 "<command>dpkg-depcheck</command> can also be used to check for run-time "
658 "dependencies, especially if your package uses <citerefentry> "
659 "<refentrytitle>exec</refentrytitle> <manvolnum>2</manvolnum> </citerefentry> "
660 "to run other programs."
663 #. type: Content of: <appendix><section><section><para>
666 "For more information please see <citerefentry> "
667 "<refentrytitle>dpkg-depcheck</refentrytitle> <manvolnum>1</manvolnum> "
671 #. type: Content of: <appendix><section><title>
673 msgid "Porting tools"
676 #. type: Content of: <appendix><section><para>
678 msgid "The following tools are helpful for porters and for cross-compilation."
681 #. type: Content of: <appendix><section><section><title>
683 msgid "<systemitem role=\"package\">quinn-diff</systemitem>"
686 #. type: Content of: <appendix><section><section><para>
689 "<systemitem role=\"package\">quinn-diff</systemitem> is used to locate the "
690 "differences from one architecture to another. For instance, it could tell "
691 "you which packages need to be ported for architecture "
692 "<replaceable>Y</replaceable>, based on architecture "
693 "<replaceable>X</replaceable>."
696 #. type: Content of: <appendix><section><section><title>
698 msgid "<systemitem role=\"package\">dpkg-cross</systemitem>"
701 #. type: Content of: <appendix><section><section><para>
704 "<systemitem role=\"package\">dpkg-cross</systemitem> is a tool for "
705 "installing libraries and headers for cross-compiling in a way similar to "
706 "<systemitem role=\"package\">dpkg</systemitem>. Furthermore, the "
707 "functionality of <command>dpkg-buildpackage</command> and "
708 "<command>dpkg-shlibdeps</command> is enhanced to support cross-compiling."
711 #. type: Content of: <appendix><section><title>
713 msgid "Documentation and information"
716 #. type: Content of: <appendix><section><para>
719 "The following packages provide information for maintainers or help with "
720 "building documentation."
723 #. type: Content of: <appendix><section><section><title>
725 msgid "<systemitem role=\"package\">docbook-xml</systemitem>"
728 #. type: Content of: <appendix><section><section><para>
731 "<systemitem role=\"package\">docbook-xml</systemitem> provides the DocBook "
732 "XML DTDs, which are commonly used for Debian documentation (as is the older "
733 "debiandoc SGML DTD). This manual, for instance, is written in DocBook XML."
736 #. type: Content of: <appendix><section><section><para>
739 "The <systemitem role=\"package\">docbook-xsl</systemitem> package provides "
740 "the XSL files for building and styling the source to various output "
741 "formats. You will need an XSLT processor, such as <systemitem "
742 "role=\"package\">xsltproc</systemitem>, to use the XSL stylesheets. "
743 "Documentation for the stylesheets can be found in the various <systemitem "
744 "role=\"package\">docbook-xsl-doc-*</systemitem> packages."
747 #. type: Content of: <appendix><section><section><para>
750 "To produce PDF from FO, you need an FO processor, such as <systemitem "
751 "role=\"package\">xmlroff</systemitem> or <systemitem "
752 "role=\"package\">fop</systemitem>. Another tool to generate PDF from DocBook "
753 "XML is <systemitem role=\"package\">dblatex</systemitem>."
756 #. type: Content of: <appendix><section><section><title>
758 msgid "<systemitem role=\"package\">debiandoc-sgml</systemitem>"
761 #. type: Content of: <appendix><section><section><para>
764 "<systemitem role=\"package\">debiandoc-sgml</systemitem> provides the "
765 "DebianDoc SGML DTD, which is commonly used for Debian documentation, but is "
766 "now deprecated (<systemitem role=\"package\">docbook-xml</systemitem> should "
767 "be used instead). It also provides scripts for building and styling the "
768 "source to various output formats."
771 #. type: Content of: <appendix><section><section><para>
774 "Documentation for the DTD can be found in the <systemitem "
775 "role=\"package\">debiandoc-sgml-doc</systemitem> package."
778 #. type: Content of: <appendix><section><section><title>
780 msgid "<systemitem role=\"package\">debian-keyring</systemitem>"
783 #. type: Content of: <appendix><section><section><para>
786 "Contains the public GPG and PGP keys of Debian developers. See <xref "
787 "linkend=\"key-maint\"/> and the package documentation for more information."
790 #. type: Content of: <appendix><section><section><title>
792 msgid "<systemitem role=\"package\">debian-maintainers</systemitem>"
795 #. type: Content of: <appendix><section><section><para>
798 "Contains the public GPG keys of Debian Maintainers. See <ulink "
799 "url=\"&url-wiki-dm;\"></ulink> for more information."
802 #. type: Content of: <appendix><section><section><title>
804 msgid "<systemitem role=\"package\">debview</systemitem>"
807 #. type: Content of: <appendix><section><section><para>
810 "<systemitem role=\"package\">debview</systemitem> provides an Emacs mode for "
811 "viewing Debian binary packages. This lets you examine a package without "