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: 2010-05-06 17:34-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"
15 "Content-Type: text/plain; charset=utf-8\n"
16 "Content-Transfer-Encoding: ENCODING"
18 #. type: Content of: <appendix><title>
20 msgid "Overview of Debian Maintainer Tools"
23 #. type: Content of: <appendix><para>
26 "This section contains a rough overview of the tools available to "
27 "maintainers. The following is by no means complete or definitive, but just "
28 "a guide to some of the more popular tools."
31 #. type: Content of: <appendix><para>
34 "Debian maintainer tools are meant to aid developers and free their time for "
35 "critical tasks. As Larry Wall says, there's more than one way to do it."
38 #. type: Content of: <appendix><para>
41 "Some people prefer to use high-level package maintenance tools and some do "
42 "not. Debian is officially agnostic on this issue; any tool which gets the "
43 "job done is fine. Therefore, this section is not meant to stipulate to "
44 "anyone which tools they should use or how they should go about their duties "
45 "of maintainership. Nor is it meant to endorse any particular tool to the "
46 "exclusion of a competing tool."
49 #. type: Content of: <appendix><para>
52 "Most of the descriptions of these packages come from the actual package "
53 "descriptions themselves. Further information can be found in the package "
54 "documentation itself. You can also see more info with the command "
55 "<command>apt-cache show <package-name></command>."
58 #. type: Content of: <appendix><section><title>
63 #. type: Content of: <appendix><section><para>
65 msgid "The following tools are pretty much required for any maintainer."
68 #. type: Content of: <appendix><section><section><title>
70 msgid "<systemitem role=\"package\">dpkg-dev</systemitem>"
73 #. type: Content of: <appendix><section><section><para>
76 "<systemitem role=\"package\">dpkg-dev</systemitem> contains the tools "
77 "(including <command>dpkg-source</command>) required to unpack, build, and "
78 "upload Debian source packages. These utilities contain the fundamental, "
79 "low-level functionality required to create and manipulate packages; as such, "
80 "they are essential for any Debian maintainer."
83 #. type: Content of: <appendix><section><section><title>
85 msgid "<systemitem role=\"package\">debconf</systemitem>"
88 #. type: Content of: <appendix><section><section><para>
91 "<systemitem role=\"package\">debconf</systemitem> provides a consistent "
92 "interface to configuring packages interactively. It is user interface "
93 "independent, allowing end-users to configure packages with a text-only "
94 "interface, an HTML interface, or a dialog interface. New interfaces can be "
98 #. type: Content of: <appendix><section><section><para>
101 "You can find documentation for this package in the <systemitem "
102 "role=\"package\">debconf-doc</systemitem> package."
105 #. type: Content of: <appendix><section><section><para>
108 "Many feel that this system should be used for all packages which require "
109 "interactive configuration; see <xref linkend=\"bpp-config-mgmt\"/> . "
110 "<systemitem role=\"package\">debconf</systemitem> is not currently required "
111 "by Debian Policy, but that may change in the future."
114 #. type: Content of: <appendix><section><section><title>
116 msgid "<systemitem role=\"package\">fakeroot</systemitem>"
119 #. type: Content of: <appendix><section><section><para>
122 "<systemitem role=\"package\">fakeroot</systemitem> simulates root "
123 "privileges. This enables you to build packages without being root (packages "
124 "usually want to install files with root ownership). If you have <systemitem "
125 "role=\"package\">fakeroot</systemitem> installed, you can build packages as "
126 "a regular user: <literal>dpkg-buildpackage -rfakeroot</literal>."
129 #. type: Content of: <appendix><section><title>
131 msgid "Package lint tools"
134 #. type: Content of: <appendix><section><para>
137 "According to the Free On-line Dictionary of Computing (FOLDOC), `lint' is a "
138 "Unix C language processor which carries out more thorough checks on the code "
139 "than is usual with C compilers. Package lint tools help package maintainers "
140 "by automatically finding common problems and policy violations in their "
144 #. type: Content of: <appendix><section><section><title>
146 msgid "<systemitem role=\"package\">lintian</systemitem>"
149 #. type: Content of: <appendix><section><section><para>
152 "<systemitem role=\"package\">lintian</systemitem> dissects Debian packages "
153 "and emits information about bugs and policy violations. It contains "
154 "automated checks for many aspects of Debian policy as well as some checks "
158 #. type: Content of: <appendix><section><section><para>
161 "You should periodically get the newest <systemitem "
162 "role=\"package\">lintian</systemitem> from <literal>unstable</literal> and "
163 "check over all your packages. Notice that the <literal>-i</literal> option "
164 "provides detailed explanations of what each error or warning means, what its "
165 "basis in Policy is, and commonly how you can fix the problem."
168 #. type: Content of: <appendix><section><section><para>
171 "Refer to <xref linkend=\"sanitycheck\"/> for more information on how and "
172 "when to use Lintian."
175 #. type: Content of: <appendix><section><section><para>
178 "You can also see a summary of all problems reported by Lintian on your "
179 "packages at <ulink url=\"&url-lintian;\"></ulink>. These reports contain "
180 "the latest <command>lintian</command> output for the whole development "
181 "distribution (<literal>unstable</literal>)."
184 #. type: Content of: <appendix><section><section><title>
186 msgid "<systemitem role=\"package\">debdiff</systemitem>"
189 #. type: Content of: <appendix><section><section><para>
192 "<command>debdiff</command> (from the <systemitem "
193 "role=\"package\">devscripts</systemitem> package, <xref "
194 "linkend=\"devscripts\"/> ) compares file lists and control files of two "
195 "packages. It is a simple regression test, as it will help you notice if the "
196 "number of binary packages has changed since the last upload, or if something "
197 "has changed in the control file. Of course, some of the changes it reports "
198 "will be all right, but it can help you prevent various accidents."
201 #. type: Content of: <appendix><section><section><para>
203 msgid "You can run it over a pair of binary packages:"
206 #. type: Content of: <appendix><section><section><screen>
209 msgid "debdiff package_1-1_arch.deb package_2-1_arch.deb\n"
212 #. type: Content of: <appendix><section><section><para>
214 msgid "Or even a pair of changes files:"
217 #. type: Content of: <appendix><section><section><screen>
220 msgid "debdiff package_1-1_arch.changes package_2-1_arch.changes\n"
223 #. type: Content of: <appendix><section><section><para>
226 "For more information please see <citerefentry> "
227 "<refentrytitle>debdiff</refentrytitle> <manvolnum>1</manvolnum> "
231 #. type: Content of: <appendix><section><title>
233 msgid "Helpers for <filename>debian/rules</filename>"
236 #. type: Content of: <appendix><section><para>
239 "Package building tools make the process of writing "
240 "<filename>debian/rules</filename> files easier. See <xref "
241 "linkend=\"helper-scripts\"/> for more information about why these might or "
242 "might not be desired."
245 #. type: Content of: <appendix><section><section><title>
247 msgid "<systemitem role=\"package\">debhelper</systemitem>"
250 #. type: Content of: <appendix><section><section><para>
253 "<systemitem role=\"package\">debhelper</systemitem> is a collection of "
254 "programs which can be used in <filename>debian/rules</filename> to automate "
255 "common tasks related to building binary Debian packages. <systemitem "
256 "role=\"package\">debhelper</systemitem> includes programs to install various "
257 "files into your package, compress files, fix file permissions, and integrate "
258 "your package with the Debian menu system."
261 #. type: Content of: <appendix><section><section><para>
264 "Unlike some approaches, <systemitem role=\"package\">debhelper</systemitem> "
265 "is broken into several small, simple commands which act in a consistent "
266 "manner. As such, it allows more fine-grained control than some of the other "
267 "debian/rules tools."
270 #. type: Content of: <appendix><section><section><para>
273 "There are a number of little <systemitem "
274 "role=\"package\">debhelper</systemitem> add-on packages, too transient to "
275 "document. You can see the list of most of them by doing <literal>apt-cache "
276 "search ^dh-</literal>."
279 #. type: Content of: <appendix><section><section><title>
281 msgid "<systemitem role=\"package\">dh-make</systemitem>"
284 #. type: Content of: <appendix><section><section><para>
287 "The <systemitem role=\"package\">dh-make</systemitem> package contains "
288 "<command>dh_make</command>, a program that creates a skeleton of files "
289 "necessary to build a Debian package out of a source tree. As the name "
290 "suggests, <command>dh_make</command> is a rewrite of <systemitem "
291 "role=\"package\">debmake</systemitem> and its template files use dh_* "
292 "programs from <systemitem role=\"package\">debhelper</systemitem>."
295 #. type: Content of: <appendix><section><section><para>
298 "While the rules files generated by <command>dh_make</command> are in general "
299 "a sufficient basis for a working package, they are still just the "
300 "groundwork: the burden still lies on the maintainer to finely tune the "
301 "generated files and make the package entirely functional and "
305 #. type: Content of: <appendix><section><section><title>
307 msgid "<systemitem role=\"package\">yada</systemitem>"
310 #. type: Content of: <appendix><section><section><para>
313 "<systemitem role=\"package\">yada</systemitem> is another packaging helper "
314 "tool. It uses a <filename>debian/packages</filename> file to auto-generate "
315 "<filename>debian/rules</filename> and other necessary files in the "
316 "<filename>debian/</filename> subdirectory. The "
317 "<filename>debian/packages</filename> file contains instruction to build "
318 "packages and there is no need to create any <filename>Makefile</filename> "
319 "files. There is possibility to use macro engine similar to the one used in "
320 "SPECS files from RPM source packages."
323 #. type: Content of: <appendix><section><section><para>
326 "For more informations see <literal><ulink "
327 "url=\"http://yada.alioth.debian.org/\">YADA site</ulink></literal>."
330 #. type: Content of: <appendix><section><section><title>
332 msgid "<systemitem role=\"package\">equivs</systemitem>"
335 #. type: Content of: <appendix><section><section><para>
338 "<systemitem role=\"package\">equivs</systemitem> is another package for "
339 "making packages. It is often suggested for local use if you need to make a "
340 "package simply to fulfill dependencies. It is also sometimes used when "
341 "making ``meta-packages'', which are packages whose only purpose is to depend "
345 #. type: Content of: <appendix><section><title>
347 msgid "Package builders"
350 #. type: Content of: <appendix><section><para>
353 "The following packages help with the package building process, general "
354 "driving <command>dpkg-buildpackage</command> as well as handling supporting "
358 #. type: Content of: <appendix><section><section><title>
360 msgid "<systemitem role=\"package\">cvs-buildpackage</systemitem>"
363 #. type: Content of: <appendix><section><section><para>
366 "<systemitem role=\"package\">cvs-buildpackage</systemitem> provides the "
367 "capability to inject or import Debian source packages into a CVS repository, "
368 "build a Debian package from the CVS repository, and helps in integrating "
369 "upstream changes into the repository."
372 #. type: Content of: <appendix><section><section><para>
375 "These utilities provide an infrastructure to facilitate the use of CVS by "
376 "Debian maintainers. This allows one to keep separate CVS branches of a "
377 "package for <literal>stable</literal>, <literal>unstable</literal> and "
378 "possibly <literal>experimental</literal> distributions, along with the other "
379 "benefits of a version control system."
382 #. type: Content of: <appendix><section><section><title>
384 msgid "<systemitem role=\"package\">debootstrap</systemitem>"
387 #. type: Content of: <appendix><section><section><para>
390 "The <systemitem role=\"package\">debootstrap</systemitem> package and script "
391 "allows you to bootstrap a Debian base system into any part of your "
392 "filesystem. By base system, we mean the bare minimum of packages required "
393 "to operate and install the rest of the system."
396 #. type: Content of: <appendix><section><section><para>
399 "Having a system like this can be useful in many ways. For instance, you can "
400 "<command>chroot</command> into it if you want to test your build "
401 "dependencies. Or you can test how your package behaves when installed into "
402 "a bare base system. Chroot builders use this package; see below."
405 #. type: Content of: <appendix><section><section><title>
407 msgid "<systemitem role=\"package\">pbuilder</systemitem>"
410 #. type: Content of: <appendix><section><section><para>
413 "<systemitem role=\"package\">pbuilder</systemitem> constructs a chrooted "
414 "system, and builds a package inside the chroot. It is very useful to check "
415 "that a package's build-dependencies are correct, and to be sure that "
416 "unnecessary and wrong build dependencies will not exist in the resulting "
420 #. type: Content of: <appendix><section><section><para>
423 "A related package is <systemitem role=\"package\">pbuilder-uml</systemitem>, "
424 "which goes even further by doing the build within a User Mode Linux "
428 #. type: Content of: <appendix><section><section><title>
430 msgid "<systemitem role=\"package\">sbuild</systemitem>"
433 #. type: Content of: <appendix><section><section><para>
436 "<systemitem role=\"package\">sbuild</systemitem> is another automated "
437 "builder. It can use chrooted environments as well. It can be used "
438 "stand-alone, or as part of a networked, distributed build environment. As "
439 "the latter, it is part of the system used by porters to build binary "
440 "packages for all the available architectures. See <xref "
441 "linkend=\"wanna-build\"/> for more information, and <ulink "
442 "url=\"&url-buildd;\"></ulink> to see the system in action."
445 #. type: Content of: <appendix><section><title>
447 msgid "Package uploaders"
450 #. type: Content of: <appendix><section><para>
453 "The following packages help automate or simplify the process of uploading "
454 "packages into the official archive."
457 #. type: Content of: <appendix><section><section><title>
459 msgid "<systemitem role=\"package\">dupload</systemitem>"
462 #. type: Content of: <appendix><section><section><para>
465 "<systemitem role=\"package\">dupload</systemitem> is a package and a script "
466 "to automatically upload Debian packages to the Debian archive, to log the "
467 "upload, and to send mail about the upload of a package. You can configure "
468 "it for new upload locations or methods."
471 #. type: Content of: <appendix><section><section><title>
473 msgid "<systemitem role=\"package\">dput</systemitem>"
476 #. type: Content of: <appendix><section><section><para>
479 "The <systemitem role=\"package\">dput</systemitem> package and script does "
480 "much the same thing as <systemitem role=\"package\">dupload</systemitem>, "
481 "but in a different way. It has some features over <systemitem "
482 "role=\"package\">dupload</systemitem>, such as the ability to check the "
483 "GnuPG signature and checksums before uploading, and the possibility of "
484 "running <command>dinstall</command> in dry-run mode after the upload."
487 #. type: Content of: <appendix><section><section><title>
489 msgid "<systemitem role=\"package\">dcut</systemitem>"
492 #. type: Content of: <appendix><section><section><para>
495 "The <systemitem role=\"package\">dcut</systemitem> script (part of the "
496 "package <xref linkend=\"dput\"/> ) helps in removing files from the ftp "
500 #. type: Content of: <appendix><section><title>
502 msgid "Maintenance automation"
505 #. type: Content of: <appendix><section><para>
508 "The following tools help automate different maintenance tasks, from adding "
509 "changelog entries or signature lines and looking up bugs in Emacs to making "
510 "use of the newest and official <filename>config.sub</filename>."
513 #. type: Content of: <appendix><section><section><title>
515 msgid "<systemitem role=\"package\">devscripts</systemitem>"
518 #. type: Content of: <appendix><section><section><para>
521 "<systemitem role=\"package\">devscripts</systemitem> is a package containing "
522 "wrappers and tools which are very helpful for maintaining your Debian "
523 "packages. Example scripts include <command>debchange</command> and "
524 "<command>dch</command>, which manipulate your "
525 "<filename>debian/changelog</filename> file from the command-line, and "
526 "<command>debuild</command>, which is a wrapper around "
527 "<command>dpkg-buildpackage</command>. The <command>bts</command> utility is "
528 "also very helpful to update the state of bug reports on the command line. "
529 "<command>uscan</command> can be used to watch for new upstream versions of "
530 "your packages. <command>debrsign</command> can be used to remotely sign a "
531 "package prior to upload, which is nice when the machine you build the "
532 "package on is different from where your GPG keys are."
535 #. type: Content of: <appendix><section><section><para>
538 "See the <citerefentry> <refentrytitle>devscripts</refentrytitle> "
539 "<manvolnum>1</manvolnum> </citerefentry> manual page for a complete list of "
543 #. type: Content of: <appendix><section><section><title>
545 msgid "<systemitem role=\"package\">autotools-dev</systemitem>"
548 #. type: Content of: <appendix><section><section><para>
551 "<systemitem role=\"package\">autotools-dev</systemitem> contains best "
552 "practices for people who maintain packages which use "
553 "<command>autoconf</command> and/or <command>automake</command>. Also "
554 "contains canonical <filename>config.sub</filename> and "
555 "<filename>config.guess</filename> files which are known to work on all "
559 #. type: Content of: <appendix><section><section><title>
561 msgid "<systemitem role=\"package\">dpkg-repack</systemitem>"
564 #. type: Content of: <appendix><section><section><para>
567 "<command>dpkg-repack</command> creates Debian package file out of a package "
568 "that has already been installed. If any changes have been made to the "
569 "package while it was unpacked (e.g., files in <filename>/etc</filename> were "
570 "modified), the new package will inherit the changes."
573 #. type: Content of: <appendix><section><section><para>
576 "This utility can make it easy to copy packages from one computer to another, "
577 "or to recreate packages which are installed on your system but no longer "
578 "available elsewhere, or to save the current state of a package before you "
582 #. type: Content of: <appendix><section><section><title>
584 msgid "<systemitem role=\"package\">alien</systemitem>"
587 #. type: Content of: <appendix><section><section><para>
590 "<command>alien</command> converts binary packages between various packaging "
591 "formats, including Debian, RPM (RedHat), LSB (Linux Standard Base), Solaris, "
592 "and Slackware packages."
595 #. type: Content of: <appendix><section><section><title>
597 msgid "<systemitem role=\"package\">debsums</systemitem>"
600 #. type: Content of: <appendix><section><section><para>
603 "<command>debsums</command> checks installed packages against their MD5 "
604 "sums. Note that not all packages have MD5 sums, since they aren't required "
608 #. type: Content of: <appendix><section><section><title>
610 msgid "<systemitem role=\"package\">dpkg-dev-el</systemitem>"
613 #. type: Content of: <appendix><section><section><para>
616 "<systemitem role=\"package\">dpkg-dev-el</systemitem> is an Emacs lisp "
617 "package which provides assistance when editing some of the files in the "
618 "<filename>debian</filename> directory of your package. For instance, there "
619 "are handy functions for listing a package's current bugs, and for finalizing "
620 "the latest entry in a <filename>debian/changelog</filename> file."
623 #. type: Content of: <appendix><section><section><title>
625 msgid "<systemitem role=\"package\">dpkg-depcheck</systemitem>"
628 #. type: Content of: <appendix><section><section><para>
631 "<command>dpkg-depcheck</command> (from the <systemitem "
632 "role=\"package\">devscripts</systemitem> package, <xref "
633 "linkend=\"devscripts\"/> ) runs a command under <command>strace</command> "
634 "to determine all the packages that were used by the said command."
637 #. type: Content of: <appendix><section><section><para>
640 "For Debian packages, this is useful when you have to compose a "
641 "<literal>Build-Depends</literal> line for your new package: running the "
642 "build process through <command>dpkg-depcheck</command> will provide you with "
643 "a good first approximation of the build-dependencies. For example:"
646 #. type: Content of: <appendix><section><section><screen>
649 msgid "dpkg-depcheck -b debian/rules build\n"
652 #. type: Content of: <appendix><section><section><para>
655 "<command>dpkg-depcheck</command> can also be used to check for run-time "
656 "dependencies, especially if your package uses exec(2) to run other programs."
659 #. type: Content of: <appendix><section><section><para>
662 "For more information please see <citerefentry> "
663 "<refentrytitle>dpkg-depcheck</refentrytitle> <manvolnum>1</manvolnum> "
667 #. type: Content of: <appendix><section><title>
669 msgid "Porting tools"
672 #. type: Content of: <appendix><section><para>
674 msgid "The following tools are helpful for porters and for cross-compilation."
677 #. type: Content of: <appendix><section><section><title>
679 msgid "<systemitem role=\"package\">quinn-diff</systemitem>"
682 #. type: Content of: <appendix><section><section><para>
685 "<systemitem role=\"package\">quinn-diff</systemitem> is used to locate the "
686 "differences from one architecture to another. For instance, it could tell "
687 "you which packages need to be ported for architecture "
688 "<replaceable>Y</replaceable>, based on architecture "
689 "<replaceable>X</replaceable>."
692 #. type: Content of: <appendix><section><section><title>
694 msgid "<systemitem role=\"package\">dpkg-cross</systemitem>"
697 #. type: Content of: <appendix><section><section><para>
700 "<systemitem role=\"package\">dpkg-cross</systemitem> is a tool for "
701 "installing libraries and headers for cross-compiling in a way similar to "
702 "<systemitem role=\"package\">dpkg</systemitem>. Furthermore, the "
703 "functionality of <command>dpkg-buildpackage</command> and "
704 "<command>dpkg-shlibdeps</command> is enhanced to support cross-compiling."
707 #. type: Content of: <appendix><section><title>
709 msgid "Documentation and information"
712 #. type: Content of: <appendix><section><para>
715 "The following packages provide information for maintainers or help with "
716 "building documentation."
719 #. type: Content of: <appendix><section><section><title>
721 msgid "<systemitem role=\"package\">docbook-xml</systemitem>"
724 #. type: Content of: <appendix><section><section><para>
727 "<systemitem role=\"package\">docbook-xml</systemitem> provides the DocBook "
728 "XML DTDs, which are commonly used for Debian documentation (as is the older "
729 "debiandoc SGML DTD). This manual, for instance, is written in DocBook XML."
732 #. type: Content of: <appendix><section><section><para>
735 "The <systemitem role=\"package\">docbook-xsl</systemitem> package provides "
736 "the XSL files for building and styling the source to various output "
737 "formats. You will need an XSLT processor, such as <systemitem "
738 "role=\"package\">xsltproc</systemitem>, to use the XSL stylesheets. "
739 "Documentation for the stylesheets can be found in the various <systemitem "
740 "role=\"package\">docbook-xsl-doc-*</systemitem> packages."
743 #. type: Content of: <appendix><section><section><para>
746 "To produce PDF from FO, you need an FO processor, such as <systemitem "
747 "role=\"package\">xmlroff</systemitem> or <systemitem "
748 "role=\"package\">fop</systemitem>. Another tool to generate PDF from DocBook "
749 "XML is <systemitem role=\"package\">dblatex</systemitem>."
752 #. type: Content of: <appendix><section><section><title>
754 msgid "<systemitem role=\"package\">debiandoc-sgml</systemitem>"
757 #. type: Content of: <appendix><section><section><para>
760 "<systemitem role=\"package\">debiandoc-sgml</systemitem> provides the "
761 "DebianDoc SGML DTD, which is commonly used for Debian documentation, but is "
762 "now deprecated (<systemitem role=\"package\">docbook-xml</systemitem> should "
763 "be used instead). It also provides scripts for building and styling the "
764 "source to various output formats."
767 #. type: Content of: <appendix><section><section><para>
770 "Documentation for the DTD can be found in the <systemitem "
771 "role=\"package\">debiandoc-sgml-doc</systemitem> package."
774 #. type: Content of: <appendix><section><section><title>
776 msgid "<systemitem role=\"package\">debian-keyring</systemitem>"
779 #. type: Content of: <appendix><section><section><para>
782 "Contains the public GPG and PGP keys of Debian developers. See <xref "
783 "linkend=\"key-maint\"/> and the package documentation for more information."
786 #. type: Content of: <appendix><section><section><title>
788 msgid "<systemitem role=\"package\">debian-maintainers</systemitem>"
791 #. type: Content of: <appendix><section><section><para>
794 "Contains the public GPG keys of Debian Maintainers. See <ulink "
795 "url=\"&url-wiki-dm;\"></ulink> for more information."
798 #. type: Content of: <appendix><section><section><title>
800 msgid "<systemitem role=\"package\">debview</systemitem>"
803 #. type: Content of: <appendix><section><section><para>
806 "<systemitem role=\"package\">debview</systemitem> provides an Emacs mode for "
807 "viewing Debian binary packages. This lets you examine a package without "