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: 2008-08-08 11:34-0300\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>
211 "debdiff package_1-1_arch.deb package_2-1_arch.deb\n"
214 # type: Content of: <appendix><section><section><para>
216 msgid "Or even a pair of changes files:"
219 # type: Content of: <appendix><section><section><screen>
224 "debdiff package_1-1_arch.changes package_2-1_arch.changes\n"
227 # type: Content of: <appendix><section><section><para>
230 "For more information please see <citerefentry> "
231 "<refentrytitle>debdiff</refentrytitle> <manvolnum>1</manvolnum> "
235 # type: Content of: <appendix><section><title>
237 msgid "Helpers for <filename>debian/rules</filename>"
240 # type: Content of: <appendix><section><para>
243 "Package building tools make the process of writing "
244 "<filename>debian/rules</filename> files easier. See <xref "
245 "linkend=\"helper-scripts\"/> for more information about why these might or "
246 "might not be desired."
249 # type: Content of: <appendix><section><section><title>
251 msgid "<systemitem role=\"package\">debhelper</systemitem>"
254 # type: Content of: <appendix><section><section><para>
257 "<systemitem role=\"package\">debhelper</systemitem> is a collection of "
258 "programs which can be used in <filename>debian/rules</filename> to automate "
259 "common tasks related to building binary Debian packages. <systemitem "
260 "role=\"package\">debhelper</systemitem> includes programs to install various "
261 "files into your package, compress files, fix file permissions, and integrate "
262 "your package with the Debian menu system."
265 # type: Content of: <appendix><section><section><para>
268 "Unlike some approaches, <systemitem role=\"package\">debhelper</systemitem> "
269 "is broken into several small, simple commands which act in a consistent "
270 "manner. As such, it allows more fine-grained control than some of the other "
271 "debian/rules tools."
274 # type: Content of: <appendix><section><section><para>
277 "There are a number of little <systemitem "
278 "role=\"package\">debhelper</systemitem> add-on packages, too transient to "
279 "document. You can see the list of most of them by doing <literal>apt-cache "
280 "search ^dh-</literal>."
283 # type: Content of: <appendix><section><section><title>
285 msgid "<systemitem role=\"package\">debmake</systemitem>"
288 # type: Content of: <appendix><section><section><para>
291 "<systemitem role=\"package\">debmake</systemitem>, a precursor to "
292 "<systemitem role=\"package\">debhelper</systemitem>, is a more "
293 "coarse-grained <filename>debian/rules</filename> assistant. It includes two "
294 "main programs: <command>deb-make</command>, which can be used to help a "
295 "maintainer convert a regular (non-Debian) source archive into a Debian "
296 "source package; and <command>debstd</command>, which incorporates in one big "
297 "shot the same sort of automated functions that one finds in <systemitem "
298 "role=\"package\">debhelper</systemitem>."
301 # type: Content of: <appendix><section><section><para>
304 "The consensus is that <systemitem role=\"package\">debmake</systemitem> is "
305 "now deprecated in favor of <systemitem "
306 "role=\"package\">debhelper</systemitem>. It is a bug to use <systemitem "
307 "role=\"package\">debmake</systemitem> in new packages. New packages using "
308 "<systemitem role=\"package\">debmake</systemitem> will be rejected from the "
312 # type: Content of: <appendix><section><section><title>
314 msgid "<systemitem role=\"package\">dh-make</systemitem>"
317 # type: Content of: <appendix><section><section><para>
320 "The <systemitem role=\"package\">dh-make</systemitem> package contains "
321 "<command>dh_make</command>, a program that creates a skeleton of files "
322 "necessary to build a Debian package out of a source tree. As the name "
323 "suggests, <command>dh_make</command> is a rewrite of <systemitem "
324 "role=\"package\">debmake</systemitem> and its template files use dh_* "
325 "programs from <systemitem role=\"package\">debhelper</systemitem>."
328 # type: Content of: <appendix><section><section><para>
331 "While the rules files generated by <command>dh_make</command> are in general "
332 "a sufficient basis for a working package, they are still just the "
333 "groundwork: the burden still lies on the maintainer to finely tune the "
334 "generated files and make the package entirely functional and "
338 # type: Content of: <appendix><section><section><title>
340 msgid "<systemitem role=\"package\">yada</systemitem>"
343 # type: Content of: <appendix><section><section><para>
346 "<systemitem role=\"package\">yada</systemitem> is another packaging helper "
347 "tool. It uses a <filename>debian/packages</filename> file to auto-generate "
348 "<filename>debian/rules</filename> and other necessary files in the "
349 "<filename>debian/</filename> subdirectory. The "
350 "<filename>debian/packages</filename> file contains instruction to build "
351 "packages and there is no need to create any <filename>Makefile</filename> "
352 "files. There is possibility to use macro engine similar to the one used in "
353 "SPECS files from RPM source packages."
356 # type: Content of: <appendix><section><section><para>
359 "For more informations see <literal><ulink "
360 "url=\"http://yada.alioth.debian.org/\">YADA site</ulink></literal>."
363 # type: Content of: <appendix><section><section><title>
365 msgid "<systemitem role=\"package\">equivs</systemitem>"
368 # type: Content of: <appendix><section><section><para>
371 "<systemitem role=\"package\">equivs</systemitem> is another package for "
372 "making packages. It is often suggested for local use if you need to make a "
373 "package simply to fulfill dependencies. It is also sometimes used when "
374 "making ``meta-packages'', which are packages whose only purpose is to depend "
378 # type: Content of: <appendix><section><title>
380 msgid "Package builders"
383 # type: Content of: <appendix><section><para>
386 "The following packages help with the package building process, general "
387 "driving <command>dpkg-buildpackage</command> as well as handling supporting "
391 # type: Content of: <appendix><section><section><title>
393 msgid "<systemitem role=\"package\">cvs-buildpackage</systemitem>"
396 # type: Content of: <appendix><section><section><para>
399 "<systemitem role=\"package\">cvs-buildpackage</systemitem> provides the "
400 "capability to inject or import Debian source packages into a CVS repository, "
401 "build a Debian package from the CVS repository, and helps in integrating "
402 "upstream changes into the repository."
405 # type: Content of: <appendix><section><section><para>
408 "These utilities provide an infrastructure to facilitate the use of CVS by "
409 "Debian maintainers. This allows one to keep separate CVS branches of a "
410 "package for <literal>stable</literal>, <literal>unstable</literal> and "
411 "possibly <literal>experimental</literal> distributions, along with the other "
412 "benefits of a version control system."
415 # type: Content of: <appendix><section><section><title>
417 msgid "<systemitem role=\"package\">debootstrap</systemitem>"
420 # type: Content of: <appendix><section><section><para>
423 "The <systemitem role=\"package\">debootstrap</systemitem> package and script "
424 "allows you to bootstrap a Debian base system into any part of your "
425 "filesystem. By base system, we mean the bare minimum of packages required "
426 "to operate and install the rest of the system."
429 # type: Content of: <appendix><section><section><para>
432 "Having a system like this can be useful in many ways. For instance, you can "
433 "<command>chroot</command> into it if you want to test your build "
434 "dependencies. Or you can test how your package behaves when installed into "
435 "a bare base system. Chroot builders use this package; see below."
438 # type: Content of: <appendix><section><section><title>
440 msgid "<systemitem role=\"package\">pbuilder</systemitem>"
443 # type: Content of: <appendix><section><section><para>
446 "<systemitem role=\"package\">pbuilder</systemitem> constructs a chrooted "
447 "system, and builds a package inside the chroot. It is very useful to check "
448 "that a package's build-dependencies are correct, and to be sure that "
449 "unnecessary and wrong build dependencies will not exist in the resulting "
453 # type: Content of: <appendix><section><section><para>
456 "A related package is <systemitem role=\"package\">pbuilder-uml</systemitem>, "
457 "which goes even further by doing the build within a User Mode Linux "
461 # type: Content of: <appendix><section><section><title>
463 msgid "<systemitem role=\"package\">sbuild</systemitem>"
466 # type: Content of: <appendix><section><section><para>
469 "<systemitem role=\"package\">sbuild</systemitem> is another automated "
470 "builder. It can use chrooted environments as well. It can be used "
471 "stand-alone, or as part of a networked, distributed build environment. As "
472 "the latter, it is part of the system used by porters to build binary "
473 "packages for all the available architectures. See <xref "
474 "linkend=\"wanna-build\"/> for more information, and <ulink "
475 "url=\"&url-buildd;\"></ulink> to see the system in action."
478 # type: Content of: <appendix><section><title>
480 msgid "Package uploaders"
483 # type: Content of: <appendix><section><para>
486 "The following packages help automate or simplify the process of uploading "
487 "packages into the official archive."
490 # type: Content of: <appendix><section><section><title>
492 msgid "<systemitem role=\"package\">dupload</systemitem>"
495 # type: Content of: <appendix><section><section><para>
498 "<systemitem role=\"package\">dupload</systemitem> is a package and a script "
499 "to automatically upload Debian packages to the Debian archive, to log the "
500 "upload, and to send mail about the upload of a package. You can configure "
501 "it for new upload locations or methods."
504 # type: Content of: <appendix><section><section><title>
506 msgid "<systemitem role=\"package\">dput</systemitem>"
509 # type: Content of: <appendix><section><section><para>
512 "The <systemitem role=\"package\">dput</systemitem> package and script does "
513 "much the same thing as <systemitem role=\"package\">dupload</systemitem>, "
514 "but in a different way. It has some features over <systemitem "
515 "role=\"package\">dupload</systemitem>, such as the ability to check the "
516 "GnuPG signature and checksums before uploading, and the possibility of "
517 "running <command>dinstall</command> in dry-run mode after the upload."
520 # type: Content of: <appendix><section><section><title>
522 msgid "<systemitem role=\"package\">dcut</systemitem>"
525 # type: Content of: <appendix><section><section><para>
528 "The <systemitem role=\"package\">dcut</systemitem> script (part of the "
529 "package <xref linkend=\"dput\"/> ) helps in removing files from the ftp "
533 # type: Content of: <appendix><section><title>
535 msgid "Maintenance automation"
538 # type: Content of: <appendix><section><para>
541 "The following tools help automate different maintenance tasks, from adding "
542 "changelog entries or signature lines and looking up bugs in Emacs to making "
543 "use of the newest and official <filename>config.sub</filename>."
546 # type: Content of: <appendix><section><section><title>
548 msgid "<systemitem role=\"package\">devscripts</systemitem>"
551 # type: Content of: <appendix><section><section><para>
554 "<systemitem role=\"package\">devscripts</systemitem> is a package containing "
555 "wrappers and tools which are very helpful for maintaining your Debian "
556 "packages. Example scripts include <command>debchange</command> and "
557 "<command>dch</command>, which manipulate your "
558 "<filename>debian/changelog</filename> file from the command-line, and "
559 "<command>debuild</command>, which is a wrapper around "
560 "<command>dpkg-buildpackage</command>. The <command>bts</command> utility is "
561 "also very helpful to update the state of bug reports on the command line. "
562 "<command>uscan</command> can be used to watch for new upstream versions of "
563 "your packages. <command>debrsign</command> can be used to remotely sign a "
564 "package prior to upload, which is nice when the machine you build the "
565 "package on is different from where your GPG keys are."
568 # type: Content of: <appendix><section><section><para>
571 "See the <citerefentry> <refentrytitle>devscripts</refentrytitle> "
572 "<manvolnum>1</manvolnum> </citerefentry> manual page for a complete list of "
576 # type: Content of: <appendix><section><section><title>
578 msgid "<systemitem role=\"package\">autotools-dev</systemitem>"
581 # type: Content of: <appendix><section><section><para>
584 "<systemitem role=\"package\">autotools-dev</systemitem> contains best "
585 "practices for people who maintain packages which use "
586 "<command>autoconf</command> and/or <command>automake</command>. Also "
587 "contains canonical <filename>config.sub</filename> and "
588 "<filename>config.guess</filename> files which are known to work on all "
592 # type: Content of: <appendix><section><section><title>
594 msgid "<systemitem role=\"package\">dpkg-repack</systemitem>"
597 # type: Content of: <appendix><section><section><para>
600 "<command>dpkg-repack</command> creates Debian package file out of a package "
601 "that has already been installed. If any changes have been made to the "
602 "package while it was unpacked (e.g., files in <filename>/etc</filename> were "
603 "modified), the new package will inherit the changes."
606 # type: Content of: <appendix><section><section><para>
609 "This utility can make it easy to copy packages from one computer to another, "
610 "or to recreate packages which are installed on your system but no longer "
611 "available elsewhere, or to save the current state of a package before you "
615 # type: Content of: <appendix><section><section><title>
617 msgid "<systemitem role=\"package\">alien</systemitem>"
620 # type: Content of: <appendix><section><section><para>
623 "<command>alien</command> converts binary packages between various packaging "
624 "formats, including Debian, RPM (RedHat), LSB (Linux Standard Base), Solaris, "
625 "and Slackware packages."
628 # type: Content of: <appendix><section><section><title>
630 msgid "<systemitem role=\"package\">debsums</systemitem>"
633 # type: Content of: <appendix><section><section><para>
636 "<command>debsums</command> checks installed packages against their MD5 "
637 "sums. Note that not all packages have MD5 sums, since they aren't required "
641 # type: Content of: <appendix><section><section><title>
643 msgid "<systemitem role=\"package\">dpkg-dev-el</systemitem>"
646 # type: Content of: <appendix><section><section><para>
649 "<systemitem role=\"package\">dpkg-dev-el</systemitem> is an Emacs lisp "
650 "package which provides assistance when editing some of the files in the "
651 "<filename>debian</filename> directory of your package. For instance, there "
652 "are handy functions for listing a package's current bugs, and for finalizing "
653 "the latest entry in a <filename>debian/changelog</filename> file."
656 # type: Content of: <appendix><section><section><title>
658 msgid "<systemitem role=\"package\">dpkg-depcheck</systemitem>"
661 # type: Content of: <appendix><section><section><para>
664 "<command>dpkg-depcheck</command> (from the <systemitem "
665 "role=\"package\">devscripts</systemitem> package, <xref "
666 "linkend=\"devscripts\"/> ) runs a command under <command>strace</command> "
667 "to determine all the packages that were used by the said command."
670 # type: Content of: <appendix><section><section><para>
673 "For Debian packages, this is useful when you have to compose a "
674 "<literal>Build-Depends</literal> line for your new package: running the "
675 "build process through <command>dpkg-depcheck</command> will provide you with "
676 "a good first approximation of the build-dependencies. For example:"
679 # type: Content of: <appendix><section><section><screen>
684 "dpkg-depcheck -b debian/rules build\n"
687 # type: Content of: <appendix><section><section><para>
690 "<command>dpkg-depcheck</command> can also be used to check for run-time "
691 "dependencies, especially if your package uses exec(2) to run other programs."
694 # type: Content of: <appendix><section><section><para>
697 "For more information please see <citerefentry> "
698 "<refentrytitle>dpkg-depcheck</refentrytitle> <manvolnum>1</manvolnum> "
702 # type: Content of: <appendix><section><title>
704 msgid "Porting tools"
707 # type: Content of: <appendix><section><para>
709 msgid "The following tools are helpful for porters and for cross-compilation."
712 # type: Content of: <appendix><section><section><title>
714 msgid "<systemitem role=\"package\">quinn-diff</systemitem>"
717 # type: Content of: <appendix><section><section><para>
720 "<systemitem role=\"package\">quinn-diff</systemitem> is used to locate the "
721 "differences from one architecture to another. For instance, it could tell "
722 "you which packages need to be ported for architecture "
723 "<replaceable>Y</replaceable>, based on architecture "
724 "<replaceable>X</replaceable>."
727 # type: Content of: <appendix><section><section><title>
729 msgid "<systemitem role=\"package\">dpkg-cross</systemitem>"
732 # type: Content of: <appendix><section><section><para>
735 "<systemitem role=\"package\">dpkg-cross</systemitem> is a tool for "
736 "installing libraries and headers for cross-compiling in a way similar to "
737 "<systemitem role=\"package\">dpkg</systemitem>. Furthermore, the "
738 "functionality of <command>dpkg-buildpackage</command> and "
739 "<command>dpkg-shlibdeps</command> is enhanced to support cross-compiling."
742 # type: Content of: <appendix><section><title>
744 msgid "Documentation and information"
747 # type: Content of: <appendix><section><para>
750 "The following packages provide information for maintainers or help with "
751 "building documentation."
754 # type: Content of: <appendix><section><section><title>
756 msgid "<systemitem role=\"package\">debiandoc-sgml</systemitem>"
759 # type: Content of: <appendix><section><section><para>
762 "<systemitem role=\"package\">debiandoc-sgml</systemitem> provides the "
763 "DebianDoc SGML DTD, which is commonly used for Debian documentation. This "
764 "manual, for instance, is written in DebianDoc. It also provides scripts for "
765 "building and styling the source to various output formats."
768 # type: Content of: <appendix><section><section><para>
771 "Documentation for the DTD can be found in the <systemitem "
772 "role=\"package\">debiandoc-sgml-doc</systemitem> package."
775 # type: Content of: <appendix><section><section><title>
777 msgid "<systemitem role=\"package\">debian-keyring</systemitem>"
780 # type: Content of: <appendix><section><section><para>
783 "Contains the public GPG and PGP keys of Debian developers. See <xref "
784 "linkend=\"key-maint\"/> and the package documentation for more information."
787 # type: Content of: <appendix><section><section><title>
789 msgid "<systemitem role=\"package\">debian-maintainers</systemitem>"
792 # type: Content of: <appendix><section><section><para>
795 "Contains the public GPG keys of Debian Maintainers. See <ulink "
796 "url=\"&url-wiki-dm;\"></ulink> for more information."
799 # type: Content of: <appendix><section><section><title>
801 msgid "<systemitem role=\"package\">debview</systemitem>"
804 # type: Content of: <appendix><section><section><para>
807 "<systemitem role=\"package\">debview</systemitem> provides an Emacs mode for "
808 "viewing Debian binary packages. This lets you examine a package without "