1 <!doctype debiandoc system [
2 <!-- include version information so we don't have to hard code it
3 within the document -->
4 <!entity % versiondata SYSTEM "version.ent"> %versiondata;
10 <title>Debian Policy Manual</title>
11 <author><qref id="authors">The Debian Policy Mailing List</qref></author>
12 <version>version &version;, &date;</version>
15 This manual describes the policy requirements for the Debian
16 GNU/Linux distribution. This includes the structure and
17 contents of the Debian archive and several design issues of
18 the operating system, as well as technical requirements that
19 each package must satisfy to be included in the distribution.
24 Copyright © 1996,1997,1998 Ian Jackson
25 and Christian Schwarz.
28 This manual is free software; you may redistribute it and/or
29 modify it under the terms of the GNU General Public License
30 as published by the Free Software Foundation; either version
31 2, or (at your option) any later version.
35 This is distributed in the hope that it will be useful, but
36 <em>without any warranty</em>; without even the implied
37 warranty of merchantability or fitness for a particular
38 purpose. See the GNU General Public License for more
43 A copy of the GNU General Public License is available as
44 <file>/usr/share/common-licenses/GPL</file> in the Debian GNU/Linux
45 distribution or on the World Wide Web at
46 <url id="http://www.gnu.org/copyleft/gpl.html"
47 name="the GNU General Public Licence">. You can also
48 obtain it by writing to the Free Software Foundation, Inc.,
49 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
57 <heading>About this manual</heading>
59 <heading>Scope</heading>
61 This manual describes the policy requirements for the Debian
62 GNU/Linux distribution. This includes the structure and
63 contents of the Debian archive and several design issues of the
64 operating system, as well as technical requirements that
65 each package must satisfy to be included in the
70 This manual also describes Debian policy as it relates to
71 creating Debian packages. It is not a tutorial on how to build
72 packages, nor is it exhaustive where it comes to describing
73 the behavior of the packaging system. Instead, this manual
74 attempts to define the interface to the package management
75 system that the developers have to be conversant with.<footnote>
76 Informally, the criteria used for inclusion is that the
77 material meet one of the following requirements:
78 <taglist compact="compact">
79 <tag>Standard interfaces</tag>
81 The material presented represents an interface to
82 the packaging system that is mandated for use, and
83 is used by, a significant number of packages, and
84 therefore should not be changed without peer
85 review. Package maintainers can then rely on this
86 interfaces not changing, and the package
87 management software authors need to ensure
88 compatibility with these interface
89 definitions. (Control file and changelog file
90 formats are examples.)
92 <tag>Chosen Convention</tag>
94 If there are a number of technically viable choices
95 that can be made, but one needs to select one of
96 these options for inter-operability. The version
97 number format is one example.
100 Please note that these are not mutually exclusive;
101 selected conventions often become parts of standard
107 The footnotes present in this manual are
108 merely informative, and are not part of Debian policy itself.
112 The appendices to this manual are not necessarily normative,
113 either. Please see <ref id="pkg-scope"> for more information.
117 In the normative part of this manual,
118 the words <em>must</em>, <em>should</em> and
119 <em>may</em>, and the adjectives <em>required</em>,
120 <em>recommended</em> and <em>optional</em>, are used to
121 distinguish the significance of the various guidelines in
122 this policy document. Packages that do not conform to the
123 guidelines denoted by <em>must</em> (or <em>required</em>)
124 will generally not be considered acceptable for the Debian
125 distribution. Non-conformance with guidelines denoted by
126 <em>should</em> (or <em>recommended</em>) will generally be
127 considered a bug, but will not necessarily render a package
128 unsuitable for distribution. Guidelines denoted by
129 <em>may</em> (or <em>optional</em>) are truly optional and
130 adherence is left to the maintainer's discretion.
134 These classifications are roughly equivalent to the bug
135 severities <em>serious</em> (for <em>must</em> or
136 <em>required</em> directive violations), <em>minor</em>,
137 <em>normal</em> or <em>important</em>
138 (for <em>should</em> or <em>recommended</em> directive
139 violations) and <em>wishlist</em> (for <em>optional</em>
142 Compare RFC 2119. Note, however, that these words are
143 used in a different way in this document.
148 Much of the information presented in this manual will be
149 useful even when building a package which is to be
150 distributed in some other way or is intended for local use
156 <heading>New versions of this document</heading>
159 This manual is distributed via the Debian package
160 <package><url name="debian-policy"
161 id="http://packages.debian.org/debian-policy"></package>
162 (<httpsite>packages.debian.org</httpsite>
163 <httppath>/debian-policy</httppath>).
167 The current version of this document is also available from
168 the Debian web mirrors at
169 <tt><url name="/doc/debian-policy/"
170 id="http://www.debian.org/doc/debian-policy/"></tt>.
172 <httpsite>www.debian.org</httpsite>
173 <httppath>/doc/debian-policy/</httppath>)
174 Also available from the same directory are several other
175 formats: <file>policy.html.tar.gz</file>
176 (<httppath>/doc/debian-policy/policy.html.tar.gz</httppath>),
177 <file>policy.pdf.gz</file>
178 (<httppath>/doc/debian-policy/policy.pdf.gz</httppath>)
179 and <file>policy.ps.gz</file>
180 (<httppath>/doc/debian-policy/policy.ps.gz</httppath>).
184 The <package>debian-policy</package> package also includes the file
185 <file>upgrading-checklist.txt.gz</file> which indicates policy
186 changes between versions of this document.
191 <heading>Authors and Maintainers</heading>
194 Originally called "Debian GNU/Linux Policy Manual", this
195 manual was initially written in 1996 by Ian Jackson.
196 It was revised on November 27th, 1996 by David A. Morris.
197 Christian Schwarz added new sections on March 15th, 1997,
198 and reworked/restructured it in April-July 1997.
199 Christoph Lameter contributed the "Web Standard".
200 Julian Gilbey largely restructured it in 2001.
204 Since September 1998, the responsibility for the contents of
205 this document lies on the <url name="debian-policy mailing list"
206 id="mailto:debian-policy@lists.debian.org">. Proposals
207 are discussed there and inserted into policy after a certain
208 consensus is established.
209 <!-- insert shameless policy-process plug here eventually -->
210 The actual editing is done by a group of maintainers that have
211 no editorial powers. These are the current maintainers:
214 <item>Julian Gilbey</item>
215 <item>Branden Robinson</item>
216 <item>Josip Rodin</item>
217 <item>Manoj Srivastava</item>
222 While the authors of this document have tried hard to avoid
223 typos and other errors, these do still occur. If you discover
224 an error in this manual or if you want to give any
225 comments, suggestions, or criticisms please send an email to
226 the Debian Policy List,
227 <email>debian-policy@lists.debian.org</email>, or submit a
228 bug report against the <tt>debian-policy</tt> package.
232 Please do not try to reach the individual authors or maintainers
233 of the Policy Manual regarding changes to the Policy.
238 <heading>Related documents</heading>
241 There are several other documents other than this Policy Manual
242 that are necessary to fully understand some Debian policies and
247 The external "sub-policy" documents are referred to in:
248 <list compact="compact">
249 <item><ref id="fhs"></item>
250 <item><ref id="virtual_pkg"></item>
251 <item><ref id="menus"></item>
252 <item><ref id="mime"></item>
253 <item><ref id="perl"></item>
254 <item><ref id="maintscriptprompt"></item>
255 <item><ref id="emacs"></item>
260 In addition to those, which carry the weight of policy, there
261 is the Debian Developer's Reference. This document describes
262 procedures and resources for Debian developers, but it is
263 <em>not</em> normative; rather, it includes things that don't
264 belong in the Policy, such as best practices for developers.
268 The Developer's Reference is available in the
269 <package>developers-reference</package> package.
270 It's also available from the Debian web mirrors at
271 <tt><url name="/doc/developers-reference/"
272 id="http://www.debian.org/doc/developers-reference/"></tt>.
276 <sect id="definitions">
277 <heading>Definitions</heading>
280 The following terms are used in this Policy Manual:
284 The character encoding specified by ANSI X3.4-1986 and its
285 predecessor standards, referred to in MIME as US-ASCII, and
286 corresponding to an encoding in eight bits per character of
287 the first 128 <url id="http://www.unicode.org/"
288 name="Unicode"> characters, with the eighth bit always zero.
292 The transformation format (sometimes called encoding) of
293 <url id="http://www.unicode.org/" name="Unicode"> defined by
294 <url id="http://www.rfc-editor.org/rfc/rfc3629.txt"
295 name="RFC 3629">. UTF-8 has the useful property of having
296 ASCII as a subset, so any text encoded in ASCII is trivially
306 <heading>The Debian Archive</heading>
309 The Debian GNU/Linux system is maintained and distributed as a
310 collection of <em>packages</em>. Since there are so many of
311 them (currently well over 15000), they are split into
312 <em>sections</em> and given <em>priorities</em> to simplify
313 the handling of them.
317 The effort of the Debian project is to build a free operating
318 system, but not every package we want to make accessible is
319 <em>free</em> in our sense (see the Debian Free Software
320 Guidelines, below), or may be imported/exported without
321 restrictions. Thus, the archive is split into the distribution
322 areas or categories based on their licenses and other restrictions.
326 The aims of this are:
328 <list compact="compact">
329 <item>to allow us to make as much software available as we can</item>
330 <item>to allow us to encourage everyone to write free software,
332 <item>to allow us to make it easy for people to produce
333 CD-ROMs of our system without violating any licenses,
334 import/export restrictions, or any other laws.</item>
339 The <em>main</em> category forms the
340 <em>Debian GNU/Linux distribution</em>.
344 Packages in the other distribution areas (<tt>contrib</tt>,
345 <tt>non-free</tt>) are not considered to be part of the Debian
346 distribution, although we support their use and provide
347 infrastructure for them (such as our bug-tracking system and
348 mailing lists). This Debian Policy Manual applies to these
353 <heading>The Debian Free Software Guidelines</heading>
355 The Debian Free Software Guidelines (DFSG) form our
356 definition of "free software". These are:
358 <tag>Free Redistribution
361 The license of a Debian component may not restrict any
362 party from selling or giving away the software as a
363 component of an aggregate software distribution
364 containing programs from several different
365 sources. The license may not require a royalty or
366 other fee for such sale.
371 The program must include source code, and must allow
372 distribution in source code as well as compiled form.
377 The license must allow modifications and derived
378 works, and must allow them to be distributed under the
379 same terms as the license of the original software.
381 <tag>Integrity of The Author's Source Code
384 The license may restrict source-code from being
385 distributed in modified form <em>only</em> if the
386 license allows the distribution of "patch files"
387 with the source code for the purpose of modifying the
388 program at build time. The license must explicitly
389 permit distribution of software built from modified
390 source code. The license may require derived works to
391 carry a different name or version number from the
392 original software. (This is a compromise. The Debian
393 Project encourages all authors to not restrict any
394 files, source or binary, from being modified.)
396 <tag>No Discrimination Against Persons or Groups
399 The license must not discriminate against any person
402 <tag>No Discrimination Against Fields of Endeavor
405 The license must not restrict anyone from making use
406 of the program in a specific field of endeavor. For
407 example, it may not restrict the program from being
408 used in a business, or from being used for genetic
411 <tag>Distribution of License
414 The rights attached to the program must apply to all
415 to whom the program is redistributed without the need
416 for execution of an additional license by those
419 <tag>License Must Not Be Specific to Debian
422 The rights attached to the program must not depend on
423 the program's being part of a Debian system. If the
424 program is extracted from Debian and used or
425 distributed without Debian but otherwise within the
426 terms of the program's license, all parties to whom
427 the program is redistributed must have the same
428 rights as those that are granted in conjunction with
431 <tag>License Must Not Contaminate Other Software
434 The license must not place restrictions on other
435 software that is distributed along with the licensed
436 software. For example, the license must not insist
437 that all other programs distributed on the same medium
438 must be free software.
440 <tag>Example Licenses
443 The "GPL," "BSD," and "Artistic" licenses are examples of
444 licenses that we consider <em>free</em>.
451 <heading>Categories</heading>
454 <heading>The main category</heading>
457 Every package in <em>main</em> must comply with the DFSG
458 (Debian Free Software Guidelines).
462 In addition, the packages in <em>main</em>
463 <list compact="compact">
465 must not require a package outside of <em>main</em>
466 for compilation or execution (thus, the package must
467 not declare a "Depends", "Recommends", or
468 "Build-Depends" relationship on a non-<em>main</em>
472 must not be so buggy that we refuse to support them,
476 must meet all policy requirements presented in this
485 <heading>The contrib category</heading>
488 Every package in <em>contrib</em> must comply with the DFSG.
492 In addition, the packages in <em>contrib</em>
493 <list compact="compact">
495 must not be so buggy that we refuse to support them,
499 must meet all policy requirements presented in this
507 Examples of packages which would be included in
508 <em>contrib</em> are:
509 <list compact="compact">
511 free packages which require <em>contrib</em>,
512 <em>non-free</em> packages or packages which are not
513 in our archive at all for compilation or execution,
517 wrapper packages or other sorts of free accessories for
524 <sect1 id="non-free">
525 <heading>The non-free category</heading>
528 Packages must be placed in <em>non-free</em> if they are
529 not compliant with the DFSG or are encumbered by patents
530 or other legal issues that make their distribution
535 In addition, the packages in <em>non-free</em>
536 <list compact="compact">
538 must not be so buggy that we refuse to support them,
542 must meet all policy requirements presented in this
543 manual that it is possible for them to meet.
545 It is possible that there are policy
546 requirements which the package is unable to
547 meet, for example, if the source is
548 unavailable. These situations will need to be
549 handled on a case-by-case basis.
558 <sect id="pkgcopyright">
559 <heading>Copyright considerations</heading>
562 Every package must be accompanied by a verbatim copy of
563 its copyright and distribution license in the file
564 <file>/usr/share/doc/<var>package</var>/copyright</file>
565 (see <ref id="copyrightfile"> for further details).
569 We reserve the right to restrict files from being included
570 anywhere in our archives if
571 <list compact="compact">
573 their use or distribution would break a law,
576 there is an ethical conflict in their distribution or
580 we would have to sign a license for them, or
583 their distribution would conflict with other project
590 Programs whose authors encourage the user to make
591 donations are fine for the main distribution, provided
592 that the authors do not claim that not donating is
593 immoral, unethical, illegal or something similar; in such
594 a case they must go in <em>non-free</em>.
598 Packages whose copyright permission notices (or patent
599 problems) do not even allow redistribution of binaries
600 only, and where no special permission has been obtained,
601 must not be placed on the Debian FTP site and its mirrors
606 Note that under international copyright law (this applies
607 in the United States, too), <em>no</em> distribution or
608 modification of a work is allowed without an explicit
609 notice saying so. Therefore a program without a copyright
610 notice <em>is</em> copyrighted and you may not do anything
611 to it without risking being sued! Likewise if a program
612 has a copyright notice but no statement saying what is
613 permitted then nothing is permitted.
617 Many authors are unaware of the problems that restrictive
618 copyrights (or lack of copyright notices) can cause for
619 the users of their supposedly-free software. It is often
620 worthwhile contacting such authors diplomatically to ask
621 them to modify their license terms. However, this can be a
622 politically difficult thing to do and you should ask for
623 advice on the <tt>debian-legal</tt> mailing list first, as
628 When in doubt about a copyright, send mail to
629 <email>debian-legal@lists.debian.org</email>. Be prepared
630 to provide us with the copyright statement. Software
631 covered by the GPL, public domain software and BSD-like
632 copyrights are safe; be wary of the phrases "commercial
633 use prohibited" and "distribution restricted".
637 <sect id="subsections">
638 <heading>Sections</heading>
641 The packages in the categories <em>main</em>,
642 <em>contrib</em> and <em>non-free</em> are grouped further
643 into <em>sections</em> to simplify handling.
647 The category and section for each package should be
648 specified in the package's <tt>Section</tt> control record
649 (see <ref id="f-Section">). However, the maintainer of the
650 Debian archive may override this selection to ensure the
651 consistency of the Debian distribution. The
652 <tt>Section</tt> field should be of the form:
653 <list compact="compact">
655 <em>section</em> if the package is in the
656 <em>main</em> category,
659 <em>segment/section</em> if the package is in
660 the <em>contrib</em> or <em>non-free</em>
667 The Debian archive maintainers provide the authoritative
668 list of sections. At present, they are:
669 <em>admin</em>, <em>comm</em>,
670 <em>devel</em>, <em>doc</em>,
671 <em>editors</em>, <em>electronics</em>, <em>embedded</em>,
672 <em>games</em>, <em>gnome</em>, <em>graphics</em>,
673 <em>hamradio</em>, <em>interpreters</em>, <em>kde</em>,
674 <em>libs</em>, <em>libdevel</em>, <em>mail</em>,
675 <em>math</em>, <em>misc</em>, <em>net</em>, <em>news</em>,
677 <em>otherosfs</em>, <em>perl</em>, <em>python</em>,
678 <em>science</em>, <em>shells</em>,
679 <em>sound</em>, <em>tex</em>, <em>text</em>,
680 <em>utils</em>, <em>web</em>, <em>x11</em>.
684 <sect id="priorities">
685 <heading>Priorities</heading>
688 Each package should have a <em>priority</em> value, which is
689 included in the package's <em>control record</em>
690 (see <ref id="f-Priority">).
691 This information is used by the Debian package management tools to
692 separate high-priority packages from less-important packages.
696 The following <em>priority levels</em> are recognized by the
697 Debian package management tools.
699 <tag><tt>required</tt></tag>
701 Packages which are necessary for the proper
702 functioning of the system (usually, this means that
703 dpkg functionality depends on these packages).
704 Removing a <tt>required</tt> package may cause your
705 system to become totally broken and you may not even
706 be able to use <prgn>dpkg</prgn> to put things back,
707 so only do so if you know what you are doing. Systems
708 with only the <tt>required</tt> packages are probably
709 unusable, but they do have enough functionality to
710 allow the sysadmin to boot and install more software.
712 <tag><tt>important</tt></tag>
714 Important programs, including those which one would
715 expect to find on any Unix-like system. If the
716 expectation is that an experienced Unix person who
717 found it missing would say "What on earth is going on,
718 where is <prgn>foo</prgn>?", it must be an
719 <tt>important</tt> package.<footnote>
720 This is an important criterion because we are
721 trying to produce, amongst other things, a free
724 Other packages without which the system will not run
725 well or be usable must also have priority
726 <tt>important</tt>. This does
727 <em>not</em> include Emacs, the X Window System, TeX
728 or any other large applications. The
729 <tt>important</tt> packages are just a bare minimum of
730 commonly-expected and necessary tools.
732 <tag><tt>standard</tt></tag>
734 These packages provide a reasonably small but not too
735 limited character-mode system. This is what will be
736 installed by default if the user doesn't select anything
737 else. It doesn't include many large applications.
739 <tag><tt>optional</tt></tag>
741 (In a sense everything that isn't required is
742 optional, but that's not what is meant here.) This is
743 all the software that you might reasonably want to
744 install if you didn't know what it was and don't have
745 specialized requirements. This is a much larger system
746 and includes the X Window System, a full TeX
747 distribution, and many applications. Note that
748 optional packages should not conflict with each other.
750 <tag><tt>extra</tt></tag>
752 This contains all packages that conflict with others
753 with required, important, standard or optional
754 priorities, or are only likely to be useful if you
755 already know what they are or have specialized
756 requirements (such as packages containing only detached
763 Packages must not depend on packages with lower priority
764 values (excluding build-time dependencies). In order to
765 ensure this, the priorities of one or more packages may need
774 <heading>Binary packages</heading>
777 The Debian GNU/Linux distribution is based on the Debian
778 package management system, called <prgn>dpkg</prgn>. Thus,
779 all packages in the Debian distribution must be provided
780 in the <tt>.deb</tt> file format.
784 <heading>The package name</heading>
787 Every package must have a name that's unique within the Debian
792 The package name is included in the control field
793 <tt>Package</tt>, the format of which is described
794 in <ref id="f-Package">.
795 The package name is also included as a part of the file name
796 of the <tt>.deb</tt> file.
801 <heading>The version of a package</heading>
804 Every package has a version number recorded in its
805 <tt>Version</tt> control file field, described in
806 <ref id="f-Version">.
810 The package management system imposes an ordering on version
811 numbers, so that it can tell whether packages are being up- or
812 downgraded and so that package system front end applications
813 can tell whether a package it finds available is newer than
814 the one installed on the system. The version number format
815 has the most significant parts (as far as comparison is
816 concerned) at the beginning.
820 If an upstream package has problematic version numbers they
821 should be converted to a sane form for use in the
822 <tt>Version</tt> field.
826 <heading>Version numbers based on dates</heading>
829 In general, Debian packages should use the same version
830 numbers as the upstream sources.
834 However, in some cases where the upstream version number is
835 based on a date (e.g., a development "snapshot" release) the
836 package management system cannot handle these version
837 numbers without epochs. For example, dpkg will consider
838 "96May01" to be greater than "96Dec24".
842 To prevent having to use epochs for every new upstream
843 version, the date based portion of the version number
844 should be changed to the following format in such cases:
845 "19960501", "19961224". It is up to the maintainer whether
846 they want to bother the upstream maintainer to change
847 the version numbers upstream, too.
851 Note that other version formats based on dates which are
852 parsed correctly by the package management system should
853 <em>not</em> be changed.
857 Native Debian packages (i.e., packages which have been
858 written especially for Debian) whose version numbers include
859 dates should always use the "YYYYMMDD" format.
866 <heading>The maintainer of a package</heading>
869 Every package must have a Debian maintainer (the
870 maintainer may be one person or a group of people
871 reachable from a common email address, such as a mailing
872 list). The maintainer is responsible for ensuring that
873 the package is placed in the appropriate distributions.
877 The maintainer must be specified in the
878 <tt>Maintainer</tt> control field with their correct name
879 and a working email address. If one person maintains
880 several packages, they should try to avoid having
881 different forms of their name and email address in
882 the <tt>Maintainer</tt> fields of those packages.
886 The format of the <tt>Maintainer</tt> control field is
887 described in <ref id="f-Maintainer">.
891 If the maintainer of a package quits from the Debian
892 project, "Debian QA Group"
893 <email>packages@qa.debian.org</email> takes over the
894 maintainer-ship of the package until someone else
895 volunteers for that task. These packages are called
896 <em>orphaned packages</em>.<footnote>
897 The detailed procedure for doing this gracefully can
898 be found in the Debian Developer's Reference,
899 see <ref id="related">.
904 <sect id="descriptions">
905 <heading>The description of a package</heading>
908 Every Debian package must have an extended description
909 stored in the appropriate field of the control record.
910 The technical information about the format of the
911 <tt>Description</tt> field is in <ref id="f-Description">.
915 The description should describe the package (the program) to a
916 user (system administrator) who has never met it before so that
917 they have enough information to decide whether they want to
918 install it. This description should not just be copied verbatim
919 from the program's documentation.
923 Put important information first, both in the synopsis and
924 extended description. Sometimes only the first part of the
925 synopsis or of the description will be displayed. You can
926 assume that there will usually be a way to see the whole
927 extended description.
931 The description should also give information about the
932 significant dependencies and conflicts between this package
933 and others, so that the user knows why these dependencies and
934 conflicts have been declared.
938 Instructions for configuring or using the package should
939 not be included (that is what installation scripts,
940 manual pages, info files, etc., are for). Copyright
941 statements and other administrivia should not be included
942 either (that is what the copyright file is for).
945 <sect1 id="synopsis"><heading>The single line synopsis</heading>
948 The single line synopsis should be kept brief - certainly
953 Do not include the package name in the synopsis line. The
954 display software knows how to display this already, and you
955 do not need to state it. Remember that in many situations
956 the user may only see the synopsis line - make it as
957 informative as you can.
962 <sect1 id="extendeddesc"><heading>The extended description</heading>
965 Do not try to continue the single line synopsis into the
966 extended description. This will not work correctly when
967 the full description is displayed, and makes no sense
968 where only the summary (the single line synopsis) is
973 The extended description should describe what the package
974 does and how it relates to the rest of the system (in terms
975 of, for example, which subsystem it is which part of).
979 The description field needs to make sense to anyone, even
980 people who have no idea about any of the things the
981 package deals with.<footnote>
982 The blurb that comes with a program in its
983 announcements and/or <prgn>README</prgn> files is
984 rarely suitable for use in a description. It is
985 usually aimed at people who are already in the
986 community where the package is used.
995 <heading>Dependencies</heading>
998 Every package must specify the dependency information
999 about other packages that are required for the first to
1004 For example, a dependency entry must be provided for any
1005 shared libraries required by a dynamically-linked executable
1006 binary in a package.
1010 Packages are not required to declare any dependencies they
1011 have on other packages which are marked <tt>Essential</tt>
1012 (see below), and should not do so unless they depend on a
1013 particular version of that package.<footnote>
1015 Essential is needed in part to avoid unresolvable dependency
1016 loops on upgrade. If packages add unnecessary dependencies
1017 on packages in this set, the chances that there
1018 <strong>will</strong> be an unresolvable dependency loop
1019 caused by forcing these Essential packages to be configured
1020 first before they need to be is greatly increased. It also
1021 increases the chances that frontends will be unable to
1022 <strong>calculate</strong> an upgrade path, even if one
1026 Also, functionality is rarely ever removed from the
1027 Essential set, but <em>packages</em> have been removed from
1028 the Essential set when the functionality moved to a
1029 different package. So depending on these packages <em>just
1030 in case</em> they stop being essential does way more harm
1037 Sometimes, a package requires another package to be installed
1038 <em>and</em> configured before it can be installed. In this
1039 case, you must specify a <tt>Pre-Depends</tt> entry for
1044 You should not specify a <tt>Pre-Depends</tt> entry for a
1045 package before this has been discussed on the
1046 <tt>debian-devel</tt> mailing list and a consensus about
1047 doing that has been reached.
1051 The format of the package interrelationship control fields is
1052 described in <ref id="relationships">.
1056 <sect id="virtual_pkg">
1057 <heading>Virtual packages</heading>
1060 Sometimes, there are several packages which offer
1061 more-or-less the same functionality. In this case, it's
1062 useful to define a <em>virtual package</em> whose name
1063 describes that common functionality. (The virtual
1064 packages only exist logically, not physically; that's why
1065 they are called <em>virtual</em>.) The packages with this
1066 particular function will then <em>provide</em> the virtual
1067 package. Thus, any other package requiring that function
1068 can simply depend on the virtual package without having to
1069 specify all possible packages individually.
1073 All packages should use virtual package names where
1074 appropriate, and arrange to create new ones if necessary.
1075 They should not use virtual package names (except privately,
1076 amongst a cooperating group of packages) unless they have
1077 been agreed upon and appear in the list of virtual package
1078 names. (See also <ref id="virtual">)
1082 The latest version of the authoritative list of virtual
1083 package names can be found in the <tt>debian-policy</tt> package.
1084 It is also available from the Debian web mirrors at
1085 <tt><url name="/doc/packaging-manuals/virtual-package-names-list.txt"
1086 id="http://www.debian.org/doc/packaging-manuals/virtual-package-names-list.txt"></tt>.
1090 The procedure for updating the list is described in the preface
1097 <heading>Base system</heading>
1100 The <tt>base system</tt> is a minimum subset of the Debian
1101 GNU/Linux system that is installed before everything else
1102 on a new system. Only very few packages are allowed to form
1103 part of the base system, in order to keep the required disk
1108 The base system consists of all those packages with priority
1109 <tt>required</tt> or <tt>important</tt>. Many of them will
1110 be tagged <tt>essential</tt> (see below).
1115 <heading>Essential packages</heading>
1118 Essential is defined as the minimal set of functionality that
1119 must be available and usable on the system at all times, even
1120 when packages are in an unconfigured (but unpacked) state.
1121 Packages are tagged <tt>essential</tt> for a system using the
1122 <tt>Essential</tt> control file field. The format of the
1123 <tt>Essential</tt> control field is described in <ref
1128 Since these packages cannot be easily removed (one has to
1129 specify an extra <em>force option</em> to
1130 <prgn>dpkg</prgn> to do so), this flag must not be used
1131 unless absolutely necessary. A shared library package
1132 must not be tagged <tt>essential</tt>; dependencies will
1133 prevent its premature removal, and we need to be able to
1134 remove it when it has been superseded.
1138 Since dpkg will not prevent upgrading of other packages
1139 while an <tt>essential</tt> package is in an unconfigured
1140 state, all <tt>essential</tt> packages must supply all of
1141 their core functionality even when unconfigured. If the
1142 package cannot satisfy this requirement it must not be
1143 tagged as essential, and any packages depending on this
1144 package must instead have explicit dependency fields as
1149 Maintainers should take great care in adding any programs,
1150 interfaces, or functionality to <tt>essential</tt> packages.
1151 Packages may assume that functionality provided by
1152 <tt>essential</tt> packages is always available without
1153 declaring explicit dependencies, which means that removing
1154 functionality from the Essential set is very difficult and is
1155 almost never done. Any capability added to an
1156 <tt>essential</tt> package therefore creates an obligation to
1157 support that capability as part of the Essential set in
1162 You must not tag any packages <tt>essential</tt> before
1163 this has been discussed on the <tt>debian-devel</tt>
1164 mailing list and a consensus about doing that has been
1169 <sect id="maintscripts">
1170 <heading>Maintainer Scripts</heading>
1173 The package installation scripts should avoid producing
1174 output which is unnecessary for the user to see and
1175 should rely on <prgn>dpkg</prgn> to stave off boredom on
1176 the part of a user installing many packages. This means,
1177 amongst other things, using the <tt>--quiet</tt> option on
1178 <prgn>install-info</prgn>.
1182 Errors which occur during the execution of an installation
1183 script must be checked and the installation must not
1184 continue after an error.
1188 Note that in general <ref id="scripts"> applies to package
1189 maintainer scripts, too.
1193 You should not use <prgn>dpkg-divert</prgn> on a file
1194 belonging to another package without consulting the
1195 maintainer of that package first.
1199 All packages which supply an instance of a common command
1200 name (or, in general, filename) should generally use
1201 <prgn>update-alternatives</prgn>, so that they may be
1202 installed together. If <prgn>update-alternatives</prgn>
1203 is not used, then each package must use
1204 <tt>Conflicts</tt> to ensure that other packages are
1205 de-installed. (In this case, it may be appropriate to
1206 specify a conflict against earlier versions of something
1207 that previously did not use
1208 <prgn>update-alternatives</prgn>; this is an exception to
1209 the usual rule that versioned conflicts should be
1213 <sect1 id="maintscriptprompt">
1214 <heading>Prompting in maintainer scripts</heading>
1216 Package maintainer scripts may prompt the user if
1217 necessary. Prompting should be done by communicating
1218 through a program, such as <prgn>debconf</prgn>, which
1219 conforms to the Debian Configuration Management
1220 Specification, version 2 or higher. Prompting the user by
1221 other means, such as by hand<footnote>
1222 From the Jargon file: by hand 2. By extension,
1223 writing code which does something in an explicit or
1224 low-level way for which a presupplied library
1225 (<em>debconf, in this instance</em>) routine ought
1226 to have been available.
1227 </footnote>, is now deprecated.
1231 The Debian Configuration Management Specification is included
1232 in the <file>debconf_specification</file> files in the
1233 <package>debian-policy</package> package.
1234 It is also available from the Debian web mirrors at
1235 <tt><url name="/doc/packaging-manuals/debconf_specification.html"
1236 id="http://www.debian.org/doc/packaging-manuals/debconf_specification.html"></tt>.
1240 Packages which use the Debian Configuration Management
1241 Specification may contain an additional
1242 <prgn>config</prgn> script and a <tt>templates</tt>
1243 file in their control archive<footnote>
1244 The control.tar.gz inside the .deb.
1245 See <manref name="deb" section="5">.
1247 The <prgn>config</prgn> script might be run before the
1248 <prgn>preinst</prgn> script, and before the package is unpacked
1249 or any of its dependencies or pre-dependencies are satisfied.
1250 Therefore it must work using only the tools present in
1251 <em>essential</em> packages.<footnote>
1252 <package>Debconf</package> or another tool that
1253 implements the Debian Configuration Management
1254 Specification will also be installed, and any
1255 versioned dependencies on it will be satisfied
1256 before preconfiguration begins.
1261 Packages which use the Debian Configuration Management
1262 Specification must allow for translation of their user-visible
1263 messages by using a gettext-based system such as the one
1264 provided by the <package>po-debconf</package> package.
1268 Packages should try to minimize the amount of prompting
1269 they need to do, and they should ensure that the user
1270 will only ever be asked each question once. This means
1271 that packages should try to use appropriate shared
1272 configuration files (such as <file>/etc/papersize</file> and
1273 <file>/etc/news/server</file>), and shared
1274 <package>debconf</package> variables rather than each
1275 prompting for their own list of required pieces of
1280 It also means that an upgrade should not ask the same
1281 questions again, unless the user has used
1282 <tt>dpkg --purge</tt> to remove the package's configuration.
1283 The answers to configuration questions should be stored in an
1284 appropriate place in <file>/etc</file> so that the user can
1285 modify them, and how this has been done should be
1290 If a package has a vitally important piece of
1291 information to pass to the user (such as "don't run me
1292 as I am, you must edit the following configuration files
1293 first or you risk your system emitting badly-formatted
1294 messages"), it should display this in the
1295 <prgn>config</prgn> or <prgn>postinst</prgn> script and
1296 prompt the user to hit return to acknowledge the
1297 message. Copyright messages do not count as vitally
1298 important (they belong in
1299 <file>/usr/share/doc/<var>package</var>/copyright</file>);
1300 neither do instructions on how to use a program (these
1301 should be in on-line documentation, where all the users
1306 Any necessary prompting should almost always be confined
1307 to the <prgn>config</prgn> or <prgn>postinst</prgn>
1308 script. If it is done in the <prgn>postinst</prgn>, it
1309 should be protected with a conditional so that
1310 unnecessary prompting doesn't happen if a package's
1311 installation fails and the <prgn>postinst</prgn> is
1312 called with <tt>abort-upgrade</tt>,
1313 <tt>abort-remove</tt> or <tt>abort-deconfigure</tt>.
1323 <heading>Source packages</heading>
1325 <sect id="standardsversion">
1326 <heading>Standards conformance</heading>
1329 Source packages should specify the most recent version number
1330 of this policy document with which your package complied
1331 when it was last updated.
1335 This information may be used to file bug reports
1336 automatically if your package becomes too much out of date.
1340 The version is specified in the <tt>Standards-Version</tt>
1342 The format of the <tt>Standards-Version</tt> field is
1343 described in <ref id="f-Standards-Version">.
1347 You should regularly, and especially if your package has
1348 become out of date, check for the newest Policy Manual
1349 available and update your package, if necessary. When your
1350 package complies with the new standards you should update the
1351 <tt>Standards-Version</tt> source package field and
1352 release it.<footnote>
1353 See the file <file>upgrading-checklist</file> for
1354 information about policy which has changed between
1355 different versions of this document.
1361 <sect id="pkg-relations">
1362 <heading>Package relationships</heading>
1365 Source packages should specify which binary packages they
1366 require to be installed or not to be installed in order to
1367 build correctly. For example, if building a package
1368 requires a certain compiler, then the compiler should be
1369 specified as a build-time dependency.
1373 It is not necessary to explicitly specify build-time
1374 relationships on a minimal set of packages that are always
1375 needed to compile, link and put in a Debian package a
1376 standard "Hello World!" program written in C or C++. The
1377 required packages are called <em>build-essential</em>, and
1378 an informational list can be found in
1379 <file>/usr/share/doc/build-essential/list</file> (which is
1380 contained in the <tt>build-essential</tt>
1383 <list compact="compact">
1385 This allows maintaining the list separately
1386 from the policy documents (the list does not
1387 need the kind of control that the policy
1391 Having a separate package allows one to install
1392 the build-essential packages on a machine, as
1393 well as allowing other packages such as tasks to
1394 require installation of the build-essential
1395 packages using the depends relation.
1398 The separate package allows bug reports against
1399 the list to be categorized separately from
1400 the policy management process in the BTS.
1407 When specifying the set of build-time dependencies, one
1408 should list only those packages explicitly required by the
1409 build. It is not necessary to list packages which are
1410 required merely because some other package in the list of
1411 build-time dependencies depends on them.<footnote>
1412 The reason for this is that dependencies change, and
1413 you should list all those packages, and <em>only</em>
1414 those packages that <em>you</em> need directly. What
1415 others need is their business. For example, if you
1416 only link against <file>libimlib</file>, you will need to
1417 build-depend on <package>libimlib2-dev</package> but
1418 not against any <tt>libjpeg*</tt> packages, even
1419 though <tt>libimlib2-dev</tt> currently depends on
1420 them: installation of <package>libimlib2-dev</package>
1421 will automatically ensure that all of its run-time
1422 dependencies are satisfied.
1427 If build-time dependencies are specified, it must be
1428 possible to build the package and produce working binaries
1429 on a system with only essential and build-essential
1430 packages installed and also those required to satisfy the
1431 build-time relationships (including any implied
1432 relationships). In particular, this means that version
1433 clauses should be used rigorously in build-time
1434 relationships so that one cannot produce bad or
1435 inconsistently configured packages when the relationships
1436 are properly satisfied.
1440 <ref id="relationships"> explains the technical details.
1445 <heading>Changes to the upstream sources</heading>
1448 If changes to the source code are made that are not
1449 specific to the needs of the Debian system, they should be
1450 sent to the upstream authors in whatever form they prefer
1451 so as to be included in the upstream version of the
1456 If you need to configure the package differently for
1457 Debian or for Linux, and the upstream source doesn't
1458 provide a way to do so, you should add such configuration
1459 facilities (for example, a new <prgn>autoconf</prgn> test
1460 or <tt>#define</tt>) and send the patch to the upstream
1461 authors, with the default set to the way they originally
1462 had it. You can then easily override the default in your
1463 <file>debian/rules</file> or wherever is appropriate.
1467 You should make sure that the <prgn>configure</prgn> utility
1468 detects the correct architecture specification string
1469 (refer to <ref id="arch-spec"> for details).
1473 If you need to edit a <prgn>Makefile</prgn> where GNU-style
1474 <prgn>configure</prgn> scripts are used, you should edit the
1475 <file>.in</file> files rather than editing the
1476 <prgn>Makefile</prgn> directly. This allows the user to
1477 reconfigure the package if necessary. You should
1478 <em>not</em> configure the package and edit the generated
1479 <prgn>Makefile</prgn>! This makes it impossible for someone
1480 else to later reconfigure the package without losing the
1486 <sect id="dpkgchangelog">
1487 <heading>Debian changelog: <file>debian/changelog</file></heading>
1490 Changes in the Debian version of the package should be
1491 briefly explained in the Debian changelog file
1492 <file>debian/changelog</file>.<footnote>
1494 Mistakes in changelogs are usually best rectified by
1495 making a new changelog entry rather than "rewriting
1496 history" by editing old changelog entries.
1499 This includes modifications
1500 made in the Debian package compared to the upstream one
1501 as well as other changes and updates to the package.
1503 Although there is nothing stopping an author who is also
1504 the Debian maintainer from using this changelog for all
1505 their changes, it will have to be renamed if the Debian
1506 and upstream maintainers become different people. In such
1507 a case, however, it might be better to maintain the package
1508 as a non-native package.
1513 The format of the <file>debian/changelog</file> allows the
1514 package building tools to discover which version of the package
1515 is being built and find out other release-specific information.
1519 That format is a series of entries like this:
1521 <example compact="compact">
1522 <var>package</var> (<var>version</var>) <var>distribution(s)</var>; urgency=<var>urgency</var>
1524 [optional blank line(s), stripped]
1526 * <var>change details</var>
1527 <var>more change details</var>
1529 [blank line(s), included in output of dpkg-parsechangelog]
1531 * <var>even more change details</var>
1533 [optional blank line(s), stripped]
1535 -- <var>maintainer name</var> <<var>email address</var>><var>[two spaces]</var> <var>date</var>
1540 <var>package</var> and <var>version</var> are the source
1541 package name and version number.
1545 <var>distribution(s)</var> lists the distributions where
1546 this version should be installed when it is uploaded - it
1547 is copied to the <tt>Distribution</tt> field in the
1548 <file>.changes</file> file. See <ref id="f-Distribution">.
1552 <var>urgency</var> is the value for the <tt>Urgency</tt>
1553 field in the <file>.changes</file> file for the upload
1554 (see <ref id="f-Urgency">). It is not possible to specify
1555 an urgency containing commas; commas are used to separate
1556 <tt><var>keyword</var>=<var>value</var></tt> settings in the
1557 <prgn>dpkg</prgn> changelog format (though there is
1558 currently only one useful <var>keyword</var>,
1563 The change details may in fact be any series of lines
1564 starting with at least two spaces, but conventionally each
1565 change starts with an asterisk and a separating space and
1566 continuation lines are indented so as to bring them in
1567 line with the start of the text above. Blank lines may be
1568 used here to separate groups of changes, if desired.
1572 If this upload resolves bugs recorded in the Bug Tracking
1573 System (BTS), they may be automatically closed on the
1574 inclusion of this package into the Debian archive by
1575 including the string: <tt>closes: Bug#<var>nnnnn</var></tt>
1576 in the change details.<footnote>
1577 To be precise, the string should match the following
1578 Perl regular expression:
1580 /closes:\s*(?:bug)?\#?\s?\d+(?:,\s*(?:bug)?\#?\s?\d+)*/i
1582 Then all of the bug numbers listed will be closed by the
1583 archive maintenance script (<prgn>katie</prgn>) using the
1584 <var>version</var> of the changelog entry.
1586 This information is conveyed via the <tt>Closes</tt> field
1587 in the <tt>.changes</tt> file (see <ref id="f-Closes">).
1591 The maintainer name and email address used in the changelog
1592 should be the details of the person uploading <em>this</em>
1593 version. They are <em>not</em> necessarily those of the
1594 usual package maintainer. The information here will be
1595 copied to the <tt>Changed-By</tt> field in the
1596 <tt>.changes</tt> file (see <ref id="f-Changed-By">),
1597 and then later used to send an acknowledgement when the
1598 upload has been installed.
1602 The <var>date</var> must be in RFC822 format<footnote>
1603 This is generated by <tt>date -R</tt>.
1604 </footnote>; it must include the time zone specified
1605 numerically, with the time zone name or abbreviation
1606 optionally present as a comment in parentheses.
1610 The first "title" line with the package name must start
1611 at the left hand margin. The "trailer" line with the
1612 maintainer and date details must be preceded by exactly
1613 one space. The maintainer details and the date must be
1614 separated by exactly two spaces.
1618 The entire changelog must be encoded in UTF-8.
1622 For more information on placement of the changelog files
1623 within binary packages, please see <ref id="changelogs">.
1627 <sect id="dpkgcopyright">
1628 <heading>Copyright: <file>debian/copyright</file></heading>
1630 Every package must be accompanied by a verbatim copy of
1631 its copyright and distribution license in the file
1632 <file>/usr/share/doc/<var>package</var>/copyright</file>
1633 (see <ref id="copyrightfile"> for further details). Also see
1634 <ref id="pkgcopyright"> for further considerations relayed
1635 to copyrights for packages.
1639 <heading>Error trapping in makefiles</heading>
1642 When <prgn>make</prgn> invokes a command in a makefile
1643 (including your package's upstream makefiles and
1644 <file>debian/rules</file>), it does so using <prgn>sh</prgn>. This
1645 means that <prgn>sh</prgn>'s usual bad error handling
1646 properties apply: if you include a miniature script as one
1647 of the commands in your makefile you'll find that if you
1648 don't do anything about it then errors are not detected
1649 and <prgn>make</prgn> will blithely continue after
1654 Every time you put more than one shell command (this
1655 includes using a loop) in a makefile command you
1656 must make sure that errors are trapped. For
1657 simple compound commands, such as changing directory and
1658 then running a program, using <tt>&&</tt> rather
1659 than semicolon as a command separator is sufficient. For
1660 more complex commands including most loops and
1661 conditionals you should include a separate <tt>set -e</tt>
1662 command at the start of every makefile command that's
1663 actually one of these miniature shell scripts.
1667 <sect id="timestamps">
1668 <heading>Time Stamps</heading>
1670 Maintainers should preserve the modification times of the
1671 upstream source files in a package, as far as is reasonably
1673 The rationale is that there is some information conveyed
1674 by knowing the age of the file, for example, you could
1675 recognize that some documentation is very old by looking
1676 at the modification time, so it would be nice if the
1677 modification time of the upstream source would be
1683 <sect id="restrictions">
1684 <heading>Restrictions on objects in source packages</heading>
1687 The source package may not contain any hard links<footnote>
1689 This is not currently detected when building source
1690 packages, but only when extracting
1694 Hard links may be permitted at some point in the
1695 future, but would require a fair amount of
1698 </footnote>, device special files, sockets or setuid or
1699 setgid files.<footnote>
1700 Setgid directories are allowed.
1705 <sect id="debianrules">
1706 <heading>Main building script: <file>debian/rules</file></heading>
1709 This file must be an executable makefile, and contains the
1710 package-specific recipes for compiling the package and
1711 building binary package(s) from the source.
1715 It must start with the line <tt>#!/usr/bin/make -f</tt>,
1716 so that it can be invoked by saying its name rather than
1717 invoking <prgn>make</prgn> explicitly.
1721 Since an interactive <file>debian/rules</file> script makes it
1722 impossible to auto-compile that package and also makes it
1723 hard for other people to reproduce the same binary
1724 package, all <em>required targets</em> MUST be
1725 non-interactive. At a minimum, required targets are the
1726 ones called by <prgn>dpkg-buildpackage</prgn>, namely,
1727 <em>clean</em>, <em>binary</em>, <em>binary-arch</em>,
1728 <em>binary-indep</em>, and <em>build</em>. It also follows
1729 that any target that these targets depend on must also be
1734 The targets are as follows (required unless stated otherwise):
1736 <tag><tt>build</tt></tag>
1739 The <tt>build</tt> target should perform all the
1740 configuration and compilation of the package.
1741 If a package has an interactive pre-build
1742 configuration routine, the Debianized source package
1743 must either be built after this has taken place (so
1744 that the binary package can be built without rerunning
1745 the configuration) or the configuration routine
1746 modified to become non-interactive. (The latter is
1747 preferable if there are architecture-specific features
1748 detected by the configuration routine.)
1752 For some packages, notably ones where the same
1753 source tree is compiled in different ways to produce
1754 two binary packages, the <tt>build</tt> target
1755 does not make much sense. For these packages it is
1756 good enough to provide two (or more) targets
1757 (<tt>build-a</tt> and <tt>build-b</tt> or whatever)
1758 for each of the ways of building the package, and a
1759 <tt>build</tt> target that does nothing. The
1760 <tt>binary</tt> target will have to build the
1761 package in each of the possible ways and make the
1762 binary package out of each.
1766 The <tt>build</tt> target must not do anything
1767 that might require root privilege.
1771 The <tt>build</tt> target may need to run the
1772 <tt>clean</tt> target first - see below.
1776 When a package has a configuration and build routine
1777 which takes a long time, or when the makefiles are
1778 poorly designed, or when <tt>build</tt> needs to
1779 run <tt>clean</tt> first, it is a good idea to
1780 <tt>touch build</tt> when the build process is
1781 complete. This will ensure that if <tt>debian/rules
1782 build</tt> is run again it will not rebuild the whole
1784 Another common way to do this is for <tt>build</tt>
1785 to depend on <prgn>build-stamp</prgn> and to do
1786 nothing else, and for the <prgn>build-stamp</prgn>
1787 target to do the building and to <tt>touch
1788 build-stamp</tt> on completion. This is
1789 especially useful if the build routine creates a
1790 file or directory called <tt>build</tt>; in such a
1791 case, <tt>build</tt> will need to be listed as
1792 a phony target (i.e., as a dependency of the
1793 <tt>.PHONY</tt> target). See the documentation of
1794 <prgn>make</prgn> for more information on phony
1800 <tag><tt>build-arch</tt> (optional),
1801 <tt>build-indep</tt> (optional)
1805 A package may also provide both of the targets
1806 <tt>build-arch</tt> and <tt>build-indep</tt>.
1807 The <tt>build-arch</tt> target, if provided, should
1808 perform all the configuration and compilation required
1809 for producing all architecture-dependant binary packages
1810 (those packages for which the body of the
1811 <tt>Architecture</tt> field in <tt>debian/control</tt>
1812 is not <tt>all</tt>).
1813 Similarly, the <tt>build-indep</tt> target, if
1814 provided, should perform all the configuration and
1815 compilation required for producing all
1816 architecture-independent binary packages
1817 (those packages for which the body of the
1818 <tt>Architecture</tt> field in <tt>debian/control</tt>
1820 The <tt>build</tt> target should depend on those of the
1821 targets <tt>build-arch</tt> and <tt>build-indep</tt> that
1822 are provided in the rules file.
1826 If one or both of the targets <tt>build-arch</tt> and
1827 <tt>build-indep</tt> are not provided, then invoking
1828 <file>debian/rules</file> with one of the not-provided
1829 targets as arguments should produce a exit status code
1830 of 2. Usually this is provided automatically by make
1831 if the target is missing.
1835 The <tt>build-arch</tt> and <tt>build-indep</tt> targets
1836 must not do anything that might require root privilege.
1840 <tag><tt>binary</tt>, <tt>binary-arch</tt>,
1841 <tt>binary-indep</tt>
1845 The <tt>binary</tt> target must be all that is
1846 necessary for the user to build the binary package(s)
1847 produced from this source package. It is
1848 split into two parts: <prgn>binary-arch</prgn> builds
1849 the binary packages which are specific to a particular
1850 architecture, and <tt>binary-indep</tt> builds
1851 those which are not.
1854 <tt>binary</tt> may be (and commonly is) a target with
1855 no commands which simply depends on
1856 <tt>binary-arch</tt> and <tt>binary-indep</tt>.
1859 Both <tt>binary-*</tt> targets should depend on the
1860 <tt>build</tt> target, or on the appropriate
1861 <tt>build-arch</tt> or <tt>build-indep</tt> target, if
1862 provided, so that the package is built if it has not
1863 been already. It should then create the relevant
1864 binary package(s), using <prgn>dpkg-gencontrol</prgn> to
1865 make their control files and <prgn>dpkg-deb</prgn> to
1866 build them and place them in the parent of the top
1871 Both the <tt>binary-arch</tt> and
1872 <tt>binary-indep</tt> targets <em>must</em> exist.
1873 If one of them has nothing to do (which will always be
1874 the case if the source generates only a single binary
1875 package, whether architecture-dependent or not), it
1876 must still exist and must always succeed.
1880 The <tt>binary</tt> targets must be invoked as
1882 The <prgn>fakeroot</prgn> package often allows one
1883 to build a package correctly even without being
1889 <tag><tt>clean</tt></tag>
1892 This must undo any effects that the <tt>build</tt>
1893 and <tt>binary</tt> targets may have had, except
1894 that it should leave alone any output files created in
1895 the parent directory by a run of a <tt>binary</tt>
1900 If a <tt>build</tt> file is touched at the end of
1901 the <tt>build</tt> target, as suggested above, it
1902 should be removed as the first action that
1903 <tt>clean</tt> performs, so that running
1904 <tt>build</tt> again after an interrupted
1905 <tt>clean</tt> doesn't think that everything is
1910 The <tt>clean</tt> target may need to be
1911 invoked as root if <tt>binary</tt> has been
1912 invoked since the last <tt>clean</tt>, or if
1913 <tt>build</tt> has been invoked as root (since
1914 <tt>build</tt> may create directories, for
1919 <tag><tt>get-orig-source</tt> (optional)</tag>
1922 This target fetches the most recent version of the
1923 original source package from a canonical archive site
1924 (via FTP or WWW, for example), does any necessary
1925 rearrangement to turn it into the original source
1926 tar file format described below, and leaves it in the
1931 This target may be invoked in any directory, and
1932 should take care to clean up any temporary files it
1937 This target is optional, but providing it if
1938 possible is a good idea.
1942 <tag><tt>patch</tt> (optional)</tag>
1945 This target performs whatever additional actions are
1946 required to make the source ready for editing (unpacking
1947 additional upstream archives, applying patches, etc.).
1948 It is recommended to be implemented for any package where
1949 <tt>dpkg-source -x</tt> does not result in source ready
1950 for additional modification. See
1951 <ref id="readmesource">.
1957 The <tt>build</tt>, <tt>binary</tt> and
1958 <tt>clean</tt> targets must be invoked with the current
1959 directory being the package's top-level directory.
1964 Additional targets may exist in <file>debian/rules</file>,
1965 either as published or undocumented interfaces or for the
1966 package's internal use.
1970 The architectures we build on and build for are determined
1971 by <prgn>make</prgn> variables using the utility
1972 <qref id="pkg-dpkg-architecture"><prgn>dpkg-architecture</prgn></qref>.
1973 You can determine the
1974 Debian architecture and the GNU style architecture
1975 specification string for the build machine (the machine type
1976 we are building on) as well as for the host machine (the
1977 machine type we are building for). Here is a list of
1978 supported <prgn>make</prgn> variables:
1979 <list compact="compact">
1981 <tt>DEB_*_ARCH</tt> (the Debian architecture)
1984 <tt>DEB_*_GNU_TYPE</tt> (the GNU style architecture
1985 specification string)
1988 <tt>DEB_*_GNU_CPU</tt> (the CPU part of
1989 <tt>DEB_*_GNU_TYPE</tt>)
1992 <tt>DEB_*_GNU_SYSTEM</tt> (the System part of
1993 <tt>DEB_*_GNU_TYPE</tt>)
1995 where <tt>*</tt> is either <tt>BUILD</tt> for specification of
1996 the build machine or <tt>HOST</tt> for specification of the
2001 Backward compatibility can be provided in the rules file
2002 by setting the needed variables to suitable default
2003 values; please refer to the documentation of
2004 <prgn>dpkg-architecture</prgn> for details.
2008 It is important to understand that the <tt>DEB_*_ARCH</tt>
2009 string only determines which Debian architecture we are
2010 building on or for. It should not be used to get the CPU
2011 or system information; the GNU style variables should be
2015 <sect1 id="debianrules-options">
2016 <heading><file>debian/rules</file> and
2017 <tt>DEB_BUILD_OPTIONS</tt></heading>
2020 Supporting the standardized environment variable
2021 <tt>DEB_BUILD_OPTIONS</tt> is recommended. This variable can
2022 contain several flags to change how a package is compiled and
2023 built. Each flag must be in the form <var>flag</var> or
2024 <var>flag</var>=<var>options</var>. If multiple flags are
2025 given, they must be separated by whitespace.<footnote>
2026 Some packages support any delimiter, but whitespace is the
2027 easiest to parse inside a makefile and avoids ambiguity with
2028 flag values that contain commas.
2030 <var>flag</var> must start with a lowercase letter
2031 (<tt>a-z</tt>) and consist only of lowercase letters,
2032 numbers (<tt>0-9</tt>), and the characters
2033 <tt>-</tt> and <tt>_</tt> (hyphen and underscore).
2034 <var>options</var> must not contain whitespace. The same
2035 tag should not be given multiple times with conflicting
2036 values. Package maintainers may assume that
2037 <tt>DEB_BUILD_OPTIONS</tt> will not contain conflicting tags.
2041 The meaning of the following tags has been standardized:
2045 This tag says to not run any build-time test suite
2046 provided by the package.
2050 The presence of this tag means that the package should
2051 be compiled with a minimum of optimization. For C
2052 programs, it is best to add <tt>-O0</tt> to
2053 <tt>CFLAGS</tt> (although this is usually the default).
2054 Some programs might fail to build or run at this level
2055 of optimization; it may be necessary to use
2056 <tt>-O1</tt>, for example.
2060 This tag means that the debugging symbols should not be
2061 stripped from the binary during installation, so that
2062 debugging information may be included in the package.
2064 <tag>parallel=n</tag>
2066 This tag means that the package should be built using up
2067 to <tt>n</tt> parallel processes if the package build
2068 system supports this.<footnote>
2069 Packages built with <tt>make</tt> can often implement
2070 this by passing the <tt>-j</tt><var>n</var> option to
2073 If the package build system does not support parallel
2074 builds, this string must be ignored. If the package
2075 build system only supports a lower level of concurrency
2076 than <var>n</var>, the package should be built using as
2077 many parallel processes as the package build system
2078 supports. It is up to the package maintainer to decide
2079 whether the package build times are long enough and the
2080 package build system is robust enough to make supporting
2081 parallel builds worthwhile.
2087 Unknown flags must be ignored by <file>debian/rules</file>.
2091 The following makefile snippet is an example of how one may
2092 implement the build options; you will probably have to
2093 massage this example in order to make it work for your
2095 <example compact="compact">
2098 INSTALL_FILE = $(INSTALL) -p -o root -g root -m 644
2099 INSTALL_PROGRAM = $(INSTALL) -p -o root -g root -m 755
2100 INSTALL_SCRIPT = $(INSTALL) -p -o root -g root -m 755
2101 INSTALL_DIR = $(INSTALL) -p -d -o root -g root -m 755
2103 ifneq (,$(filter noopt,$(DEB_BUILD_OPTIONS)))
2108 ifeq (,$(filter nostrip,$(DEB_BUILD_OPTIONS)))
2109 INSTALL_PROGRAM += -s
2111 ifneq (,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
2112 NUMJOBS = $(patsubst parallel=%,%,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
2113 MAKEFLAGS += -j$(NUMJOBS)
2118 ifeq (,$(filter nocheck,$(DEB_BUILD_OPTIONS)))
2119 # Code to run the package test suite.
2126 <!-- FIXME: section pkg-srcsubstvars is the same as substvars -->
2127 <sect id="substvars">
2128 <heading>Variable substitutions: <file>debian/substvars</file></heading>
2131 When <prgn>dpkg-gencontrol</prgn>,
2132 <prgn>dpkg-genchanges</prgn> and <prgn>dpkg-source</prgn>
2133 generate control files they perform variable substitutions
2134 on their output just before writing it. Variable
2135 substitutions have the form <tt>${<var>variable</var>}</tt>.
2136 The optional file <file>debian/substvars</file> contains
2137 variable substitutions to be used; variables can also be set
2138 directly from <file>debian/rules</file> using the <tt>-V</tt>
2139 option to the source packaging commands, and certain
2140 predefined variables are also available.
2144 The <file>debian/substvars</file> file is usually generated and
2145 modified dynamically by <file>debian/rules</file> targets, in
2146 which case it must be removed by the <tt>clean</tt> target.
2150 See <manref name="deb-substvars" section="5"> for full
2151 details about source variable substitutions, including the
2152 format of <file>debian/substvars</file>.</p>
2155 <sect id="debianwatch">
2156 <heading>Optional upstream source location: <file>debian/watch</file></heading>
2159 This is an optional, recommended control file for the
2160 <tt>uscan</tt> utility which defines how to automatically
2161 scan ftp or http sites for newly available updates of the
2162 package. This is used by <url id="
2163 http://dehs.alioth.debian.org/"> and other Debian QA tools
2164 to help with quality control and maintenance of the
2165 distribution as a whole.
2170 <sect id="debianfiles">
2171 <heading>Generated files list: <file>debian/files</file></heading>
2174 This file is not a permanent part of the source tree; it
2175 is used while building packages to record which files are
2176 being generated. <prgn>dpkg-genchanges</prgn> uses it
2177 when it generates a <file>.changes</file> file.
2181 It should not exist in a shipped source package, and so it
2182 (and any backup files or temporary files such as
2183 <file>files.new</file><footnote>
2184 <file>files.new</file> is used as a temporary file by
2185 <prgn>dpkg-gencontrol</prgn> and
2186 <prgn>dpkg-distaddfile</prgn> - they write a new
2187 version of <tt>files</tt> here before renaming it,
2188 to avoid leaving a corrupted copy if an error
2190 </footnote>) should be removed by the
2191 <tt>clean</tt> target. It may also be wise to
2192 ensure a fresh start by emptying or removing it at the
2193 start of the <tt>binary</tt> target.
2197 When <prgn>dpkg-gencontrol</prgn> is run for a binary
2198 package, it adds an entry to <file>debian/files</file> for the
2199 <file>.deb</file> file that will be created when <tt>dpkg-deb
2200 --build</tt> is run for that binary package. So for most
2201 packages all that needs to be done with this file is to
2202 delete it in the <tt>clean</tt> target.
2206 If a package upload includes files besides the source
2207 package and any binary packages whose control files were
2208 made with <prgn>dpkg-gencontrol</prgn> then they should be
2209 placed in the parent of the package's top-level directory
2210 and <prgn>dpkg-distaddfile</prgn> should be called to add
2211 the file to the list in <file>debian/files</file>.</p>
2214 <sect id="embeddedfiles">
2215 <heading>Convenience copies of code</heading>
2218 Some software packages include in their distribution convenience
2219 copies of code from other software packages, generally so that
2220 users compiling from source don't have to download multiple
2221 packages. Debian packages should not make use of these
2222 convenience copies unless the included package is explicitly
2223 intended to be used in this way.<footnote>
2224 For example, parts of the GNU build system work like this.
2226 If the included code is already in the Debian archive in the
2227 form of a library, the Debian packaging should ensure that
2228 binary packages reference the libraries already in Debian and
2229 the convenience copy is not used. If the included code is not
2230 already in Debian, it should be packaged separately as a
2231 prerequisite if possible.
2233 Having multiple copies of the same code in Debian is
2234 inefficient, often creates either static linking or shared
2235 library conflicts, and, most importantly, increases the
2236 difficulty of handling security vulnerabilities in the
2242 <sect id="readmesource">
2243 <heading>Source package handling:
2244 <file>debian/README.source</file></heading>
2247 If running <prgn>dpkg-source -x</prgn> on a source package
2248 doesn't produce the source of the package, ready for editing,
2249 and allow one to make changes and run
2250 <prgn>dpkg-buildpackage</prgn> to produce a modified package
2251 without taking any additional steps, creating a
2252 <file>debian/README.source</file> documentation file is
2253 recommended. This file should explain how to do all of the
2256 <item>Generate the fully patched source, in a form ready for
2257 editing, that would be built to create Debian
2258 packages. Doing this with a <tt>patch</tt> target in
2259 <file>debian/rules</file> is recommended; see
2260 <ref id="debianrules">.</item>
2261 <item>Modify the source and save those modifications so that
2262 they will be applied when building the package.</item>
2263 <item>Remove source modifications that are currently being
2264 applied when building the package.</item>
2265 <item>Optionally, document what steps are necessary to
2266 upgrade the Debian source package to a new upstream version,
2267 if applicable.</item>
2269 This explanation should include specific commands and mention
2270 any additional required Debian packages. It should not assume
2271 familiarity with any specific Debian packaging system or patch
2276 This explanation may refer to a documentation file installed by
2277 one of the package's build dependencies provided that the
2278 referenced documentation clearly explains these tasks and is not
2279 a general reference manual.
2283 <file>debian/README.source</file> may also include any other
2284 information that would be helpful to someone modifying the
2285 source package. Even if the package doesn't fit the above
2286 description, maintainers are encouraged to document in a
2287 <file>debian/README.source</file> file any source package with a
2288 particularly complex or unintuitive source layout or build
2289 system (for example, a package that builds the same source
2290 multiple times to generate different binary packages).
2296 <chapt id="controlfields">
2297 <heading>Control files and their fields</heading>
2300 The package management system manipulates data represented in
2301 a common format, known as <em>control data</em>, stored in
2302 <em>control files</em>.
2303 Control files are used for source packages, binary packages and
2304 the <file>.changes</file> files which control the installation
2305 of uploaded files<footnote>
2306 <prgn>dpkg</prgn>'s internal databases are in a similar
2311 <sect id="controlsyntax">
2312 <heading>Syntax of control files</heading>
2315 A control file consists of one or more paragraphs of
2317 The paragraphs are also sometimes referred to as stanzas.
2319 The paragraphs are separated by blank lines. Some control
2320 files allow only one paragraph; others allow several, in
2321 which case each paragraph usually refers to a different
2322 package. (For example, in source packages, the first
2323 paragraph refers to the source package, and later paragraphs
2324 refer to binary packages generated from the source.)
2328 Each paragraph consists of a series of data fields; each
2329 field consists of the field name, followed by a colon and
2330 then the data/value associated with that field. It ends at
2331 the end of the (logical) line. Horizontal whitespace
2332 (spaces and tabs) may occur immediately before or after the
2333 value and is ignored there; it is conventional to put a
2334 single space after the colon. For example, a field might
2336 <example compact="compact">
2339 the field name is <tt>Package</tt> and the field value
2344 Many fields' values may span several lines; in this case
2345 each continuation line must start with a space or a tab.
2346 Any trailing spaces or tabs at the end of individual
2347 lines of a field value are ignored.
2351 In fields where it is specified that lines may not wrap,
2352 only a single line of data is allowed and whitespace is not
2353 significant in a field body. Whitespace must not appear
2354 inside names (of packages, architectures, files or anything
2355 else) or version numbers, or between the characters of
2356 multi-character version relationships.
2360 Field names are not case-sensitive, but it is usual to
2361 capitalize the field names using mixed case as shown below.
2365 Blank lines, or lines consisting only of spaces and tabs,
2366 are not allowed within field values or between fields - that
2367 would mean a new paragraph.
2371 All control files must be encoded in UTF-8.
2375 <sect id="sourcecontrolfiles">
2376 <heading>Source package control files -- <file>debian/control</file></heading>
2379 The <file>debian/control</file> file contains the most vital
2380 (and version-independent) information about the source package
2381 and about the binary packages it creates.
2385 The first paragraph of the control file contains information about
2386 the source package in general. The subsequent sets each describe a
2387 binary package that the source tree builds.
2391 The fields in the general paragraph (the first one, for the source
2394 <list compact="compact">
2395 <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2396 <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2397 <item><qref id="f-Uploaders"><tt>Uploaders</tt></qref></item>
2398 <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2399 <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2400 <item><qref id="sourcebinarydeps"><tt>Build-Depends</tt> et al</qref></item>
2401 <item><qref id="f-Standards-Version"><tt>Standards-Version</tt></qref> (recommended)</item>
2402 <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2407 The fields in the binary package paragraphs are:
2409 <list compact="compact">
2410 <item><qref id="f-Package"><tt>Package</tt></qref> (mandatory)</item>
2411 <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2412 <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2413 <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2414 <item><qref id="f-Essential"><tt>Essential</tt></qref></item>
2415 <item><qref id="binarydeps"><tt>Depends</tt> et al</qref></item>
2416 <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2417 <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2422 The syntax and semantics of the fields are described below.
2428 These fields are used by <prgn>dpkg-gencontrol</prgn> to
2429 generate control files for binary packages (see below), by
2430 <prgn>dpkg-genchanges</prgn> to generate the
2431 <tt>.changes</tt> file to accompany the upload, and by
2432 <prgn>dpkg-source</prgn> when it creates the
2433 <file>.dsc</file> source control file as part of a source
2434 archive. Many fields are permitted to span multiple lines in
2435 <file>debian/control</file> but not in any other control
2436 file. These tools are responsible for removing the line
2437 breaks from such fields when using fields from
2438 <file>debian/control</file> to generate other control files.
2442 The fields here may contain variable references - their
2443 values will be substituted by <prgn>dpkg-gencontrol</prgn>,
2444 <prgn>dpkg-genchanges</prgn> or <prgn>dpkg-source</prgn>
2445 when they generate output control files.
2446 See <ref id="substvars"> for details.
2451 <sect id="binarycontrolfiles">
2452 <heading>Binary package control files -- <file>DEBIAN/control</file></heading>
2455 The <file>DEBIAN/control</file> file contains the most vital
2456 (and version-dependent) information about a binary package.
2460 The fields in this file are:
2462 <list compact="compact">
2463 <item><qref id="f-Package"><tt>Package</tt></qref> (mandatory)</item>
2464 <item><qref id="f-Source"><tt>Source</tt></qref></item>
2465 <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2466 <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2467 <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2468 <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2469 <item><qref id="f-Essential"><tt>Essential</tt></qref></item>
2470 <item><qref id="binarydeps"><tt>Depends</tt> et al</qref></item>
2471 <item><qref id="f-Installed-Size"><tt>Installed-Size</tt></qref></item>
2472 <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2473 <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2474 <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2479 <sect id="debiansourcecontrolfiles">
2480 <heading>Debian source control files -- <tt>.dsc</tt></heading>
2483 This file contains a series of fields, identified and
2484 separated just like the fields in the control file of
2485 a binary package. The fields are listed below; their
2486 syntax is described above, in <ref id="pkg-controlfields">.
2488 <list compact="compact">
2489 <item><qref id="f-Format"><tt>Format</tt></qref> (mandatory)</item>
2490 <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2491 <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2492 <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2493 <item><qref id="f-Uploaders"><tt>Uploaders</tt></qref></item>
2494 <item><qref id="f-Binary"><tt>Binary</tt></qref></item>
2495 <item><qref id="f-Architecture"><tt>Architecture</tt></qref></item>
2496 <item><qref id="sourcebinarydeps"><tt>Build-Depends</tt> et al</qref></item>
2497 <item><qref id="f-Standards-Version"><tt>Standards-Version</tt></qref> (recommended)</item>
2498 <item><qref id="f-Files"><tt>Files</tt></qref> (mandatory)</item>
2499 <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2504 The source package control file is generated by
2505 <prgn>dpkg-source</prgn> when it builds the source
2506 archive, from other files in the source package,
2507 described above. When unpacking, it is checked against
2508 the files and directories in the other parts of the
2514 <sect id="debianchangesfiles">
2515 <heading>Debian changes files -- <file>.changes</file></heading>
2518 The .changes files are used by the Debian archive maintenance
2519 software to process updates to packages. They contain one
2520 paragraph which contains information from the
2521 <tt>debian/control</tt> file and other data about the
2522 source package gathered via <tt>debian/changelog</tt>
2523 and <tt>debian/rules</tt>.
2527 The fields in this file are:
2529 <list compact="compact">
2530 <item><qref id="f-Format"><tt>Format</tt></qref> (mandatory)</item>
2531 <item><qref id="f-Date"><tt>Date</tt></qref> (mandatory)</item>
2532 <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2533 <item><qref id="f-Binary"><tt>Binary</tt></qref> (mandatory)</item>
2534 <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2535 <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2536 <item><qref id="f-Distribution"><tt>Distribution</tt></qref> (mandatory)</item>
2537 <item><qref id="f-Urgency"><tt>Urgency</tt></qref> (recommended)</item>
2538 <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2539 <item><qref id="f-Changed-By"><tt>Changed-By</tt></qref></item>
2540 <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2541 <item><qref id="f-Closes"><tt>Closes</tt></qref></item>
2542 <item><qref id="f-Changes"><tt>Changes</tt></qref> (mandatory)</item>
2543 <item><qref id="f-Files"><tt>Files</tt></qref> (mandatory)</item>
2548 <sect id="controlfieldslist">
2549 <heading>List of fields</heading>
2551 <sect1 id="f-Source">
2552 <heading><tt>Source</tt></heading>
2555 This field identifies the source package name.
2559 In <file>debian/control</file> or a <file>.dsc</file> file,
2560 this field must contain only the name of the source package.
2564 In a binary package control file or a <file>.changes</file>
2565 file, the source package name may be followed by a version
2566 number in parentheses<footnote>
2567 It is customary to leave a space after the package name
2568 if a version number is specified.
2570 This version number may be omitted (and is, by
2571 <prgn>dpkg-gencontrol</prgn>) if it has the same value as
2572 the <tt>Version</tt> field of the binary package in
2573 question. The field itself may be omitted from a binary
2574 package control file when the source package has the same
2575 name and version as the binary package.
2579 <sect1 id="f-Maintainer">
2580 <heading><tt>Maintainer</tt></heading>
2583 The package maintainer's name and email address. The name
2584 should come first, then the email address inside angle
2585 brackets <tt><></tt> (in RFC822 format).
2589 If the maintainer's name contains a full stop then the
2590 whole field will not work directly as an email address due
2591 to a misfeature in the syntax specified in RFC822; a
2592 program using this field as an address must check for this
2593 and correct the problem if necessary (for example by
2594 putting the name in round brackets and moving it to the
2595 end, and bringing the email address forward).
2599 <sect1 id="f-Uploaders">
2600 <heading><tt>Uploaders</tt></heading>
2603 List of the names and email addresses of co-maintainers of
2604 the package, if any. If the package has other maintainers
2605 beside the one named in the
2606 <qref id="f-Maintainer">Maintainer field</qref>, their
2607 names and email addresses should be listed here. The
2608 format is the same as that of the Maintainer tag, and
2609 multiple entries should be comma separated. Currently,
2610 this field is restricted to a single line of data. This
2611 is an optional field.
2614 Any parser that interprets the Uploaders field in
2615 <file>debian/control</file> must permit it to span multiple
2616 lines. Line breaks in an Uploaders field that spans multiple
2617 lines are not significant and the semantics of the field are
2618 the same as if the line breaks had not been present.
2622 <sect1 id="f-Changed-By">
2623 <heading><tt>Changed-By</tt></heading>
2626 The name and email address of the person who changed the
2627 said package. Usually the name of the maintainer.
2628 All the rules for the Maintainer field apply here, too.
2632 <sect1 id="f-Section">
2633 <heading><tt>Section</tt></heading>
2636 This field specifies an application area into which the package
2637 has been classified. See <ref id="subsections">.
2641 When it appears in the <file>debian/control</file> file,
2642 it gives the value for the subfield of the same name in
2643 the <tt>Files</tt> field of the <file>.changes</file> file.
2644 It also gives the default for the same field in the binary
2649 <sect1 id="f-Priority">
2650 <heading><tt>Priority</tt></heading>
2653 This field represents how important that it is that the user
2654 have the package installed. See <ref id="priorities">.
2658 When it appears in the <file>debian/control</file> file,
2659 it gives the value for the subfield of the same name in
2660 the <tt>Files</tt> field of the <file>.changes</file> file.
2661 It also gives the default for the same field in the binary
2666 <sect1 id="f-Package">
2667 <heading><tt>Package</tt></heading>
2670 The name of the binary package.
2674 Package names must consist only of lower case letters
2675 (<tt>a-z</tt>), digits (<tt>0-9</tt>), plus (<tt>+</tt>)
2676 and minus (<tt>-</tt>) signs, and periods (<tt>.</tt>).
2677 They must be at least two characters long and must start
2678 with an alphanumeric character.
2682 <sect1 id="f-Architecture">
2683 <heading><tt>Architecture</tt></heading>
2686 Depending on context and the control file used, the
2687 <tt>Architecture</tt> field can include the following sets of
2690 <item>A unique single word identifying a Debian machine
2691 architecture, see <ref id="arch-spec">.
2692 <item><tt>all</tt>, which indicates an
2693 architecture-independent package.
2694 <item><tt>any</tt>, which indicates a package available
2695 for building on any architecture.
2696 <item><tt>source</tt>, which indicates a source package.
2701 In the main <file>debian/control</file> file in the source
2702 package, or in the source package control file
2703 <file>.dsc</file>, one may specify a list of architectures
2704 separated by spaces, or the special values <tt>any</tt> or
2709 Specifying <tt>any</tt> indicates that the source package
2710 isn't dependent on any particular architecture and should
2711 compile fine on any one. The produced binary package(s)
2712 will be specific to whatever the current build architecture
2714 This is the most often used setting, and is recommended
2715 for new packages that aren't <tt>Architecture: all</tt>.
2720 Specifying a list of architectures indicates that the source
2721 will build an architecture-dependent package, and will only
2722 work correctly on the listed architectures.<footnote>
2723 This is a setting used for a minority of cases where the
2724 program is not portable. Generally, it should not be used
2730 In a <file>.changes</file> file, the <tt>Architecture</tt>
2731 field lists the architecture(s) of the package(s)
2732 currently being uploaded. This will be a list; if the
2733 source for the package is also being uploaded, the special
2734 entry <tt>source</tt> is also present.
2738 See <ref id="debianrules"> for information how to get the
2739 architecture for the build process.
2743 <sect1 id="f-Essential">
2744 <heading><tt>Essential</tt></heading>
2747 This is a boolean field which may occur only in the
2748 control file of a binary package or in a per-package fields
2749 paragraph of a main source control data file.
2753 If set to <tt>yes</tt> then the package management system
2754 will refuse to remove the package (upgrading and replacing
2755 it is still possible). The other possible value is <tt>no</tt>,
2756 which is the same as not having the field at all.
2761 <heading>Package interrelationship fields:
2762 <tt>Depends</tt>, <tt>Pre-Depends</tt>,
2763 <tt>Recommends</tt>, <tt>Suggests</tt>,
2764 <tt>Breaks</tt>, <tt>Conflicts</tt>,
2765 <tt>Provides</tt>, <tt>Replaces</tt>, <tt>Enhances</tt>
2769 These fields describe the package's relationships with
2770 other packages. Their syntax and semantics are described
2771 in <ref id="relationships">.</p>
2774 <sect1 id="f-Standards-Version">
2775 <heading><tt>Standards-Version</tt></heading>
2778 The most recent version of the standards (the policy
2779 manual and associated texts) with which the package
2784 The version number has four components: major and minor
2785 version number and major and minor patch level. When the
2786 standards change in a way that requires every package to
2787 change the major number will be changed. Significant
2788 changes that will require work in many packages will be
2789 signaled by a change to the minor number. The major patch
2790 level will be changed for any change to the meaning of the
2791 standards, however small; the minor patch level will be
2792 changed when only cosmetic, typographical or other edits
2793 are made which neither change the meaning of the document
2794 nor affect the contents of packages.
2798 Thus only the first three components of the policy version
2799 are significant in the <em>Standards-Version</em> control
2800 field, and so either these three components or the all
2801 four components may be specified.<footnote>
2802 In the past, people specified the full version number
2803 in the Standards-Version field, for example "2.3.0.0".
2804 Since minor patch-level changes don't introduce new
2805 policy, it was thought it would be better to relax
2806 policy and only require the first 3 components to be
2807 specified, in this example "2.3.0". All four
2808 components may still be used if someone wishes to do so.
2814 <sect1 id="f-Version">
2815 <heading><tt>Version</tt></heading>
2818 The version number of a package. The format is:
2819 [<var>epoch</var><tt>:</tt>]<var>upstream_version</var>[<tt>-</tt><var>debian_revision</var>]
2823 The three components here are:
2825 <tag><var>epoch</var></tag>
2828 This is a single (generally small) unsigned integer. It
2829 may be omitted, in which case zero is assumed. If it is
2830 omitted then the <var>upstream_version</var> may not
2835 It is provided to allow mistakes in the version numbers
2836 of older versions of a package, and also a package's
2837 previous version numbering schemes, to be left behind.
2841 <tag><var>upstream_version</var></tag>
2844 This is the main part of the version number. It is
2845 usually the version number of the original ("upstream")
2846 package from which the <file>.deb</file> file has been made,
2847 if this is applicable. Usually this will be in the same
2848 format as that specified by the upstream author(s);
2849 however, it may need to be reformatted to fit into the
2850 package management system's format and comparison
2855 The comparison behavior of the package management system
2856 with respect to the <var>upstream_version</var> is
2857 described below. The <var>upstream_version</var>
2858 portion of the version number is mandatory.
2862 The <var>upstream_version</var> may contain only
2863 alphanumerics<footnote>
2864 Alphanumerics are <tt>A-Za-z0-9</tt> only.
2866 and the characters <tt>.</tt> <tt>+</tt> <tt>-</tt>
2867 <tt>:</tt> <tt>~</tt> (full stop, plus, hyphen, colon,
2868 tilde) and should start with a digit. If there is no
2869 <var>debian_revision</var> then hyphens are not allowed;
2870 if there is no <var>epoch</var> then colons are not
2875 <tag><var>debian_revision</var></tag>
2878 This part of the version number specifies the version of
2879 the Debian package based on the upstream version. It
2880 may contain only alphanumerics and the characters
2881 <tt>+</tt> <tt>.</tt> <tt>~</tt> (plus, full stop,
2882 tilde) and is compared in the same way as the
2883 <var>upstream_version</var> is.
2887 It is optional; if it isn't present then the
2888 <var>upstream_version</var> may not contain a hyphen.
2889 This format represents the case where a piece of
2890 software was written specifically to be turned into a
2891 Debian package, and so there is only one "debianisation"
2892 of it and therefore no revision indication is required.
2896 It is conventional to restart the
2897 <var>debian_revision</var> at <tt>1</tt> each time the
2898 <var>upstream_version</var> is increased.
2902 The package management system will break the version
2903 number apart at the last hyphen in the string (if there
2904 is one) to determine the <var>upstream_version</var> and
2905 <var>debian_revision</var>. The absence of a
2906 <var>debian_revision</var> is equivalent to a
2907 <var>debian_revision</var> of <tt>0</tt>.
2914 When comparing two version numbers, first the <var>epoch</var>
2915 of each are compared, then the <var>upstream_version</var> if
2916 <var>epoch</var> is equal, and then <var>debian_revision</var>
2917 if <var>upstream_version</var> is also equal.
2918 <var>epoch</var> is compared numerically. The
2919 <var>upstream_version</var> and <var>debian_revision</var>
2920 parts are compared by the package management system using the
2921 following algorithm:
2925 The strings are compared from left to right.
2929 First the initial part of each string consisting entirely of
2930 non-digit characters is determined. These two parts (one of
2931 which may be empty) are compared lexically. If a difference
2932 is found it is returned. The lexical comparison is a
2933 comparison of ASCII values modified so that all the letters
2934 sort earlier than all the non-letters and so that a tilde
2935 sorts before anything, even the end of a part. For example,
2936 the following parts are in sorted order from earliest to
2937 latest: <tt>~~</tt>, <tt>~~a</tt>, <tt>~</tt>, the empty part,
2938 <tt>a</tt>.<footnote>
2939 One common use of <tt>~</tt> is for upstream pre-releases.
2940 For example, <tt>1.0~beta1~svn1245</tt> sorts earlier than
2941 <tt>1.0~beta1</tt>, which sorts earlier than <tt>1.0</tt>.
2946 Then the initial part of the remainder of each string which
2947 consists entirely of digit characters is determined. The
2948 numerical values of these two parts are compared, and any
2949 difference found is returned as the result of the comparison.
2950 For these purposes an empty string (which can only occur at
2951 the end of one or both version strings being compared) counts
2956 These two steps (comparing and removing initial non-digit
2957 strings and initial digit strings) are repeated until a
2958 difference is found or both strings are exhausted.
2962 Note that the purpose of epochs is to allow us to leave behind
2963 mistakes in version numbering, and to cope with situations
2964 where the version numbering scheme changes. It is
2965 <em>not</em> intended to cope with version numbers containing
2966 strings of letters which the package management system cannot
2967 interpret (such as <tt>ALPHA</tt> or <tt>pre-</tt>), or with
2968 silly orderings (the author of this manual has heard of a
2969 package whose versions went <tt>1.1</tt>, <tt>1.2</tt>,
2970 <tt>1.3</tt>, <tt>1</tt>, <tt>2.1</tt>, <tt>2.2</tt>,
2971 <tt>2</tt> and so forth).
2975 <sect1 id="f-Description">
2976 <heading><tt>Description</tt></heading>
2979 In a source or binary control file, the <tt>Description</tt>
2980 field contains a description of the binary package, consisting
2981 of two parts, the synopsis or the short description, and the
2982 long description. The field's format is as follows:
2987 Description: <single line synopsis>
2988 <extended description over several lines>
2993 The lines in the extended description can have these formats:
2999 Those starting with a single space are part of a paragraph.
3000 Successive lines of this form will be word-wrapped when
3001 displayed. The leading space will usually be stripped off.
3005 Those starting with two or more spaces. These will be
3006 displayed verbatim. If the display cannot be panned
3007 horizontally, the displaying program will line wrap them "hard"
3008 (i.e., without taking account of word breaks). If it can they
3009 will be allowed to trail off to the right. None, one or two
3010 initial spaces may be deleted, but the number of spaces
3011 deleted from each line will be the same (so that you can have
3012 indenting work correctly, for example).
3016 Those containing a single space followed by a single full stop
3017 character. These are rendered as blank lines. This is the
3018 <em>only</em> way to get a blank line<footnote>
3019 Completely empty lines will not be rendered as blank lines.
3020 Instead, they will cause the parser to think you're starting
3021 a whole new record in the control file, and will therefore
3022 likely abort with an error.
3027 Those containing a space, a full stop and some more characters.
3028 These are for future expansion. Do not use them.
3034 Do not use tab characters. Their effect is not predictable.
3038 See <ref id="descriptions"> for further information on this.
3042 In a <file>.changes</file> file, the <tt>Description</tt> field
3043 contains a summary of the descriptions for the packages being
3048 The part of the field before the first newline is empty;
3049 thereafter each line has the name of a binary package and
3050 the summary description line from that binary package.
3051 Each line is indented by one space.
3056 <sect1 id="f-Distribution">
3057 <heading><tt>Distribution</tt></heading>
3060 In a <file>.changes</file> file or parsed changelog output
3061 this contains the (space-separated) name(s) of the
3062 distribution(s) where this version of the package should
3063 be installed. Valid distributions are determined by the
3064 archive maintainers.<footnote>
3065 Current distribution names are:
3066 <taglist compact="compact">
3067 <tag><em>stable</em></tag>
3069 This is the current "released" version of Debian
3070 GNU/Linux. Once the distribution is
3071 <em>stable</em> only security fixes and other
3072 major bug fixes are allowed. When changes are
3073 made to this distribution, the release number is
3074 increased (for example: 2.2r1 becomes 2.2r2 then
3078 <tag><em>unstable</em></tag>
3080 This distribution value refers to the
3081 <em>developmental</em> part of the Debian
3082 distribution tree. New packages, new upstream
3083 versions of packages and bug fixes go into the
3084 <em>unstable</em> directory tree. Download from
3085 this distribution at your own risk.
3088 <tag><em>testing</em></tag>
3090 This distribution value refers to the
3091 <em>testing</em> part of the Debian distribution
3092 tree. It receives its packages from the
3093 unstable distribution after a short time lag to
3094 ensure that there are no major issues with the
3095 unstable packages. It is less prone to breakage
3096 than unstable, but still risky. It is not
3097 possible to upload packages directly to
3101 <tag><em>frozen</em></tag>
3103 From time to time, the <em>testing</em>
3104 distribution enters a state of "code-freeze" in
3105 anticipation of release as a <em>stable</em>
3106 version. During this period of testing only
3107 fixes for existing or newly-discovered bugs will
3108 be allowed. The exact details of this stage are
3109 determined by the Release Manager.
3112 <tag><em>experimental</em></tag>
3114 The packages with this distribution value are
3115 deemed by their maintainers to be high
3116 risk. Oftentimes they represent early beta or
3117 developmental packages from various sources that
3118 the maintainers want people to try, but are not
3119 ready to be a part of the other parts of the
3120 Debian distribution tree. Download at your own
3126 You should list <em>all</em> distributions that the
3127 package should be installed into.
3131 More information is available in the Debian Developer's
3132 Reference, section "The Debian archive".
3139 <heading><tt>Date</tt></heading>
3142 This field includes the date the package was built or last edited.
3146 The value of this field is usually extracted from the
3147 <file>debian/changelog</file> file - see
3148 <ref id="dpkgchangelog">).
3152 <sect1 id="f-Format">
3153 <heading><tt>Format</tt></heading>
3156 This field specifies a format revision for the file.
3157 The most current format described in the Policy Manual
3158 is version <strong>1.5</strong>. The syntax of the
3159 format value is the same as that of a package version
3160 number except that no epoch or Debian revision is allowed
3161 - see <ref id="f-Version">.
3165 <sect1 id="f-Urgency">
3166 <heading><tt>Urgency</tt></heading>
3169 This is a description of how important it is to upgrade to
3170 this version from previous ones. It consists of a single
3171 keyword taking one of the values <tt>low</tt>,
3172 <tt>medium</tt>, <tt>high</tt>, <tt>emergency</tt>, or
3173 <tt>critical</tt><footnote>
3174 Other urgency values are supported with configuration
3175 changes in the archive software but are not used in Debian.
3176 The urgency affects how quickly a package will be considered
3177 for inclusion into the <tt>testing</tt> distribution and
3178 gives an indication of the importance of any fixes included
3179 in the upload. <tt>Emergency</tt> and <tt>critical</tt> are
3180 treated as synonymous.
3181 </footnote> (not case-sensitive) followed by an optional
3182 commentary (separated by a space) which is usually in
3183 parentheses. For example:
3186 Urgency: low (HIGH for users of diversions)
3192 The value of this field is usually extracted from the
3193 <file>debian/changelog</file> file - see
3194 <ref id="dpkgchangelog">.
3198 <sect1 id="f-Changes">
3199 <heading><tt>Changes</tt></heading>
3202 This field contains the human-readable changes data, describing
3203 the differences between the last version and the current one.
3207 There should be nothing in this field before the first
3208 newline; all the subsequent lines must be indented by at
3209 least one space; blank lines must be represented by a line
3210 consisting only of a space and a full stop.
3214 The value of this field is usually extracted from the
3215 <file>debian/changelog</file> file - see
3216 <ref id="dpkgchangelog">).
3220 Each version's change information should be preceded by a
3221 "title" line giving at least the version, distribution(s)
3222 and urgency, in a human-readable way.
3226 If data from several versions is being returned the entry
3227 for the most recent version should be returned first, and
3228 entries should be separated by the representation of a
3229 blank line (the "title" line may also be followed by the
3230 representation of blank line).
3234 <sect1 id="f-Binary">
3235 <heading><tt>Binary</tt></heading>
3238 This field is a list of binary packages.
3242 When it appears in the <file>.dsc</file> file it is the list
3243 of binary packages which a source package can produce. It
3244 does not necessarily produce all of these binary packages
3245 for every architecture. The source control file doesn't
3246 contain details of which architectures are appropriate for
3247 which of the binary packages.
3251 When it appears in a <file>.changes</file> file it lists the
3252 names of the binary packages actually being uploaded.
3256 The syntax is a list of binary packages separated by
3258 A space after each comma is conventional.
3259 </footnote>. Currently the packages must be separated using
3260 only spaces in the <file>.changes</file> file.
3264 <sect1 id="f-Installed-Size">
3265 <heading><tt>Installed-Size</tt></heading>
3268 This field appears in the control files of binary
3269 packages, and in the <file>Packages</file> files. It gives
3270 the total amount of disk space required to install the
3275 The disk space is represented in kilobytes as a simple
3280 <sect1 id="f-Files">
3281 <heading><tt>Files</tt></heading>
3284 This field contains a list of files with information about
3285 each one. The exact information and syntax varies with
3286 the context. In all cases the part of the field
3287 contents on the same line as the field name is empty. The
3288 remainder of the field is one line per file, each line
3289 being indented by one space and containing a number of
3290 sub-fields separated by spaces.
3294 In the <file>.dsc</file> file, each line contains the MD5
3295 checksum, size and filename of the tar file and (if applicable)
3296 diff file which make up the remainder of the source
3298 That is, the parts which are not the <tt>.dsc</tt>.
3300 The exact forms of the filenames are described
3301 in <ref id="pkg-sourcearchives">.
3305 In the <file>.changes</file> file this contains one line per
3306 file being uploaded. Each line contains the MD5 checksum,
3307 size, section and priority and the filename.
3308 The <qref id="f-Section">section</qref>
3309 and <qref id="f-Priority">priority</qref>
3310 are the values of the corresponding fields in
3311 the main source control file. If no section or priority is
3312 specified then <tt>-</tt> should be used, though section
3313 and priority values must be specified for new packages to
3314 be installed properly.
3318 The special value <tt>byhand</tt> for the section in a
3319 <tt>.changes</tt> file indicates that the file in question
3320 is not an ordinary package file and must by installed by
3321 hand by the distribution maintainers. If the section is
3322 <tt>byhand</tt> the priority should be <tt>-</tt>.
3326 If a new Debian revision of a package is being shipped and
3327 no new original source archive is being distributed the
3328 <tt>.dsc</tt> must still contain the <tt>Files</tt> field
3329 entry for the original source archive
3330 <file><var>package</var>-<var>upstream-version</var>.orig.tar.gz</file>,
3331 but the <file>.changes</file> file should leave it out. In
3332 this case the original source archive on the distribution
3333 site must match exactly, byte-for-byte, the original
3334 source archive which was used to generate the
3335 <file>.dsc</file> file and diff which are being uploaded.</p>
3338 <sect1 id="f-Closes">
3339 <heading><tt>Closes</tt></heading>
3342 A space-separated list of bug report numbers that the upload
3343 governed by the .changes file closes.
3347 <sect1 id="f-Homepage">
3348 <heading><tt>Homepage</tt></heading>
3351 The URL of the web site for this package, preferably (when
3352 applicable) the site from which the original source can be
3353 obtained and any additional upstream documentation or
3354 information may be found. The content of this field is a
3355 simple URL without any surrounding characters such as
3363 <heading>User-defined fields</heading>
3366 Additional user-defined fields may be added to the
3367 source package control file. Such fields will be
3368 ignored, and not copied to (for example) binary or
3369 source package control files or upload control files.
3373 If you wish to add additional unsupported fields to
3374 these output files you should use the mechanism
3379 Fields in the main source control information file with
3380 names starting <tt>X</tt>, followed by one or more of
3381 the letters <tt>BCS</tt> and a hyphen <tt>-</tt>, will
3382 be copied to the output files. Only the part of the
3383 field name after the hyphen will be used in the output
3384 file. Where the letter <tt>B</tt> is used the field
3385 will appear in binary package control files, where the
3386 letter <tt>S</tt> is used in source package control
3387 files and where <tt>C</tt> is used in upload control
3388 (<tt>.changes</tt>) files.
3392 For example, if the main source information control file
3395 XBS-Comment: I stand between the candle and the star.
3397 then the binary and source package control files will contain the
3400 Comment: I stand between the candle and the star.
3409 <chapt id="maintainerscripts">
3410 <heading>Package maintainer scripts and installation procedure</heading>
3413 <heading>Introduction to package maintainer scripts</heading>
3416 It is possible to supply scripts as part of a package which
3417 the package management system will run for you when your
3418 package is installed, upgraded or removed.
3422 These scripts are the files <prgn>preinst</prgn>,
3423 <prgn>postinst</prgn>, <prgn>prerm</prgn> and
3424 <prgn>postrm</prgn> in the control area of the package.
3425 They must be proper executable files; if they are scripts
3426 (which is recommended), they must start with the usual
3427 <tt>#!</tt> convention. They should be readable and
3428 executable by anyone, and must not be world-writable.
3432 The package management system looks at the exit status from
3433 these scripts. It is important that they exit with a
3434 non-zero status if there is an error, so that the package
3435 management system can stop its processing. For shell
3436 scripts this means that you <em>almost always</em> need to
3437 use <tt>set -e</tt> (this is usually true when writing shell
3438 scripts, in fact). It is also important, of course, that
3439 they exit with a zero status if everything went well.
3443 Additionally, packages interacting with users using
3444 <tt>debconf</tt> in the <prgn>postinst</prgn> script should
3445 install a <prgn>config</prgn> script in the control area,
3446 see <ref id="maintscriptprompt"> for details.
3450 When a package is upgraded a combination of the scripts from
3451 the old and new packages is called during the upgrade
3452 procedure. If your scripts are going to be at all
3453 complicated you need to be aware of this, and may need to
3454 check the arguments to your scripts.
3458 Broadly speaking the <prgn>preinst</prgn> is called before
3459 (a particular version of) a package is installed, and the
3460 <prgn>postinst</prgn> afterwards; the <prgn>prerm</prgn>
3461 before (a version of) a package is removed and the
3462 <prgn>postrm</prgn> afterwards.
3466 Programs called from maintainer scripts should not normally
3467 have a path prepended to them. Before installation is
3468 started, the package management system checks to see if the
3469 programs <prgn>ldconfig</prgn>,
3470 <prgn>start-stop-daemon</prgn>, <prgn>install-info</prgn>,
3471 and <prgn>update-rc.d</prgn> can be found via the
3472 <tt>PATH</tt> environment variable. Those programs, and any
3473 other program that one would expect to be in the
3474 <tt>PATH</tt>, should thus be invoked without an absolute
3475 pathname. Maintainer scripts should also not reset the
3476 <tt>PATH</tt>, though they might choose to modify it by
3477 prepending or appending package-specific directories. These
3478 considerations really apply to all shell scripts.</p>
3481 <sect id="idempotency">
3482 <heading>Maintainer scripts idempotency</heading>
3485 It is necessary for the error recovery procedures that the
3486 scripts be idempotent. This means that if it is run
3487 successfully, and then it is called again, it doesn't bomb
3488 out or cause any harm, but just ensures that everything is
3489 the way it ought to be. If the first call failed, or
3490 aborted half way through for some reason, the second call
3491 should merely do the things that were left undone the first
3492 time, if any, and exit with a success status if everything
3494 This is so that if an error occurs, the user interrupts
3495 <prgn>dpkg</prgn> or some other unforeseen circumstance
3496 happens you don't leave the user with a badly-broken
3497 package when <prgn>dpkg</prgn> attempts to repeat the
3503 <sect id="controllingterminal">
3504 <heading>Controlling terminal for maintainer scripts</heading>
3507 The maintainer scripts are guaranteed to run with a
3508 controlling terminal and can interact with the user.
3509 Because these scripts may be executed with standard output
3510 redirected into a pipe for logging purposes, Perl scripts
3511 should set unbuffered output by setting <tt>$|=1</tt> so
3512 that the output is printed immediately rather than being
3516 <sect id="exitstatus">
3517 <heading>Exit status</heading>
3520 Each script must return a zero exit status for
3521 success, or a nonzero one for failure, since the package
3522 management system looks for the exit status of these scripts
3523 and determines what action to take next based on that datum.
3527 <sect id="mscriptsinstact"><heading>Summary of ways maintainer
3532 <list compact="compact">
3534 <var>new-preinst</var> <tt>install</tt>
3537 <var>new-preinst</var> <tt>install</tt> <var>old-version</var>
3540 <var>new-preinst</var> <tt>upgrade</tt> <var>old-version</var>
3543 <var>old-preinst</var> <tt>abort-upgrade</tt>
3544 <var>new-version</var>
3549 <list compact="compact">
3551 <var>postinst</var> <tt>configure</tt>
3552 <var>most-recently-configured-version</var>
3555 <var>old-postinst</var> <tt>abort-upgrade</tt>
3556 <var>new-version</var>
3559 <var>conflictor's-postinst</var> <tt>abort-remove</tt>
3560 <tt>in-favour</tt> <var>package</var>
3561 <var>new-version</var>
3564 <var>postinst</var> <tt>abort-remove</tt>
3567 <var>deconfigured's-postinst</var>
3568 <tt>abort-deconfigure</tt> <tt>in-favour</tt>
3569 <var>failed-install-package</var> <var>version</var>
3570 [<tt>removing</tt> <var>conflicting-package</var>
3576 <list compact="compact">
3578 <var>prerm</var> <tt>remove</tt>
3581 <var>old-prerm</var> <tt>upgrade</tt>
3582 <var>new-version</var>
3585 <var>new-prerm</var> <tt>failed-upgrade</tt>
3586 <var>old-version</var>
3589 <var>conflictor's-prerm</var> <tt>remove</tt>
3590 <tt>in-favour</tt> <var>package</var>
3591 <var>new-version</var>
3594 <var>deconfigured's-prerm</var> <tt>deconfigure</tt>
3595 <tt>in-favour</tt> <var>package-being-installed</var>
3596 <var>version</var> [<tt>removing</tt>
3597 <var>conflicting-package</var>
3603 <list compact="compact">
3605 <var>postrm</var> <tt>remove</tt>
3608 <var>postrm</var> <tt>purge</tt>
3611 <var>old-postrm</var> <tt>upgrade</tt>
3612 <var>new-version</var>
3615 <var>new-postrm</var> <tt>failed-upgrade</tt>
3616 <var>old-version</var>
3619 <var>new-postrm</var> <tt>abort-install</tt>
3622 <var>new-postrm</var> <tt>abort-install</tt>
3623 <var>old-version</var>
3626 <var>new-postrm</var> <tt>abort-upgrade</tt>
3627 <var>old-version</var>
3630 <var>disappearer's-postrm</var> <tt>disappear</tt>
3631 <var>overwriter</var>
3632 <var>overwriter-version</var>
3638 <sect id="unpackphase">
3639 <heading>Details of unpack phase of installation or upgrade</heading>
3642 The procedure on installation/upgrade/overwrite/disappear
3643 (i.e., when running <tt>dpkg --unpack</tt>, or the unpack
3644 stage of <tt>dpkg --install</tt>) is as follows. In each
3645 case, if a major error occurs (unless listed below) the
3646 actions are, in general, run backwards - this means that the
3647 maintainer scripts are run with different arguments in
3648 reverse order. These are the "error unwind" calls listed
3655 If a version of the package is already installed, call
3656 <example compact="compact">
3657 <var>old-prerm</var> upgrade <var>new-version</var>
3661 If the script runs but exits with a non-zero
3662 exit status, <prgn>dpkg</prgn> will attempt:
3663 <example compact="compact">
3664 <var>new-prerm</var> failed-upgrade <var>old-version</var>
3666 If this works, the upgrade continues. If this
3667 does not work, the error unwind:
3668 <example compact="compact">
3669 <var>old-postinst</var> abort-upgrade <var>new-version</var>
3671 If this works, then the old-version is
3672 "Installed", if not, the old version is in a
3673 "Failed-Config" state.
3679 If a "conflicting" package is being removed at the same time,
3680 or if any package will be broken (due to <tt>Breaks</tt>):
3683 If <tt>--auto-deconfigure</tt> is
3684 specified, call, for each package to be deconfigured
3685 due to <tt>Breaks</tt>:
3686 <example compact="compact">
3687 <var>deconfigured's-prerm</var> deconfigure \
3688 in-favour <var>package-being-installed</var> <var>version</var>
3691 <example compact="compact">
3692 <var>deconfigured's-postinst</var> abort-deconfigure \
3693 in-favour <var>package-being-installed-but-failed</var> <var>version</var>
3695 The deconfigured packages are marked as
3696 requiring configuration, so that if
3697 <tt>--install</tt> is used they will be
3698 configured again if possible.
3701 If any packages depended on a conflicting
3702 package being removed and <tt>--auto-deconfigure</tt> is
3703 specified, call, for each such package:
3704 <example compact="compact">
3705 <var>deconfigured's-prerm</var> deconfigure \
3706 in-favour <var>package-being-installed</var> <var>version</var> \
3707 removing <var>conflicting-package</var> <var>version</var>
3710 <example compact="compact">
3711 <var>deconfigured's-postinst</var> abort-deconfigure \
3712 in-favour <var>package-being-installed-but-failed</var> <var>version</var> \
3713 removing <var>conflicting-package</var> <var>version</var>
3715 The deconfigured packages are marked as
3716 requiring configuration, so that if
3717 <tt>--install</tt> is used they will be
3718 configured again if possible.
3721 To prepare for removal of each conflicting package, call:
3722 <example compact="compact">
3723 <var>conflictor's-prerm</var> remove \
3724 in-favour <var>package</var> <var>new-version</var>
3727 <example compact="compact">
3728 <var>conflictor's-postinst</var> abort-remove \
3729 in-favour <var>package</var> <var>new-version</var>
3738 If the package is being upgraded, call:
3739 <example compact="compact">
3740 <var>new-preinst</var> upgrade <var>old-version</var>
3742 If this fails, we call:
3744 <var>new-postrm</var> abort-upgrade <var>old-version</var>
3751 <var>old-postinst</var> abort-upgrade <var>new-version</var>
3753 is called. If this works, then the old version
3754 is in an "Installed" state, or else it is left
3755 in an "Unpacked" state.
3760 If it fails, then the old version is left
3761 in an "Half-Installed" state.
3768 Otherwise, if the package had some configuration
3769 files from a previous version installed (i.e., it
3770 is in the "configuration files only" state):
3771 <example compact="compact">
3772 <var>new-preinst</var> install <var>old-version</var>
3776 <var>new-postrm</var> abort-install <var>old-version</var>
3778 If this fails, the package is left in a
3779 "Half-Installed" state, which requires a
3780 reinstall. If it works, the packages is left in
3781 a "Config Files" state.
3784 Otherwise (i.e., the package was completely purged):
3785 <example compact="compact">
3786 <var>new-preinst</var> install
3789 <example compact="compact">
3790 <var>new-postrm</var> abort-install
3792 If the error-unwind fails, the package is in a
3793 "Half Installed" phase, and requires a
3794 reinstall. If the error unwind works, the
3795 package is in a not installed state.
3802 The new package's files are unpacked, overwriting any
3803 that may be on the system already, for example any
3804 from the old version of the same package or from
3805 another package. Backups of the old files are kept
3806 temporarily, and if anything goes wrong the package
3807 management system will attempt to put them back as
3808 part of the error unwind.
3812 It is an error for a package to contain files which
3813 are on the system in another package, unless
3814 <tt>Replaces</tt> is used (see <ref id="replaces">).
3816 The following paragraph is not currently the case:
3817 Currently the <tt>- - force-overwrite</tt> flag is
3818 enabled, downgrading it to a warning, but this may not
3824 It is a more serious error for a package to contain a
3825 plain file or other kind of non-directory where another
3826 package has a directory (again, unless
3827 <tt>Replaces</tt> is used). This error can be
3828 overridden if desired using
3829 <tt>--force-overwrite-dir</tt>, but this is not
3834 Packages which overwrite each other's files produce
3835 behavior which, though deterministic, is hard for the
3836 system administrator to understand. It can easily
3837 lead to "missing" programs if, for example, a package
3838 is installed which overwrites a file from another
3839 package, and is then removed again.<footnote>
3840 Part of the problem is due to what is arguably a
3841 bug in <prgn>dpkg</prgn>.
3846 A directory will never be replaced by a symbolic link
3847 to a directory or vice versa; instead, the existing
3848 state (symlink or not) will be left alone and
3849 <prgn>dpkg</prgn> will follow the symlink if there is
3858 If the package is being upgraded, call
3859 <example compact="compact">
3860 <var>old-postrm</var> upgrade <var>new-version</var>
3864 If this fails, <prgn>dpkg</prgn> will attempt:
3865 <example compact="compact">
3866 <var>new-postrm</var> failed-upgrade <var>old-version</var>
3868 If this works, installation continues. If not,
3870 <example compact="compact">
3871 <var>old-preinst</var> abort-upgrade <var>new-version</var>
3873 If this fails, the old version is left in an
3874 "Half Installed" state. If it works, dpkg now
3876 <example compact="compact">
3877 <var>new-postrm</var> abort-upgrade <var>old-version</var>
3879 If this fails, the old version is left in an
3880 "Half Installed" state. If it works, dpkg now
3882 <example compact="compact">
3883 <var>old-postinst</var> abort-upgrade <var>new-version</var>
3885 If this fails, the old version is in an
3892 This is the point of no return - if
3893 <prgn>dpkg</prgn> gets this far, it won't back off
3894 past this point if an error occurs. This will
3895 leave the package in a fairly bad state, which
3896 will require a successful re-installation to clear
3897 up, but it's when <prgn>dpkg</prgn> starts doing
3898 things that are irreversible.
3903 Any files which were in the old version of the package
3904 but not in the new are removed.
3908 The new file list replaces the old.
3912 The new maintainer scripts replace the old.
3916 Any packages all of whose files have been overwritten
3917 during the installation, and which aren't required for
3918 dependencies, are considered to have been removed.
3919 For each such package
3922 <prgn>dpkg</prgn> calls:
3923 <example compact="compact">
3924 <var>disappearer's-postrm</var> disappear \
3925 <var>overwriter</var> <var>overwriter-version</var>
3929 The package's maintainer scripts are removed.
3932 It is noted in the status database as being in a
3933 sane state, namely not installed (any conffiles
3934 it may have are ignored, rather than being
3935 removed by <prgn>dpkg</prgn>). Note that
3936 disappearing packages do not have their prerm
3937 called, because <prgn>dpkg</prgn> doesn't know
3938 in advance that the package is going to
3945 Any files in the package we're unpacking that are also
3946 listed in the file lists of other packages are removed
3947 from those lists. (This will lobotomize the file list
3948 of the "conflicting" package if there is one.)
3952 The backup files made during installation, above, are
3958 The new package's status is now sane, and recorded as
3963 Here is another point of no return - if the
3964 conflicting package's removal fails we do not unwind
3965 the rest of the installation; the conflicting package
3966 is left in a half-removed limbo.
3971 If there was a conflicting package we go and do the
3972 removal actions (described below), starting with the
3973 removal of the conflicting package's files (any that
3974 are also in the package being installed have already
3975 been removed from the conflicting package's file list,
3976 and so do not get removed now).
3982 <sect id="configdetails"><heading>Details of configuration</heading>
3985 When we configure a package (this happens with <tt>dpkg
3986 --install</tt> and <tt>dpkg --configure</tt>), we first
3987 update any <tt>conffile</tt>s and then call:
3988 <example compact="compact">
3989 <var>postinst</var> configure <var>most-recently-configured-version</var>
3994 No attempt is made to unwind after errors during
3995 configuration. If the configuration fails, the package is in
3996 a "Failed Config" state, and an error message is generated.
4000 If there is no most recently configured version
4001 <prgn>dpkg</prgn> will pass a null argument.
4004 Historical note: Truly ancient (pre-1997) versions of
4005 <prgn>dpkg</prgn> passed <tt><unknown></tt>
4006 (including the angle brackets) in this case. Even older
4007 ones did not pass a second argument at all, under any
4008 circumstance. Note that upgrades using such an old dpkg
4009 version are unlikely to work for other reasons, even if
4010 this old argument behavior is handled by your postinst script.
4016 <sect id="removedetails"><heading>Details of removal and/or
4017 configuration purging</heading>
4023 <example compact="compact">
4024 <var>prerm</var> remove
4028 If prerm fails during replacement due to conflict
4030 <var>conflictor's-postinst</var> abort-remove \
4031 in-favour <var>package</var> <var>new-version</var>
4035 <var>postinst</var> abort-remove
4039 If this fails, the package is in a "Failed-Config"
4040 state, or else it remains "Installed".
4044 The package's files are removed (except <tt>conffile</tt>s).
4047 <example compact="compact">
4048 <var>postrm</var> remove
4052 If it fails, there's no error unwind, and the package is in
4053 an "Half-Installed" state.
4058 All the maintainer scripts except the <prgn>postrm</prgn>
4063 If we aren't purging the package we stop here. Note
4064 that packages which have no <prgn>postrm</prgn> and no
4065 <tt>conffile</tt>s are automatically purged when
4066 removed, as there is no difference except for the
4067 <prgn>dpkg</prgn> status.
4071 The <tt>conffile</tt>s and any backup files
4072 (<tt>~</tt>-files, <tt>#*#</tt> files,
4073 <tt>%</tt>-files, <tt>.dpkg-{old,new,tmp}</tt>, etc.)
4078 <example compact="compact">
4079 <var>postrm</var> purge
4083 If this fails, the package remains in a "Config-Files"
4088 The package's file list is removed.
4097 <chapt id="relationships">
4098 <heading>Declaring relationships between packages</heading>
4100 <sect id="depsyntax">
4101 <heading>Syntax of relationship fields</heading>
4104 These fields all have a uniform syntax. They are a list of
4105 package names separated by commas.
4109 In the <tt>Depends</tt>, <tt>Recommends</tt>,
4110 <tt>Suggests</tt>, <tt>Pre-Depends</tt>,
4111 <tt>Build-Depends</tt> and <tt>Build-Depends-Indep</tt>
4112 control file fields of the package, which declare
4113 dependencies on other packages, the package names listed may
4114 also include lists of alternative package names, separated
4115 by vertical bar (pipe) symbols <tt>|</tt>. In such a case,
4116 if any one of the alternative packages is installed, that
4117 part of the dependency is considered to be satisfied.
4121 All of the fields except for <tt>Provides</tt> may restrict
4122 their applicability to particular versions of each named
4123 package. This is done in parentheses after each individual
4124 package name; the parentheses should contain a relation from
4125 the list below followed by a version number, in the format
4126 described in <ref id="f-Version">.
4130 The relations allowed are <tt><<</tt>, <tt><=</tt>,
4131 <tt>=</tt>, <tt>>=</tt> and <tt>>></tt> for
4132 strictly earlier, earlier or equal, exactly equal, later or
4133 equal and strictly later, respectively. The deprecated
4134 forms <tt><</tt> and <tt>></tt> were used to mean
4135 earlier/later or equal, rather than strictly earlier/later,
4136 so they should not appear in new packages (though
4137 <prgn>dpkg</prgn> still supports them).
4141 Whitespace may appear at any point in the version
4142 specification subject to the rules in <ref
4143 id="controlsyntax">, and must appear where it's necessary to
4144 disambiguate; it is not otherwise significant. All of the
4145 relationship fields may span multiple lines. For
4146 consistency and in case of future changes to
4147 <prgn>dpkg</prgn> it is recommended that a single space be
4148 used after a version relationship and before a version
4149 number; it is also conventional to put a single space after
4150 each comma, on either side of each vertical bar, and before
4151 each open parenthesis. When wrapping a relationship field, it
4152 is conventional to do so after a comma and before the space
4153 following that comma.
4157 For example, a list of dependencies might appear as:
4158 <example compact="compact">
4161 Depends: libc6 (>= 2.2.1), exim | mail-transport-agent
4166 All fields that specify build-time relationships
4167 (<tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
4168 <tt>Build-Conflicts</tt> and <tt>Build-Conflicts-Indep</tt>)
4169 may be restricted to a certain set of architectures. This
4170 is indicated in brackets after each individual package name and
4171 the optional version specification. The brackets enclose a
4172 list of Debian architecture names separated by whitespace.
4173 Exclamation marks may be prepended to each of the names.
4174 (It is not permitted for some names to be prepended with
4175 exclamation marks while others aren't.) If the current Debian
4176 host architecture is not in this list and there are no
4177 exclamation marks in the list, or it is in the list with a
4178 prepended exclamation mark, the package name and the
4179 associated version specification are ignored completely for
4180 the purposes of defining the relationships.
4185 <example compact="compact">
4187 Build-Depends-Indep: texinfo
4188 Build-Depends: kernel-headers-2.2.10 [!hurd-i386],
4189 hurd-dev [hurd-i386], gnumach-dev [hurd-i386]
4194 Note that the binary package relationship fields such as
4195 <tt>Depends</tt> appear in one of the binary package
4196 sections of the control file, whereas the build-time
4197 relationships such as <tt>Build-Depends</tt> appear in the
4198 source package section of the control file (which is the
4203 <sect id="binarydeps">
4204 <heading>Binary Dependencies - <tt>Depends</tt>,
4205 <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
4206 <tt>Pre-Depends</tt>
4210 Packages can declare in their control file that they have
4211 certain relationships to other packages - for example, that
4212 they may not be installed at the same time as certain other
4213 packages, and/or that they depend on the presence of others.
4217 This is done using the <tt>Depends</tt>, <tt>Pre-Depends</tt>,
4218 <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
4219 <tt>Breaks</tt> and <tt>Conflicts</tt> control file fields.
4223 These seven fields are used to declare a dependency
4224 relationship by one package on another. Except for
4225 <tt>Enhances</tt> and <tt>Breaks</tt>, they appear in the
4226 depending (binary) package's control file.
4227 (<tt>Enhances</tt> appears in the recommending package's
4228 control file, and <tt>Breaks</tt> appears in the version of
4229 depended-on package which causes the named package to
4234 A <tt>Depends</tt> field takes effect <em>only</em> when a
4235 package is to be configured. It does not prevent a package
4236 being on the system in an unconfigured state while its
4237 dependencies are unsatisfied, and it is possible to replace
4238 a package whose dependencies are satisfied and which is
4239 properly installed with a different version whose
4240 dependencies are not and cannot be satisfied; when this is
4241 done the depending package will be left unconfigured (since
4242 attempts to configure it will give errors) and will not
4243 function properly. If it is necessary, a
4244 <tt>Pre-Depends</tt> field can be used, which has a partial
4245 effect even when a package is being unpacked, as explained
4246 in detail below. (The other three dependency fields,
4247 <tt>Recommends</tt>, <tt>Suggests</tt> and
4248 <tt>Enhances</tt>, are only used by the various front-ends
4249 to <prgn>dpkg</prgn> such as <prgn>apt-get</prgn>,
4250 <prgn>aptitude</prgn>, and <prgn>dselect</prgn>.)
4254 For this reason packages in an installation run are usually
4255 all unpacked first and all configured later; this gives
4256 later versions of packages with dependencies on later
4257 versions of other packages the opportunity to have their
4258 dependencies satisfied.
4262 In case of circular dependencies, since installation or
4263 removal order honoring the dependency order can't be
4264 established, dependency loops are broken at some point
4265 (based on rules below), and some packages may not be able to
4266 rely on their dependencies being present when being
4267 installed or removed, depending on which side of the break
4268 of the circular dependency loop they happen to be on. If one
4269 of the packages in the loop has no postinst script, then the
4270 cycle will be broken at that package, so as to ensure that
4271 all postinst scripts run with the dependencies properly
4272 configured if this is possible. Otherwise the breaking point
4277 The <tt>Depends</tt> field thus allows package maintainers
4278 to impose an order in which packages should be configured.
4282 The meaning of the five dependency fields is as follows:
4284 <tag><tt>Depends</tt></tag>
4287 This declares an absolute dependency. A package will
4288 not be configured unless all of the packages listed in
4289 its <tt>Depends</tt> field have been correctly
4294 The <tt>Depends</tt> field should be used if the
4295 depended-on package is required for the depending
4296 package to provide a significant amount of
4301 The <tt>Depends</tt> field should also be used if the
4302 <prgn>postinst</prgn>, <prgn>prerm</prgn> or
4303 <prgn>postrm</prgn> scripts require the package to be
4304 present in order to run. Note, however, that the
4305 <prgn>postrm</prgn> cannot rely on any non-essential
4306 packages to be present during the <tt>purge</tt>
4310 <tag><tt>Recommends</tt></tag>
4313 This declares a strong, but not absolute, dependency.
4317 The <tt>Recommends</tt> field should list packages
4318 that would be found together with this one in all but
4319 unusual installations.
4323 <tag><tt>Suggests</tt></tag>
4325 This is used to declare that one package may be more
4326 useful with one or more others. Using this field
4327 tells the packaging system and the user that the
4328 listed packages are related to this one and can
4329 perhaps enhance its usefulness, but that installing
4330 this one without them is perfectly reasonable.
4333 <tag><tt>Enhances</tt></tag>
4335 This field is similar to Suggests but works in the
4336 opposite direction. It is used to declare that a
4337 package can enhance the functionality of another
4341 <tag><tt>Pre-Depends</tt></tag>
4344 This field is like <tt>Depends</tt>, except that it
4345 also forces <prgn>dpkg</prgn> to complete installation
4346 of the packages named before even starting the
4347 installation of the package which declares the
4348 pre-dependency, as follows:
4352 When a package declaring a pre-dependency is about to
4353 be <em>unpacked</em> the pre-dependency can be
4354 satisfied if the depended-on package is either fully
4355 configured, <em>or even if</em> the depended-on
4356 package(s) are only unpacked or half-configured,
4357 provided that they have been configured correctly at
4358 some point in the past (and not removed or partially
4359 removed since). In this case, both the
4360 previously-configured and currently unpacked or
4361 half-configured versions must satisfy any version
4362 clause in the <tt>Pre-Depends</tt> field.
4366 When the package declaring a pre-dependency is about
4367 to be <em>configured</em>, the pre-dependency will be
4368 treated as a normal <tt>Depends</tt>, that is, it will
4369 be considered satisfied only if the depended-on
4370 package has been correctly configured.
4374 <tt>Pre-Depends</tt> should be used sparingly,
4375 preferably only by packages whose premature upgrade or
4376 installation would hamper the ability of the system to
4377 continue with any upgrade that might be in progress.
4381 <tt>Pre-Depends</tt> are also required if the
4382 <prgn>preinst</prgn> script depends on the named
4383 package. It is best to avoid this situation if
4391 When selecting which level of dependency to use you should
4392 consider how important the depended-on package is to the
4393 functionality of the one declaring the dependency. Some
4394 packages are composed of components of varying degrees of
4395 importance. Such a package should list using
4396 <tt>Depends</tt> the package(s) which are required by the
4397 more important components. The other components'
4398 requirements may be mentioned as Suggestions or
4399 Recommendations, as appropriate to the components' relative
4405 <heading>Packages which break other packages - <tt>Breaks</tt></heading>
4408 Using <tt>Breaks</tt> may cause problems for upgrades from older
4409 versions of Debian and should not be used until the stable
4410 release of Debian supports <tt>Breaks</tt>.
4414 When one binary package declares that it breaks another,
4415 <prgn>dpkg</prgn> will refuse to allow the package which
4416 declares <tt>Breaks</tt> be installed unless the broken
4417 package is deconfigured first, and it will refuse to
4418 allow the broken package to be reconfigured.
4422 A package will not be regarded as causing breakage merely
4423 because its configuration files are still installed; it must
4424 be at least half-installed.
4428 A special exception is made for packages which declare that
4429 they break their own package name or a virtual package which
4430 they provide (see below): this does not count as a real
4435 Normally a <tt>Breaks</tt> entry will have an "earlier than"
4436 version clause; such a <tt>Breaks</tt> is introduced in the
4437 version of an (implicit or explicit) dependency which
4438 violates an assumption or reveals a bug in earlier versions
4439 of the broken package. This use of <tt>Breaks</tt> will
4440 inform higher-level package management tools that broken
4441 package must be upgraded before the new one.
4445 If the breaking package also overwrites some files from the
4446 older package, it should use <tt>Replaces</tt> (not
4447 <tt>Conflicts</tt>) to ensure this goes smoothly.
4451 <sect id="conflicts">
4452 <heading>Conflicting binary packages - <tt>Conflicts</tt></heading>
4455 When one binary package declares a conflict with another
4456 using a <tt>Conflicts</tt> field, <prgn>dpkg</prgn> will
4457 refuse to allow them to be installed on the system at the
4462 If one package is to be installed, the other must be removed
4463 first - if the package being installed is marked as
4464 replacing (see <ref id="replaces">) the one on the system,
4465 or the one on the system is marked as deselected, or both
4466 packages are marked <tt>Essential</tt>, then
4467 <prgn>dpkg</prgn> will automatically remove the package
4468 which is causing the conflict, otherwise it will halt the
4469 installation of the new package with an error. This
4470 mechanism is specifically designed to produce an error when
4471 the installed package is <tt>Essential</tt>, but the new
4476 A package will not cause a conflict merely because its
4477 configuration files are still installed; it must be at least
4482 A special exception is made for packages which declare a
4483 conflict with their own package name, or with a virtual
4484 package which they provide (see below): this does not
4485 prevent their installation, and allows a package to conflict
4486 with others providing a replacement for it. You use this
4487 feature when you want the package in question to be the only
4488 package providing some feature.
4492 A <tt>Conflicts</tt> entry should almost never have an
4493 "earlier than" version clause. This would prevent
4494 <prgn>dpkg</prgn> from upgrading or installing the package
4495 which declared such a conflict until the upgrade or removal
4496 of the conflicted-with package had been completed. Instead,
4497 <tt>Breaks</tt> may be used (once <tt>Breaks</tt> is supported
4498 by the stable release of Debian).
4502 <sect id="virtual"><heading>Virtual packages - <tt>Provides</tt>
4506 As well as the names of actual ("concrete") packages, the
4507 package relationship fields <tt>Depends</tt>,
4508 <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
4509 <tt>Pre-Depends</tt>, <tt>Breaks</tt>, <tt>Conflicts</tt>,
4510 <tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
4511 <tt>Build-Conflicts</tt> and <tt>Build-Conflicts-Indep</tt>
4512 may mention "virtual packages".
4516 A <em>virtual package</em> is one which appears in the
4517 <tt>Provides</tt> control file field of another package.
4518 The effect is as if the package(s) which provide a
4519 particular virtual package name had been listed by name
4520 everywhere the virtual package name appears. (See also <ref
4525 If there are both concrete and virtual packages of the same
4526 name, then the dependency may be satisfied (or the conflict
4527 caused) by either the concrete package with the name in
4528 question or any other concrete package which provides the
4529 virtual package with the name in question. This is so that,
4530 for example, supposing we have
4531 <example compact="compact">
4534 </example> and someone else releases an enhanced version of
4535 the <tt>bar</tt> package they can say:
4536 <example compact="compact">
4540 and the <tt>bar-plus</tt> package will now also satisfy the
4541 dependency for the <tt>foo</tt> package.
4545 If a relationship field has a version number attached
4546 then only real packages will be considered to see whether
4547 the relationship is satisfied (or the prohibition violated,
4548 for a conflict or breakage) - it is assumed that a real
4549 package which provides the virtual package is not of the
4550 "right" version. So, a <tt>Provides</tt> field may not
4551 contain version numbers, and the version number of the
4552 concrete package which provides a particular virtual package
4553 will not be looked at when considering a dependency on or
4554 conflict with the virtual package name.
4558 It is likely that the ability will be added in a future
4559 release of <prgn>dpkg</prgn> to specify a version number for
4560 each virtual package it provides. This feature is not yet
4561 present, however, and is expected to be used only
4566 If you want to specify which of a set of real packages
4567 should be the default to satisfy a particular dependency on
4568 a virtual package, you should list the real package as an
4569 alternative before the virtual one.
4574 <sect id="replaces"><heading>Overwriting files and replacing
4575 packages - <tt>Replaces</tt></heading>
4578 Packages can declare in their control file that they should
4579 overwrite files in certain other packages, or completely
4580 replace other packages. The <tt>Replaces</tt> control file
4581 field has these two distinct purposes.
4584 <sect1><heading>Overwriting files in other packages</heading>
4587 Firstly, as mentioned before, it is usually an error for a
4588 package to contain files which are on the system in
4593 However, if the overwriting package declares that it
4594 <tt>Replaces</tt> the one containing the file being
4595 overwritten, then <prgn>dpkg</prgn> will replace the file
4596 from the old package with that from the new. The file
4597 will no longer be listed as "owned" by the old package.
4601 If a package is completely replaced in this way, so that
4602 <prgn>dpkg</prgn> does not know of any files it still
4603 contains, it is considered to have "disappeared". It will
4604 be marked as not wanted on the system (selected for
4605 removal) and not installed. Any <tt>conffile</tt>s
4606 details noted for the package will be ignored, as they
4607 will have been taken over by the overwriting package. The
4608 package's <prgn>postrm</prgn> script will be run with a
4609 special argument to allow the package to do any final
4610 cleanup required. See <ref id="mscriptsinstact">.
4613 Replaces is a one way relationship -- you have to
4614 install the replacing package after the replaced
4621 For this usage of <tt>Replaces</tt>, virtual packages (see
4622 <ref id="virtual">) are not considered when looking at a
4623 <tt>Replaces</tt> field - the packages declared as being
4624 replaced must be mentioned by their real names.
4628 Furthermore, this usage of <tt>Replaces</tt> only takes
4629 effect when both packages are at least partially on the
4630 system at once, so that it can only happen if they do not
4631 conflict or if the conflict has been overridden.
4636 <sect1><heading>Replacing whole packages, forcing their
4640 Secondly, <tt>Replaces</tt> allows the packaging system to
4641 resolve which package should be removed when there is a
4642 conflict - see <ref id="conflicts">. This usage only
4643 takes effect when the two packages <em>do</em> conflict,
4644 so that the two usages of this field do not interfere with
4649 In this situation, the package declared as being replaced
4650 can be a virtual package, so for example, all mail
4651 transport agents (MTAs) would have the following fields in
4652 their control files:
4653 <example compact="compact">
4654 Provides: mail-transport-agent
4655 Conflicts: mail-transport-agent
4656 Replaces: mail-transport-agent
4658 ensuring that only one MTA can be installed at any one
4663 <sect id="sourcebinarydeps">
4664 <heading>Relationships between source and binary packages -
4665 <tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
4666 <tt>Build-Conflicts</tt>, <tt>Build-Conflicts-Indep</tt>
4670 Source packages that require certain binary packages to be
4671 installed or absent at the time of building the package
4672 can declare relationships to those binary packages.
4676 This is done using the <tt>Build-Depends</tt>,
4677 <tt>Build-Depends-Indep</tt>, <tt>Build-Conflicts</tt> and
4678 <tt>Build-Conflicts-Indep</tt> control file fields.
4682 Build-dependencies on "build-essential" binary packages can be
4683 omitted. Please see <ref id="pkg-relations"> for more information.
4687 The dependencies and conflicts they define must be satisfied
4688 (as defined earlier for binary packages) in order to invoke
4689 the targets in <tt>debian/rules</tt>, as follows:<footnote>
4691 If you make "build-arch" or "binary-arch", you need
4692 Build-Depends. If you make "build-indep" or
4693 "binary-indep", you need Build-Depends and
4694 Build-Depends-Indep. If you make "build" or "binary",
4698 There is no Build-Depends-Arch; this role is essentially
4699 met with Build-Depends. Anyone building the
4700 <tt>build-indep</tt> and binary-indep<tt></tt> targets
4701 is basically assumed to be building the whole package
4702 anyway and so installs all build dependencies. The
4703 autobuilders use <tt>dpkg-buildpackage -B</tt>, which
4704 calls <tt>build</tt> (not <tt>build-arch</tt>, since it
4705 does not yet know how to check for its existence) and
4706 <tt>binary-arch</tt>.
4709 The purpose of the original split, I recall, was so that
4710 the autobuilders wouldn't need to install extra packages
4711 needed only for the binary-indep targets. But without a
4712 build-arch/build-indep split, this didn't work, since
4713 most of the work is done in the build target, not in the
4719 <tag><tt>Build-Depends</tt>, <tt>Build-Conflicts</tt></tag>
4721 The <tt>Build-Depends</tt> and
4722 <tt>Build-Conflicts</tt> fields must be satisfied when
4723 any of the following targets is invoked:
4724 <tt>build</tt>, <tt>clean</tt>, <tt>binary</tt>,
4725 <tt>binary-arch</tt>, <tt>build-arch</tt>,
4726 <tt>build-indep</tt> and <tt>binary-indep</tt>.
4728 <tag><tt>Build-Depends-Indep</tt>,
4729 <tt>Build-Conflicts-Indep</tt></tag>
4731 The <tt>Build-Depends-Indep</tt> and
4732 <tt>Build-Conflicts-Indep</tt> fields must be
4733 satisfied when any of the following targets is
4734 invoked: <tt>build</tt>, <tt>build-indep</tt>,
4735 <tt>binary</tt> and <tt>binary-indep</tt>.
4745 <chapt id="sharedlibs"><heading>Shared libraries</heading>
4748 Packages containing shared libraries must be constructed with
4749 a little care to make sure that the shared library is always
4750 available. This is especially important for packages whose
4751 shared libraries are vitally important, such as the C library
4752 (currently <tt>libc6</tt>).
4756 Packages involving shared libraries should be split up into
4757 several binary packages. This section mostly deals with how
4758 this separation is to be accomplished; rules for files within
4759 the shared library packages are in <ref id="libraries"> instead.
4762 <sect id="sharedlibs-runtime">
4763 <heading>Run-time shared libraries</heading>
4766 The run-time shared library needs to be placed in a package
4767 whose name changes whenever the shared object version
4770 Since it is common place to install several versions of a
4771 package that just provides shared libraries, it is a
4772 good idea that the library package should not
4773 contain any extraneous non-versioned files, unless they
4774 happen to be in versioned directories.</p>
4776 The most common mechanism is to place it in a package
4778 <package><var>libraryname</var><var>soversion</var></package>,
4779 where <file><var>soversion</var></file> is the version number
4780 in the soname of the shared library<footnote>
4781 The soname is the shared object name: it's the thing
4782 that has to match exactly between building an executable
4783 and running it for the dynamic linker to be able run the
4784 program. For example, if the soname of the library is
4785 <file>libfoo.so.6</file>, the library package would be
4786 called <file>libfoo6</file>.
4788 Alternatively, if it would be confusing to directly append
4789 <var>soversion</var> to <var>libraryname</var> (e.g. because
4790 <var>libraryname</var> itself ends in a number), you may use
4791 <package><var>libraryname</var>-<var>soversion</var></package> and
4792 <package><var>libraryname</var>-<var>soversion</var>-dev</package>
4797 If you have several shared libraries built from the same
4798 source tree you may lump them all together into a single
4799 shared library package, provided that you change all of
4800 their sonames at once (so that you don't get filename
4801 clashes if you try to install different versions of the
4802 combined shared libraries package).
4806 The package should install the shared libraries under
4807 their normal names. For example, the <package>libgdbm3</package>
4808 package should install <file>libgdbm.so.3.0.0</file> as
4809 <file>/usr/lib/libgdbm.so.3.0.0</file>. The files should not be
4810 renamed or re-linked by any <prgn>prerm</prgn> or
4811 <prgn>postrm</prgn> scripts; <prgn>dpkg</prgn> will take care
4812 of renaming things safely without affecting running programs,
4813 and attempts to interfere with this are likely to lead to
4818 Shared libraries should not be installed executable, since
4819 the dynamic linker does not require this and trying to
4820 execute a shared library usually results in a core dump.
4824 The run-time library package should include the symbolic link that
4825 <prgn>ldconfig</prgn> would create for the shared libraries.
4826 For example, the <package>libgdbm3</package> package should include
4827 a symbolic link from <file>/usr/lib/libgdbm.so.3</file> to
4828 <file>libgdbm.so.3.0.0</file>. This is needed so that the dynamic
4829 linker (for example <prgn>ld.so</prgn> or
4830 <prgn>ld-linux.so.*</prgn>) can find the library between the
4831 time that <prgn>dpkg</prgn> installs it and the time that
4832 <prgn>ldconfig</prgn> is run in the <prgn>postinst</prgn>
4834 The package management system requires the library to be
4835 placed before the symbolic link pointing to it in the
4836 <file>.deb</file> file. This is so that when
4837 <prgn>dpkg</prgn> comes to install the symlink
4838 (overwriting the previous symlink pointing at an older
4839 version of the library), the new shared library is already
4840 in place. In the past, this was achieved by creating the
4841 library in the temporary packaging directory before
4842 creating the symlink. Unfortunately, this was not always
4843 effective, since the building of the tar file in the
4844 <file>.deb</file> depended on the behavior of the underlying
4845 file system. Some file systems (such as reiserfs) reorder
4846 the files so that the order of creation is forgotten.
4847 Since version 1.7.0, <prgn>dpkg</prgn>
4848 reorders the files itself as necessary when building a
4849 package. Thus it is no longer important to concern
4850 oneself with the order of file creation.
4854 <sect1 id="ldconfig">
4855 <heading><tt>ldconfig</tt></heading>
4858 Any package installing shared libraries in one of the default
4859 library directories of the dynamic linker (which are currently
4860 <file>/usr/lib</file> and <file>/lib</file>) or a directory that is
4861 listed in <file>/etc/ld.so.conf</file><footnote>
4863 <list compact="compact">
4864 <item>/usr/local/lib</item>
4865 <item>/usr/lib/libc5-compat</item>
4866 <item>/lib/libc5-compat</item>
4869 must use <prgn>ldconfig</prgn> to update the shared library
4874 The package maintainer scripts must only call
4875 <prgn>ldconfig</prgn> under these circumstances:
4876 <list compact="compact">
4877 <item>When the <prgn>postinst</prgn> script is run with a
4878 first argument of <tt>configure</tt>, the script must call
4879 <prgn>ldconfig</prgn>, and may optionally invoke
4880 <prgn>ldconfig</prgn> at other times.
4882 <item>When the <prgn>postrm</prgn> script is run with a
4883 first argument of <tt>remove</tt>, the script should call
4884 <prgn>ldconfig</prgn>.
4889 During install or upgrade, the preinst is called before
4890 the new files are installed, so calling "ldconfig" is
4891 pointless. The preinst of an existing package can also be
4892 called if an upgrade fails. However, this happens during
4893 the critical time when a shared libs may exist on-disk
4894 under a temporary name. Thus, it is dangerous and
4895 forbidden by current policy to call "ldconfig" at this
4900 When a package is installed or upgraded, "postinst
4901 configure" runs after the new files are safely on-disk.
4902 Since it is perfectly safe to invoke ldconfig
4903 unconditionally in a postinst, it is OK for a package to
4904 simply put ldconfig in its postinst without checking the
4905 argument. The postinst can also be called to recover from
4906 a failed upgrade. This happens before any new files are
4907 unpacked, so there is no reason to call "ldconfig" at this
4912 For a package that is being removed, prerm is
4913 called with all the files intact, so calling ldconfig is
4914 useless. The other calls to "prerm" happen in the case of
4915 upgrade at a time when all the files of the old package
4916 are on-disk, so again calling "ldconfig" is pointless.
4920 postrm, on the other hand, is called with the "remove"
4921 argument just after the files are removed, so this is
4922 the proper time to call "ldconfig" to notify the system
4923 of the fact that the shared libraries from the package
4924 are removed. The postrm can be called at several other
4925 times. At the time of "postrm purge", "postrm
4926 abort-install", or "postrm abort-upgrade", calling
4927 "ldconfig" is useless because the shared lib files are
4928 not on-disk. However, when "postrm" is invoked with
4929 arguments "upgrade", "failed-upgrade", or "disappear", a
4930 shared lib may exist on-disk under a temporary filename.
4938 <sect id="sharedlibs-support-files">
4939 <heading>Shared library support files</heading>
4942 If your package contains files whose names do not change with
4943 each change in the library shared object version, you must not
4944 put them in the shared library package. Otherwise, several
4945 versions of the shared library cannot be installed at the same
4946 time without filename clashes, making upgrades and transitions
4947 unnecessarily difficult.
4951 It is recommended that supporting files and run-time support
4952 programs that do not need to be invoked manually by users, but
4953 are nevertheless required for the package to function, be placed
4954 (if they are binary) in a subdirectory of <file>/usr/lib</file>,
4955 preferably under <file>/usr/lib/</file><var>package-name</var>.
4956 If the program or file is architecture independent, the
4957 recommendation is for it to be placed in a subdirectory of
4958 <file>/usr/share</file> instead, preferably under
4959 <file>/usr/share/</file><var>package-name</var>. Following the
4960 <var>package-name</var> naming convention ensures that the file
4961 names change when the shared object version changes.
4965 Run-time support programs that use the shared library but are
4966 not required for the library to function or files used by the
4967 shared library that can be used by any version of the shared
4968 library package should instead be put in a separate package.
4969 This package might typically be named
4970 <package><var>libraryname</var>-tools</package>; note the
4971 absence of the <var>soversion</var> in the package name.
4975 Files and support programs only useful when compiling software
4976 against the library should be included in the development
4977 package for the library.<footnote>
4978 For example, a <file><var>package-name</var>-config</file>
4979 script or <package>pkg-config</package> configuration files.
4984 <sect id="sharedlibs-static">
4985 <heading>Static libraries</heading>
4988 The static library (<file><var>libraryname.a</var></file>)
4989 is usually provided in addition to the shared version.
4990 It is placed into the development package (see below).
4994 In some cases, it is acceptable for a library to be
4995 available in static form only; these cases include:
4997 <item>libraries for languages whose shared library support
4998 is immature or unstable</item>
4999 <item>libraries whose interfaces are in flux or under
5000 development (commonly the case when the library's
5001 major version number is zero, or where the ABI breaks
5002 across patchlevels)</item>
5003 <item>libraries which are explicitly intended to be
5004 available only in static form by their upstream
5009 <sect id="sharedlibs-dev">
5010 <heading>Development files</heading>
5013 The development files associated to a shared library need to be
5014 placed in a package called
5015 <package><var>libraryname</var><var>soversion</var>-dev</package>,
5016 or if you prefer only to support one development version at a
5017 time, <package><var>libraryname</var>-dev</package>.
5021 In case several development versions of a library exist, you may
5022 need to use <prgn>dpkg</prgn>'s Conflicts mechanism (see
5023 <ref id="conflicts">) to ensure that the user only installs one
5024 development version at a time (as different development versions are
5025 likely to have the same header files in them, which would cause a
5026 filename clash if both were installed).
5030 The development package should contain a symlink for the associated
5031 shared library without a version number. For example, the
5032 <package>libgdbm-dev</package> package should include a symlink
5033 from <file>/usr/lib/libgdbm.so</file> to
5034 <file>libgdbm.so.3.0.0</file>. This symlink is needed by the linker
5035 (<prgn>ld</prgn>) when compiling packages, as it will only look for
5036 <file>libgdbm.so</file> when compiling dynamically.
5040 <sect id="sharedlibs-intradeps">
5041 <heading>Dependencies between the packages of the same library</heading>
5044 Typically the development version should have an exact
5045 version dependency on the runtime library, to make sure that
5046 compilation and linking happens correctly. The
5047 <tt>${binary:Version}</tt> substitution variable can be
5048 useful for this purpose.
5050 Previously, <tt>${Source-Version}</tt> was used, but its name
5051 was confusing and it has been deprecated since dpkg 1.13.19.
5056 <sect id="sharedlibs-shlibdeps">
5057 <heading>Dependencies between the library and other packages -
5058 the <tt>shlibs</tt> system</heading>
5061 If a package contains a binary or library which links to a
5062 shared library, we must ensure that when the package is
5063 installed on the system, all of the libraries needed are
5064 also installed. This requirement led to the creation of the
5065 <tt>shlibs</tt> system, which is very simple in its design:
5066 any package which <em>provides</em> a shared library also
5067 provides information on the package dependencies required to
5068 ensure the presence of this library, and any package which
5069 <em>uses</em> a shared library uses this information to
5070 determine the dependencies it requires. The files which
5071 contain the mapping from shared libraries to the necessary
5072 dependency information are called <file>shlibs</file> files.
5076 Thus, when a package is built which contains any shared
5077 libraries, it must provide a <file>shlibs</file> file for other
5078 packages to use, and when a package is built which contains
5079 any shared libraries or compiled binaries, it must run
5080 <qref id="pkg-dpkg-shlibdeps"><prgn>dpkg-shlibdeps</prgn></qref>
5081 on these to determine the libraries used and hence the
5082 dependencies needed by this package.<footnote>
5084 In the past, the shared libraries linked to were
5085 determined by calling <prgn>ldd</prgn>, but now
5086 <prgn>objdump</prgn> is used to do this. The only
5087 change this makes to package building is that
5088 <prgn>dpkg-shlibdeps</prgn> must also be run on shared
5089 libraries, whereas in the past this was unnecessary.
5090 The rest of this footnote explains the advantage that
5095 We say that a binary <tt>foo</tt> <em>directly</em> uses
5096 a library <tt>libbar</tt> if it is explicitly linked
5097 with that library (that is, it uses the flag
5098 <tt>-lbar</tt> during the linking stage). Other
5099 libraries that are needed by <tt>libbar</tt> are linked
5100 <em>indirectly</em> to <tt>foo</tt>, and the dynamic
5101 linker will load them automatically when it loads
5102 <tt>libbar</tt>. A package should depend on
5103 the libraries it directly uses, and the dependencies for
5104 those libraries should automatically pull in the other
5109 Unfortunately, the <prgn>ldd</prgn> program shows both
5110 the directly and indirectly used libraries, meaning that
5111 the dependencies determined included both direct and
5112 indirect dependencies. The use of <prgn>objdump</prgn>
5113 avoids this problem by determining only the directly
5118 A good example of where this helps is the following. We
5119 could update <tt>libimlib</tt> with a new version that
5120 supports a new graphics format called dgf (but retaining
5121 the same major version number). If we used the old
5122 <prgn>ldd</prgn> method, every package that uses
5123 <tt>libimlib</tt> would need to be recompiled so it
5124 would also depend on <tt>libdgf</tt> or it wouldn't run
5125 due to missing symbols. However with the new system,
5126 packages using <tt>libimlib</tt> can rely on
5127 <tt>libimlib</tt> itself having the dependency on
5128 <tt>libdgf</tt> and so they would not need rebuilding.
5134 In the following sections, we will first describe where the
5135 various <tt>shlibs</tt> files are to be found, then how to
5136 use <prgn>dpkg-shlibdeps</prgn>, and finally the <tt>shlibs</tt>
5137 file format and how to create them if your package contains a
5142 <heading>The <tt>shlibs</tt> files present on the system</heading>
5145 There are several places where <tt>shlibs</tt> files are
5146 found. The following list gives them in the order in which
5148 <qref id="pkg-dpkg-shlibdeps"><prgn>dpkg-shlibdeps</prgn></qref>.
5149 (The first one which gives the required information is used.)
5155 <p><file>debian/shlibs.local</file></p>
5158 This lists overrides for this package. Its use is
5159 described below (see <ref id="shlibslocal">).
5164 <p><file>/etc/dpkg/shlibs.override</file></p>
5167 This lists global overrides. This list is normally
5168 empty. It is maintained by the local system
5174 <p><file>DEBIAN/shlibs</file> files in the "build directory"</p>
5177 When packages are being built, any
5178 <file>debian/shlibs</file> files are copied into the
5179 control file area of the temporary build directory and
5180 given the name <file>shlibs</file>. These files give
5181 details of any shared libraries included in the
5183 An example may help here. Let us say that the
5184 source package <tt>foo</tt> generates two binary
5185 packages, <tt>libfoo2</tt> and
5186 <tt>foo-runtime</tt>. When building the binary
5187 packages, the two packages are created in the
5188 directories <file>debian/libfoo2</file> and
5189 <file>debian/foo-runtime</file> respectively.
5190 (<file>debian/tmp</file> could be used instead of one
5191 of these.) Since <tt>libfoo2</tt> provides the
5192 <tt>libfoo</tt> shared library, it will require a
5193 <tt>shlibs</tt> file, which will be installed in
5194 <file>debian/libfoo2/DEBIAN/shlibs</file>, eventually
5196 <file>/var/lib/dpkg/info/libfoo2.shlibs</file>. Then
5197 when <prgn>dpkg-shlibdeps</prgn> is run on the
5199 <file>debian/foo-runtime/usr/bin/foo-prog</file>, it
5201 <file>debian/libfoo2/DEBIAN/shlibs</file> file to
5202 determine whether <tt>foo-prog</tt>'s library
5203 dependencies are satisfied by any of the libraries
5204 provided by <tt>libfoo2</tt>. For this reason,
5205 <prgn>dpkg-shlibdeps</prgn> must only be run once
5206 all of the individual binary packages'
5207 <tt>shlibs</tt> files have been installed into the
5214 <p><file>/var/lib/dpkg/info/*.shlibs</file></p>
5217 These are the <file>shlibs</file> files corresponding to
5218 all of the packages installed on the system, and are
5219 maintained by the relevant package maintainers.
5224 <p><file>/etc/dpkg/shlibs.default</file></p>
5227 This file lists any shared libraries whose packages
5228 have failed to provide correct <file>shlibs</file> files.
5229 It was used when the <file>shlibs</file> setup was first
5230 introduced, but it is now normally empty. It is
5231 maintained by the <tt>dpkg</tt> maintainer.
5239 <heading>How to use <prgn>dpkg-shlibdeps</prgn> and the
5240 <file>shlibs</file> files</heading>
5244 <qref id="pkg-dpkg-shlibdeps"><prgn>dpkg-shlibdeps</prgn></qref>
5245 into your <file>debian/rules</file> file. If your package
5246 contains only compiled binaries and libraries (but no scripts),
5247 you can use a command such as:
5248 <example compact="compact">
5249 dpkg-shlibdeps debian/tmp/usr/bin/* debian/tmp/usr/sbin/* \
5250 debian/tmp/usr/lib/*
5252 Otherwise, you will need to explicitly list the compiled
5253 binaries and libraries.<footnote>
5254 If you are using <tt>debhelper</tt>, the
5255 <prgn>dh_shlibdeps</prgn> program will do this work for
5256 you. It will also correctly handle multi-binary
5262 This command puts the dependency information into the
5263 <file>debian/substvars</file> file, which is then used by
5264 <prgn>dpkg-gencontrol</prgn>. You will need to place a
5265 <tt>${shlibs:Depends}</tt> variable in the <tt>Depends</tt>
5266 field in the control file for this to work.
5270 If <prgn>dpkg-shlibdeps</prgn> doesn't complain, you're
5271 done. If it does complain you might need to create your own
5272 <file>debian/shlibs.local</file> file, as explained below (see
5273 <ref id="shlibslocal">).
5277 If you have multiple binary packages, you will need to call
5278 <prgn>dpkg-shlibdeps</prgn> on each one which contains
5279 compiled libraries or binaries. In such a case, you will
5280 need to use the <tt>-T</tt> option to the <tt>dpkg</tt>
5281 utilities to specify a different <file>substvars</file> file.
5285 If you are creating a udeb for use in the Debian Installer, you
5286 will need to specify that <prgn>dpkg-shlibdeps</prgn> should use
5287 the dependency line of type <tt>udeb</tt> by adding
5288 <tt>-tudeb</tt> as option<footnote>
5289 <prgn>dh_shlibdeps</prgn> from the <tt>debhelper</tt> suite
5290 will automatically add this option if it knows it is
5292 </footnote>. If there is no dependency line of type <tt>udeb</tt>
5293 in the <file>shlibs</file> file, <prgn>dpkg-shlibdeps</prgn> will
5294 fall back to the regular dependency line.
5298 For more details on dpkg-shlibdeps, please see
5299 <ref id="pkg-dpkg-shlibdeps"> and
5300 <manref name="dpkg-shlibdeps" section="1">.
5305 <heading>The <file>shlibs</file> File Format</heading>
5308 Each <file>shlibs</file> file has the same format. Lines
5309 beginning with <tt>#</tt> are considered to be comments and
5310 are ignored. Each line is of the form:
5311 <example compact="compact">
5312 [<var>type</var>: ]<var>library-name</var> <var>soname-version</var> <var>dependencies ...</var>
5317 We will explain this by reference to the example of the
5318 <tt>zlib1g</tt> package, which (at the time of writing)
5319 installs the shared library <file>/usr/lib/libz.so.1.1.3</file>.
5323 <var>type</var> is an optional element that indicates the type
5324 of package for which the line is valid. The only type currently
5325 in use is <tt>udeb</tt>. The colon and space after the type are
5330 <var>library-name</var> is the name of the shared library,
5331 in this case <tt>libz</tt>. (This must match the name part
5332 of the soname, see below.)
5336 <var>soname-version</var> is the version part of the soname of
5337 the library. The soname is the thing that must exactly match
5338 for the library to be recognized by the dynamic linker, and is
5340 <tt><var>name</var>.so.<var>major-version</var></tt>, in our
5341 example, <tt>libz.so.1</tt>.<footnote>
5342 This can be determined using the command
5343 <example compact="compact">
5344 objdump -p /usr/lib/libz.so.1.1.3 | grep SONAME
5347 The version part is the part which comes after
5348 <tt>.so.</tt>, so in our case, it is <tt>1</tt>.
5352 <var>dependencies</var> has the same syntax as a dependency
5353 field in a binary package control file. It should give
5354 details of which packages are required to satisfy a binary
5355 built against the version of the library contained in the
5356 package. See <ref id="depsyntax"> for details.
5360 In our example, if the first version of the <tt>zlib1g</tt>
5361 package which contained a minor number of at least
5362 <tt>1.3</tt> was <var>1:1.1.3-1</var>, then the
5363 <tt>shlibs</tt> entry for this library could say:
5364 <example compact="compact">
5365 libz 1 zlib1g (>= 1:1.1.3)
5367 The version-specific dependency is to avoid warnings from
5368 the dynamic linker about using older shared libraries with
5373 As zlib1g also provides a udeb containing the shared library,
5374 there would also be a second line:
5375 <example compact="compact">
5376 udeb: libz 1 zlib1g-udeb (>= 1:1.1.3)
5382 <heading>Providing a <file>shlibs</file> file</heading>
5385 If your package provides a shared library, you need to create
5386 a <file>shlibs</file> file following the format described above.
5387 It is usual to call this file <file>debian/shlibs</file> (but if
5388 you have multiple binary packages, you might want to call it
5389 <file>debian/shlibs.<var>package</var></file> instead). Then
5390 let <file>debian/rules</file> install it in the control area:
5391 <example compact="compact">
5392 install -m644 debian/shlibs debian/tmp/DEBIAN
5394 or, in the case of a multi-binary package:
5395 <example compact="compact">
5396 install -m644 debian/shlibs.<var>package</var> debian/<var>package</var>/DEBIAN/shlibs
5398 An alternative way of doing this is to create the
5399 <file>shlibs</file> file in the control area directly from
5400 <file>debian/rules</file> without using a <file>debian/shlibs</file>
5401 file at all,<footnote>
5402 This is what <prgn>dh_makeshlibs</prgn> in the
5403 <tt>debhelper</tt> suite does. If your package also has a udeb
5404 that provides a shared library, <prgn>dh_makeshlibs</prgn> can
5405 automatically generate the <tt>udeb:</tt> lines if you specify
5406 the name of the udeb with the <tt>--add-udeb</tt> option.
5408 since the <file>debian/shlibs</file> file itself is ignored by
5409 <prgn>dpkg-shlibdeps</prgn>.
5413 As <prgn>dpkg-shlibdeps</prgn> reads the
5414 <file>DEBIAN/shlibs</file> files in all of the binary packages
5415 being built from this source package, all of the
5416 <file>DEBIAN/shlibs</file> files should be installed before
5417 <prgn>dpkg-shlibdeps</prgn> is called on any of the binary
5422 <sect1 id="shlibslocal">
5423 <heading>Writing the <file>debian/shlibs.local</file> file</heading>
5426 This file is intended only as a <em>temporary</em> fix if
5427 your binaries or libraries depend on a library whose package
5428 does not yet provide a correct <file>shlibs</file> file.
5432 We will assume that you are trying to package a binary
5433 <tt>foo</tt>. When you try running
5434 <prgn>dpkg-shlibdeps</prgn> you get the following error
5435 message (<tt>-O</tt> displays the dependency information on
5436 <tt>stdout</tt> instead of writing it to
5437 <tt>debian/substvars</tt>, and the lines have been wrapped
5438 for ease of reading):
5439 <example compact="compact">
5440 $ dpkg-shlibdeps -O debian/tmp/usr/bin/foo
5441 dpkg-shlibdeps: warning: unable to find dependency
5442 information for shared library libbar (soname 1,
5443 path /usr/lib/libbar.so.1, dependency field Depends)
5444 shlibs:Depends=libc6 (>= 2.2.2-2)
5446 You can then run <prgn>ldd</prgn> on the binary to find the
5447 full location of the library concerned:
5448 <example compact="compact">
5450 libbar.so.1 => /usr/lib/libbar.so.1 (0x4001e000)
5451 libc.so.6 => /lib/libc.so.6 (0x40032000)
5452 /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0x40000000)
5454 So the <prgn>foo</prgn> binary depends on the
5455 <prgn>libbar</prgn> shared library, but no package seems to
5456 provide a <file>*.shlibs</file> file handling
5457 <file>libbar.so.1</file> in <file>/var/lib/dpkg/info/</file>. Let's
5458 determine the package responsible:
5459 <example compact="compact">
5460 $ dpkg -S /usr/lib/libbar.so.1
5461 bar1: /usr/lib/libbar.so.1
5462 $ dpkg -s bar1 | grep Version
5465 This tells us that the <tt>bar1</tt> package, version 1.0-1,
5466 is the one we are using. Now we can file a bug against the
5467 <tt>bar1</tt> package and create our own
5468 <file>debian/shlibs.local</file> to locally fix the problem.
5469 Including the following line into your
5470 <file>debian/shlibs.local</file> file:
5471 <example compact="compact">
5472 libbar 1 bar1 (>= 1.0-1)
5474 should allow the package build to work.
5478 As soon as the maintainer of <tt>bar1</tt> provides a
5479 correct <file>shlibs</file> file, you should remove this line
5480 from your <file>debian/shlibs.local</file> file. (You should
5481 probably also then have a versioned <tt>Build-Depends</tt>
5482 on <tt>bar1</tt> to help ensure that others do not have the
5483 same problem building your package.)
5492 <chapt id="opersys"><heading>The Operating System</heading>
5495 <heading>File system hierarchy</heading>
5499 <heading>File system Structure</heading>
5502 The location of all installed files and directories must
5503 comply with the File system Hierarchy Standard (FHS),
5504 version 2.3, with the exceptions noted below, and except
5505 where doing so would violate other terms of Debian
5506 Policy. The following exceptions to the FHS apply:
5511 Legacy XFree86 servers are permitted to retain the
5512 configuration file location
5513 <file>/etc/X11/XF86Config-4</file>.
5518 The optional rules related to user specific
5519 configuration files for applications are stored in
5520 the user's home directory are relaxed. It is
5521 recommended that such files start with the
5522 '<tt>.</tt>' character (a "dot file"), and if an
5523 application needs to create more than one dot file
5524 then the preferred placement is in a subdirectory
5525 with a name starting with a '.' character, (a "dot
5526 directory"). In this case it is recommended the
5527 configuration files not start with the '.'
5533 The requirement for amd64 to use <file>/lib64</file>
5534 for 64 bit binaries is removed.
5539 The requirement that
5540 <file>/usr/local/share/man</file> be "synonymous"
5541 with <file>/usr/local/man</file> is relaxed to a
5546 The requirement that windowmanagers with a single
5547 configuration file call it <file>system.*wmrc</file>
5548 is removed, as is the restriction that the window
5549 manager subdirectory be named identically to the
5550 window manager name itself.
5555 The requirement that boot manager configuration
5556 files live in <file>/etc</file>, or at least are
5557 symlinked there, is relaxed to a recommendation.
5564 The version of this document referred here can be
5565 found in the <tt>debian-policy</tt> package or on <url
5566 id="http://www.debian.org/doc/packaging-manuals/fhs/"
5567 name="FHS (Debian copy)"> alongside this manual (or, if
5568 you have the <package>debian-policy</package> installed,
5570 id="file:///usr/share/doc/debian-policy/fhs/" name="FHS
5571 (local copy)">). The
5572 latest version, which may be a more recent version, may
5574 <url id="http://www.pathname.com/fhs/" name="FHS (upstream)">.
5575 Specific questions about following the standard may be
5576 asked on the <tt>debian-devel</tt> mailing list, or
5577 referred to the FHS mailing list (see the
5578 <url id="http://www.pathname.com/fhs/" name="FHS web site"> for
5584 <heading>Site-specific programs</heading>
5587 As mandated by the FHS, packages must not place any
5588 files in <file>/usr/local</file>, either by putting them in
5589 the file system archive to be unpacked by <prgn>dpkg</prgn>
5590 or by manipulating them in their maintainer scripts.
5594 However, the package may create empty directories below
5595 <file>/usr/local</file> so that the system administrator knows
5596 where to place site-specific files. These are not
5597 directories <em>in</em> <file>/usr/local</file>, but are
5598 children of directories in <file>/usr/local</file>. These
5599 directories (<file>/usr/local/*/dir/</file>)
5600 should be removed on package removal if they are
5605 Note, that this applies only to directories <em>below</em>
5606 <file>/usr/local</file>, not <em>in</em> <file>/usr/local</file>.
5607 Packages must not create sub-directories in the directory
5608 <file>/usr/local</file> itself, except those listed in FHS,
5609 section 4.5. However, you may create directories below
5610 them as you wish. You must not remove any of the
5611 directories listed in 4.5, even if you created them.
5615 Since <file>/usr/local</file> can be mounted read-only from a
5616 remote server, these directories must be created and
5617 removed by the <prgn>postinst</prgn> and <prgn>prerm</prgn>
5618 maintainer scripts and not be included in the
5619 <file>.deb</file> archive. These scripts must not fail if
5620 either of these operations fail.
5624 For example, the <tt>emacsen-common</tt> package could
5625 contain something like
5626 <example compact="compact">
5627 if [ ! -e /usr/local/share/emacs ]
5629 if mkdir /usr/local/share/emacs 2>/dev/null
5631 chown root:staff /usr/local/share/emacs
5632 chmod 2775 /usr/local/share/emacs
5636 in its <prgn>postinst</prgn> script, and
5637 <example compact="compact">
5638 rmdir /usr/local/share/emacs/site-lisp 2>/dev/null || true
5639 rmdir /usr/local/share/emacs 2>/dev/null || true
5641 in the <prgn>prerm</prgn> script. (Note that this form is
5642 used to ensure that if the script is interrupted, the
5643 directory <file>/usr/local/share/emacs</file> will still be
5648 If you do create a directory in <file>/usr/local</file> for
5649 local additions to a package, you should ensure that
5650 settings in <file>/usr/local</file> take precedence over the
5651 equivalents in <file>/usr</file>.
5655 However, because <file>/usr/local</file> and its contents are
5656 for exclusive use of the local administrator, a package
5657 must not rely on the presence or absence of files or
5658 directories in <file>/usr/local</file> for normal operation.
5662 The <file>/usr/local</file> directory itself and all the
5663 subdirectories created by the package should (by default) have
5664 permissions 2775 (group-writable and set-group-id) and be
5665 owned by <tt>root:staff</tt>.
5670 <heading>The system-wide mail directory</heading>
5672 The system-wide mail directory is <file>/var/mail</file>. This
5673 directory is part of the base system and should not owned
5674 by any particular mail agents. The use of the old
5675 location <file>/var/spool/mail</file> is deprecated, even
5676 though the spool may still be physically located there.
5677 To maintain partial upgrade compatibility for systems
5678 which have <file>/var/spool/mail</file> as their physical mail
5679 spool, packages using <file>/var/mail</file> must depend on
5680 either <package>libc6</package> (>= 2.1.3-13), or on
5681 <package>base-files</package> (>= 2.2.0), or on later
5682 versions of either one of these packages.
5688 <heading>Users and groups</heading>
5691 <heading>Introduction</heading>
5693 The Debian system can be configured to use either plain or
5698 Some user ids (UIDs) and group ids (GIDs) are reserved
5699 globally for use by certain packages. Because some
5700 packages need to include files which are owned by these
5701 users or groups, or need the ids compiled into binaries,
5702 these ids must be used on any Debian system only for the
5703 purpose for which they are allocated. This is a serious
5704 restriction, and we should avoid getting in the way of
5705 local administration policies. In particular, many sites
5706 allocate users and/or local system groups starting at 100.
5710 Apart from this we should have dynamically allocated ids,
5711 which should by default be arranged in some sensible
5712 order, but the behavior should be configurable.
5716 Packages other than <tt>base-passwd</tt> must not modify
5717 <file>/etc/passwd</file>, <file>/etc/shadow</file>,
5718 <file>/etc/group</file> or <file>/etc/gshadow</file>.
5723 <heading>UID and GID classes</heading>
5725 The UID and GID numbers are divided into classes as
5731 Globally allocated by the Debian project, the same
5732 on every Debian system. These ids will appear in
5733 the <file>passwd</file> and <file>group</file> files of all
5734 Debian systems, new ids in this range being added
5735 automatically as the <tt>base-passwd</tt> package is
5740 Packages which need a single statically allocated
5741 uid or gid should use one of these; their
5742 maintainers should ask the <tt>base-passwd</tt>
5750 Dynamically allocated system users and groups.
5751 Packages which need a user or group, but can have
5752 this user or group allocated dynamically and
5753 differently on each system, should use <tt>adduser
5754 --system</tt> to create the group and/or user.
5755 <prgn>adduser</prgn> will check for the existence of
5756 the user or group, and if necessary choose an unused
5757 id based on the ranges specified in
5758 <file>adduser.conf</file>.
5762 <tag>1000-29999:</tag>
5765 Dynamically allocated user accounts. By default
5766 <prgn>adduser</prgn> will choose UIDs and GIDs for
5767 user accounts in this range, though
5768 <file>adduser.conf</file> may be used to modify this
5773 <tag>30000-59999:</tag>
5778 <tag>60000-64999:</tag>
5781 Globally allocated by the Debian project, but only
5782 created on demand. The ids are allocated centrally
5783 and statically, but the actual accounts are only
5784 created on users' systems on demand.
5788 These ids are for packages which are obscure or
5789 which require many statically-allocated ids. These
5790 packages should check for and create the accounts in
5791 <file>/etc/passwd</file> or <file>/etc/group</file> (using
5792 <prgn>adduser</prgn> if it has this facility) if
5793 necessary. Packages which are likely to require
5794 further allocations should have a "hole" left after
5795 them in the allocation, to give them room to
5800 <tag>65000-65533:</tag>
5808 User <tt>nobody</tt>. The corresponding gid refers
5809 to the group <tt>nogroup</tt>.
5816 <tt>(uid_t)(-1) == (gid_t)(-1)</tt> <em>must
5817 not</em> be used, because it is the error return
5826 <sect id="sysvinit">
5827 <heading>System run levels and <file>init.d</file> scripts</heading>
5829 <sect1 id="/etc/init.d">
5830 <heading>Introduction</heading>
5833 The <file>/etc/init.d</file> directory contains the scripts
5834 executed by <prgn>init</prgn> at boot time and when the
5835 init state (or "runlevel") is changed (see <manref
5836 name="init" section="8">).
5840 There are at least two different, yet functionally
5841 equivalent, ways of handling these scripts. For the sake
5842 of simplicity, this document describes only the symbolic
5843 link method. However, it must not be assumed by maintainer
5844 scripts that this method is being used, and any automated
5845 manipulation of the various runlevel behaviors by
5846 maintainer scripts must be performed using
5847 <prgn>update-rc.d</prgn> as described below and not by
5848 manually installing or removing symlinks. For information
5849 on the implementation details of the other method,
5850 implemented in the <tt>file-rc</tt> package, please refer
5851 to the documentation of that package.
5855 These scripts are referenced by symbolic links in the
5856 <file>/etc/rc<var>n</var>.d</file> directories. When changing
5857 runlevels, <prgn>init</prgn> looks in the directory
5858 <file>/etc/rc<var>n</var>.d</file> for the scripts it should
5859 execute, where <tt><var>n</var></tt> is the runlevel that
5860 is being changed to, or <tt>S</tt> for the boot-up
5865 The names of the links all have the form
5866 <file>S<var>mm</var><var>script</var></file> or
5867 <file>K<var>mm</var><var>script</var></file> where
5868 <var>mm</var> is a two-digit number and <var>script</var>
5869 is the name of the script (this should be the same as the
5870 name of the actual script in <file>/etc/init.d</file>).
5874 When <prgn>init</prgn> changes runlevel first the targets
5875 of the links whose names start with a <tt>K</tt> are
5876 executed, each with the single argument <tt>stop</tt>,
5877 followed by the scripts prefixed with an <tt>S</tt>, each
5878 with the single argument <tt>start</tt>. (The links are
5879 those in the <file>/etc/rc<var>n</var>.d</file> directory
5880 corresponding to the new runlevel.) The <tt>K</tt> links
5881 are responsible for killing services and the <tt>S</tt>
5882 link for starting services upon entering the runlevel.
5886 For example, if we are changing from runlevel 2 to
5887 runlevel 3, init will first execute all of the <tt>K</tt>
5888 prefixed scripts it finds in <file>/etc/rc3.d</file>, and then
5889 all of the <tt>S</tt> prefixed scripts in that directory.
5890 The links starting with <tt>K</tt> will cause the
5891 referred-to file to be executed with an argument of
5892 <tt>stop</tt>, and the <tt>S</tt> links with an argument
5897 The two-digit number <var>mm</var> is used to determine
5898 the order in which to run the scripts: low-numbered links
5899 have their scripts run first. For example, the
5900 <tt>K20</tt> scripts will be executed before the
5901 <tt>K30</tt> scripts. This is used when a certain service
5902 must be started before another. For example, the name
5903 server <prgn>bind</prgn> might need to be started before
5904 the news server <prgn>inn</prgn> so that <prgn>inn</prgn>
5905 can set up its access lists. In this case, the script
5906 that starts <prgn>bind</prgn> would have a lower number
5907 than the script that starts <prgn>inn</prgn> so that it
5909 <example compact="compact">
5916 The two runlevels 0 (halt) and 6 (reboot) are slightly
5917 different. In these runlevels, the links with an
5918 <tt>S</tt> prefix are still called after those with a
5919 <tt>K</tt> prefix, but they too are called with the single
5920 argument <tt>stop</tt>.
5924 Also, if the script name ends in <tt>.sh</tt>, the script
5925 will be sourced in runlevel <tt>S</tt> rather than being
5926 run in a forked subprocess, but will be explicitly run by
5927 <prgn>sh</prgn> in all other runlevels.
5932 <heading>Writing the scripts</heading>
5935 Packages that include daemons for system services should
5936 place scripts in <file>/etc/init.d</file> to start or stop
5937 services at boot time or during a change of runlevel.
5938 These scripts should be named
5939 <file>/etc/init.d/<var>package</var></file>, and they should
5940 accept one argument, saying what to do:
5943 <tag><tt>start</tt></tag>
5944 <item>start the service,</item>
5946 <tag><tt>stop</tt></tag>
5947 <item>stop the service,</item>
5949 <tag><tt>restart</tt></tag>
5950 <item>stop and restart the service if it's already running,
5951 otherwise start the service</item>
5953 <tag><tt>reload</tt></tag>
5954 <item><p>cause the configuration of the service to be
5955 reloaded without actually stopping and restarting
5958 <tag><tt>force-reload</tt></tag>
5959 <item>cause the configuration to be reloaded if the
5960 service supports this, otherwise restart the
5964 The <tt>start</tt>, <tt>stop</tt>, <tt>restart</tt>, and
5965 <tt>force-reload</tt> options should be supported by all
5966 scripts in <file>/etc/init.d</file>, the <tt>reload</tt>
5971 The <file>init.d</file> scripts must ensure that they will
5972 behave sensibly (i.e., returning success and not starting
5973 multiple copies of a service) if invoked with <tt>start</tt>
5974 when the service is already running, or with <tt>stop</tt>
5975 when it isn't, and that they don't kill unfortunately-named
5976 user processes. The best way to achieve this is usually to
5977 use <prgn>start-stop-daemon</prgn> with the <tt>--oknodo</tt>
5982 If a service reloads its configuration automatically (as
5983 in the case of <prgn>cron</prgn>, for example), the
5984 <tt>reload</tt> option of the <file>init.d</file> script
5985 should behave as if the configuration has been reloaded
5990 The <file>/etc/init.d</file> scripts must be treated as
5991 configuration files, either (if they are present in the
5992 package, that is, in the .deb file) by marking them as
5993 <tt>conffile</tt>s, or, (if they do not exist in the .deb)
5994 by managing them correctly in the maintainer scripts (see
5995 <ref id="config-files">). This is important since we want
5996 to give the local system administrator the chance to adapt
5997 the scripts to the local system, e.g., to disable a
5998 service without de-installing the package, or to specify
5999 some special command line options when starting a service,
6000 while making sure their changes aren't lost during the next
6005 These scripts should not fail obscurely when the
6006 configuration files remain but the package has been
6007 removed, as configuration files remain on the system after
6008 the package has been removed. Only when <prgn>dpkg</prgn>
6009 is executed with the <tt>--purge</tt> option will
6010 configuration files be removed. In particular, as the
6011 <file>/etc/init.d/<var>package</var></file> script itself is
6012 usually a <tt>conffile</tt>, it will remain on the system
6013 if the package is removed but not purged. Therefore, you
6014 should include a <tt>test</tt> statement at the top of the
6016 <example compact="compact">
6017 test -f <var>program-executed-later-in-script</var> || exit 0
6022 Often there are some variables in the <file>init.d</file>
6023 scripts whose values control the behavior of the scripts,
6024 and which a system administrator is likely to want to
6025 change. As the scripts themselves are frequently
6026 <tt>conffile</tt>s, modifying them requires that the
6027 administrator merge in their changes each time the package
6028 is upgraded and the <tt>conffile</tt> changes. To ease
6029 the burden on the system administrator, such configurable
6030 values should not be placed directly in the script.
6031 Instead, they should be placed in a file in
6032 <file>/etc/default</file>, which typically will have the same
6033 base name as the <file>init.d</file> script. This extra file
6034 should be sourced by the script when the script runs. It
6035 must contain only variable settings and comments in SUSv3
6036 <prgn>sh</prgn> format. It may either be a
6037 <tt>conffile</tt> or a configuration file maintained by
6038 the package maintainer scripts. See <ref id="config-files">
6043 To ensure that vital configurable values are always
6044 available, the <file>init.d</file> script should set default
6045 values for each of the shell variables it uses, either
6046 before sourcing the <file>/etc/default/</file> file or
6047 afterwards using something like the <tt>:
6048 ${VAR:=default}</tt> syntax. Also, the <file>init.d</file>
6049 script must behave sensibly and not fail if the
6050 <file>/etc/default</file> file is deleted.
6055 <heading>Interfacing with the initscript system</heading>
6058 Maintainers should use the abstraction layer provided by
6059 the <prgn>update-rc.d</prgn> and <prgn>invoke-rc.d</prgn>
6060 programs to deal with initscripts in their packages'
6061 scripts such as <prgn>postinst</prgn>, <prgn>prerm</prgn>
6062 and <prgn>postrm</prgn>.
6066 Directly managing the /etc/rc?.d links and directly
6067 invoking the <file>/etc/init.d/</file> initscripts should
6068 be done only by packages providing the initscript
6069 subsystem (such as <prgn>sysv-rc</prgn> and
6070 <prgn>file-rc</prgn>).
6074 <heading>Managing the links</heading>
6077 The program <prgn>update-rc.d</prgn> is provided for
6078 package maintainers to arrange for the proper creation and
6079 removal of <file>/etc/rc<var>n</var>.d</file> symbolic links,
6080 or their functional equivalent if another method is being
6081 used. This may be used by maintainers in their packages'
6082 <prgn>postinst</prgn> and <prgn>postrm</prgn> scripts.
6086 You must not include any <file>/etc/rc<var>n</var>.d</file>
6087 symbolic links in the actual archive or manually create or
6088 remove the symbolic links in maintainer scripts; you must
6089 use the <prgn>update-rc.d</prgn> program instead. (The
6090 former will fail if an alternative method of maintaining
6091 runlevel information is being used.) You must not include
6092 the <file>/etc/rc<var>n</var>.d</file> directories themselves
6093 in the archive either. (Only the <tt>sysvinit</tt>
6098 By default <prgn>update-rc.d</prgn> will start services in
6099 each of the multi-user state runlevels (2, 3, 4, and 5)
6100 and stop them in the halt runlevel (0), the single-user
6101 runlevel (1) and the reboot runlevel (6). The system
6102 administrator will have the opportunity to customize
6103 runlevels by simply adding, moving, or removing the
6104 symbolic links in <file>/etc/rc<var>n</var>.d</file> if
6105 symbolic links are being used, or by modifying
6106 <file>/etc/runlevel.conf</file> if the <tt>file-rc</tt> method
6111 To get the default behavior for your package, put in your
6112 <prgn>postinst</prgn> script
6113 <example compact="compact">
6114 update-rc.d <var>package</var> defaults
6116 and in your <prgn>postrm</prgn>
6117 <example compact="compact">
6118 if [ "$1" = purge ]; then
6119 update-rc.d <var>package</var> remove
6121 </example>. Note that if your package changes runlevels
6122 or priority, you may have to remove and recreate the links,
6123 since otherwise the old links may persist. Refer to the
6124 documentation of <prgn>update-rc.d</prgn>.
6128 This will use a default sequence number of 20. If it does
6129 not matter when or in which order the <file>init.d</file>
6130 script is run, use this default. If it does, then you
6131 should talk to the maintainer of the <prgn>sysvinit</prgn>
6132 package or post to <tt>debian-devel</tt>, and they will
6133 help you choose a number.
6137 For more information about using <tt>update-rc.d</tt>,
6138 please consult its man page <manref name="update-rc.d"
6144 <heading>Running initscripts</heading>
6146 The program <prgn>invoke-rc.d</prgn> is provided to make
6147 it easier for package maintainers to properly invoke an
6148 initscript, obeying runlevel and other locally-defined
6149 constraints that might limit a package's right to start,
6150 stop and otherwise manage services. This program may be
6151 used by maintainers in their packages' scripts.
6155 The package maintainer scripts must use
6156 <prgn>invoke-rc.d</prgn> to invoke the
6157 <file>/etc/init.d/*</file> initscripts, instead of
6158 calling them directly.
6162 By default, <prgn>invoke-rc.d</prgn> will pass any
6163 action requests (start, stop, reload, restart...) to the
6164 <file>/etc/init.d</file> script, filtering out requests
6165 to start or restart a service out of its intended
6170 Most packages will simply need to change:
6171 <example compact="compact">/etc/init.d/<package>
6172 <action></example> in their <prgn>postinst</prgn>
6173 and <prgn>prerm</prgn> scripts to:
6174 <example compact="compact">
6175 if which invoke-rc.d >/dev/null 2>&1; then
6176 invoke-rc.d <var>package</var> <action>
6178 /etc/init.d/<var>package</var> <action>
6184 A package should register its initscript services using
6185 <prgn>update-rc.d</prgn> before it tries to invoke them
6186 using <prgn>invoke-rc.d</prgn>. Invocation of
6187 unregistered services may fail.
6191 For more information about using
6192 <prgn>invoke-rc.d</prgn>, please consult its man page
6193 <manref name="invoke-rc.d" section="8">.
6199 <heading>Boot-time initialization</heading>
6202 There used to be another directory, <file>/etc/rc.boot</file>,
6203 which contained scripts which were run once per machine
6204 boot. This has been deprecated in favour of links from
6205 <file>/etc/rcS.d</file> to files in <file>/etc/init.d</file> as
6206 described in <ref id="/etc/init.d">. Packages must not
6207 place files in <file>/etc/rc.boot</file>.
6212 <heading>Example</heading>
6215 An example on which you can base your
6216 <file>/etc/init.d</file> scripts is found in
6217 <file>/etc/init.d/skeleton</file>.
6224 <heading>Console messages from <file>init.d</file> scripts</heading>
6227 This section describes the formats to be used for messages
6228 written to standard output by the <file>/etc/init.d</file>
6229 scripts. The intent is to improve the consistency of
6230 Debian's startup and shutdown look and feel. For this
6231 reason, please look very carefully at the details. We want
6232 the messages to have the same format in terms of wording,
6233 spaces, punctuation and case of letters.
6237 Here is a list of overall rules that should be used for
6238 messages generated by <file>/etc/init.d</file> scripts.
6244 The message should fit in one line (fewer than 80
6245 characters), start with a capital letter and end with
6246 a period (<tt>.</tt>) and line feed (<tt>"\n"</tt>).
6250 If the script is performing some time consuming task in
6251 the background (not merely starting or stopping a
6252 program, for instance), an ellipsis (three dots:
6253 <tt>...</tt>) should be output to the screen, with no
6254 leading or tailing whitespace or line feeds.
6258 The messages should appear as if the computer is telling
6259 the user what it is doing (politely :-), but should not
6260 mention "it" directly. For example, instead of:
6261 <example compact="compact">
6262 I'm starting network daemons: nfsd mountd.
6264 the message should say
6265 <example compact="compact">
6266 Starting network daemons: nfsd mountd.
6273 <tt>init.d</tt> script should use the following standard
6274 message formats for the situations enumerated below.
6280 <p>When daemons are started</p>
6283 If the script starts one or more daemons, the output
6284 should look like this (a single line, no leading
6286 <example compact="compact">
6287 Starting <var>description</var>: <var>daemon-1</var> ... <var>daemon-n</var>.
6289 The <var>description</var> should describe the
6290 subsystem the daemon or set of daemons are part of,
6291 while <var>daemon-1</var> up to <var>daemon-n</var>
6292 denote each daemon's name (typically the file name of
6297 For example, the output of <file>/etc/init.d/lpd</file>
6299 <example compact="compact">
6300 Starting printer spooler: lpd.
6305 This can be achieved by saying
6306 <example compact="compact">
6307 echo -n "Starting printer spooler: lpd"
6308 start-stop-daemon --start --quiet --exec /usr/sbin/lpd
6311 in the script. If there are more than one daemon to
6312 start, the output should look like this:
6313 <example compact="compact">
6314 echo -n "Starting remote file system services:"
6315 echo -n " nfsd"; start-stop-daemon --start --quiet nfsd
6316 echo -n " mountd"; start-stop-daemon --start --quiet mountd
6317 echo -n " ugidd"; start-stop-daemon --start --quiet ugidd
6320 This makes it possible for the user to see what is
6321 happening and when the final daemon has been started.
6322 Care should be taken in the placement of white spaces:
6323 in the example above the system administrators can
6324 easily comment out a line if they don't want to start
6325 a specific daemon, while the displayed message still
6331 <p>When a system parameter is being set</p>
6334 If you have to set up different system parameters
6335 during the system boot, you should use this format:
6336 <example compact="compact">
6337 Setting <var>parameter</var> to "<var>value</var>".
6342 You can use a statement such as the following to get
6344 <example compact="compact">
6345 echo "Setting DNS domainname to \"$domainname\"."
6350 Note that the same symbol (<tt>"</tt>) is used for the left
6351 and right quotation marks. A grave accent (<tt>`</tt>) is
6352 not a quote character; neither is an apostrophe
6358 <p>When a daemon is stopped or restarted</p>
6361 When you stop or restart a daemon, you should issue a
6362 message identical to the startup message, except that
6363 <tt>Starting</tt> is replaced with <tt>Stopping</tt>
6364 or <tt>Restarting</tt> respectively.
6368 For example, stopping the printer daemon will look like
6370 <example compact="compact">
6371 Stopping printer spooler: lpd.
6377 <p>When something is executed</p>
6380 There are several examples where you have to run a
6381 program at system startup or shutdown to perform a
6382 specific task, for example, setting the system's clock
6383 using <prgn>netdate</prgn> or killing all processes
6384 when the system shuts down. Your message should look
6386 <example compact="compact">
6387 Doing something very useful...done.
6389 You should print the <tt>done.</tt> immediately after
6390 the job has been completed, so that the user is
6391 informed why they have to wait. You can get this
6393 <example compact="compact">
6394 echo -n "Doing something very useful..."
6403 <p>When the configuration is reloaded</p>
6406 When a daemon is forced to reload its configuration
6407 files you should use the following format:
6408 <example compact="compact">
6409 Reloading <var>description</var> configuration...done.
6411 where <var>description</var> is the same as in the
6412 daemon starting message.
6420 <heading>Cron jobs</heading>
6423 Packages must not modify the configuration file
6424 <file>/etc/crontab</file>, and they must not modify the files in
6425 <file>/var/spool/cron/crontabs</file>.</p>
6428 If a package wants to install a job that has to be executed
6429 via cron, it should place a file with the name of the
6430 package in one or more of the following directories:
6431 <example compact="compact">
6437 As these directory names imply, the files within them are
6438 executed on an hourly, daily, weekly, or monthly basis,
6439 respectively. The exact times are listed in
6440 <file>/etc/crontab</file>.</p>
6443 All files installed in any of these directories must be
6444 scripts (e.g., shell scripts or Perl scripts) so that they
6445 can easily be modified by the local system administrator.
6446 In addition, they must be treated as configuration files.
6450 If a certain job has to be executed at some other frequency or
6451 at a specific time, the package should install a file
6452 <file>/etc/cron.d/<var>package</var></file>. This file uses the
6453 same syntax as <file>/etc/crontab</file> and is processed by
6454 <prgn>cron</prgn> automatically. The file must also be
6455 treated as a configuration file. (Note that entries in the
6456 <file>/etc/cron.d</file> directory are not handled by
6457 <prgn>anacron</prgn>. Thus, you should only use this
6458 directory for jobs which may be skipped if the system is not
6462 The scripts or crontab entries in these directories should
6463 check if all necessary programs are installed before they
6464 try to execute them. Otherwise, problems will arise when a
6465 package was removed but not purged since configuration files
6466 are kept on the system in this situation.</p>
6470 <heading>Menus</heading>
6473 The Debian <tt>menu</tt> package provides a standard
6474 interface between packages providing applications and
6475 <em>menu programs</em> (either X window managers or
6476 text-based menu programs such as <prgn>pdmenu</prgn>).
6480 All packages that provide applications that need not be
6481 passed any special command line arguments for normal
6482 operation should register a menu entry for those
6483 applications, so that users of the <tt>menu</tt> package
6484 will automatically get menu entries in their window
6485 managers, as well in shells like <tt>pdmenu</tt>.
6489 Menu entries should follow the current menu policy.
6493 The menu policy can be found in the <tt>menu-policy</tt>
6494 files in the <tt>debian-policy</tt> package.
6495 It is also available from the Debian web mirrors at
6496 <tt><url name="/doc/packaging-manuals/menu-policy/"
6497 id="http://www.debian.org/doc/packaging-manuals/menu-policy/"></tt>.
6501 Please also refer to the <em>Debian Menu System</em>
6502 documentation that comes with the <package>menu</package>
6503 package for information about how to register your
6509 <heading>Multimedia handlers</heading>
6512 MIME (Multipurpose Internet Mail Extensions, RFCs 2045-2049)
6513 is a mechanism for encoding files and data streams and
6514 providing meta-information about them, in particular their
6515 type (e.g. audio or video) and format (e.g. PNG, HTML,
6520 Registration of MIME type handlers allows programs like mail
6521 user agents and web browsers to invoke these handlers to
6522 view, edit or display MIME types they don't support directly.
6526 Packages which provide the ability to view/show/play,
6527 compose, edit or print MIME types should register themselves
6528 as such following the current MIME support policy.
6532 The MIME support policy can be found in the <tt>mime-policy</tt>
6533 files in the <tt>debian-policy</tt> package.
6534 It is also available from the Debian web mirrors at
6535 <tt><url name="/doc/packaging-manuals/mime-policy/"
6536 id="http://www.debian.org/doc/packaging-manuals/mime-policy/"></tt>.
6542 <heading>Keyboard configuration</heading>
6545 To achieve a consistent keyboard configuration so that all
6546 applications interpret a keyboard event the same way, all
6547 programs in the Debian distribution must be configured to
6548 comply with the following guidelines.
6552 The following keys must have the specified interpretations:
6555 <tag><tt><--</tt></tag>
6556 <item>delete the character to the left of the cursor</item>
6558 <tag><tt>Delete</tt></tag>
6559 <item>delete the character to the right of the cursor</item>
6561 <tag><tt>Control+H</tt></tag>
6562 <item>emacs: the help prefix</item>
6565 The interpretation of any keyboard events should be
6566 independent of the terminal that is used, be it a virtual
6567 console, an X terminal emulator, an rlogin/telnet session,
6572 The following list explains how the different programs
6573 should be set up to achieve this:
6579 <tt><--</tt> generates <tt>KB_BackSpace</tt> in X.
6583 <tt>Delete</tt> generates <tt>KB_Delete</tt> in X.
6587 X translations are set up to make
6588 <tt>KB_Backspace</tt> generate ASCII DEL, and to make
6589 <tt>KB_Delete</tt> generate <tt>ESC [ 3 ~</tt> (this
6590 is the vt220 escape code for the "delete character"
6591 key). This must be done by loading the X resources
6592 using <prgn>xrdb</prgn> on all local X displays, not
6593 using the application defaults, so that the
6594 translation resources used correspond to the
6595 <prgn>xmodmap</prgn> settings.
6599 The Linux console is configured to make
6600 <tt><--</tt> generate DEL, and <tt>Delete</tt>
6601 generate <tt>ESC [ 3 ~</tt>.
6605 X applications are configured so that <tt><</tt>
6606 deletes left, and <tt>Delete</tt> deletes right. Motif
6607 applications already work like this.
6611 Terminals should have <tt>stty erase ^?</tt> .
6615 The <tt>xterm</tt> terminfo entry should have <tt>ESC
6616 [ 3 ~</tt> for <tt>kdch1</tt>, just as for
6617 <tt>TERM=linux</tt> and <tt>TERM=vt220</tt>.
6621 Emacs is programmed to map <tt>KB_Backspace</tt> or
6622 the <tt>stty erase</tt> character to
6623 <tt>delete-backward-char</tt>, and <tt>KB_Delete</tt>
6624 or <tt>kdch1</tt> to <tt>delete-forward-char</tt>, and
6625 <tt>^H</tt> to <tt>help</tt> as always.
6629 Other applications use the <tt>stty erase</tt>
6630 character and <tt>kdch1</tt> for the two delete keys,
6631 with ASCII DEL being "delete previous character" and
6632 <tt>kdch1</tt> being "delete character under
6640 This will solve the problem except for the following
6647 Some terminals have a <tt><--</tt> key that cannot
6648 be made to produce anything except <tt>^H</tt>. On
6649 these terminals Emacs help will be unavailable on
6650 <tt>^H</tt> (assuming that the <tt>stty erase</tt>
6651 character takes precedence in Emacs, and has been set
6652 correctly). <tt>M-x help</tt> or <tt>F1</tt> (if
6653 available) can be used instead.
6657 Some operating systems use <tt>^H</tt> for <tt>stty
6658 erase</tt>. However, modern telnet versions and all
6659 rlogin versions propagate <tt>stty</tt> settings, and
6660 almost all UNIX versions honour <tt>stty erase</tt>.
6661 Where the <tt>stty</tt> settings are not propagated
6662 correctly, things can be made to work by using
6663 <tt>stty</tt> manually.
6667 Some systems (including previous Debian versions) use
6668 <prgn>xmodmap</prgn> to arrange for both
6669 <tt><--</tt> and <tt>Delete</tt> to generate
6670 <tt>KB_Delete</tt>. We can change the behavior of
6671 their X clients using the same X resources that we use
6672 to do it for our own clients, or configure our clients
6673 using their resources when things are the other way
6674 around. On displays configured like this
6675 <tt>Delete</tt> will not work, but <tt><--</tt>
6680 Some operating systems have different <tt>kdch1</tt>
6681 settings in their <tt>terminfo</tt> database for
6682 <tt>xterm</tt> and others. On these systems the
6683 <tt>Delete</tt> key will not work correctly when you
6684 log in from a system conforming to our policy, but
6685 <tt><--</tt> will.
6692 <heading>Environment variables</heading>
6695 A program must not depend on environment variables to get
6696 reasonable defaults. (That's because these environment
6697 variables would have to be set in a system-wide
6698 configuration file like <file>/etc/profile</file>, which is not
6699 supported by all shells.)
6703 If a program usually depends on environment variables for its
6704 configuration, the program should be changed to fall back to
6705 a reasonable default configuration if these environment
6706 variables are not present. If this cannot be done easily
6707 (e.g., if the source code of a non-free program is not
6708 available), the program must be replaced by a small
6709 "wrapper" shell script which sets the environment variables
6710 if they are not already defined, and calls the original program.
6714 Here is an example of a wrapper script for this purpose:
6716 <example compact="compact">
6718 BAR=${BAR:-/var/lib/fubar}
6720 exec /usr/lib/foo/foo "$@"
6725 Furthermore, as <file>/etc/profile</file> is a configuration
6726 file of the <prgn>base-files</prgn> package, other packages must
6727 not put any environment variables or other commands into that
6732 <sect id="doc-base">
6733 <heading>Registering Documents using doc-base</heading>
6736 The <package>doc-base</package> package implements a
6737 flexible mechanism for handling and presenting
6738 documentation. The recommended practice is for every Debian
6739 package that provides online documentation (other than just
6740 manual pages) to register these documents with
6741 <package>doc-base</package> by installing a
6742 <package>doc-base</package> control file via the
6743 <prgn/install-docs/ script at installation time and
6744 de-register the manuals again when the package is removed.
6747 Please refer to the documentation that comes with the
6748 <package>doc-base</package> package for information and
6757 <heading>Files</heading>
6760 <heading>Binaries</heading>
6763 Two different packages must not install programs with
6764 different functionality but with the same filenames. (The
6765 case of two programs having the same functionality but
6766 different implementations is handled via "alternatives" or
6767 the "Conflicts" mechanism. See <ref id="maintscripts"> and
6768 <ref id="conflicts"> respectively.) If this case happens,
6769 one of the programs must be renamed. The maintainers should
6770 report this to the <tt>debian-devel</tt> mailing list and
6771 try to find a consensus about which program will have to be
6772 renamed. If a consensus cannot be reached, <em>both</em>
6773 programs must be renamed.
6777 By default, when a package is being built, any binaries
6778 created should include debugging information, as well as
6779 being compiled with optimization. You should also turn on
6780 as many reasonable compilation warnings as possible; this
6781 makes life easier for porters, who can then look at build
6782 logs for possible problems. For the C programming language,
6783 this means the following compilation parameters should be
6785 <example compact="compact">
6787 CFLAGS = -O2 -g -Wall # sane warning options vary between programs
6789 INSTALL = install -s # (or use strip on the files in debian/tmp)
6794 Note that by default all installed binaries should be stripped,
6795 either by using the <tt>-s</tt> flag to
6796 <prgn>install</prgn>, or by calling <prgn>strip</prgn> on
6797 the binaries after they have been copied into
6798 <file>debian/tmp</file> but before the tree is made into a
6803 Although binaries in the build tree should be compiled with
6804 debugging information by default, it can often be difficult to
6805 debug programs if they are also subjected to compiler
6806 optimization. For this reason, it is recommended to support the
6807 standardized environment variable <tt>DEB_BUILD_OPTIONS</tt>
6808 (see <ref id="debianrules-options">). This variable can contain
6809 several flags to change how a package is compiled and built.
6813 It is up to the package maintainer to decide what
6814 compilation options are best for the package. Certain
6815 binaries (such as computationally-intensive programs) will
6816 function better with certain flags (<tt>-O3</tt>, for
6817 example); feel free to use them. Please use good judgment
6818 here. Don't use flags for the sake of it; only use them
6819 if there is good reason to do so. Feel free to override
6820 the upstream author's ideas about which compilation
6821 options are best: they are often inappropriate for our
6827 <sect id="libraries">
6828 <heading>Libraries</heading>
6831 If the package is <strong>architecture: any</strong>, then
6832 the shared library compilation and linking flags must have
6833 <tt>-fPIC</tt>, or the package shall not build on some of
6834 the supported architectures<footnote>
6836 If you are using GCC, <tt>-fPIC</tt> produces code with
6837 relocatable position independent code, which is required for
6838 most architectures to create a shared library, with i386 and
6839 perhaps some others where non position independent code is
6840 permitted in a shared library.
6843 Position independent code may have a performance penalty,
6844 especially on <tt>i386</tt>. However, in most cases the
6845 speed penalty must be measured against the memory wasted on
6846 the few architectures where non position independent code is
6849 </footnote>. Any exception to this rule must be discussed on
6850 the mailing list <em>debian-devel@lists.debian.org</em>, and
6851 a rough consensus obtained. The reasons for not compiling
6852 with <tt>-fPIC</tt> flag must be recorded in the file
6853 <tt>README.Debian</tt>, and care must be taken to either
6854 restrict the architecture or arrange for <tt>-fPIC</tt> to
6855 be used on architectures where it is required.<footnote>
6857 Some of the reasons why this might be required is if the
6858 library contains hand crafted assembly code that is not
6859 relocatable, the speed penalty is excessive for compute
6860 intensive libs, and similar reasons.
6865 As to the static libraries, the common case is not to have
6866 relocatable code, since there is no benefit, unless in specific
6867 cases; therefore the static version must not be compiled
6868 with the <tt>-fPIC</tt> flag. Any exception to this rule
6869 should be discussed on the mailing list
6870 <em>debian-devel@lists.debian.org</em>, and the reasons for
6871 compiling with the <tt>-fPIC</tt> flag must be recorded in
6872 the file <tt>README.Debian</tt>. <footnote>
6874 Some of the reasons for linking static libraries with
6875 the <tt>-fPIC</tt> flag are if, for example, one needs a
6876 Perl API for a library that is under rapid development,
6877 and has an unstable API, so shared libraries are
6878 pointless at this phase of the library's development. In
6879 that case, since Perl needs a library with relocatable
6880 code, it may make sense to create a static library with
6881 relocatable code. Another reason cited is if you are
6882 distilling various libraries into a common shared
6883 library, like <tt>mklibs</tt> does in the Debian
6889 In other words, if both a shared and a static library is
6890 being built, each source unit (<tt>*.c</tt>, for example,
6891 for C files) will need to be compiled twice, for the normal
6895 You must specify the gcc option <tt>-D_REENTRANT</tt>
6896 when building a library (either static or shared) to make
6897 the library compatible with LinuxThreads.
6901 Although not enforced by the build tools, shared libraries
6902 must be linked against all libraries that they use symbols from
6903 in the same way that binaries are. This ensures the correct
6904 functioning of the <qref id="sharedlibs-shlibdeps">shlibs</qref>
6905 system and guarantees that all libraries can be safely opened
6906 with <tt>dlopen()</tt>. Packagers may wish to use the gcc
6907 option <tt>-Wl,-z,defs</tt> when building a shared library.
6908 Since this option enforces symbol resolution at build time,
6909 a missing library reference will be caught early as a fatal
6914 All installed shared libraries should be stripped with
6915 <example compact="compact">
6916 strip --strip-unneeded <var>your-lib</var>
6918 (The option <tt>--strip-unneeded</tt> makes
6919 <prgn>strip</prgn> remove only the symbols which aren't
6920 needed for relocation processing.) Shared libraries can
6921 function perfectly well when stripped, since the symbols for
6922 dynamic linking are in a separate part of the ELF object
6924 You might also want to use the options
6925 <tt>--remove-section=.comment</tt> and
6926 <tt>--remove-section=.note</tt> on both shared libraries
6927 and executables, and <tt>--strip-debug</tt> on static
6933 Note that under some circumstances it may be useful to
6934 install a shared library unstripped, for example when
6935 building a separate package to support debugging.
6939 Shared object files (often <file>.so</file> files) that are not
6940 public libraries, that is, they are not meant to be linked
6941 to by third party executables (binaries of other packages),
6942 should be installed in subdirectories of the
6943 <file>/usr/lib</file> directory. Such files are exempt from the
6944 rules that govern ordinary shared libraries, except that
6945 they must not be installed executable and should be
6947 A common example are the so-called "plug-ins",
6948 internal shared objects that are dynamically loaded by
6949 programs using <manref name="dlopen" section="3">.
6954 Packages containing shared libraries that may be linked to
6955 by other packages' binaries, but which for some
6956 <em>compelling</em> reason can not be installed in
6957 <file>/usr/lib</file> directory, may install the shared library
6958 files in subdirectories of the <file>/usr/lib</file> directory,
6959 in which case they should arrange to add that directory in
6960 <file>/etc/ld.so.conf</file> in the package's post-installation
6961 script, and remove it in the package's post-removal script.
6965 An ever increasing number of packages are using
6966 <prgn>libtool</prgn> to do their linking. The latest GNU
6967 libtools (>= 1.3a) can take advantage of the metadata in the
6968 installed <prgn>libtool</prgn> archive files (<file>*.la</file>
6969 files). The main advantage of <prgn>libtool</prgn>'s
6970 <file>.la</file> files is that it allows <prgn>libtool</prgn> to
6971 store and subsequently access metadata with respect to the
6972 libraries it builds. <prgn>libtool</prgn> will search for
6973 those files, which contain a lot of useful information about
6974 a library (such as library dependency information for static
6975 linking). Also, they're <em>essential</em> for programs
6976 using <tt>libltdl</tt>.<footnote>
6977 Although <prgn>libtool</prgn> is fully capable of
6978 linking against shared libraries which don't have
6979 <tt>.la</tt> files, as it is a mere shell script it can
6980 add considerably to the build time of a
6981 <prgn>libtool</prgn>-using package if that shell script
6982 has to derive all this information from first principles
6983 for each library every time it is linked. With the
6984 advent of <prgn>libtool</prgn> version 1.4 (and to a
6985 lesser extent <prgn>libtool</prgn> version 1.3), the
6986 <file>.la</file> files also store information about
6987 inter-library dependencies which cannot necessarily be
6988 derived after the <file>.la</file> file is deleted.
6993 Packages that use <prgn>libtool</prgn> to create shared
6994 libraries should include the <file>.la</file> files in the
6995 <tt>-dev</tt> package, unless the package relies on
6996 <tt>libtool</tt>'s <tt>libltdl</tt> library, in which case
6997 the <tt>.la</tt> files must go in the run-time library
7002 You must make sure that you use only released versions of
7003 shared libraries to build your packages; otherwise other
7004 users will not be able to run your binaries
7005 properly. Producing source packages that depend on
7006 unreleased compilers is also usually a bad
7013 <heading>Shared libraries</heading>
7015 This section has moved to <ref id="sharedlibs">.
7021 <heading>Scripts</heading>
7024 All command scripts, including the package maintainer
7025 scripts inside the package and used by <prgn>dpkg</prgn>,
7026 should have a <tt>#!</tt> line naming the shell to be used
7031 In the case of Perl scripts this should be
7032 <tt>#!/usr/bin/perl</tt>.
7036 When scripts are installed into a directory in the system
7037 PATH, the script name should not include an extension such
7038 as <tt>.sh</tt> or <tt>.pl</tt> that denotes the scripting
7039 language currently used to implement it.
7042 Shell scripts (<prgn>sh</prgn> and <prgn>bash</prgn>)
7043 should almost certainly start with <tt>set -e</tt> so that
7044 errors are detected. Every script should use
7045 <tt>set -e</tt> or check the exit status of <em>every</em>
7050 Scripts may assume that <file>/bin/sh</file> implements the
7051 SUSv3 Shell Command Language<footnote>
7052 Single UNIX Specification, version 3, which is also IEEE
7053 1003.1-2004 (POSIX), and is available on the World Wide Web
7054 from <url id="http://www.unix.org/version3/online.html"
7055 name="The Open Group"> after free
7056 registration.</footnote>
7057 plus the following additional features not mandated by
7059 These features are in widespread use in the Linux community
7060 and are implemented in all of bash, dash, and ksh, the most
7061 common shells users may wish to use as <file>/bin/sh</file>.
7064 <item><tt>echo -n</tt>, if implemented as a shell built-in,
7065 must not generate a newline.</item>
7066 <item><tt>test</tt>, if implemented as a shell built-in, must
7067 support <tt>-a</tt> and <tt>-o</tt> as binary logical
7069 <item><tt>local</tt> to create a scoped variable must be
7070 supported, including listing multiple variables in a single
7071 local command and assigning a value to a variable at the
7072 same time as localizing it. <tt>local</tt> may or
7073 may not preserve the variable value from an outer scope if
7074 no assignment is present. Uses such as:
7078 # ... use a, b, c, d ...
7081 must be supported and must set the value of <tt>c</tt> to
7085 If a shell script requires non-SUSv3 features from the shell
7086 interpreter other than those listed above, the appropriate shell
7087 must be specified in the first line of the script (e.g.,
7088 <tt>#!/bin/bash</tt>) and the package must depend on the package
7089 providing the shell (unless the shell package is marked
7090 "Essential", as in the case of <prgn>bash</prgn>).
7094 You may wish to restrict your script to SUSv3 features plus the
7095 above set when possible so that it may use <file>/bin/sh</file>
7096 as its interpreter. If your script works with <prgn>dash</prgn>
7097 (originally called <prgn>ash</prgn>), it probably complies with
7098 the above requirements, but if you are in doubt, use
7099 <file>/bin/bash</file>.
7103 Perl scripts should check for errors when making any
7104 system calls, including <tt>open</tt>, <tt>print</tt>,
7105 <tt>close</tt>, <tt>rename</tt> and <tt>system</tt>.
7109 <prgn>csh</prgn> and <prgn>tcsh</prgn> should be avoided as
7110 scripting languages. See <em>Csh Programming Considered
7111 Harmful</em>, one of the <tt>comp.unix.*</tt> FAQs, which
7112 can be found at <url id="http://www.faqs.org/faqs/unix-faq/shell/csh-whynot/">.
7113 If an upstream package comes with <prgn>csh</prgn> scripts
7114 then you must make sure that they start with
7115 <tt>#!/bin/csh</tt> and make your package depend on the
7116 <prgn>c-shell</prgn> virtual package.
7120 Any scripts which create files in world-writeable
7121 directories (e.g., in <file>/tmp</file>) must use a
7122 mechanism which will fail atomically if a file with the same
7123 name already exists.
7127 The Debian base system provides the <prgn>tempfile</prgn>
7128 and <prgn>mktemp</prgn> utilities for use by scripts for
7135 <heading>Symbolic links</heading>
7138 In general, symbolic links within a top-level directory
7139 should be relative, and symbolic links pointing from one
7140 top-level directory into another should be absolute. (A
7141 top-level directory is a sub-directory of the root
7142 directory <file>/</file>.)
7146 In addition, symbolic links should be specified as short as
7147 possible, i.e., link targets like <file>foo/../bar</file> are
7152 Note that when creating a relative link using
7153 <prgn>ln</prgn> it is not necessary for the target of the
7154 link to exist relative to the working directory you're
7155 running <prgn>ln</prgn> from, nor is it necessary to change
7156 directory to the directory where the link is to be made.
7157 Simply include the string that should appear as the target
7158 of the link (this will be a pathname relative to the
7159 directory in which the link resides) as the first argument
7164 For example, in your <prgn>Makefile</prgn> or
7165 <file>debian/rules</file>, you can do things like:
7166 <example compact="compact">
7167 ln -fs gcc $(prefix)/bin/cc
7168 ln -fs gcc debian/tmp/usr/bin/cc
7169 ln -fs ../sbin/sendmail $(prefix)/bin/runq
7170 ln -fs ../sbin/sendmail debian/tmp/usr/bin/runq
7175 A symbolic link pointing to a compressed file should always
7176 have the same file extension as the referenced file. (For
7177 example, if a file <file>foo.gz</file> is referenced by a
7178 symbolic link, the filename of the link has to end with
7179 "<file>.gz</file>" too, as in <file>bar.gz</file>.)
7184 <heading>Device files</heading>
7187 Packages must not include device files in the package file
7192 If a package needs any special device files that are not
7193 included in the base system, it must call
7194 <prgn>MAKEDEV</prgn> in the <prgn>postinst</prgn> script,
7195 after notifying the user<footnote>
7196 This notification could be done via a (low-priority)
7197 debconf message, or an echo (printf) statement.
7202 Packages must not remove any device files in the
7203 <prgn>postrm</prgn> or any other script. This is left to the
7204 system administrator.
7208 Debian uses the serial devices
7209 <file>/dev/ttyS*</file>. Programs using the old
7210 <file>/dev/cu*</file> devices should be changed to use
7211 <file>/dev/ttyS*</file>.
7215 <sect id="config-files">
7216 <heading>Configuration files</heading>
7219 <heading>Definitions</heading>
7223 <tag>configuration file</tag>
7225 A file that affects the operation of a program, or
7226 provides site- or host-specific information, or
7227 otherwise customizes the behavior of a program.
7228 Typically, configuration files are intended to be
7229 modified by the system administrator (if needed or
7230 desired) to conform to local policy or to provide
7231 more useful site-specific behavior.
7234 <tag><tt>conffile</tt></tag>
7236 A file listed in a package's <tt>conffiles</tt>
7237 file, and is treated specially by <prgn>dpkg</prgn>
7238 (see <ref id="configdetails">).
7244 The distinction between these two is important; they are
7245 not interchangeable concepts. Almost all
7246 <tt>conffile</tt>s are configuration files, but many
7247 configuration files are not <tt>conffiles</tt>.
7251 As noted elsewhere, <file>/etc/init.d</file> scripts,
7252 <file>/etc/default</file> files, scripts installed in
7253 <file>/etc/cron.{hourly,daily,weekly,monthly}</file>, and cron
7254 configuration installed in <file>/etc/cron.d</file> must be
7255 treated as configuration files. In general, any script that
7256 embeds configuration information is de-facto a configuration
7257 file and should be treated as such.
7262 <heading>Location</heading>
7265 Any configuration files created or used by your package
7266 must reside in <file>/etc</file>. If there are several,
7267 consider creating a subdirectory of <file>/etc</file>
7268 named after your package.
7272 If your package creates or uses configuration files
7273 outside of <file>/etc</file>, and it is not feasible to modify
7274 the package to use <file>/etc</file> directly, put the files
7275 in <file>/etc</file> and create symbolic links to those files
7276 from the location that the package requires.
7281 <heading>Behavior</heading>
7284 Configuration file handling must conform to the following
7286 <list compact="compact">
7288 local changes must be preserved during a package
7292 configuration files must be preserved when the
7293 package is removed, and only deleted when the
7300 The easy way to achieve this behavior is to make the
7301 configuration file a <tt>conffile</tt>. This is
7302 appropriate only if it is possible to distribute a default
7303 version that will work for most installations, although
7304 some system administrators may choose to modify it. This
7305 implies that the default version will be part of the
7306 package distribution, and must not be modified by the
7307 maintainer scripts during installation (or at any other
7312 In order to ensure that local changes are preserved
7313 correctly, no package may contain or make hard links to
7314 conffiles.<footnote>
7315 Rationale: There are two problems with hard links.
7316 The first is that some editors break the link while
7317 editing one of the files, so that the two files may
7318 unwittingly become unlinked and different. The second
7319 is that <prgn>dpkg</prgn> might break the hard link
7320 while upgrading <tt>conffile</tt>s.
7325 The other way to do it is via the maintainer scripts. In
7326 this case, the configuration file must not be listed as a
7327 <tt>conffile</tt> and must not be part of the package
7328 distribution. If the existence of a file is required for
7329 the package to be sensibly configured it is the
7330 responsibility of the package maintainer to provide
7331 maintainer scripts which correctly create, update and
7332 maintain the file and remove it on purge. (See <ref
7333 id="maintainerscripts"> for more information.) These
7334 scripts must be idempotent (i.e., must work correctly if
7335 <prgn>dpkg</prgn> needs to re-run them due to errors
7336 during installation or removal), must cope with all the
7337 variety of ways <prgn>dpkg</prgn> can call maintainer
7338 scripts, must not overwrite or otherwise mangle the user's
7339 configuration without asking, must not ask unnecessary
7340 questions (particularly during upgrades), and must
7341 otherwise be good citizens.
7345 The scripts are not required to configure every possible
7346 option for the package, but only those necessary to get
7347 the package running on a given system. Ideally the
7348 sysadmin should not have to do any configuration other
7349 than that done (semi-)automatically by the
7350 <prgn>postinst</prgn> script.
7354 A common practice is to create a script called
7355 <file><var>package</var>-configure</file> and have the
7356 package's <prgn>postinst</prgn> call it if and only if the
7357 configuration file does not already exist. In certain
7358 cases it is useful for there to be an example or template
7359 file which the maintainer scripts use. Such files should
7360 be in <file>/usr/share/<var>package</var></file> or
7361 <file>/usr/lib/<var>package</var></file> (depending on whether
7362 they are architecture-independent or not). There should
7363 be symbolic links to them from
7364 <file>/usr/share/doc/<var>package</var>/examples</file> if
7365 they are examples, and should be perfectly ordinary
7366 <prgn>dpkg</prgn>-handled files (<em>not</em>
7367 configuration files).
7371 These two styles of configuration file handling must
7372 not be mixed, for that way lies madness:
7373 <prgn>dpkg</prgn> will ask about overwriting the file
7374 every time the package is upgraded.
7379 <heading>Sharing configuration files</heading>
7382 Packages which specify the same file as a
7383 <tt>conffile</tt> must be tagged as <em>conflicting</em>
7384 with each other. (This is an instance of the general rule
7385 about not sharing files. Note that neither alternatives
7386 nor diversions are likely to be appropriate in this case;
7387 in particular, <prgn>dpkg</prgn> does not handle diverted
7388 <tt>conffile</tt>s well.)
7392 The maintainer scripts must not alter a <tt>conffile</tt>
7393 of <em>any</em> package, including the one the scripts
7398 If two or more packages use the same configuration file
7399 and it is reasonable for both to be installed at the same
7400 time, one of these packages must be defined as
7401 <em>owner</em> of the configuration file, i.e., it will be
7402 the package which handles that file as a configuration
7403 file. Other packages that use the configuration file must
7404 depend on the owning package if they require the
7405 configuration file to operate. If the other package will
7406 use the configuration file if present, but is capable of
7407 operating without it, no dependency need be declared.
7411 If it is desirable for two or more related packages to
7412 share a configuration file <em>and</em> for all of the
7413 related packages to be able to modify that configuration
7414 file, then the following should be done:
7415 <enumlist compact="compact">
7417 One of the related packages (the "owning" package)
7418 will manage the configuration file with maintainer
7419 scripts as described in the previous section.
7422 The owning package should also provide a program
7423 that the other packages may use to modify the
7427 The related packages must use the provided program
7428 to make any desired modifications to the
7429 configuration file. They should either depend on
7430 the core package to guarantee that the configuration
7431 modifier program is available or accept gracefully
7432 that they cannot modify the configuration file if it
7433 is not. (This is in addition to the fact that the
7434 configuration file may not even be present in the
7441 Sometimes it's appropriate to create a new package which
7442 provides the basic infrastructure for the other packages
7443 and which manages the shared configuration files. (The
7444 <tt>sgml-base</tt> package is a good example.)
7449 <heading>User configuration files ("dotfiles")</heading>
7452 The files in <file>/etc/skel</file> will automatically be
7453 copied into new user accounts by <prgn>adduser</prgn>.
7454 No other program should reference the files in
7455 <file>/etc/skel</file>.
7459 Therefore, if a program needs a dotfile to exist in
7460 advance in <file>$HOME</file> to work sensibly, that dotfile
7461 should be installed in <file>/etc/skel</file> and treated as a
7466 However, programs that require dotfiles in order to
7467 operate sensibly are a bad thing, unless they do create
7468 the dotfiles themselves automatically.
7472 Furthermore, programs should be configured by the Debian
7473 default installation to behave as closely to the upstream
7474 default behavior as possible.
7478 Therefore, if a program in a Debian package needs to be
7479 configured in some way in order to operate sensibly, that
7480 should be done using a site-wide configuration file placed
7481 in <file>/etc</file>. Only if the program doesn't support a
7482 site-wide default configuration and the package maintainer
7483 doesn't have time to add it may a default per-user file be
7484 placed in <file>/etc/skel</file>.
7488 <file>/etc/skel</file> should be as empty as we can make it.
7489 This is particularly true because there is no easy (or
7490 necessarily desirable) mechanism for ensuring that the
7491 appropriate dotfiles are copied into the accounts of
7492 existing users when a package is installed.
7498 <heading>Log files</heading>
7500 Log files should usually be named
7501 <file>/var/log/<var>package</var>.log</file>. If you have many
7502 log files, or need a separate directory for permission
7503 reasons (<file>/var/log</file> is writable only by
7504 <file>root</file>), you should usually create a directory named
7505 <file>/var/log/<var>package</var></file> and place your log
7510 Log files must be rotated occasionally so that they don't
7511 grow indefinitely; the best way to do this is to drop a log
7512 rotation configuration file into the directory
7513 <file>/etc/logrotate.d</file> and use the facilities provided by
7514 logrotate.<footnote>
7516 The traditional approach to log files has been to set up
7517 <em>ad hoc</em> log rotation schemes using simple shell
7518 scripts and cron. While this approach is highly
7519 customizable, it requires quite a lot of sysadmin work.
7520 Even though the original Debian system helped a little
7521 by automatically installing a system which can be used
7522 as a template, this was deemed not enough.
7526 The use of <prgn>logrotate</prgn>, a program developed
7527 by Red Hat, is better, as it centralizes log management.
7528 It has both a configuration file
7529 (<file>/etc/logrotate.conf</file>) and a directory where
7530 packages can drop their individual log rotation
7531 configurations (<file>/etc/logrotate.d</file>).
7534 Here is a good example for a logrotate config
7535 file (for more information see <manref name="logrotate"
7537 <example compact="compact">
7538 /var/log/foo/*.log {
7543 /etc/init.d/foo force-reload
7547 This rotates all files under <file>/var/log/foo</file>, saves 12
7548 compressed generations, and forces the daemon to reload its
7549 configuration information after the log rotation.
7553 Log files should be removed when the package is
7554 purged (but not when it is only removed). This should be
7555 done by the <prgn>postrm</prgn> script when it is called
7556 with the argument <tt>purge</tt> (see <ref
7557 id="removedetails">).
7562 <heading>Permissions and owners</heading>
7565 The rules in this section are guidelines for general use.
7566 If necessary you may deviate from the details below.
7567 However, if you do so you must make sure that what is done
7568 is secure and you should try to be as consistent as possible
7569 with the rest of the system. You should probably also
7570 discuss it on <prgn>debian-devel</prgn> first.
7574 Files should be owned by <tt>root:root</tt>, and made
7575 writable only by the owner and universally readable (and
7576 executable, if appropriate), that is mode 644 or 755.
7580 Directories should be mode 755 or (for group-writability)
7581 mode 2775. The ownership of the directory should be
7582 consistent with its mode: if a directory is mode 2775, it
7583 should be owned by the group that needs write access to
7586 When a package is upgraded, and the owner or permissions
7587 of a file included in the package has changed, dpkg
7588 arranges for the ownership and permissions to be
7589 correctly set upon installation. However, this does not
7590 extend to directories; the permissions and ownership of
7591 directories already on the system does not change on
7592 install or upgrade of packages. This makes sense, since
7593 otherwise common directories like <tt>/usr</tt> would
7594 always be in flux. To correctly change permissions of a
7595 directory the package owns, explicit action is required,
7596 usually in the <tt>postinst</tt> script. Care must be
7597 taken to handle downgrades as well, in that case.
7604 Setuid and setgid executables should be mode 4755 or 2755
7605 respectively, and owned by the appropriate user or group.
7606 They should not be made unreadable (modes like 4711 or
7607 2711 or even 4111); doing so achieves no extra security,
7608 because anyone can find the binary in the freely available
7609 Debian package; it is merely inconvenient. For the same
7610 reason you should not restrict read or execute permissions
7611 on non-set-id executables.
7615 Some setuid programs need to be restricted to particular
7616 sets of users, using file permissions. In this case they
7617 should be owned by the uid to which they are set-id, and by
7618 the group which should be allowed to execute them. They
7619 should have mode 4754; again there is no point in making
7620 them unreadable to those users who must not be allowed to
7625 It is possible to arrange that the system administrator can
7626 reconfigure the package to correspond to their local
7627 security policy by changing the permissions on a binary:
7628 they can do this by using <prgn>dpkg-statoverride</prgn>, as
7629 described below.<footnote>
7630 Ordinary files installed by <prgn>dpkg</prgn> (as
7631 opposed to <tt>conffile</tt>s and other similar objects)
7632 normally have their permissions reset to the distributed
7633 permissions when the package is reinstalled. However,
7634 the use of <prgn>dpkg-statoverride</prgn> overrides this
7635 default behavior. If you use this method, you should
7636 remember to describe <prgn>dpkg-statoverride</prgn> in
7637 the package documentation; being a relatively new
7638 addition to Debian, it is probably not yet well-known.
7640 Another method you should consider is to create a group for
7641 people allowed to use the program(s) and make any setuid
7642 executables executable only by that group.
7646 If you need to create a new user or group for your package
7647 there are two possibilities. Firstly, you may need to
7648 make some files in the binary package be owned by this
7649 user or group, or you may need to compile the user or
7650 group id (rather than just the name) into the binary
7651 (though this latter should be avoided if possible, as in
7652 this case you need a statically allocated id).</p>
7655 If you need a statically allocated id, you must ask for a
7656 user or group id from the <tt>base-passwd</tt> maintainer,
7657 and must not release the package until you have been
7658 allocated one. Once you have been allocated one you must
7659 either make the package depend on a version of the
7660 <tt>base-passwd</tt> package with the id present in
7661 <file>/etc/passwd</file> or <file>/etc/group</file>, or arrange for
7662 your package to create the user or group itself with the
7663 correct id (using <tt>adduser</tt>) in its
7664 <prgn>preinst</prgn> or <prgn>postinst</prgn>. (Doing it in
7665 the <prgn>postinst</prgn> is to be preferred if it is
7666 possible, otherwise a pre-dependency will be needed on the
7667 <tt>adduser</tt> package.)
7671 On the other hand, the program might be able to determine
7672 the uid or gid from the user or group name at runtime, so
7673 that a dynamically allocated id can be used. In this case
7674 you should choose an appropriate user or group name,
7675 discussing this on <prgn>debian-devel</prgn> and checking
7676 with the <package/base-passwd/ maintainer that it is unique and that
7677 they do not wish you to use a statically allocated id
7678 instead. When this has been checked you must arrange for
7679 your package to create the user or group if necessary using
7680 <prgn>adduser</prgn> in the <prgn>preinst</prgn> or
7681 <prgn>postinst</prgn> script (again, the latter is to be
7682 preferred if it is possible).
7686 Note that changing the numeric value of an id associated
7687 with a name is very difficult, and involves searching the
7688 file system for all appropriate files. You need to think
7689 carefully whether a static or dynamic id is required, since
7690 changing your mind later will cause problems.
7693 <sect1><heading>The use of <prgn>dpkg-statoverride</prgn></heading>
7695 This section is not intended as policy, but as a
7696 description of the use of <prgn>dpkg-statoverride</prgn>.
7700 If a system administrator wishes to have a file (or
7701 directory or other such thing) installed with owner and
7702 permissions different from those in the distributed Debian
7703 package, they can use the <prgn>dpkg-statoverride</prgn>
7704 program to instruct <prgn>dpkg</prgn> to use the different
7705 settings every time the file is installed. Thus the
7706 package maintainer should distribute the files with their
7707 normal permissions, and leave it for the system
7708 administrator to make any desired changes. For example, a
7709 daemon which is normally required to be setuid root, but
7710 in certain situations could be used without being setuid,
7711 should be installed setuid in the <tt>.deb</tt>. Then the
7712 local system administrator can change this if they wish.
7713 If there are two standard ways of doing it, the package
7714 maintainer can use <tt>debconf</tt> to find out the
7715 preference, and call <prgn>dpkg-statoverride</prgn> in the
7716 maintainer script if necessary to accommodate the system
7717 administrator's choice. Care must be taken during
7718 upgrades to not override an existing setting.
7722 Given the above, <prgn>dpkg-statoverride</prgn> is
7723 essentially a tool for system administrators and would not
7724 normally be needed in the maintainer scripts. There is
7725 one type of situation, though, where calls to
7726 <prgn>dpkg-statoverride</prgn> would be needed in the
7727 maintainer scripts, and that involves packages which use
7728 dynamically allocated user or group ids. In such a
7729 situation, something like the following idiom can be very
7730 helpful in the package's <prgn>postinst</prgn>, where
7731 <tt>sysuser</tt> is a dynamically allocated id:
7733 for i in /usr/bin/foo /usr/sbin/bar
7735 # only do something when no setting exists
7736 if ! dpkg-statoverride --list $i >/dev/null 2>&1
7738 #include: debconf processing, question about foo and bar
7739 if [ "$RET" = "true" ] ; then
7740 dpkg-statoverride --update --add sysuser root 4755 $i
7745 The corresponding <tt>dpkg-statoverride --remove</tt>
7746 calls can then be made unconditionally when the package is
7754 <chapt id="customized-programs">
7755 <heading>Customized programs</heading>
7757 <sect id="arch-spec">
7758 <heading>Architecture specification strings</heading>
7761 If a program needs to specify an <em>architecture specification
7762 string</em> in some place, it should select one of the
7763 strings provided by <tt>dpkg-architecture -L</tt>. The
7764 strings are in the format
7765 <tt><var>os</var>-<var>arch</var></tt>, though the OS part
7766 is sometimes elided, as when the OS is Linux.<footnote>
7767 <p>Currently, the strings are:
7768 i386 ia64 alpha amd64 armeb arm hppa m32r m68k mips
7769 mipsel powerpc ppc64 s390 s390x sh3 sh3eb sh4 sh4eb
7770 sparc darwin-i386 darwin-ia64 darwin-alpha darwin-amd64
7771 darwin-armeb darwin-arm darwin-hppa darwin-m32r
7772 darwin-m68k darwin-mips darwin-mipsel darwin-powerpc
7773 darwin-ppc64 darwin-s390 darwin-s390x darwin-sh3
7774 darwin-sh3eb darwin-sh4 darwin-sh4eb darwin-sparc
7775 freebsd-i386 freebsd-ia64 freebsd-alpha freebsd-amd64
7776 freebsd-armeb freebsd-arm freebsd-hppa freebsd-m32r
7777 freebsd-m68k freebsd-mips freebsd-mipsel freebsd-powerpc
7778 freebsd-ppc64 freebsd-s390 freebsd-s390x freebsd-sh3
7779 freebsd-sh3eb freebsd-sh4 freebsd-sh4eb freebsd-sparc
7780 kfreebsd-i386 kfreebsd-ia64 kfreebsd-alpha
7781 kfreebsd-amd64 kfreebsd-armeb kfreebsd-arm kfreebsd-hppa
7782 kfreebsd-m32r kfreebsd-m68k kfreebsd-mips
7783 kfreebsd-mipsel kfreebsd-powerpc kfreebsd-ppc64
7784 kfreebsd-s390 kfreebsd-s390x kfreebsd-sh3 kfreebsd-sh3eb
7785 kfreebsd-sh4 kfreebsd-sh4eb kfreebsd-sparc knetbsd-i386
7786 knetbsd-ia64 knetbsd-alpha knetbsd-amd64 knetbsd-armeb
7787 knetbsd-arm knetbsd-hppa knetbsd-m32r knetbsd-m68k
7788 knetbsd-mips knetbsd-mipsel knetbsd-powerpc
7789 knetbsd-ppc64 knetbsd-s390 knetbsd-s390x knetbsd-sh3
7790 knetbsd-sh3eb knetbsd-sh4 knetbsd-sh4eb knetbsd-sparc
7791 netbsd-i386 netbsd-ia64 netbsd-alpha netbsd-amd64
7792 netbsd-armeb netbsd-arm netbsd-hppa netbsd-m32r
7793 netbsd-m68k netbsd-mips netbsd-mipsel netbsd-powerpc
7794 netbsd-ppc64 netbsd-s390 netbsd-s390x netbsd-sh3
7795 netbsd-sh3eb netbsd-sh4 netbsd-sh4eb netbsd-sparc
7796 openbsd-i386 openbsd-ia64 openbsd-alpha openbsd-amd64
7797 openbsd-armeb openbsd-arm openbsd-hppa openbsd-m32r
7798 openbsd-m68k openbsd-mips openbsd-mipsel openbsd-powerpc
7799 openbsd-ppc64 openbsd-s390 openbsd-s390x openbsd-sh3
7800 openbsd-sh3eb openbsd-sh4 openbsd-sh4eb openbsd-sparc
7801 hurd-i386 hurd-ia64 hurd-alpha hurd-amd64 hurd-armeb
7802 hurd-arm hurd-hppa hurd-m32r hurd-m68k hurd-mips
7803 hurd-mipsel hurd-powerpc hurd-ppc64 hurd-s390 hurd-s390x
7804 hurd-sh3 hurd-sh3eb hurd-sh4 hurd-sh4eb hurd-sparc
7810 Note that we don't want to use
7811 <tt><var>arch</var>-debian-linux</tt> to apply to the rule
7812 <tt><var>architecture</var>-<var>vendor</var>-<var>os</var></tt>
7813 since this would make our programs incompatible with other
7814 Linux distributions. We also don't use something like
7815 <tt><var>arch</var>-unknown-linux</tt>, since the
7816 <tt>unknown</tt> does not look very good.
7821 <heading>Daemons</heading>
7824 The configuration files <file>/etc/services</file>,
7825 <file>/etc/protocols</file>, and <file>/etc/rpc</file> are managed
7826 by the <prgn>netbase</prgn> package and must not be modified
7831 If a package requires a new entry in one of these files, the
7832 maintainer should get in contact with the
7833 <prgn>netbase</prgn> maintainer, who will add the entries
7834 and release a new version of the <prgn>netbase</prgn>
7839 The configuration file <file>/etc/inetd.conf</file> must not be
7840 modified by the package's scripts except via the
7841 <prgn>update-inetd</prgn> script or the
7842 <file>DebianNet.pm</file> Perl module. See their documentation
7843 for details on how to add entries.
7847 If a package wants to install an example entry into
7848 <file>/etc/inetd.conf</file>, the entry must be preceded with
7849 exactly one hash character (<tt>#</tt>). Such lines are
7850 treated as "commented out by user" by the
7851 <prgn>update-inetd</prgn> script and are not changed or
7852 activated during package updates.
7857 <heading>Using pseudo-ttys and modifying wtmp, utmp and
7861 Some programs need to create pseudo-ttys. This should be done
7862 using Unix98 ptys if the C library supports it. The resulting
7863 program must not be installed setuid root, unless that
7864 is required for other functionality.
7868 The files <file>/var/run/utmp</file>, <file>/var/log/wtmp</file> and
7869 <file>/var/log/lastlog</file> must be installed writable by
7870 group <tt>utmp</tt>. Programs which need to modify those
7871 files must be installed setgid <tt>utmp</tt>.
7876 <heading>Editors and pagers</heading>
7879 Some programs have the ability to launch an editor or pager
7880 program to edit or display a text document. Since there are
7881 lots of different editors and pagers available in the Debian
7882 distribution, the system administrator and each user should
7883 have the possibility to choose their preferred editor and
7888 In addition, every program should choose a good default
7889 editor/pager if none is selected by the user or system
7894 Thus, every program that launches an editor or pager must
7895 use the EDITOR or PAGER environment variable to determine
7896 the editor or pager the user wishes to use. If these
7897 variables are not set, the programs <file>/usr/bin/editor</file>
7898 and <file>/usr/bin/pager</file> should be used, respectively.
7902 These two files are managed through the <prgn>dpkg</prgn>
7903 "alternatives" mechanism. Thus every package providing an
7904 editor or pager must call the
7905 <prgn>update-alternatives</prgn> script to register these
7910 If it is very hard to adapt a program to make use of the
7911 EDITOR or PAGER variables, that program may be configured to
7912 use <file>/usr/bin/sensible-editor</file> and
7913 <file>/usr/bin/sensible-pager</file> as the editor or pager
7914 program respectively. These are two scripts provided in the
7915 Debian base system that check the EDITOR and PAGER variables
7916 and launch the appropriate program, and fall back to
7917 <file>/usr/bin/editor</file> and <file>/usr/bin/pager</file> if the
7918 variable is not set.
7922 A program may also use the VISUAL environment variable to
7923 determine the user's choice of editor. If it exists, it
7924 should take precedence over EDITOR. This is in fact what
7925 <file>/usr/bin/sensible-editor</file> does.
7929 It is not required for a package to depend on
7930 <tt>editor</tt> and <tt>pager</tt>, nor is it required for a
7931 package to provide such virtual packages.<footnote>
7932 The Debian base system already provides an editor and a
7938 <sect id="web-appl">
7939 <heading>Web servers and applications</heading>
7942 This section describes the locations and URLs that should
7943 be used by all web servers and web applications in the
7950 Cgi-bin executable files are installed in the
7952 <example compact="compact">
7953 /usr/lib/cgi-bin/<var>cgi-bin-name</var>
7955 and should be referred to as
7956 <example compact="compact">
7957 http://localhost/cgi-bin/<var>cgi-bin-name</var>
7963 <p>Access to HTML documents</p>
7966 HTML documents for a package are stored in
7967 <file>/usr/share/doc/<var>package</var></file>
7968 and can be referred to as
7969 <example compact="compact">
7970 http://localhost/doc/<var>package</var>/<var>filename</var>
7975 The web server should restrict access to the document
7976 tree so that only clients on the same host can read
7977 the documents. If the web server does not support such
7978 access controls, then it should not provide access at
7979 all, or ask about providing access during installation.
7984 <p>Access to images</p>
7986 It is recommended that images for a package be stored
7987 in <tt>/usr/share/images/<var>package</var></tt> and
7988 may be referred to through an alias <tt>/images/</tt>
7991 http://localhost/images/<package>/<filename>
7998 <p>Web Document Root</p>
8001 Web Applications should try to avoid storing files in
8002 the Web Document Root. Instead they should use the
8003 /usr/share/doc/<var>package</var> directory for
8004 documents and register the Web Application via the
8005 <package>doc-base</package> package. If access to the
8006 web document root is unavoidable then use
8007 <example compact="compact">
8010 as the Document Root. This might be just a symbolic
8011 link to the location where the system administrator
8012 has put the real document root.
8015 <item><p>Providing httpd and/or httpd-cgi</p>
8017 All web servers should provide the virtual package
8018 <tt>httpd</tt>. If a web server has CGI support it should
8019 provide <tt>httpd-cgi</tt> additionally.
8022 All web applications which do not contain CGI scripts should
8023 depend on <tt>httpd</tt>, all those web applications which
8024 <tt>do</tt> contain CGI scripts, should depend on
8032 <sect id="mail-transport-agents">
8033 <heading>Mail transport, delivery and user agents</heading>
8036 Debian packages which process electronic mail, whether mail
8037 user agents (MUAs) or mail transport agents (MTAs), must
8038 ensure that they are compatible with the configuration
8039 decisions below. Failure to do this may result in lost
8040 mail, broken <tt>From:</tt> lines, and other serious brain
8045 The mail spool is <file>/var/mail</file> and the interface to
8046 send a mail message is <file>/usr/sbin/sendmail</file> (as per
8047 the FHS). On older systems, the mail spool may be
8048 physically located in <file>/var/spool/mail</file>, but all
8049 access to the mail spool should be via the
8050 <file>/var/mail</file> symlink. The mail spool is part of the
8051 base system and not part of the MTA package.
8055 All Debian MUAs, MTAs, MDAs and other mailbox accessing
8056 programs (such as IMAP daemons) must lock the mailbox in an
8057 NFS-safe way. This means that <tt>fcntl()</tt> locking must
8058 be combined with dot locking. To avoid deadlocks, a program
8059 should use <tt>fcntl()</tt> first and dot locking after
8060 this, or alternatively implement the two locking methods in
8061 a non blocking way<footnote>
8062 If it is not possible to establish both locks, the
8063 system shouldn't wait for the second lock to be
8064 established, but remove the first lock, wait a (random)
8065 time, and start over locking again.
8066 </footnote>. Using the functions <tt>maillock</tt> and
8067 <tt>mailunlock</tt> provided by the
8068 <tt>liblockfile*</tt><footnote>
8069 You will need to depend on <tt>liblockfile1 (>>1.01)</tt>
8070 to use these functions.
8071 </footnote> packages is the recommended way to realize this.
8075 Mailboxes are generally mode 660
8076 <tt><var>user</var>:mail</tt> unless the system
8077 administrator has chosen otherwise. A MUA may remove a
8078 mailbox (unless it has nonstandard permissions) in which
8079 case the MTA or another MUA must recreate it if needed.
8080 Mailboxes must be writable by group mail.
8084 The mail spool is 2775 <tt>root:mail</tt>, and MUAs should
8085 be setgid mail to do the locking mentioned above (and
8086 must obviously avoid accessing other users' mailboxes
8087 using this privilege).</p>
8090 <file>/etc/aliases</file> is the source file for the system mail
8091 aliases (e.g., postmaster, usenet, etc.), it is the one
8092 which the sysadmin and <prgn>postinst</prgn> scripts may
8093 edit. After <file>/etc/aliases</file> is edited the program or
8094 human editing it must call <prgn>newaliases</prgn>. All MTA
8095 packages must come with a <prgn>newaliases</prgn> program,
8096 even if it does nothing, but older MTA packages did not do
8097 this so programs should not fail if <prgn>newaliases</prgn>
8098 cannot be found. Note that because of this, all MTA
8099 packages must have <tt>Provides</tt>, <tt>Conflicts</tt> and
8100 <tt>Replaces: mail-transport-agent</tt> control file
8105 The convention of writing <tt>forward to
8106 <var>address</var></tt> in the mailbox itself is not
8107 supported. Use a <tt>.forward</tt> file instead.</p>
8110 The <prgn>rmail</prgn> program used by UUCP
8111 for incoming mail should be <file>/usr/sbin/rmail</file>.
8112 Likewise, <prgn>rsmtp</prgn>, for receiving
8113 batch-SMTP-over-UUCP, should be <file>/usr/sbin/rsmtp</file> if it
8117 If your package needs to know what hostname to use on (for
8118 example) outgoing news and mail messages which are generated
8119 locally, you should use the file <file>/etc/mailname</file>. It
8120 will contain the portion after the username and <tt>@</tt>
8121 (at) sign for email addresses of users on the machine
8122 (followed by a newline).
8126 Such a package should check for the existence of this file
8127 when it is being configured. If it exists, it should be
8128 used without comment, although an MTA's configuration script
8129 may wish to prompt the user even if it finds that this file
8130 exists. If the file does not exist, the package should
8131 prompt the user for the value (preferably using
8132 <prgn>debconf</prgn>) and store it in <file>/etc/mailname</file>
8133 as well as using it in the package's configuration. The
8134 prompt should make it clear that the name will not just be
8135 used by that package. For example, in this situation the
8136 <tt>inn</tt> package could say something like:
8137 <example compact="compact">
8138 Please enter the "mail name" of your system. This is the
8139 hostname portion of the address to be shown on outgoing
8140 news and mail messages. The default is
8141 <var>syshostname</var>, your system's host name. Mail
8142 name ["<var>syshostname</var>"]:
8144 where <var>syshostname</var> is the output of <tt>hostname
8150 <heading>News system configuration</heading>
8153 All the configuration files related to the NNTP (news)
8154 servers and clients should be located under
8155 <file>/etc/news</file>.</p>
8158 There are some configuration issues that apply to a number
8159 of news clients and server packages on the machine. These
8163 <tag><file>/etc/news/organization</file></tag>
8165 A string which should appear as the
8166 organization header for all messages posted
8167 by NNTP clients on the machine
8170 <tag><file>/etc/news/server</file></tag>
8172 Contains the FQDN of the upstream NNTP
8173 server, or localhost if the local machine is
8178 Other global files may be added as required for cross-package news
8185 <heading>Programs for the X Window System</heading>
8188 <heading>Providing X support and package priorities</heading>
8191 Programs that can be configured with support for the X
8192 Window System must be configured to do so and must declare
8193 any package dependencies necessary to satisfy their
8194 runtime requirements when using the X Window System. If
8195 such a package is of higher priority than the X packages
8196 on which it depends, it is required that either the
8197 X-specific components be split into a separate package, or
8198 that an alternative version of the package, which includes
8199 X support, be provided, or that the package's priority be
8205 <heading>Packages providing an X server</heading>
8208 Packages that provide an X server that, directly or
8209 indirectly, communicates with real input and display
8210 hardware should declare in their control data that they
8211 provide the virtual package <tt>xserver</tt>.<footnote>
8212 This implements current practice, and provides an
8213 actual policy for usage of the <tt>xserver</tt>
8214 virtual package which appears in the virtual packages
8215 list. In a nutshell, X servers that interface
8216 directly with the display and input hardware or via
8217 another subsystem (e.g., GGI) should provide
8218 <tt>xserver</tt>. Things like <tt>Xvfb</tt>,
8219 <tt>Xnest</tt>, and <tt>Xprt</tt> should not.
8225 <heading>Packages providing a terminal emulator</heading>
8228 Packages that provide a terminal emulator for the X Window
8229 System which meet the criteria listed below should declare
8230 in their control data that they provide the virtual
8231 package <tt>x-terminal-emulator</tt>. They should also
8232 register themselves as an alternative for
8233 <file>/usr/bin/x-terminal-emulator</file>, with a priority of
8238 To be an <tt>x-terminal-emulator</tt>, a program must:
8239 <list compact="compact">
8241 Be able to emulate a DEC VT100 terminal, or a
8242 compatible terminal.
8246 Support the command-line option <tt>-e
8247 <var>command</var></tt>, which creates a new
8248 terminal window<footnote>
8249 "New terminal window" does not necessarily mean
8250 a new top-level X window directly parented by
8251 the window manager; it could, if the terminal
8252 emulator application were so coded, be a new
8253 "view" in a multiple-document interface (MDI).
8255 and runs the specified <var>command</var>,
8256 interpreting the entirety of the rest of the command
8257 line as a command to pass straight to exec, in the
8258 manner that <tt>xterm</tt> does.
8262 Support the command-line option <tt>-T
8263 <var>title</var></tt>, which creates a new terminal
8264 window with the window title <var>title</var>.
8271 <heading>Packages providing a window manager</heading>
8274 Packages that provide a window manager should declare in
8275 their control data that they provide the virtual package
8276 <tt>x-window-manager</tt>. They should also register
8277 themselves as an alternative for
8278 <file>/usr/bin/x-window-manager</file>, with a priority
8279 calculated as follows:
8280 <list compact="compact">
8282 Start with a priority of 20.
8286 If the window manager supports the Debian menu
8287 system, add 20 points if this support is available
8288 in the package's default configuration (i.e., no
8289 configuration files belonging to the system or user
8290 have to be edited to activate the feature); if
8291 configuration files must be modified, add only 10
8297 If the window manager complies with <url
8298 id="http://www.freedesktop.org/Standards/wm-spec"
8299 name="The Window Manager Specification Project">,
8300 written by the <url id="http://www.freedesktop.org/"
8301 name="Free Desktop Group">, add 40 points.
8305 If the window manager permits the X session to be
8306 restarted using a <em>different</em> window manager
8307 (without killing the X server) in its default
8308 configuration, add 10 points; otherwise add none.
8315 <heading>Packages providing fonts</heading>
8318 Packages that provide fonts for the X Window
8320 For the purposes of Debian Policy, a "font for the X
8321 Window System" is one which is accessed via X protocol
8322 requests. Fonts for the Linux console, for PostScript
8323 renderer, or any other purpose, do not fit this
8324 definition. Any tool which makes such fonts available
8325 to the X Window System, however, must abide by this
8328 must do a number of things to ensure that they are both
8329 available without modification of the X or font server
8330 configuration, and that they do not corrupt files used by
8331 other font packages to register information about
8335 Fonts of any type supported by the X Window System
8336 must be in a separate binary package from any
8337 executables, libraries, or documentation (except
8338 that specific to the fonts shipped, such as their
8339 license information). If one or more of the fonts
8340 so packaged are necessary for proper operation of
8341 the package with which they are associated the font
8342 package may be Recommended; if the fonts merely
8343 provide an enhancement, a Suggests relationship may
8344 be used. Packages must not Depend on font
8346 This is because the X server may retrieve fonts
8347 from the local file system or over the network
8348 from an X font server; the Debian package system
8349 is empowered to deal only with the local
8355 BDF fonts must be converted to PCF fonts with the
8356 <prgn>bdftopcf</prgn> utility (available in the
8357 <tt>xfonts-utils</tt> package, <prgn>gzip</prgn>ped, and
8358 placed in a directory that corresponds to their
8360 <list compact="compact">
8362 100 dpi fonts must be placed in
8363 <file>/usr/share/fonts/X11/100dpi/</file>.
8367 75 dpi fonts must be placed in
8368 <file>/usr/share/fonts/X11/75dpi/</file>.
8372 Character-cell fonts, cursor fonts, and other
8373 low-resolution fonts must be placed in
8374 <file>/usr/share/fonts/X11/misc/</file>.
8380 Speedo fonts must be placed in
8381 <file>/usr/share/fonts/X11/Speedo/</file>.
8385 Type 1 fonts must be placed in
8386 <file>/usr/share/fonts/X11/Type1/</file>. If font
8387 metric files are available, they must be placed here
8392 Subdirectories of <file>/usr/share/fonts/X11/</file>
8393 other than those listed above must be neither
8394 created nor used. (The <file>PEX</file>, <file>CID</file>,
8395 and <file>cyrillic</file> directories are excepted for
8396 historical reasons, but installation of files into
8397 these directories remains discouraged.)
8401 Font packages may, instead of placing files directly
8402 in the X font directories listed above, provide
8403 symbolic links in that font directory pointing to
8404 the files' actual location in the filesystem. Such
8405 a location must comply with the FHS.
8409 Font packages should not contain both 75dpi and
8410 100dpi versions of a font. If both are available,
8411 they should be provided in separate binary packages
8412 with <tt>-75dpi</tt> or <tt>-100dpi</tt> appended to
8413 the names of the packages containing the
8414 corresponding fonts.
8418 Fonts destined for the <file>misc</file> subdirectory
8419 should not be included in the same package as 75dpi
8420 or 100dpi fonts; instead, they should be provided in
8421 a separate package with <tt>-misc</tt> appended to
8426 Font packages must not provide the files
8427 <file>fonts.dir</file>, <file>fonts.alias</file>, or
8428 <file>fonts.scale</file> in a font directory:
8431 <file>fonts.dir</file> files must not be provided at all.
8435 <file>fonts.alias</file> and <file>fonts.scale</file>
8436 files, if needed, should be provided in the
8438 <file>/etc/X11/fonts/<var>fontdir</var>/<var>package</var>.<var>extension</var></file>,
8439 where <var>fontdir</var> is the name of the
8441 <file>/usr/share/fonts/X11/</file> where the
8442 package's corresponding fonts are stored
8443 (e.g., <tt>75dpi</tt> or <tt>misc</tt>),
8444 <var>package</var> is the name of the package
8445 that provides these fonts, and
8446 <var>extension</var> is either <tt>scale</tt>
8447 or <tt>alias</tt>, whichever corresponds to
8454 Font packages must declare a dependency on
8455 <tt>xfonts-utils</tt> in their control
8460 Font packages that provide one or more
8461 <file>fonts.scale</file> files as described above must
8462 invoke <prgn>update-fonts-scale</prgn> on each
8463 directory into which they installed fonts
8464 <em>before</em> invoking
8465 <prgn>update-fonts-dir</prgn> on that directory.
8466 This invocation must occur in both the
8467 <prgn>postinst</prgn> (for all arguments) and
8468 <prgn>postrm</prgn> (for all arguments except
8469 <tt>upgrade</tt>) scripts.
8473 Font packages that provide one or more
8474 <file>fonts.alias</file> files as described above must
8475 invoke <prgn>update-fonts-alias</prgn> on each
8476 directory into which they installed fonts. This
8477 invocation must occur in both the
8478 <prgn>postinst</prgn> (for all arguments) and
8479 <prgn>postrm</prgn> (for all arguments except
8480 <tt>upgrade</tt>) scripts.
8484 Font packages must invoke
8485 <prgn>update-fonts-dir</prgn> on each directory into
8486 which they installed fonts. This invocation must
8487 occur in both the <prgn>postinst</prgn> (for all
8488 arguments) and <prgn>postrm</prgn> (for all
8489 arguments except <tt>upgrade</tt>) scripts.
8493 Font packages must not provide alias names for the
8494 fonts they include which collide with alias names
8495 already in use by fonts already packaged.
8499 Font packages must not provide fonts with the same
8500 XLFD registry name as another font already packaged.
8507 <heading>Application defaults files</heading>
8510 Application defaults files must be installed in the
8511 directory <file>/etc/X11/app-defaults/</file> (use of a
8512 localized subdirectory of <file>/etc/X11/</file> as described
8513 in the <em>X Toolkit Intrinsics - C Language
8514 Interface</em> manual is also permitted). They must be
8515 registered as <tt>conffile</tt>s or handled as
8516 configuration files.
8520 Customization of programs' X resources may also be
8521 supported with the provision of a file with the same name
8522 as that of the package placed in the
8523 <file>/etc/X11/Xresources/</file> directory, which must
8524 registered as a <tt>conffile</tt> or handled as a
8525 configuration file.<footnote>
8526 Note that this mechanism is not the same as using
8527 app-defaults; app-defaults are tied to the client
8528 binary on the local file system, whereas X resources
8529 are stored in the X server and affect all connecting
8536 <heading>Installation directory issues</heading>
8539 Packages using the X Window System should not be
8540 configured to install files under the
8541 <file>/usr/X11R6/</file> directory. The
8542 <file>/usr/X11R6/</file> directory hierarchy should be
8543 regarded as obsolete.
8547 Programs that use GNU <prgn>autoconf</prgn> and
8548 <prgn>automake</prgn> are usually easily configured at
8549 compile time to use <file>/usr/</file> instead of
8550 <file>/usr/X11R6/</file>, and this should be done whenever
8551 possible. Configuration files for window managers and
8552 display managers should be placed in a subdirectory of
8553 <file>/etc/X11/</file> corresponding to the package name due
8554 to these programs' tight integration with the mechanisms
8555 of the X Window System. Application-level programs should
8556 use the <file>/etc/</file> directory unless otherwise mandated
8561 The installation of files into subdirectories
8562 of <file>/usr/X11R6/include/X11/</file> and
8563 <file>/usr/X11R6/lib/X11/</file> is now prohibited;
8564 package maintainers should determine if subdirectories of
8565 <file>/usr/lib/</file> and <file>/usr/share/</file> can be used
8570 Packages should install any relevant files into the
8571 directories <file>/usr/include/X11/</file> and
8572 <file>/usr/lib/X11/</file>, but if they do so, they must
8573 pre-depend on <tt>x11-common (>=
8574 1:7.0.0)</tt><footnote>
8576 These libraries used to be all symbolic
8577 links. However, with <tt>X11R7</tt>,
8578 <tt>/usr/include/X11</tt> and <tt>/usr/lib/X11</tt>
8579 are now real directories, and packages
8580 <strong>should</strong> ship their files here instead
8581 of in <tt>/usr/X11R6/{include,lib}/X11</tt>.
8582 <tt>x11-common (>= 1:7.0.0) </tt> is the package
8583 responsible for converting these symlinks into
8591 <heading>The OSF/Motif and OpenMotif libraries</heading>
8594 <em>Programs that require the non-DFSG-compliant OSF/Motif or
8595 OpenMotif libraries</em><footnote>
8596 OSF/Motif and OpenMotif are collectively referred to as
8597 "Motif" in this policy document.
8599 should be compiled against and tested with LessTif (a free
8600 re-implementation of Motif) instead. If the maintainer
8601 judges that the program or programs do not work
8602 sufficiently well with LessTif to be distributed and
8603 supported, but do so when compiled against Motif, then two
8604 versions of the package should be created; one linked
8605 statically against Motif and with <tt>-smotif</tt>
8606 appended to the package name, and one linked dynamically
8607 against Motif and with <tt>-dmotif</tt> appended to the
8612 Both Motif-linked versions are dependent
8613 upon non-DFSG-compliant software and thus cannot be
8614 uploaded to the <em>main</em> distribution; if the
8615 software is itself DFSG-compliant it may be uploaded to
8616 the <em>contrib</em> distribution. While known existing
8617 versions of Motif permit unlimited redistribution of
8618 binaries linked against the library (whether statically or
8619 dynamically), it is the package maintainer's
8620 responsibility to determine whether this is permitted by
8621 the license of the copy of Motif in their possession.
8627 <heading>Perl programs and modules</heading>
8630 Perl programs and modules should follow the current Perl policy.
8634 The Perl policy can be found in the <tt>perl-policy</tt>
8635 files in the <tt>debian-policy</tt> package.
8636 It is also available from the Debian web mirrors at
8637 <tt><url name="/doc/packaging-manuals/perl-policy/"
8638 id="http://www.debian.org/doc/packaging-manuals/perl-policy/"></tt>.
8643 <heading>Emacs lisp programs</heading>
8646 Please refer to the "Debian Emacs Policy" for details of how to
8647 package emacs lisp programs.
8651 The Emacs policy is available in
8652 <file>debian-emacs-policy.gz</file> of the
8653 <package>emacsen-common</package> package.
8654 It is also available from the Debian web mirrors at
8655 <tt><url name="/doc/packaging-manuals/debian-emacs-policy"
8656 id="http://www.debian.org/doc/packaging-manuals/debian-emacs-policy"></tt>.
8661 <heading>Games</heading>
8664 The permissions on <file>/var/games</file> are mode 755, owner
8665 <tt>root</tt> and group <tt>root</tt>.
8669 Each game decides on its own security policy.</p>
8672 Games which require protected, privileged access to
8673 high-score files, saved games, etc., may be made
8674 set-<em>group</em>-id (mode 2755) and owned by
8675 <tt>root:games</tt>, and use files and directories with
8676 appropriate permissions (770 <tt>root:games</tt>, for
8677 example). They must not be made
8678 set-<em>user</em>-id, as this causes security problems. (If
8679 an attacker can subvert any set-user-id game they can
8680 overwrite the executable of any other, causing other players
8681 of these games to run a Trojan horse program. With a
8682 set-group-id game the attacker only gets access to less
8683 important game data, and if they can get at the other
8684 players' accounts at all it will take considerably more
8688 Some packages, for example some fortune cookie programs, are
8689 configured by the upstream authors to install with their
8690 data files or other static information made unreadable so
8691 that they can only be accessed through set-id programs
8692 provided. You should not do this in a Debian package: anyone can
8693 download the <file>.deb</file> file and read the data from it,
8694 so there is no point making the files unreadable. Not
8695 making the files unreadable also means that you don't have
8696 to make so many programs set-id, which reduces the risk of a
8700 As described in the FHS, binaries of games should be
8701 installed in the directory <file>/usr/games</file>. This also
8702 applies to games that use the X Window System. Manual pages
8703 for games (X and non-X games) should be installed in
8704 <file>/usr/share/man/man6</file>.</p>
8710 <heading>Documentation</heading>
8713 <heading>Manual pages</heading>
8716 You should install manual pages in <prgn>nroff</prgn> source
8717 form, in appropriate places under <file>/usr/share/man</file>.
8718 You should only use sections 1 to 9 (see the FHS for more
8719 details). You must not install a pre-formatted "cat page".
8723 Each program, utility, and function should have an
8724 associated manual page included in the same package. It is
8725 suggested that all configuration files also have a manual
8726 page included as well. Manual pages for protocols and other
8727 auxiliary things are optional.
8731 If no manual page is available, this is considered as a bug
8732 and should be reported to the Debian Bug Tracking System (the
8733 maintainer of the package is allowed to write this bug report
8734 themselves, if they so desire). Do not close the bug report
8735 until a proper man page is available.<footnote>
8736 It is not very hard to write a man page. See the
8737 <url id="http://www.schweikhardt.net/man_page_howto.html"
8738 name="Man-Page-HOWTO">,
8739 <manref name="man" section="7">, the examples
8740 created by <prgn>debmake</prgn> or <prgn>dh_make</prgn>,
8741 the helper programs <prgn>help2man</prgn>, or the
8742 directory <file>/usr/share/doc/man-db/examples</file>.
8747 You may forward a complaint about a missing man page to the
8748 upstream authors, and mark the bug as forwarded in the
8749 Debian bug tracking system. Even though the GNU Project do
8750 not in general consider the lack of a man page to be a bug,
8751 we do; if they tell you that they don't consider it a bug
8752 you should leave the bug in our bug tracking system open
8757 Manual pages should be installed compressed using <tt>gzip -9</tt>.
8761 If one man page needs to be accessible via several names it
8762 is better to use a symbolic link than the <file>.so</file>
8763 feature, but there is no need to fiddle with the relevant
8764 parts of the upstream source to change from <file>.so</file> to
8765 symlinks: don't do it unless it's easy. You should not
8766 create hard links in the manual page directories, nor put
8767 absolute filenames in <file>.so</file> directives. The filename
8768 in a <file>.so</file> in a man page should be relative to the
8769 base of the man page tree (usually
8770 <file>/usr/share/man</file>). If you do not create any links
8771 (whether symlinks, hard links, or <tt>.so</tt> directives)
8772 in the file system to the alternate names of the man page,
8773 then you should not rely on <prgn>man</prgn> finding your
8774 man page under those names based solely on the information in
8775 the man page's header.<footnote>
8776 Supporting this in <prgn>man</prgn> often requires
8777 unreasonable processing time to find a manual page or to
8778 report that none exists, and moves knowledge into man's
8779 database that would be better left in the file system.
8780 This support is therefore deprecated and will cease to
8781 be present in the future.
8786 Manual pages in locale-specific subdirectories of
8787 <file>/usr/share/man</file> should use either UTF-8 or the usual
8788 legacy encoding for that language (normally the one corresponding
8789 to the shortest relevant locale name in
8790 <file>/usr/share/i18n/SUPPORTED</file>). For example, pages under
8791 <file>/usr/share/man/fr</file> should use either UTF-8 or
8792 ISO-8859-1.<footnote>
8793 <prgn>man</prgn> will automatically detect whether UTF-8 is in
8794 use. In future, all manual pages will be required to use
8800 A country name (the <tt>DE</tt> in <tt>de_DE</tt>) should not be
8801 included in the subdirectory name unless it indicates a
8802 significant difference in the language, as this excludes
8803 speakers of the language in other countries.<footnote>
8804 At the time of writing, Chinese and Portuguese are the main
8805 languages with such differences, so <file>pt_BR</file>,
8806 <file>zh_CN</file>, and <file>zh_TW</file> are all allowed.
8811 Due to limitations in current implementations, all characters
8812 in the manual page source should be representable in the usual
8813 legacy encoding for that language, even if the file is
8814 actually encoded in UTF-8. Safe alternative ways to write many
8815 characters outside that range may be found in
8816 <manref name="groff_char" section="7">.
8821 <heading>Info documents</heading>
8824 Info documents should be installed in <file>/usr/share/info</file>.
8825 They should be compressed with <tt>gzip -9</tt>.
8829 Your package should call <prgn>install-info</prgn> to update
8830 the Info <file>dir</file> file in its <prgn>postinst</prgn>
8831 script when called with a <tt>configure</tt> argument, for
8833 <example compact="compact">
8834 install-info --quiet --section Development Development \
8835 /usr/share/info/foobar.info
8839 It is a good idea to specify a section for the location of
8840 your program; this is done with the <tt>--section</tt>
8841 switch. To determine which section to use, you should look
8842 at <file>/usr/share/info/dir</file> on your system and choose the most
8843 relevant (or create a new section if none of the current
8844 sections are relevant). Note that the <tt>--section</tt>
8845 flag takes two arguments; the first is a regular expression
8846 to match (case-insensitively) against an existing section,
8847 the second is used when creating a new one.</p>
8850 You should remove the entries in the <prgn>prerm</prgn>
8851 script when called with a <tt>remove</tt> argument:
8852 <example compact="compact">
8853 install-info --quiet --remove /usr/share/info/foobar.info
8857 If <prgn>install-info</prgn> cannot find a description entry
8858 in the Info file you must supply one. See <manref
8859 name="install-info" section="8"> for details.</p>
8863 <heading>Additional documentation</heading>
8866 Any additional documentation that comes with the package may
8867 be installed at the discretion of the package maintainer.
8868 Plain text documentation should be installed in the directory
8869 <file>/usr/share/doc/<var>package</var></file>, where
8870 <var>package</var> is the name of the package, and
8871 compressed with <tt>gzip -9</tt> unless it is small.
8875 If a package comes with large amounts of documentation which
8876 many users of the package will not require you should create
8877 a separate binary package to contain it, so that it does not
8878 take up disk space on the machines of users who do not need
8879 or want it installed.</p>
8882 It is often a good idea to put text information files
8883 (<file>README</file>s, changelogs, and so forth) that come with
8884 the source package in <file>/usr/share/doc/<var>package</var></file>
8885 in the binary package. However, you don't need to install
8886 the instructions for building and installing the package, of
8890 Packages must not require the existence of any files in
8891 <file>/usr/share/doc/</file> in order to function
8893 The system administrator should be able to
8894 delete files in <file>/usr/share/doc/</file> without causing
8895 any programs to break.
8897 Any files that are referenced by programs but are also
8898 useful as stand alone documentation should be installed under
8899 <file>/usr/share/<var>package</var>/</file> with symbolic links from
8900 <file>/usr/share/doc/<var>package</var></file>.
8904 <file>/usr/share/doc/<var>package</var></file> may be a symbolic
8905 link to another directory in <file>/usr/share/doc</file> only if
8906 the two packages both come from the same source and the
8907 first package Depends on the second.<footnote>
8909 Please note that this does not override the section on
8910 changelog files below, so the file
8911 <file>/usr/share/<var>package</var>/changelog.Debian.gz</file>
8912 must refer to the changelog for the current version of
8913 <var>package</var> in question. In practice, this means
8914 that the sources of the target and the destination of the
8915 symlink must be the same (same source package and
8922 Former Debian releases placed all additional documentation
8923 in <file>/usr/doc/<var>package</var></file>. This has been
8924 changed to <file>/usr/share/doc/<var>package</var></file>,
8925 and packages must not put documentation in the directory
8926 <file>/usr/doc/<var>package</var></file>. <footnote>
8927 At this phase of the transition, we no longer require a
8928 symbolic link in <file>/usr/doc/</file>. At a later point,
8929 policy shall change to make the symbolic links a bug.
8935 <heading>Preferred documentation formats</heading>
8938 The unification of Debian documentation is being carried out
8942 If your package comes with extensive documentation in a
8943 markup format that can be converted to various other formats
8944 you should if possible ship HTML versions in a binary
8945 package, in the directory
8946 <file>/usr/share/doc/<var>appropriate-package</var></file> or
8947 its subdirectories.<footnote>
8948 The rationale: The important thing here is that HTML
8949 docs should be available in <em>some</em> package, not
8950 necessarily in the main binary package.
8955 Other formats such as PostScript may be provided at the
8956 package maintainer's discretion.
8960 <sect id="copyrightfile">
8961 <heading>Copyright information</heading>
8964 Every package must be accompanied by a verbatim copy of its
8965 copyright and distribution license in the file
8966 <file>/usr/share/doc/<var>package</var>/copyright</file>. This
8967 file must neither be compressed nor be a symbolic link.
8971 In addition, the copyright file must say where the upstream
8972 sources (if any) were obtained. It should name the original
8973 authors of the package and the Debian maintainer(s) who were
8974 involved with its creation.
8978 Packages in the <em>contrib</em> or <em>non-free</em> categories
8979 should state in the copyright file that the package is not part
8980 of the Debian GNU/Linux distribution and briefly explain why.
8984 A copy of the file which will be installed in
8985 <file>/usr/share/doc/<var>package</var>/copyright</file> should
8986 be in <file>debian/copyright</file> in the source package.
8990 <file>/usr/share/doc/<var>package</var></file> may be a symbolic
8991 link to another directory in <file>/usr/share/doc</file> only if
8992 the two packages both come from the same source and the
8993 first package Depends on the second. These rules are
8994 important because copyrights must be extractable by
8999 Packages distributed under the UCB BSD license, the Apache
9000 license (version 2.0), the Artistic license, the GNU GPL
9001 (version 2 or 3), the GNU LGPL (versions 2, 2.1, or 3), and
9002 the GNU FDL (version 1.2) should refer to the corresponding
9003 files under <file>/usr/share/common-licenses</file>,<footnote>
9006 <file>/usr/share/common-licenses/BSD</file>,
9007 <file>/usr/share/common-licenses/Apache-2.0</file>,
9008 <file>/usr/share/common-licenses/Artistic</file>,
9009 <file>/usr/share/common-licenses/GPL-2</file>,
9010 <file>/usr/share/common-licenses/GPL-3</file>,
9011 <file>/usr/share/common-licenses/LGPL-2</file>,
9012 <file>/usr/share/common-licenses/LGPL-2.1</file>,
9013 <file>/usr/share/common-licenses/LGPL-3</file>, and
9014 <file>/usr/share/common-licenses/GFDL-1.2</file>
9017 </footnote> rather than quoting them in the copyright
9022 You should not use the copyright file as a general <file>README</file>
9023 file. If your package has such a file it should be
9024 installed in <file>/usr/share/doc/<var>package</var>/README</file> or
9025 <file>README.Debian</file> or some other appropriate place.</p>
9029 <heading>Examples</heading>
9032 Any examples (configurations, source files, whatever),
9033 should be installed in a directory
9034 <file>/usr/share/doc/<var>package</var>/examples</file>. These
9035 files should not be referenced by any program: they're there
9036 for the benefit of the system administrator and users as
9037 documentation only. Architecture-specific example files
9038 should be installed in a directory
9039 <file>/usr/lib/<var>package</var>/examples</file> with symbolic
9041 <file>/usr/share/doc/<var>package</var>/examples</file>, or the
9042 latter directory itself may be a symbolic link to the
9047 If the purpose of a package is to provide examples, then the
9048 example files may be installed into
9049 <file>/usr/share/doc/<var>package</var></file>.
9053 <sect id="changelogs">
9054 <heading>Changelog files</heading>
9057 Packages that are not Debian-native must contain a
9058 compressed copy of the <file>debian/changelog</file> file from
9059 the Debian source tree in
9060 <file>/usr/share/doc/<var>package</var></file> with the name
9061 <file>changelog.Debian.gz</file>.
9065 If an upstream changelog is available, it should be accessible as
9066 <file>/usr/share/doc/<var>package</var>/changelog.gz</file> in
9067 plain text. If the upstream changelog is distributed in
9068 HTML, it should be made available in that form as
9069 <file>/usr/share/doc/<var>package</var>/changelog.html.gz</file>
9070 and a plain text <file>changelog.gz</file> should be generated
9071 from it using, for example, <tt>lynx -dump -nolist</tt>. If
9072 the upstream changelog files do not already conform to this
9073 naming convention, then this may be achieved either by
9074 renaming the files, or by adding a symbolic link, at the
9075 maintainer's discretion.<footnote>
9076 Rationale: People should not have to look in places for
9077 upstream changelogs merely because they are given
9078 different names or are distributed in HTML format.
9083 All of these files should be installed compressed using
9084 <tt>gzip -9</tt>, as they will become large with time even
9085 if they start out small.
9089 If the package has only one changelog which is used both as
9090 the Debian changelog and the upstream one because there is
9091 no separate upstream maintainer then that changelog should
9092 usually be installed as
9093 <file>/usr/share/doc/<var>package</var>/changelog.gz</file>; if
9094 there is a separate upstream maintainer, but no upstream
9095 changelog, then the Debian changelog should still be called
9096 <file>changelog.Debian.gz</file>.
9100 For details about the format and contents of the Debian
9101 changelog file, please see <ref id="dpkgchangelog">.
9106 <appendix id="pkg-scope">
9107 <heading>Introduction and scope of these appendices</heading>
9110 These appendices are taken essentially verbatim from the
9111 now-deprecated Packaging Manual, version 3.2.1.0. They are
9112 the chapters which are likely to be of use to package
9113 maintainers and which have not already been included in the
9114 policy document itself. Most of these sections are very likely
9115 not relevant to policy; they should be treated as
9116 documentation for the packaging system. Please note that these
9117 appendices are included for convenience, and for historical
9118 reasons: they used to be part of policy package, and they have
9119 not yet been incorporated into dpkg documentation. However,
9120 they still have value, and hence they are presented here.
9124 They have not yet been checked to ensure that they are
9125 compatible with the contents of policy, and if there are any
9126 contradictions, the version in the main policy document takes
9127 precedence. The remaining chapters of the old Packaging
9128 Manual have also not been read in detail to ensure that there
9129 are not parts which have been left out. Both of these will be
9134 Certain parts of the Packaging manual were integrated into the
9135 Policy Manual proper, and removed from the appendices. Links
9136 have been placed from the old locations to the new ones.
9140 <prgn>dpkg</prgn> is a suite of programs for creating binary
9141 package files and installing and removing them on Unix
9143 <prgn>dpkg</prgn> is targeted primarily at Debian
9144 GNU/Linux, but may work on or be ported to other
9150 The binary packages are designed for the management of
9151 installed executable programs (usually compiled binaries) and
9152 their associated data, though source code examples and
9153 documentation are provided as part of some packages.</p>
9156 This manual describes the technical aspects of creating Debian
9157 binary packages (<file>.deb</file> files). It documents the
9158 behavior of the package management programs
9159 <prgn>dpkg</prgn>, <prgn>dselect</prgn> et al. and the way
9160 they interact with packages.</p>
9163 It also documents the interaction between
9164 <prgn>dselect</prgn>'s core and the access method scripts it
9165 uses to actually install the selected packages, and describes
9166 how to create a new access method.</p>
9169 This manual does not go into detail about the options and
9170 usage of the package building and installation tools. It
9171 should therefore be read in conjunction with those programs'
9176 The utility programs which are provided with <prgn>dpkg</prgn>
9177 for managing various system configuration and similar issues,
9178 such as <prgn>update-rc.d</prgn> and
9179 <prgn>install-info</prgn>, are not described in detail here -
9180 please see their man pages.
9184 It is assumed that the reader is reasonably familiar with the
9185 <prgn>dpkg</prgn> System Administrators' manual.
9186 Unfortunately this manual does not yet exist.
9190 The Debian version of the FSF's GNU hello program is provided
9191 as an example for people wishing to create Debian
9192 packages. The Debian <prgn>debmake</prgn> package is
9193 recommended as a very helpful tool in creating and maintaining
9194 Debian packages. However, while the tools and examples are
9195 helpful, they do not replace the need to read and follow the
9196 Policy and Programmer's Manual.</p>
9199 <appendix id="pkg-binarypkg">
9200 <heading>Binary packages (from old Packaging Manual)</heading>
9203 The binary package has two main sections. The first part
9204 consists of various control information files and scripts used
9205 by <prgn>dpkg</prgn> when installing and removing. See <ref
9206 id="pkg-controlarea">.
9210 The second part is an archive containing the files and
9211 directories to be installed.
9215 In the future binary packages may also contain other
9216 components, such as checksums and digital signatures. The
9217 format for the archive is described in full in the
9218 <file>deb(5)</file> man page.
9222 <sect id="pkg-bincreating"><heading>Creating package files -
9223 <prgn>dpkg-deb</prgn>
9227 All manipulation of binary package files is done by
9228 <prgn>dpkg-deb</prgn>; it's the only program that has
9229 knowledge of the format. (<prgn>dpkg-deb</prgn> may be
9230 invoked by calling <prgn>dpkg</prgn>, as <prgn>dpkg</prgn>
9231 will spot that the options requested are appropriate to
9232 <prgn>dpkg-deb</prgn> and invoke that instead with the same
9237 In order to create a binary package you must make a
9238 directory tree which contains all the files and directories
9239 you want to have in the file system data part of the package.
9240 In Debian-format source packages this directory is usually
9241 <file>debian/tmp</file>, relative to the top of the package's
9246 They should have the locations (relative to the root of the
9247 directory tree you're constructing) ownerships and
9248 permissions which you want them to have on the system when
9253 With current versions of <prgn>dpkg</prgn> the uid/username
9254 and gid/groupname mappings for the users and groups being
9255 used should be the same on the system where the package is
9256 built and the one where it is installed.
9260 You need to add one special directory to the root of the
9261 miniature file system tree you're creating:
9262 <prgn>DEBIAN</prgn>. It should contain the control
9263 information files, notably the binary package control file
9264 (see <ref id="pkg-controlfile">).
9268 The <prgn>DEBIAN</prgn> directory will not appear in the
9269 file system archive of the package, and so won't be installed
9270 by <prgn>dpkg</prgn> when the package is installed.
9274 When you've prepared the package, you should invoke:
9276 dpkg --build <var>directory</var>
9281 This will build the package in
9282 <file><var>directory</var>.deb</file>. (<prgn>dpkg</prgn> knows
9283 that <tt>--build</tt> is a <prgn>dpkg-deb</prgn> option, so
9284 it invokes <prgn>dpkg-deb</prgn> with the same arguments to
9289 See the man page <manref name="dpkg-deb" section="8"> for details of how
9290 to examine the contents of this newly-created file. You may find the
9291 output of following commands enlightening:
9293 dpkg-deb --info <var>filename</var>.deb
9294 dpkg-deb --contents <var>filename</var>.deb
9295 dpkg --contents <var>filename</var>.deb
9297 To view the copyright file for a package you could use this command:
9299 dpkg --fsys-tarfile <var>filename</var>.deb | tar xOf - --wildcards \*/copyright | pager
9304 <sect id="pkg-controlarea">
9305 <heading>Package control information files</heading>
9308 The control information portion of a binary package is a
9309 collection of files with names known to <prgn>dpkg</prgn>.
9310 It will treat the contents of these files specially - some
9311 of them contain information used by <prgn>dpkg</prgn> when
9312 installing or removing the package; others are scripts which
9313 the package maintainer wants <prgn>dpkg</prgn> to run.
9317 It is possible to put other files in the package control
9318 area, but this is not generally a good idea (though they
9319 will largely be ignored).
9323 Here is a brief list of the control info files supported by
9324 <prgn>dpkg</prgn> and a summary of what they're used for.
9329 <tag><tt>control</tt>
9332 This is the key description file used by
9333 <prgn>dpkg</prgn>. It specifies the package's name
9334 and version, gives its description for the user,
9335 states its relationships with other packages, and so
9336 forth. See <ref id="sourcecontrolfiles"> and
9337 <ref id="binarycontrolfiles">.
9341 It is usually generated automatically from information
9342 in the source package by the
9343 <prgn>dpkg-gencontrol</prgn> program, and with
9344 assistance from <prgn>dpkg-shlibdeps</prgn>.
9345 See <ref id="pkg-sourcetools">.
9349 <tag><tt>postinst</tt>, <tt>preinst</tt>, <tt>postrm</tt>,
9354 These are executable files (usually scripts) which
9355 <prgn>dpkg</prgn> runs during installation, upgrade
9356 and removal of packages. They allow the package to
9357 deal with matters which are particular to that package
9358 or require more complicated processing than that
9359 provided by <prgn>dpkg</prgn>. Details of when and
9360 how they are called are in <ref id="maintainerscripts">.
9364 It is very important to make these scripts idempotent.
9365 See <ref id="idempotency">.
9369 The maintainer scripts are guaranteed to run with a
9370 controlling terminal and can interact with the user.
9371 See <ref id="controllingterminal">.
9375 <tag><tt>conffiles</tt>
9378 This file contains a list of configuration files which
9379 are to be handled automatically by <prgn>dpkg</prgn>
9380 (see <ref id="pkg-conffiles">). Note that not necessarily
9381 every configuration file should be listed here.
9384 <tag><tt>shlibs</tt>
9387 This file contains a list of the shared libraries
9388 supplied by the package, with dependency details for
9389 each. This is used by <prgn>dpkg-shlibdeps</prgn>
9390 when it determines what dependencies are required in a
9391 package control file. The <tt>shlibs</tt> file format
9392 is described on <ref id="shlibs">.
9397 <sect id="pkg-controlfile">
9398 <heading>The main control information file: <tt>control</tt></heading>
9401 The most important control information file used by
9402 <prgn>dpkg</prgn> when it installs a package is
9403 <tt>control</tt>. It contains all the package's "vital
9408 The binary package control files of packages built from
9409 Debian sources are made by a special tool,
9410 <prgn>dpkg-gencontrol</prgn>, which reads
9411 <file>debian/control</file> and <file>debian/changelog</file> to
9412 find the information it needs. See <ref id="pkg-sourcepkg"> for
9417 The fields in binary package control files are listed in
9418 <ref id="binarycontrolfiles">.
9422 A description of the syntax of control files and the purpose
9423 of the fields is available in <ref id="controlfields">.
9428 <heading>Time Stamps</heading>
9431 See <ref id="timestamps">.
9436 <appendix id="pkg-sourcepkg">
9437 <heading>Source packages (from old Packaging Manual) </heading>
9440 The Debian binary packages in the distribution are generated
9441 from Debian sources, which are in a special format to assist
9442 the easy and automatic building of binaries.
9445 <sect id="pkg-sourcetools">
9446 <heading>Tools for processing source packages</heading>
9449 Various tools are provided for manipulating source packages;
9450 they pack and unpack sources and help build of binary
9451 packages and help manage the distribution of new versions.
9455 They are introduced and typical uses described here; see
9456 <manref name="dpkg-source" section="1"> for full
9457 documentation about their arguments and operation.
9461 For examples of how to construct a Debian source package,
9462 and how to use those utilities that are used by Debian
9463 source packages, please see the <prgn>hello</prgn> example
9467 <sect1 id="pkg-dpkg-source">
9469 <prgn>dpkg-source</prgn> - packs and unpacks Debian source
9474 This program is frequently used by hand, and is also
9475 called from package-independent automated building scripts
9476 such as <prgn>dpkg-buildpackage</prgn>.
9480 To unpack a package it is typically invoked with
9482 dpkg-source -x <var>.../path/to/filename</var>.dsc
9487 with the <file><var>filename</var>.tar.gz</file> and
9488 <file><var>filename</var>.diff.gz</file> (if applicable) in
9489 the same directory. It unpacks into
9490 <file><var>package</var>-<var>version</var></file>, and if
9492 <file><var>package</var>-<var>version</var>.orig</file>, in
9493 the current directory.
9497 To create a packed source archive it is typically invoked:
9499 dpkg-source -b <var>package</var>-<var>version</var>
9504 This will create the <file>.dsc</file>, <file>.tar.gz</file> and
9505 <file>.diff.gz</file> (if appropriate) in the current
9506 directory. <prgn>dpkg-source</prgn> does not clean the
9507 source tree first - this must be done separately if it is
9512 See also <ref id="pkg-sourcearchives">.</p>
9516 <sect1 id="pkg-dpkg-buildpackage">
9518 <prgn>dpkg-buildpackage</prgn> - overall package-building
9523 <prgn>dpkg-buildpackage</prgn> is a script which invokes
9524 <prgn>dpkg-source</prgn>, the <file>debian/rules</file>
9525 targets <tt>clean</tt>, <tt>build</tt> and
9526 <tt>binary</tt>, <prgn>dpkg-genchanges</prgn> and
9527 <prgn>gpg</prgn> (or <prgn>pgp</prgn>) to build a signed
9528 source and binary package upload.
9532 It is usually invoked by hand from the top level of the
9533 built or unbuilt source directory. It may be invoked with
9534 no arguments; useful arguments include:
9535 <taglist compact="compact">
9536 <tag><tt>-uc</tt>, <tt>-us</tt></tag>
9539 Do not sign the <tt>.changes</tt> file or the
9540 source package <tt>.dsc</tt> file, respectively.</p>
9542 <tag><tt>-p<var>sign-command</var></tt></tag>
9545 Invoke <var>sign-command</var> instead of finding
9546 <tt>gpg</tt> or <tt>pgp</tt> on the <prgn>PATH</prgn>.
9547 <var>sign-command</var> must behave just like
9548 <prgn>gpg</prgn> or <tt>pgp</tt>.</p>
9550 <tag><tt>-r<var>root-command</var></tt></tag>
9553 When root privilege is required, invoke the command
9554 <var>root-command</var>. <var>root-command</var>
9555 should invoke its first argument as a command, from
9556 the <prgn>PATH</prgn> if necessary, and pass its
9557 second and subsequent arguments to the command it
9558 calls. If no <var>root-command</var> is supplied
9559 then <var>dpkg-buildpackage</var> will take no
9560 special action to gain root privilege, so that for
9561 most packages it will have to be invoked as root to
9564 <tag><tt>-b</tt>, <tt>-B</tt></tag>
9567 Two types of binary-only build and upload - see
9568 <manref name="dpkg-source" section="1">.
9575 <sect1 id="pkg-dpkg-gencontrol">
9577 <prgn>dpkg-gencontrol</prgn> - generates binary package
9582 This program is usually called from <file>debian/rules</file>
9583 (see <ref id="pkg-sourcetree">) in the top level of the source
9588 This is usually done just before the files and directories in the
9589 temporary directory tree where the package is being built have their
9590 permissions and ownerships set and the package is constructed using
9591 <prgn>dpkg-deb/</prgn>
9593 This is so that the control file which is produced has
9594 the right permissions
9599 <prgn>dpkg-gencontrol</prgn> must be called after all the
9600 files which are to go into the package have been placed in
9601 the temporary build directory, so that its calculation of
9602 the installed size of a package is correct.
9606 It is also necessary for <prgn>dpkg-gencontrol</prgn> to
9607 be run after <prgn>dpkg-shlibdeps</prgn> so that the
9608 variable substitutions created by
9609 <prgn>dpkg-shlibdeps</prgn> in <file>debian/substvars</file>
9614 For a package which generates only one binary package, and
9615 which builds it in <file>debian/tmp</file> relative to the top
9616 of the source package, it is usually sufficient to call
9617 <prgn>dpkg-gencontrol</prgn>.
9621 Sources which build several binaries will typically need
9624 dpkg-gencontrol -Pdebian/tmp-<var>pkg</var> -p<var>package</var>
9625 </example> The <tt>-P</tt> tells
9626 <prgn>dpkg-gencontrol</prgn> that the package is being
9627 built in a non-default directory, and the <tt>-p</tt>
9628 tells it which package's control file should be generated.
9632 <prgn>dpkg-gencontrol</prgn> also adds information to the
9633 list of files in <file>debian/files</file>, for the benefit of
9634 (for example) a future invocation of
9635 <prgn>dpkg-genchanges</prgn>.</p>
9638 <sect1 id="pkg-dpkg-shlibdeps">
9640 <prgn>dpkg-shlibdeps</prgn> - calculates shared library
9645 This program is usually called from <file>debian/rules</file>
9646 just before <prgn>dpkg-gencontrol</prgn> (see <ref
9647 id="pkg-sourcetree">), in the top level of the source tree.
9651 Its arguments are executables and shared libraries
9654 They may be specified either in the locations in the
9655 source tree where they are created or in the locations
9656 in the temporary build tree where they are installed
9657 prior to binary package creation.
9659 </footnote> for which shared library dependencies should
9660 be included in the binary package's control file.
9664 If some of the found shared libraries should only
9665 warrant a <tt>Recommends</tt> or <tt>Suggests</tt>, or if
9666 some warrant a <tt>Pre-Depends</tt>, this can be achieved
9667 by using the <tt>-d<var>dependency-field</var></tt> option
9668 before those executable(s). (Each <tt>-d</tt> option
9669 takes effect until the next <tt>-d</tt>.)
9673 <prgn>dpkg-shlibdeps</prgn> does not directly cause the
9674 output control file to be modified. Instead by default it
9675 adds to the <file>debian/substvars</file> file variable
9676 settings like <tt>shlibs:Depends</tt>. These variable
9677 settings must be referenced in dependency fields in the
9678 appropriate per-binary-package sections of the source
9683 For example, a package that generates an essential part
9684 which requires dependencies, and optional parts that
9685 which only require a recommendation, would separate those
9686 two sets of dependencies into two different fields.<footnote>
9687 At the time of writing, an example for this was the
9688 <package/xmms/ package, with Depends used for the xmms
9689 executable, Recommends for the plug-ins and Suggests for
9690 even more optional features provided by unzip.
9692 It can say in its <file>debian/rules</file>:
9694 dpkg-shlibdeps -dDepends <var>program anotherprogram ...</var> \
9695 -dRecommends <var>optionalpart anotheroptionalpart</var>
9697 and then in its main control file <file>debian/control</file>:
9700 Depends: ${shlibs:Depends}
9701 Recommends: ${shlibs:Recommends}
9707 Sources which produce several binary packages with
9708 different shared library dependency requirements can use
9709 the <tt>-p<var>varnameprefix</var></tt> option to override
9710 the default <tt>shlibs:</tt> prefix (one invocation of
9711 <prgn>dpkg-shlibdeps</prgn> per setting of this option).
9712 They can thus produce several sets of dependency
9713 variables, each of the form
9714 <tt><var>varnameprefix</var>:<var>dependencyfield</var></tt>,
9715 which can be referred to in the appropriate parts of the
9716 binary package control files.
9721 <sect1 id="pkg-dpkg-distaddfile">
9723 <prgn>dpkg-distaddfile</prgn> - adds a file to
9724 <file>debian/files</file>
9728 Some packages' uploads need to include files other than
9729 the source and binary package files.
9733 <prgn>dpkg-distaddfile</prgn> adds a file to the
9734 <file>debian/files</file> file so that it will be included in
9735 the <file>.changes</file> file when
9736 <prgn>dpkg-genchanges</prgn> is run.
9740 It is usually invoked from the <tt>binary</tt> target of
9741 <file>debian/rules</file>:
9743 dpkg-distaddfile <var>filename</var> <var>section</var> <var>priority</var>
9745 The <var>filename</var> is relative to the directory where
9746 <prgn>dpkg-genchanges</prgn> will expect to find it - this
9747 is usually the directory above the top level of the source
9748 tree. The <file>debian/rules</file> target should put the
9749 file there just before or just after calling
9750 <prgn>dpkg-distaddfile</prgn>.
9754 The <var>section</var> and <var>priority</var> are passed
9755 unchanged into the resulting <file>.changes</file> file.
9760 <sect1 id="pkg-dpkg-genchanges">
9762 <prgn>dpkg-genchanges</prgn> - generates a <file>.changes</file>
9767 This program is usually called by package-independent
9768 automatic building scripts such as
9769 <prgn>dpkg-buildpackage</prgn>, but it may also be called
9774 It is usually called in the top level of a built source
9775 tree, and when invoked with no arguments will print out a
9776 straightforward <file>.changes</file> file based on the
9777 information in the source package's changelog and control
9778 file and the binary and source packages which should have
9784 <sect1 id="pkg-dpkg-parsechangelog">
9786 <prgn>dpkg-parsechangelog</prgn> - produces parsed
9787 representation of a changelog
9791 This program is used internally by
9792 <prgn>dpkg-source</prgn> et al. It may also occasionally
9793 be useful in <file>debian/rules</file> and elsewhere. It
9794 parses a changelog, <file>debian/changelog</file> by default,
9795 and prints a control-file format representation of the
9796 information in it to standard output.
9800 <sect1 id="pkg-dpkg-architecture">
9802 <prgn>dpkg-architecture</prgn> - information about the build and
9807 This program can be used manually, but is also invoked by
9808 <tt>dpkg-buildpackage</tt> or <file>debian/rules</file> to set
9809 environment or make variables which specify the build and host
9810 architecture for the package building process.
9815 <sect id="pkg-sourcetree">
9816 <heading>The Debianised source tree</heading>
9819 The source archive scheme described later is intended to
9820 allow a Debianised source tree with some associated control
9821 information to be reproduced and transported easily. The
9822 Debianised source tree is a version of the original program
9823 with certain files added for the benefit of the
9824 Debianisation process, and with any other changes required
9825 made to the rest of the source code and installation
9830 The extra files created for Debian are in the subdirectory
9831 <file>debian</file> of the top level of the Debianised source
9832 tree. They are described below.
9835 <sect1 id="pkg-debianrules">
9836 <heading><file>debian/rules</file> - the main building script</heading>
9839 See <ref id="debianrules">.
9844 <sect1 id="pkg-dpkgchangelog">
9845 <heading><file>debian/changelog</file></heading>
9848 See <ref id="dpkgchangelog">.
9851 <sect2><heading>Defining alternative changelog formats
9855 It is possible to use a different format to the standard
9856 one, by providing a parser for the format you wish to
9861 In order to have <tt>dpkg-parsechangelog</tt> run your
9862 parser, you must include a line within the last 40 lines
9863 of your file matching the Perl regular expression:
9864 <tt>\schangelog-format:\s+([0-9a-z]+)\W</tt> The part in
9865 parentheses should be the name of the format. For
9866 example, you might say:
9868 @@@ changelog-format: joebloggs @@@
9870 Changelog format names are non-empty strings of alphanumerics.
9874 If such a line exists then <tt>dpkg-parsechangelog</tt>
9875 will look for the parser as
9876 <file>/usr/lib/dpkg/parsechangelog/<var>format-name</var></file>
9878 <file>/usr/local/lib/dpkg/parsechangelog/<var>format-name</var></file>;
9879 it is an error for it not to find it, or for it not to
9880 be an executable program. The default changelog format
9881 is <tt>dpkg</tt>, and a parser for it is provided with
9882 the <tt>dpkg</tt> package.
9886 The parser will be invoked with the changelog open on
9887 standard input at the start of the file. It should read
9888 the file (it may seek if it wishes) to determine the
9889 information required and return the parsed information
9890 to standard output in the form of a series of control
9891 fields in the standard format. By default it should
9892 return information about only the most recent version in
9893 the changelog; it should accept a
9894 <tt>-v<var>version</var></tt> option to return changes
9895 information from all versions present <em>strictly
9896 after</em> <var>version</var>, and it should then be an
9897 error for <var>version</var> not to be present in the
9903 <list compact="compact">
9904 <item><qref id="f-Source"><tt>Source</tt></qref></item>
9905 <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
9906 <item><qref id="f-Distribution"><tt>Distribution</tt></qref> (mandatory)</item>
9907 <item><qref id="f-Urgency"><tt>Urgency</tt></qref> (mandatory)</item>
9908 <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
9909 <item><qref id="f-Date"><tt>Date</tt></qref></item>
9910 <item><qref id="f-Changes"><tt>Changes</tt></qref> (mandatory)</item>
9915 If several versions are being returned (due to the use
9916 of <tt>-v</tt>), the urgency value should be of the
9917 highest urgency code listed at the start of any of the
9918 versions requested followed by the concatenated
9919 (space-separated) comments from all the versions
9920 requested; the maintainer, version, distribution and
9921 date should always be from the most recent version.
9925 For the format of the <tt>Changes</tt> field see
9926 <ref id="f-Changes">.
9930 If the changelog format which is being parsed always or
9931 almost always leaves a blank line between individual
9932 change notes these blank lines should be stripped out,
9933 so as to make the resulting output compact.
9937 If the changelog format does not contain date or package
9938 name information this information should be omitted from
9939 the output. The parser should not attempt to synthesize
9940 it or find it from other sources.
9944 If the changelog does not have the expected format the
9945 parser should exit with a nonzero exit status, rather
9946 than trying to muddle through and possibly generating
9951 A changelog parser may not interact with the user at
9957 <sect1 id="pkg-srcsubstvars">
9958 <heading><file>debian/substvars</file> and variable substitutions</heading>
9961 See <ref id="substvars">.
9967 <heading><file>debian/files</file></heading>
9970 See <ref id="debianfiles">.
9974 <sect1><heading><file>debian/tmp</file>
9978 This is the canonical temporary location for the
9979 construction of binary packages by the <tt>binary</tt>
9980 target. The directory <file>tmp</file> serves as the root of
9981 the file system tree as it is being constructed (for
9982 example, by using the package's upstream makefiles install
9983 targets and redirecting the output there), and it also
9984 contains the <tt>DEBIAN</tt> subdirectory. See <ref
9985 id="pkg-bincreating">.
9989 If several binary packages are generated from the same
9990 source tree it is usual to use several
9991 <file>debian/tmp<var>something</var></file> directories, for
9992 example <file>tmp-a</file> or <file>tmp-doc</file>.
9996 Whatever <file>tmp</file> directories are created and used by
9997 <tt>binary</tt> must of course be removed by the
9998 <tt>clean</tt> target.</p></sect1>
10002 <sect id="pkg-sourcearchives"><heading>Source packages as archives
10006 As it exists on the FTP site, a Debian source package
10007 consists of three related files. You must have the right
10008 versions of all three to be able to use them.
10013 <tag>Debian source control file - <tt>.dsc</tt></tag>
10015 This file is a control file used by <prgn>dpkg-source</prgn>
10016 to extract a source package.
10017 See <ref id="debiansourcecontrolfiles">.
10021 Original source archive -
10023 <var>package</var>_<var>upstream-version</var>.orig.tar.gz
10029 This is a compressed (with <tt>gzip -9</tt>)
10030 <prgn>tar</prgn> file containing the source code from
10031 the upstream authors of the program.
10036 Debianisation diff -
10038 <var>package</var>_<var>upstream_version-revision</var>.diff.gz
10044 This is a unified context diff (<tt>diff -u</tt>)
10045 giving the changes which are required to turn the
10046 original source into the Debian source. These changes
10047 may only include editing and creating plain files.
10048 The permissions of files, the targets of symbolic
10049 links and the characteristics of special files or
10050 pipes may not be changed and no files may be removed
10055 All the directories in the diff must exist, except the
10056 <file>debian</file> subdirectory of the top of the source
10057 tree, which will be created by
10058 <prgn>dpkg-source</prgn> if necessary when unpacking.
10062 The <prgn>dpkg-source</prgn> program will
10063 automatically make the <file>debian/rules</file> file
10064 executable (see below).</p></item>
10069 If there is no original source code - for example, if the
10070 package is specially prepared for Debian or the Debian
10071 maintainer is the same as the upstream maintainer - the
10072 format is slightly different: then there is no diff, and the
10074 <file><var>package</var>_<var>version</var>.tar.gz</file>,
10075 and preferably contains a directory named
10076 <file><var>package</var>-<var>version</var></file>.
10081 <heading>Unpacking a Debian source package without <prgn>dpkg-source</prgn></heading>
10084 <tt>dpkg-source -x</tt> is the recommended way to unpack a
10085 Debian source package. However, if it is not available it
10086 is possible to unpack a Debian source archive as follows:
10087 <enumlist compact="compact">
10090 Untar the tarfile, which will create a <file>.orig</file>
10094 <p>Rename the <file>.orig</file> directory to
10095 <file><var>package</var>-<var>version</var></file>.</p>
10099 Create the subdirectory <file>debian</file> at the top of
10100 the source tree.</p>
10102 <item><p>Apply the diff using <tt>patch -p0</tt>.</p>
10104 <item><p>Untar the tarfile again if you want a copy of the original
10105 source code alongside the Debianised version.</p>
10110 It is not possible to generate a valid Debian source archive
10111 without using <prgn>dpkg-source</prgn>. In particular,
10112 attempting to use <prgn>diff</prgn> directly to generate the
10113 <file>.diff.gz</file> file will not work.
10117 <heading>Restrictions on objects in source packages</heading>
10120 The source package may not contain any hard links
10122 This is not currently detected when building source
10123 packages, but only when extracting
10127 Hard links may be permitted at some point in the
10128 future, but would require a fair amount of
10130 </footnote>, device special files, sockets or setuid or
10133 Setgid directories are allowed.
10138 The source packaging tools manage the changes between the
10139 original and Debianised source using <prgn>diff</prgn> and
10140 <prgn>patch</prgn>. Turning the original source tree as
10141 included in the <file>.orig.tar.gz</file> into the debianised
10142 source must not involve any changes which cannot be
10143 handled by these tools. Problematic changes which cause
10144 <prgn>dpkg-source</prgn> to halt with an error when
10145 building the source package are:
10146 <list compact="compact">
10147 <item><p>Adding or removing symbolic links, sockets or pipes.</p>
10149 <item><p>Changing the targets of symbolic links.</p>
10151 <item><p>Creating directories, other than <file>debian</file>.</p>
10153 <item><p>Changes to the contents of binary files.</p></item>
10154 </list> Changes which cause <prgn>dpkg-source</prgn> to
10155 print a warning but continue anyway are:
10156 <list compact="compact">
10159 Removing files, directories or symlinks.
10161 Renaming a file is not treated specially - it is
10162 seen as the removal of the old file (which
10163 generates a warning, but is otherwise ignored),
10164 and the creation of the new one.
10170 Changed text files which are missing the usual final
10171 newline (either in the original or the modified
10176 Changes which are not represented, but which are not detected by
10177 <prgn>dpkg-source</prgn>, are:
10178 <list compact="compact">
10179 <item><p>Changing the permissions of files (other than
10180 <file>debian/rules</file>) and directories.</p></item>
10185 The <file>debian</file> directory and <file>debian/rules</file>
10186 are handled specially by <prgn>dpkg-source</prgn> - before
10187 applying the changes it will create the <file>debian</file>
10188 directory, and afterwards it will make
10189 <file>debian/rules</file> world-executable.
10195 <appendix id="pkg-controlfields">
10196 <heading>Control files and their fields (from old Packaging Manual)</heading>
10199 Many of the tools in the <prgn>dpkg</prgn> suite manipulate
10200 data in a common format, known as control files. Binary and
10201 source packages have control data as do the <file>.changes</file>
10202 files which control the installation of uploaded files, and
10203 <prgn>dpkg</prgn>'s internal databases are in a similar
10208 <heading>Syntax of control files</heading>
10211 See <ref id="controlsyntax">.
10215 It is important to note that there are several fields which
10216 are optional as far as <prgn>dpkg</prgn> and the related
10217 tools are concerned, but which must appear in every Debian
10218 package, or whose omission may cause problems.
10223 <heading>List of fields</heading>
10226 See <ref id="controlfieldslist">.
10230 This section now contains only the fields that didn't belong
10231 to the Policy manual.
10234 <sect1 id="pkg-f-Filename">
10235 <heading><tt>Filename</tt> and <tt>MSDOS-Filename</tt></heading>
10238 These fields in <tt>Packages</tt> files give the
10239 filename(s) of (the parts of) a package in the
10240 distribution directories, relative to the root of the
10241 Debian hierarchy. If the package has been split into
10242 several parts the parts are all listed in order, separated
10247 <sect1 id="pkg-f-Size">
10248 <heading><tt>Size</tt> and <tt>MD5sum</tt></heading>
10251 These fields in <file>Packages</file> files give the size (in
10252 bytes, expressed in decimal) and MD5 checksum of the
10253 file(s) which make(s) up a binary package in the
10254 distribution. If the package is split into several parts
10255 the values for the parts are listed in order, separated by
10260 <sect1 id="pkg-f-Status">
10261 <heading><tt>Status</tt></heading>
10264 This field in <prgn>dpkg</prgn>'s status file records
10265 whether the user wants a package installed, removed or
10266 left alone, whether it is broken (requiring
10267 re-installation) or not and what its current state on the
10268 system is. Each of these pieces of information is a
10273 <sect1 id="pkg-f-Config-Version">
10274 <heading><tt>Config-Version</tt></heading>
10277 If a package is not installed or not configured, this
10278 field in <prgn>dpkg</prgn>'s status file records the last
10279 version of the package which was successfully
10284 <sect1 id="pkg-f-Conffiles">
10285 <heading><tt>Conffiles</tt></heading>
10288 This field in <prgn>dpkg</prgn>'s status file contains
10289 information about the automatically-managed configuration
10290 files held by a package. This field should <em>not</em>
10291 appear anywhere in a package!
10296 <heading>Obsolete fields</heading>
10299 These are still recognized by <prgn>dpkg</prgn> but should
10300 not appear anywhere any more.
10302 <taglist compact="compact">
10304 <tag><tt>Revision</tt></tag>
10305 <tag><tt>Package-Revision</tt></tag>
10306 <tag><tt>Package_Revision</tt></tag>
10308 The Debian revision part of the package version was
10309 at one point in a separate control file field. This
10310 field went through several names.
10313 <tag><tt>Recommended</tt></tag>
10314 <item>Old name for <tt>Recommends</tt>.</item>
10316 <tag><tt>Optional</tt></tag>
10317 <item>Old name for <tt>Suggests</tt>.</item>
10319 <tag><tt>Class</tt></tag>
10320 <item>Old name for <tt>Priority</tt>.</item>
10329 <appendix id="pkg-conffiles">
10330 <heading>Configuration file handling (from old Packaging Manual)</heading>
10333 <prgn>dpkg</prgn> can do a certain amount of automatic
10334 handling of package configuration files.
10338 Whether this mechanism is appropriate depends on a number of
10339 factors, but basically there are two approaches to any
10340 particular configuration file.
10344 The easy method is to ship a best-effort configuration in the
10345 package, and use <prgn>dpkg</prgn>'s conffile mechanism to
10346 handle updates. If the user is unlikely to want to edit the
10347 file, but you need them to be able to without losing their
10348 changes, and a new package with a changed version of the file
10349 is only released infrequently, this is a good approach.
10353 The hard method is to build the configuration file from
10354 scratch in the <prgn>postinst</prgn> script, and to take the
10355 responsibility for fixing any mistakes made in earlier
10356 versions of the package automatically. This will be
10357 appropriate if the file is likely to need to be different on
10361 <sect><heading>Automatic handling of configuration files by
10366 A package may contain a control area file called
10367 <tt>conffiles</tt>. This file should be a list of filenames
10368 of configuration files needing automatic handling, separated
10369 by newlines. The filenames should be absolute pathnames,
10370 and the files referred to should actually exist in the
10375 When a package is upgraded <prgn>dpkg</prgn> will process
10376 the configuration files during the configuration stage,
10377 shortly before it runs the package's <prgn>postinst</prgn>
10382 For each file it checks to see whether the version of the
10383 file included in the package is the same as the one that was
10384 included in the last version of the package (the one that is
10385 being upgraded from); it also compares the version currently
10386 installed on the system with the one shipped with the last
10391 If neither the user nor the package maintainer has changed
10392 the file, it is left alone. If one or the other has changed
10393 their version, then the changed version is preferred - i.e.,
10394 if the user edits their file, but the package maintainer
10395 doesn't ship a different version, the user's changes will
10396 stay, silently, but if the maintainer ships a new version
10397 and the user hasn't edited it the new version will be
10398 installed (with an informative message). If both have
10399 changed their version the user is prompted about the problem
10400 and must resolve the differences themselves.
10404 The comparisons are done by calculating the MD5 message
10405 digests of the files, and storing the MD5 of the file as it
10406 was included in the most recent version of the package.
10410 When a package is installed for the first time
10411 <prgn>dpkg</prgn> will install the file that comes with it,
10412 unless that would mean overwriting a file already on the
10417 However, note that <prgn>dpkg</prgn> will <em>not</em>
10418 replace a conffile that was removed by the user (or by a
10419 script). This is necessary because with some programs a
10420 missing file produces an effect hard or impossible to
10421 achieve in another way, so that a missing file needs to be
10422 kept that way if the user did it.
10426 Note that a package should <em>not</em> modify a
10427 <prgn>dpkg</prgn>-handled conffile in its maintainer
10428 scripts. Doing this will lead to <prgn>dpkg</prgn> giving
10429 the user confusing and possibly dangerous options for
10430 conffile update when the package is upgraded.</p>
10433 <sect><heading>Fully-featured maintainer script configuration
10438 For files which contain site-specific information such as
10439 the hostname and networking details and so forth, it is
10440 better to create the file in the package's
10441 <prgn>postinst</prgn> script.
10445 This will typically involve examining the state of the rest
10446 of the system to determine values and other information, and
10447 may involve prompting the user for some information which
10448 can't be obtained some other way.
10452 When using this method there are a couple of important
10453 issues which should be considered:
10457 If you discover a bug in the program which generates the
10458 configuration file, or if the format of the file changes
10459 from one version to the next, you will have to arrange for
10460 the postinst script to do something sensible - usually this
10461 will mean editing the installed configuration file to remove
10462 the problem or change the syntax. You will have to do this
10463 very carefully, since the user may have changed the file,
10464 perhaps to fix the very problem that your script is trying
10465 to deal with - you will have to detect these situations and
10466 deal with them correctly.
10470 If you do go down this route it's probably a good idea to
10471 make the program that generates the configuration file(s) a
10472 separate program in <file>/usr/sbin</file>, by convention called
10473 <file><var>package</var>config</file> and then run that if
10474 appropriate from the post-installation script. The
10475 <tt><var>package</var>config</tt> program should not
10476 unquestioningly overwrite an existing configuration - if its
10477 mode of operation is geared towards setting up a package for
10478 the first time (rather than any arbitrary reconfiguration
10479 later) you should have it check whether the configuration
10480 already exists, and require a <tt>--force</tt> flag to
10481 overwrite it.</p></sect>
10484 <appendix id="pkg-alternatives"><heading>Alternative versions of
10485 an interface - <prgn>update-alternatives</prgn> (from old
10490 When several packages all provide different versions of the
10491 same program or file it is useful to have the system select a
10492 default, but to allow the system administrator to change it
10493 and have their decisions respected.
10497 For example, there are several versions of the <prgn>vi</prgn>
10498 editor, and there is no reason to prevent all of them from
10499 being installed at once, each under their own name
10500 (<prgn>nvi</prgn>, <prgn>vim</prgn> or whatever).
10501 Nevertheless it is desirable to have the name <tt>vi</tt>
10502 refer to something, at least by default.
10506 If all the packages involved cooperate, this can be done with
10507 <prgn>update-alternatives</prgn>.
10511 Each package provides its own version under its own name, and
10512 calls <prgn>update-alternatives</prgn> in its postinst to
10513 register its version (and again in its prerm to deregister
10518 See the man page <manref name="update-alternatives"
10519 section="8"> for details.
10523 If <prgn>update-alternatives</prgn> does not seem appropriate
10524 you may wish to consider using diversions instead.</p>
10527 <appendix id="pkg-diversions"><heading>Diversions - overriding a
10528 package's version of a file (from old Packaging Manual)
10532 It is possible to have <prgn>dpkg</prgn> not overwrite a file
10533 when it reinstalls the package it belongs to, and to have it
10534 put the file from the package somewhere else instead.
10538 This can be used locally to override a package's version of a
10539 file, or by one package to override another's version (or
10540 provide a wrapper for it).
10544 Before deciding to use a diversion, read <ref
10545 id="pkg-alternatives"> to see if you really want a diversion
10546 rather than several alternative versions of a program.
10550 There is a diversion list, which is read by <prgn>dpkg</prgn>,
10551 and updated by a special program <prgn>dpkg-divert</prgn>.
10552 Please see <manref name="dpkg-divert" section="8"> for full
10553 details of its operation.
10557 When a package wishes to divert a file from another, it should
10558 call <prgn>dpkg-divert</prgn> in its preinst to add the
10559 diversion and rename the existing file. For example,
10560 supposing that a <prgn>smailwrapper</prgn> package wishes to
10561 install a wrapper around <file>/usr/sbin/smail</file>:
10563 dpkg-divert --package smailwrapper --add --rename \
10564 --divert /usr/sbin/smail.real /usr/sbin/smail
10565 </example> The <tt>--package smailwrapper</tt> ensures that
10566 <prgn>smailwrapper</prgn>'s copy of <file>/usr/sbin/smail</file>
10567 can bypass the diversion and get installed as the true version.
10568 It's safe to add the diversion unconditionally on upgrades since
10569 it will be left unchanged if it already exists, but
10570 <prgn>dpkg-divert</prgn> will display a message. To suppress that
10571 message, make the command conditional on the version from which
10572 the package is being upgraded:
10574 if [ upgrade != "$1" ] || dpkg --compare-versions "$2" lt 1.0-2; then
10575 dpkg-divert --package smailwrapper --add --rename \
10576 --divert /usr/sbin/smail.real /usr/sbin/smail
10578 </example> where <tt>1.0-2</tt> is the version at which the
10579 diversion was first added to the package. Running the command
10580 during abort-upgrade is pointless but harmless.
10584 The postrm has to do the reverse:
10586 if [ remove = "$1" -o abort-install = "$1" -o disappear = "$1" ]; then
10587 dpkg-divert --package smailwrapper --remove --rename \
10588 --divert /usr/sbin/smail.real /usr/sbin/smail
10590 </example> If the diversion was added at a particular version, the
10591 postrm should also handle the failure case of upgrading from an
10592 older version (unless the older version is so old that direct
10593 upgrades are no longer supported):
10595 if [ abort-upgrade = "$1" ] && dpkg --compare-versions "$2" lt 1.0-2; then
10596 dpkg-divert --package smailwrapper --remove --rename \
10597 --divert /usr/sbin/smail.real /usr/sbin/smail
10599 </example> where <tt>1.02-2</tt> is the version at which the
10600 diversion was first added to the package. The postrm should not
10601 remove the diversion on upgrades both because there's no reason to
10602 remove the diversion only to immediately re-add it and since the
10603 postrm of the old package is run after unpacking so the removal of
10604 the diversion will fail.
10608 Do not attempt to divert a file which is vitally important for
10609 the system's operation - when using <prgn>dpkg-divert</prgn>
10610 there is a time, after it has been diverted but before
10611 <prgn>dpkg</prgn> has installed the new version, when the file
10612 does not exist.</p>
10617 <!-- Local variables: -->
10618 <!-- indent-tabs-mode: t -->
10620 <!-- vim:set ai et sts=2 sw=2 tw=76: -->