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 areas<footnote>
322 The Debian archive software uses the term "component" internally
323 and in the Release file format to refer to the division of an
324 archive. The Debian Social Contract simply refers to "areas."
325 This document uses terminology similar to the Social Contract.
326 </footnote> based on their licenses and other restrictions.
330 The aims of this are:
332 <list compact="compact">
333 <item>to allow us to make as much software available as we can</item>
334 <item>to allow us to encourage everyone to write free software,
336 <item>to allow us to make it easy for people to produce
337 CD-ROMs of our system without violating any licenses,
338 import/export restrictions, or any other laws.</item>
343 The <em>main</em> archive area forms the <em>Debian GNU/Linux
348 Packages in the other archive areas (<tt>contrib</tt>,
349 <tt>non-free</tt>) are not considered to be part of the Debian
350 distribution, although we support their use and provide
351 infrastructure for them (such as our bug-tracking system and
352 mailing lists). This Debian Policy Manual applies to these
357 <heading>The Debian Free Software Guidelines</heading>
359 The Debian Free Software Guidelines (DFSG) form our
360 definition of "free software". These are:
362 <tag>Free Redistribution
365 The license of a Debian component may not restrict any
366 party from selling or giving away the software as a
367 component of an aggregate software distribution
368 containing programs from several different
369 sources. The license may not require a royalty or
370 other fee for such sale.
375 The program must include source code, and must allow
376 distribution in source code as well as compiled form.
381 The license must allow modifications and derived
382 works, and must allow them to be distributed under the
383 same terms as the license of the original software.
385 <tag>Integrity of The Author's Source Code
388 The license may restrict source-code from being
389 distributed in modified form <em>only</em> if the
390 license allows the distribution of "patch files"
391 with the source code for the purpose of modifying the
392 program at build time. The license must explicitly
393 permit distribution of software built from modified
394 source code. The license may require derived works to
395 carry a different name or version number from the
396 original software. (This is a compromise. The Debian
397 Project encourages all authors to not restrict any
398 files, source or binary, from being modified.)
400 <tag>No Discrimination Against Persons or Groups
403 The license must not discriminate against any person
406 <tag>No Discrimination Against Fields of Endeavor
409 The license must not restrict anyone from making use
410 of the program in a specific field of endeavor. For
411 example, it may not restrict the program from being
412 used in a business, or from being used for genetic
415 <tag>Distribution of License
418 The rights attached to the program must apply to all
419 to whom the program is redistributed without the need
420 for execution of an additional license by those
423 <tag>License Must Not Be Specific to Debian
426 The rights attached to the program must not depend on
427 the program's being part of a Debian system. If the
428 program is extracted from Debian and used or
429 distributed without Debian but otherwise within the
430 terms of the program's license, all parties to whom
431 the program is redistributed must have the same
432 rights as those that are granted in conjunction with
435 <tag>License Must Not Contaminate Other Software
438 The license must not place restrictions on other
439 software that is distributed along with the licensed
440 software. For example, the license must not insist
441 that all other programs distributed on the same medium
442 must be free software.
444 <tag>Example Licenses
447 The "GPL," "BSD," and "Artistic" licenses are examples of
448 licenses that we consider <em>free</em>.
455 <heading>Archive areas</heading>
458 <heading>The main archive area</heading>
461 Every package in <em>main</em> must comply with the DFSG
462 (Debian Free Software Guidelines).
466 In addition, the packages in <em>main</em>
467 <list compact="compact">
469 must not require a package outside of <em>main</em>
470 for compilation or execution (thus, the package must
471 not declare a "Depends", "Recommends", or
472 "Build-Depends" relationship on a non-<em>main</em>
476 must not be so buggy that we refuse to support them,
480 must meet all policy requirements presented in this
489 <heading>The contrib archive area</heading>
492 Every package in <em>contrib</em> must comply with the DFSG.
496 In addition, the packages in <em>contrib</em>
497 <list compact="compact">
499 must not be so buggy that we refuse to support them,
503 must meet all policy requirements presented in this
511 Examples of packages which would be included in
512 <em>contrib</em> are:
513 <list compact="compact">
515 free packages which require <em>contrib</em>,
516 <em>non-free</em> packages or packages which are not
517 in our archive at all for compilation or execution,
521 wrapper packages or other sorts of free accessories for
528 <sect1 id="non-free">
529 <heading>The non-free archive area</heading>
532 Packages must be placed in <em>non-free</em> if they are
533 not compliant with the DFSG or are encumbered by patents
534 or other legal issues that make their distribution
539 In addition, the packages in <em>non-free</em>
540 <list compact="compact">
542 must not be so buggy that we refuse to support them,
546 must meet all policy requirements presented in this
547 manual that it is possible for them to meet.
549 It is possible that there are policy
550 requirements which the package is unable to
551 meet, for example, if the source is
552 unavailable. These situations will need to be
553 handled on a case-by-case basis.
562 <sect id="pkgcopyright">
563 <heading>Copyright considerations</heading>
566 Every package must be accompanied by a verbatim copy of
567 its copyright and distribution license in the file
568 <file>/usr/share/doc/<var>package</var>/copyright</file>
569 (see <ref id="copyrightfile"> for further details).
573 We reserve the right to restrict files from being included
574 anywhere in our archives if
575 <list compact="compact">
577 their use or distribution would break a law,
580 there is an ethical conflict in their distribution or
584 we would have to sign a license for them, or
587 their distribution would conflict with other project
594 Programs whose authors encourage the user to make
595 donations are fine for the main distribution, provided
596 that the authors do not claim that not donating is
597 immoral, unethical, illegal or something similar; in such
598 a case they must go in <em>non-free</em>.
602 Packages whose copyright permission notices (or patent
603 problems) do not even allow redistribution of binaries
604 only, and where no special permission has been obtained,
605 must not be placed on the Debian FTP site and its mirrors
610 Note that under international copyright law (this applies
611 in the United States, too), <em>no</em> distribution or
612 modification of a work is allowed without an explicit
613 notice saying so. Therefore a program without a copyright
614 notice <em>is</em> copyrighted and you may not do anything
615 to it without risking being sued! Likewise if a program
616 has a copyright notice but no statement saying what is
617 permitted then nothing is permitted.
621 Many authors are unaware of the problems that restrictive
622 copyrights (or lack of copyright notices) can cause for
623 the users of their supposedly-free software. It is often
624 worthwhile contacting such authors diplomatically to ask
625 them to modify their license terms. However, this can be a
626 politically difficult thing to do and you should ask for
627 advice on the <tt>debian-legal</tt> mailing list first, as
632 When in doubt about a copyright, send mail to
633 <email>debian-legal@lists.debian.org</email>. Be prepared
634 to provide us with the copyright statement. Software
635 covered by the GPL, public domain software and BSD-like
636 copyrights are safe; be wary of the phrases "commercial
637 use prohibited" and "distribution restricted".
641 <sect id="subsections">
642 <heading>Sections</heading>
645 The packages in the archive areas <em>main</em>,
646 <em>contrib</em> and <em>non-free</em> are grouped further into
647 <em>sections</em> to simplify handling.
651 The archive area and section for each package should be
652 specified in the package's <tt>Section</tt> control record (see
653 <ref id="f-Section">). However, the maintainer of the Debian
654 archive may override this selection to ensure the consistency of
655 the Debian distribution. The <tt>Section</tt> field should be
657 <list compact="compact">
659 <em>section</em> if the package is in the
660 <em>main</em> archive area,
663 <em>area/section</em> if the package is in
664 the <em>contrib</em> or <em>non-free</em>
671 The Debian archive maintainers provide the authoritative
672 list of sections. At present, they are:
673 <em>admin</em>, <em>cli-mono</em>, <em>comm</em>, <em>database</em>,
674 <em>devel</em>, <em>debug</em>, <em>doc</em>, <em>editors</em>,
675 <em>electronics</em>, <em>embedded</em>, <em>fonts</em>,
676 <em>games</em>, <em>gnome</em>, <em>graphics</em>, <em>gnu-r</em>,
677 <em>gnustep</em>, <em>hamradio</em>, <em>haskell</em>,
678 <em>httpd</em>, <em>interpreters</em>, <em>java</em>, <em>kde</em>,
679 <em>kernel</em>, <em>libs</em>, <em>libdevel</em>, <em>lisp</em>,
680 <em>localization</em>, <em>mail</em>, <em>math</em>, <em>misc</em>,
681 <em>net</em>, <em>news</em>, <em>ocaml</em>, <em>oldlibs</em>,
682 <em>otherosfs</em>, <em>perl</em>, <em>php</em>, <em>python</em>,
683 <em>ruby</em>, <em>science</em>, <em>shells</em>, <em>sound</em>,
684 <em>tex</em>, <em>text</em>, <em>utils</em>, <em>vcs</em>,
685 <em>video</em>, <em>web</em>, <em>x11</em>, <em>xfce</em>,
690 <sect id="priorities">
691 <heading>Priorities</heading>
694 Each package should have a <em>priority</em> value, which is
695 included in the package's <em>control record</em>
696 (see <ref id="f-Priority">).
697 This information is used by the Debian package management tools to
698 separate high-priority packages from less-important packages.
702 The following <em>priority levels</em> are recognized by the
703 Debian package management tools.
705 <tag><tt>required</tt></tag>
707 Packages which are necessary for the proper
708 functioning of the system (usually, this means that
709 dpkg functionality depends on these packages).
710 Removing a <tt>required</tt> package may cause your
711 system to become totally broken and you may not even
712 be able to use <prgn>dpkg</prgn> to put things back,
713 so only do so if you know what you are doing. Systems
714 with only the <tt>required</tt> packages are probably
715 unusable, but they do have enough functionality to
716 allow the sysadmin to boot and install more software.
718 <tag><tt>important</tt></tag>
720 Important programs, including those which one would
721 expect to find on any Unix-like system. If the
722 expectation is that an experienced Unix person who
723 found it missing would say "What on earth is going on,
724 where is <prgn>foo</prgn>?", it must be an
725 <tt>important</tt> package.<footnote>
726 This is an important criterion because we are
727 trying to produce, amongst other things, a free
730 Other packages without which the system will not run
731 well or be usable must also have priority
732 <tt>important</tt>. This does
733 <em>not</em> include Emacs, the X Window System, TeX
734 or any other large applications. The
735 <tt>important</tt> packages are just a bare minimum of
736 commonly-expected and necessary tools.
738 <tag><tt>standard</tt></tag>
740 These packages provide a reasonably small but not too
741 limited character-mode system. This is what will be
742 installed by default if the user doesn't select anything
743 else. It doesn't include many large applications.
745 <tag><tt>optional</tt></tag>
747 (In a sense everything that isn't required is
748 optional, but that's not what is meant here.) This is
749 all the software that you might reasonably want to
750 install if you didn't know what it was and don't have
751 specialized requirements. This is a much larger system
752 and includes the X Window System, a full TeX
753 distribution, and many applications. Note that
754 optional packages should not conflict with each other.
756 <tag><tt>extra</tt></tag>
758 This contains all packages that conflict with others
759 with required, important, standard or optional
760 priorities, or are only likely to be useful if you
761 already know what they are or have specialized
762 requirements (such as packages containing only detached
769 Packages must not depend on packages with lower priority
770 values (excluding build-time dependencies). In order to
771 ensure this, the priorities of one or more packages may need
780 <heading>Binary packages</heading>
783 The Debian GNU/Linux distribution is based on the Debian
784 package management system, called <prgn>dpkg</prgn>. Thus,
785 all packages in the Debian distribution must be provided
786 in the <tt>.deb</tt> file format.
790 <heading>The package name</heading>
793 Every package must have a name that's unique within the Debian
798 The package name is included in the control field
799 <tt>Package</tt>, the format of which is described
800 in <ref id="f-Package">.
801 The package name is also included as a part of the file name
802 of the <tt>.deb</tt> file.
807 <heading>The version of a package</heading>
810 Every package has a version number recorded in its
811 <tt>Version</tt> control file field, described in
812 <ref id="f-Version">.
816 The package management system imposes an ordering on version
817 numbers, so that it can tell whether packages are being up- or
818 downgraded and so that package system front end applications
819 can tell whether a package it finds available is newer than
820 the one installed on the system. The version number format
821 has the most significant parts (as far as comparison is
822 concerned) at the beginning.
826 If an upstream package has problematic version numbers they
827 should be converted to a sane form for use in the
828 <tt>Version</tt> field.
832 <heading>Version numbers based on dates</heading>
835 In general, Debian packages should use the same version
836 numbers as the upstream sources.
840 However, in some cases where the upstream version number is
841 based on a date (e.g., a development "snapshot" release) the
842 package management system cannot handle these version
843 numbers without epochs. For example, dpkg will consider
844 "96May01" to be greater than "96Dec24".
848 To prevent having to use epochs for every new upstream
849 version, the date based portion of the version number
850 should be changed to the following format in such cases:
851 "19960501", "19961224". It is up to the maintainer whether
852 they want to bother the upstream maintainer to change
853 the version numbers upstream, too.
857 Note that other version formats based on dates which are
858 parsed correctly by the package management system should
859 <em>not</em> be changed.
863 Native Debian packages (i.e., packages which have been
864 written especially for Debian) whose version numbers include
865 dates should always use the "YYYYMMDD" format.
872 <heading>The maintainer of a package</heading>
875 Every package must have a Debian maintainer (the
876 maintainer may be one person or a group of people
877 reachable from a common email address, such as a mailing
878 list). The maintainer is responsible for ensuring that
879 the package is placed in the appropriate distributions.
883 The maintainer must be specified in the
884 <tt>Maintainer</tt> control field with their correct name
885 and a working email address. If one person maintains
886 several packages, they should try to avoid having
887 different forms of their name and email address in
888 the <tt>Maintainer</tt> fields of those packages.
892 The format of the <tt>Maintainer</tt> control field is
893 described in <ref id="f-Maintainer">.
897 If the maintainer of a package quits from the Debian
898 project, "Debian QA Group"
899 <email>packages@qa.debian.org</email> takes over the
900 maintainer-ship of the package until someone else
901 volunteers for that task. These packages are called
902 <em>orphaned packages</em>.<footnote>
903 The detailed procedure for doing this gracefully can
904 be found in the Debian Developer's Reference,
905 see <ref id="related">.
910 <sect id="descriptions">
911 <heading>The description of a package</heading>
914 Every Debian package must have an extended description
915 stored in the appropriate field of the control record.
916 The technical information about the format of the
917 <tt>Description</tt> field is in <ref id="f-Description">.
921 The description should describe the package (the program) to a
922 user (system administrator) who has never met it before so that
923 they have enough information to decide whether they want to
924 install it. This description should not just be copied verbatim
925 from the program's documentation.
929 Put important information first, both in the synopsis and
930 extended description. Sometimes only the first part of the
931 synopsis or of the description will be displayed. You can
932 assume that there will usually be a way to see the whole
933 extended description.
937 The description should also give information about the
938 significant dependencies and conflicts between this package
939 and others, so that the user knows why these dependencies and
940 conflicts have been declared.
944 Instructions for configuring or using the package should
945 not be included (that is what installation scripts,
946 manual pages, info files, etc., are for). Copyright
947 statements and other administrivia should not be included
948 either (that is what the copyright file is for).
951 <sect1 id="synopsis"><heading>The single line synopsis</heading>
954 The single line synopsis should be kept brief - certainly
959 Do not include the package name in the synopsis line. The
960 display software knows how to display this already, and you
961 do not need to state it. Remember that in many situations
962 the user may only see the synopsis line - make it as
963 informative as you can.
968 <sect1 id="extendeddesc"><heading>The extended description</heading>
971 Do not try to continue the single line synopsis into the
972 extended description. This will not work correctly when
973 the full description is displayed, and makes no sense
974 where only the summary (the single line synopsis) is
979 The extended description should describe what the package
980 does and how it relates to the rest of the system (in terms
981 of, for example, which subsystem it is which part of).
985 The description field needs to make sense to anyone, even
986 people who have no idea about any of the things the
987 package deals with.<footnote>
988 The blurb that comes with a program in its
989 announcements and/or <prgn>README</prgn> files is
990 rarely suitable for use in a description. It is
991 usually aimed at people who are already in the
992 community where the package is used.
1001 <heading>Dependencies</heading>
1004 Every package must specify the dependency information
1005 about other packages that are required for the first to
1010 For example, a dependency entry must be provided for any
1011 shared libraries required by a dynamically-linked executable
1012 binary in a package.
1016 Packages are not required to declare any dependencies they
1017 have on other packages which are marked <tt>Essential</tt>
1018 (see below), and should not do so unless they depend on a
1019 particular version of that package.<footnote>
1021 Essential is needed in part to avoid unresolvable dependency
1022 loops on upgrade. If packages add unnecessary dependencies
1023 on packages in this set, the chances that there
1024 <strong>will</strong> be an unresolvable dependency loop
1025 caused by forcing these Essential packages to be configured
1026 first before they need to be is greatly increased. It also
1027 increases the chances that frontends will be unable to
1028 <strong>calculate</strong> an upgrade path, even if one
1032 Also, functionality is rarely ever removed from the
1033 Essential set, but <em>packages</em> have been removed from
1034 the Essential set when the functionality moved to a
1035 different package. So depending on these packages <em>just
1036 in case</em> they stop being essential does way more harm
1043 Sometimes, a package requires another package to be installed
1044 <em>and</em> configured before it can be installed. In this
1045 case, you must specify a <tt>Pre-Depends</tt> entry for
1050 You should not specify a <tt>Pre-Depends</tt> entry for a
1051 package before this has been discussed on the
1052 <tt>debian-devel</tt> mailing list and a consensus about
1053 doing that has been reached.
1057 The format of the package interrelationship control fields is
1058 described in <ref id="relationships">.
1062 <sect id="virtual_pkg">
1063 <heading>Virtual packages</heading>
1066 Sometimes, there are several packages which offer
1067 more-or-less the same functionality. In this case, it's
1068 useful to define a <em>virtual package</em> whose name
1069 describes that common functionality. (The virtual
1070 packages only exist logically, not physically; that's why
1071 they are called <em>virtual</em>.) The packages with this
1072 particular function will then <em>provide</em> the virtual
1073 package. Thus, any other package requiring that function
1074 can simply depend on the virtual package without having to
1075 specify all possible packages individually.
1079 All packages should use virtual package names where
1080 appropriate, and arrange to create new ones if necessary.
1081 They should not use virtual package names (except privately,
1082 amongst a cooperating group of packages) unless they have
1083 been agreed upon and appear in the list of virtual package
1084 names. (See also <ref id="virtual">)
1088 The latest version of the authoritative list of virtual
1089 package names can be found in the <tt>debian-policy</tt> package.
1090 It is also available from the Debian web mirrors at
1091 <tt><url name="/doc/packaging-manuals/virtual-package-names-list.txt"
1092 id="http://www.debian.org/doc/packaging-manuals/virtual-package-names-list.txt"></tt>.
1096 The procedure for updating the list is described in the preface
1103 <heading>Base system</heading>
1106 The <tt>base system</tt> is a minimum subset of the Debian
1107 GNU/Linux system that is installed before everything else
1108 on a new system. Only very few packages are allowed to form
1109 part of the base system, in order to keep the required disk
1114 The base system consists of all those packages with priority
1115 <tt>required</tt> or <tt>important</tt>. Many of them will
1116 be tagged <tt>essential</tt> (see below).
1121 <heading>Essential packages</heading>
1124 Essential is defined as the minimal set of functionality that
1125 must be available and usable on the system at all times, even
1126 when packages are in an unconfigured (but unpacked) state.
1127 Packages are tagged <tt>essential</tt> for a system using the
1128 <tt>Essential</tt> control file field. The format of the
1129 <tt>Essential</tt> control field is described in <ref
1134 Since these packages cannot be easily removed (one has to
1135 specify an extra <em>force option</em> to
1136 <prgn>dpkg</prgn> to do so), this flag must not be used
1137 unless absolutely necessary. A shared library package
1138 must not be tagged <tt>essential</tt>; dependencies will
1139 prevent its premature removal, and we need to be able to
1140 remove it when it has been superseded.
1144 Since dpkg will not prevent upgrading of other packages
1145 while an <tt>essential</tt> package is in an unconfigured
1146 state, all <tt>essential</tt> packages must supply all of
1147 their core functionality even when unconfigured. If the
1148 package cannot satisfy this requirement it must not be
1149 tagged as essential, and any packages depending on this
1150 package must instead have explicit dependency fields as
1155 Maintainers should take great care in adding any programs,
1156 interfaces, or functionality to <tt>essential</tt> packages.
1157 Packages may assume that functionality provided by
1158 <tt>essential</tt> packages is always available without
1159 declaring explicit dependencies, which means that removing
1160 functionality from the Essential set is very difficult and is
1161 almost never done. Any capability added to an
1162 <tt>essential</tt> package therefore creates an obligation to
1163 support that capability as part of the Essential set in
1168 You must not tag any packages <tt>essential</tt> before
1169 this has been discussed on the <tt>debian-devel</tt>
1170 mailing list and a consensus about doing that has been
1175 <sect id="maintscripts">
1176 <heading>Maintainer Scripts</heading>
1179 The package installation scripts should avoid producing
1180 output which is unnecessary for the user to see and
1181 should rely on <prgn>dpkg</prgn> to stave off boredom on
1182 the part of a user installing many packages. This means,
1183 amongst other things, using the <tt>--quiet</tt> option on
1184 <prgn>install-info</prgn>.
1188 Errors which occur during the execution of an installation
1189 script must be checked and the installation must not
1190 continue after an error.
1194 Note that in general <ref id="scripts"> applies to package
1195 maintainer scripts, too.
1199 You should not use <prgn>dpkg-divert</prgn> on a file
1200 belonging to another package without consulting the
1201 maintainer of that package first.
1205 All packages which supply an instance of a common command
1206 name (or, in general, filename) should generally use
1207 <prgn>update-alternatives</prgn>, so that they may be
1208 installed together. If <prgn>update-alternatives</prgn>
1209 is not used, then each package must use
1210 <tt>Conflicts</tt> to ensure that other packages are
1211 de-installed. (In this case, it may be appropriate to
1212 specify a conflict against earlier versions of something
1213 that previously did not use
1214 <prgn>update-alternatives</prgn>; this is an exception to
1215 the usual rule that versioned conflicts should be
1219 <sect1 id="maintscriptprompt">
1220 <heading>Prompting in maintainer scripts</heading>
1222 Package maintainer scripts may prompt the user if
1223 necessary. Prompting must be done by communicating
1224 through a program, such as <prgn>debconf</prgn>, which
1225 conforms to the Debian Configuration Management
1226 Specification, version 2 or higher.
1230 Packages which are essential, or which are dependencies of
1231 essential packages, may fall back on another prompting method
1232 if no such interface is available when they are executed.
1236 The Debian Configuration Management Specification is included
1237 in the <file>debconf_specification</file> files in the
1238 <package>debian-policy</package> package.
1239 It is also available from the Debian web mirrors at
1240 <tt><url name="/doc/packaging-manuals/debconf_specification.html"
1241 id="http://www.debian.org/doc/packaging-manuals/debconf_specification.html"></tt>.
1245 Packages which use the Debian Configuration Management
1246 Specification may contain an additional
1247 <prgn>config</prgn> script and a <tt>templates</tt>
1248 file in their control archive<footnote>
1249 The control.tar.gz inside the .deb.
1250 See <manref name="deb" section="5">.
1252 The <prgn>config</prgn> script might be run before the
1253 <prgn>preinst</prgn> script, and before the package is unpacked
1254 or any of its dependencies or pre-dependencies are satisfied.
1255 Therefore it must work using only the tools present in
1256 <em>essential</em> packages.<footnote>
1257 <package>Debconf</package> or another tool that
1258 implements the Debian Configuration Management
1259 Specification will also be installed, and any
1260 versioned dependencies on it will be satisfied
1261 before preconfiguration begins.
1266 Packages which use the Debian Configuration Management
1267 Specification must allow for translation of their user-visible
1268 messages by using a gettext-based system such as the one
1269 provided by the <package>po-debconf</package> package.
1273 Packages should try to minimize the amount of prompting
1274 they need to do, and they should ensure that the user
1275 will only ever be asked each question once. This means
1276 that packages should try to use appropriate shared
1277 configuration files (such as <file>/etc/papersize</file> and
1278 <file>/etc/news/server</file>), and shared
1279 <package>debconf</package> variables rather than each
1280 prompting for their own list of required pieces of
1285 It also means that an upgrade should not ask the same
1286 questions again, unless the user has used
1287 <tt>dpkg --purge</tt> to remove the package's configuration.
1288 The answers to configuration questions should be stored in an
1289 appropriate place in <file>/etc</file> so that the user can
1290 modify them, and how this has been done should be
1295 If a package has a vitally important piece of
1296 information to pass to the user (such as "don't run me
1297 as I am, you must edit the following configuration files
1298 first or you risk your system emitting badly-formatted
1299 messages"), it should display this in the
1300 <prgn>config</prgn> or <prgn>postinst</prgn> script and
1301 prompt the user to hit return to acknowledge the
1302 message. Copyright messages do not count as vitally
1303 important (they belong in
1304 <file>/usr/share/doc/<var>package</var>/copyright</file>);
1305 neither do instructions on how to use a program (these
1306 should be in on-line documentation, where all the users
1311 Any necessary prompting should almost always be confined
1312 to the <prgn>config</prgn> or <prgn>postinst</prgn>
1313 script. If it is done in the <prgn>postinst</prgn>, it
1314 should be protected with a conditional so that
1315 unnecessary prompting doesn't happen if a package's
1316 installation fails and the <prgn>postinst</prgn> is
1317 called with <tt>abort-upgrade</tt>,
1318 <tt>abort-remove</tt> or <tt>abort-deconfigure</tt>.
1328 <heading>Source packages</heading>
1330 <sect id="standardsversion">
1331 <heading>Standards conformance</heading>
1334 Source packages should specify the most recent version number
1335 of this policy document with which your package complied
1336 when it was last updated.
1340 This information may be used to file bug reports
1341 automatically if your package becomes too much out of date.
1345 The version is specified in the <tt>Standards-Version</tt>
1347 The format of the <tt>Standards-Version</tt> field is
1348 described in <ref id="f-Standards-Version">.
1352 You should regularly, and especially if your package has
1353 become out of date, check for the newest Policy Manual
1354 available and update your package, if necessary. When your
1355 package complies with the new standards you should update the
1356 <tt>Standards-Version</tt> source package field and
1357 release it.<footnote>
1358 See the file <file>upgrading-checklist</file> for
1359 information about policy which has changed between
1360 different versions of this document.
1366 <sect id="pkg-relations">
1367 <heading>Package relationships</heading>
1370 Source packages should specify which binary packages they
1371 require to be installed or not to be installed in order to
1372 build correctly. For example, if building a package
1373 requires a certain compiler, then the compiler should be
1374 specified as a build-time dependency.
1378 It is not necessary to explicitly specify build-time
1379 relationships on a minimal set of packages that are always
1380 needed to compile, link and put in a Debian package a
1381 standard "Hello World!" program written in C or C++. The
1382 required packages are called <em>build-essential</em>, and
1383 an informational list can be found in
1384 <file>/usr/share/doc/build-essential/list</file> (which is
1385 contained in the <tt>build-essential</tt>
1388 <list compact="compact">
1390 This allows maintaining the list separately
1391 from the policy documents (the list does not
1392 need the kind of control that the policy
1396 Having a separate package allows one to install
1397 the build-essential packages on a machine, as
1398 well as allowing other packages such as tasks to
1399 require installation of the build-essential
1400 packages using the depends relation.
1403 The separate package allows bug reports against
1404 the list to be categorized separately from
1405 the policy management process in the BTS.
1412 When specifying the set of build-time dependencies, one
1413 should list only those packages explicitly required by the
1414 build. It is not necessary to list packages which are
1415 required merely because some other package in the list of
1416 build-time dependencies depends on them.<footnote>
1417 The reason for this is that dependencies change, and
1418 you should list all those packages, and <em>only</em>
1419 those packages that <em>you</em> need directly. What
1420 others need is their business. For example, if you
1421 only link against <file>libimlib</file>, you will need to
1422 build-depend on <package>libimlib2-dev</package> but
1423 not against any <tt>libjpeg*</tt> packages, even
1424 though <tt>libimlib2-dev</tt> currently depends on
1425 them: installation of <package>libimlib2-dev</package>
1426 will automatically ensure that all of its run-time
1427 dependencies are satisfied.
1432 If build-time dependencies are specified, it must be
1433 possible to build the package and produce working binaries
1434 on a system with only essential and build-essential
1435 packages installed and also those required to satisfy the
1436 build-time relationships (including any implied
1437 relationships). In particular, this means that version
1438 clauses should be used rigorously in build-time
1439 relationships so that one cannot produce bad or
1440 inconsistently configured packages when the relationships
1441 are properly satisfied.
1445 <ref id="relationships"> explains the technical details.
1450 <heading>Changes to the upstream sources</heading>
1453 If changes to the source code are made that are not
1454 specific to the needs of the Debian system, they should be
1455 sent to the upstream authors in whatever form they prefer
1456 so as to be included in the upstream version of the
1461 If you need to configure the package differently for
1462 Debian or for Linux, and the upstream source doesn't
1463 provide a way to do so, you should add such configuration
1464 facilities (for example, a new <prgn>autoconf</prgn> test
1465 or <tt>#define</tt>) and send the patch to the upstream
1466 authors, with the default set to the way they originally
1467 had it. You can then easily override the default in your
1468 <file>debian/rules</file> or wherever is appropriate.
1472 You should make sure that the <prgn>configure</prgn> utility
1473 detects the correct architecture specification string
1474 (refer to <ref id="arch-spec"> for details).
1478 If you need to edit a <prgn>Makefile</prgn> where GNU-style
1479 <prgn>configure</prgn> scripts are used, you should edit the
1480 <file>.in</file> files rather than editing the
1481 <prgn>Makefile</prgn> directly. This allows the user to
1482 reconfigure the package if necessary. You should
1483 <em>not</em> configure the package and edit the generated
1484 <prgn>Makefile</prgn>! This makes it impossible for someone
1485 else to later reconfigure the package without losing the
1491 <sect id="dpkgchangelog">
1492 <heading>Debian changelog: <file>debian/changelog</file></heading>
1495 Changes in the Debian version of the package should be
1496 briefly explained in the Debian changelog file
1497 <file>debian/changelog</file>.<footnote>
1499 Mistakes in changelogs are usually best rectified by
1500 making a new changelog entry rather than "rewriting
1501 history" by editing old changelog entries.
1504 This includes modifications
1505 made in the Debian package compared to the upstream one
1506 as well as other changes and updates to the package.
1508 Although there is nothing stopping an author who is also
1509 the Debian maintainer from using this changelog for all
1510 their changes, it will have to be renamed if the Debian
1511 and upstream maintainers become different people. In such
1512 a case, however, it might be better to maintain the package
1513 as a non-native package.
1518 The format of the <file>debian/changelog</file> allows the
1519 package building tools to discover which version of the package
1520 is being built and find out other release-specific information.
1524 That format is a series of entries like this:
1526 <example compact="compact">
1527 <var>package</var> (<var>version</var>) <var>distribution(s)</var>; urgency=<var>urgency</var>
1529 [optional blank line(s), stripped]
1531 * <var>change details</var>
1532 <var>more change details</var>
1534 [blank line(s), included in output of dpkg-parsechangelog]
1536 * <var>even more change details</var>
1538 [optional blank line(s), stripped]
1540 -- <var>maintainer name</var> <<var>email address</var>><var>[two spaces]</var> <var>date</var>
1545 <var>package</var> and <var>version</var> are the source
1546 package name and version number.
1550 <var>distribution(s)</var> lists the distributions where
1551 this version should be installed when it is uploaded - it
1552 is copied to the <tt>Distribution</tt> field in the
1553 <file>.changes</file> file. See <ref id="f-Distribution">.
1557 <var>urgency</var> is the value for the <tt>Urgency</tt>
1558 field in the <file>.changes</file> file for the upload
1559 (see <ref id="f-Urgency">). It is not possible to specify
1560 an urgency containing commas; commas are used to separate
1561 <tt><var>keyword</var>=<var>value</var></tt> settings in the
1562 <prgn>dpkg</prgn> changelog format (though there is
1563 currently only one useful <var>keyword</var>,
1568 The change details may in fact be any series of lines
1569 starting with at least two spaces, but conventionally each
1570 change starts with an asterisk and a separating space and
1571 continuation lines are indented so as to bring them in
1572 line with the start of the text above. Blank lines may be
1573 used here to separate groups of changes, if desired.
1577 If this upload resolves bugs recorded in the Bug Tracking
1578 System (BTS), they may be automatically closed on the
1579 inclusion of this package into the Debian archive by
1580 including the string: <tt>closes: Bug#<var>nnnnn</var></tt>
1581 in the change details.<footnote>
1582 To be precise, the string should match the following
1583 Perl regular expression:
1585 /closes:\s*(?:bug)?\#?\s?\d+(?:,\s*(?:bug)?\#?\s?\d+)*/i
1587 Then all of the bug numbers listed will be closed by the
1588 archive maintenance script (<prgn>katie</prgn>) using the
1589 <var>version</var> of the changelog entry.
1591 This information is conveyed via the <tt>Closes</tt> field
1592 in the <tt>.changes</tt> file (see <ref id="f-Closes">).
1596 The maintainer name and email address used in the changelog
1597 should be the details of the person uploading <em>this</em>
1598 version. They are <em>not</em> necessarily those of the
1599 usual package maintainer. The information here will be
1600 copied to the <tt>Changed-By</tt> field in the
1601 <tt>.changes</tt> file (see <ref id="f-Changed-By">),
1602 and then later used to send an acknowledgement when the
1603 upload has been installed.
1607 The <var>date</var> must be in RFC822 format<footnote>
1608 This is generated by <tt>date -R</tt>.
1609 </footnote>; it must include the time zone specified
1610 numerically, with the time zone name or abbreviation
1611 optionally present as a comment in parentheses.
1615 The first "title" line with the package name must start
1616 at the left hand margin. The "trailer" line with the
1617 maintainer and date details must be preceded by exactly
1618 one space. The maintainer details and the date must be
1619 separated by exactly two spaces.
1623 The entire changelog must be encoded in UTF-8.
1627 For more information on placement of the changelog files
1628 within binary packages, please see <ref id="changelogs">.
1632 <sect id="dpkgcopyright">
1633 <heading>Copyright: <file>debian/copyright</file></heading>
1635 Every package must be accompanied by a verbatim copy of
1636 its copyright and distribution license in the file
1637 <file>/usr/share/doc/<var>package</var>/copyright</file>
1638 (see <ref id="copyrightfile"> for further details). Also see
1639 <ref id="pkgcopyright"> for further considerations relayed
1640 to copyrights for packages.
1644 <heading>Error trapping in makefiles</heading>
1647 When <prgn>make</prgn> invokes a command in a makefile
1648 (including your package's upstream makefiles and
1649 <file>debian/rules</file>), it does so using <prgn>sh</prgn>. This
1650 means that <prgn>sh</prgn>'s usual bad error handling
1651 properties apply: if you include a miniature script as one
1652 of the commands in your makefile you'll find that if you
1653 don't do anything about it then errors are not detected
1654 and <prgn>make</prgn> will blithely continue after
1659 Every time you put more than one shell command (this
1660 includes using a loop) in a makefile command you
1661 must make sure that errors are trapped. For
1662 simple compound commands, such as changing directory and
1663 then running a program, using <tt>&&</tt> rather
1664 than semicolon as a command separator is sufficient. For
1665 more complex commands including most loops and
1666 conditionals you should include a separate <tt>set -e</tt>
1667 command at the start of every makefile command that's
1668 actually one of these miniature shell scripts.
1672 <sect id="timestamps">
1673 <heading>Time Stamps</heading>
1675 Maintainers should preserve the modification times of the
1676 upstream source files in a package, as far as is reasonably
1678 The rationale is that there is some information conveyed
1679 by knowing the age of the file, for example, you could
1680 recognize that some documentation is very old by looking
1681 at the modification time, so it would be nice if the
1682 modification time of the upstream source would be
1688 <sect id="restrictions">
1689 <heading>Restrictions on objects in source packages</heading>
1692 The source package may not contain any hard links<footnote>
1694 This is not currently detected when building source
1695 packages, but only when extracting
1699 Hard links may be permitted at some point in the
1700 future, but would require a fair amount of
1703 </footnote>, device special files, sockets or setuid or
1704 setgid files.<footnote>
1705 Setgid directories are allowed.
1710 <sect id="debianrules">
1711 <heading>Main building script: <file>debian/rules</file></heading>
1714 This file must be an executable makefile, and contains the
1715 package-specific recipes for compiling the package and
1716 building binary package(s) from the source.
1720 It must start with the line <tt>#!/usr/bin/make -f</tt>,
1721 so that it can be invoked by saying its name rather than
1722 invoking <prgn>make</prgn> explicitly.
1726 Since an interactive <file>debian/rules</file> script makes it
1727 impossible to auto-compile that package and also makes it
1728 hard for other people to reproduce the same binary
1729 package, all <em>required targets</em> MUST be
1730 non-interactive. At a minimum, required targets are the
1731 ones called by <prgn>dpkg-buildpackage</prgn>, namely,
1732 <em>clean</em>, <em>binary</em>, <em>binary-arch</em>,
1733 <em>binary-indep</em>, and <em>build</em>. It also follows
1734 that any target that these targets depend on must also be
1739 The targets are as follows (required unless stated otherwise):
1741 <tag><tt>build</tt></tag>
1744 The <tt>build</tt> target should perform all the
1745 configuration and compilation of the package.
1746 If a package has an interactive pre-build
1747 configuration routine, the Debianized source package
1748 must either be built after this has taken place (so
1749 that the binary package can be built without rerunning
1750 the configuration) or the configuration routine
1751 modified to become non-interactive. (The latter is
1752 preferable if there are architecture-specific features
1753 detected by the configuration routine.)
1757 For some packages, notably ones where the same
1758 source tree is compiled in different ways to produce
1759 two binary packages, the <tt>build</tt> target
1760 does not make much sense. For these packages it is
1761 good enough to provide two (or more) targets
1762 (<tt>build-a</tt> and <tt>build-b</tt> or whatever)
1763 for each of the ways of building the package, and a
1764 <tt>build</tt> target that does nothing. The
1765 <tt>binary</tt> target will have to build the
1766 package in each of the possible ways and make the
1767 binary package out of each.
1771 The <tt>build</tt> target must not do anything
1772 that might require root privilege.
1776 The <tt>build</tt> target may need to run the
1777 <tt>clean</tt> target first - see below.
1781 When a package has a configuration and build routine
1782 which takes a long time, or when the makefiles are
1783 poorly designed, or when <tt>build</tt> needs to
1784 run <tt>clean</tt> first, it is a good idea to
1785 <tt>touch build</tt> when the build process is
1786 complete. This will ensure that if <tt>debian/rules
1787 build</tt> is run again it will not rebuild the whole
1789 Another common way to do this is for <tt>build</tt>
1790 to depend on <prgn>build-stamp</prgn> and to do
1791 nothing else, and for the <prgn>build-stamp</prgn>
1792 target to do the building and to <tt>touch
1793 build-stamp</tt> on completion. This is
1794 especially useful if the build routine creates a
1795 file or directory called <tt>build</tt>; in such a
1796 case, <tt>build</tt> will need to be listed as
1797 a phony target (i.e., as a dependency of the
1798 <tt>.PHONY</tt> target). See the documentation of
1799 <prgn>make</prgn> for more information on phony
1805 <tag><tt>build-arch</tt> (optional),
1806 <tt>build-indep</tt> (optional)
1810 A package may also provide both of the targets
1811 <tt>build-arch</tt> and <tt>build-indep</tt>.
1812 The <tt>build-arch</tt> target, if provided, should
1813 perform all the configuration and compilation required
1814 for producing all architecture-dependant binary packages
1815 (those packages for which the body of the
1816 <tt>Architecture</tt> field in <tt>debian/control</tt>
1817 is not <tt>all</tt>).
1818 Similarly, the <tt>build-indep</tt> target, if
1819 provided, should perform all the configuration and
1820 compilation required for producing all
1821 architecture-independent binary packages
1822 (those packages for which the body of the
1823 <tt>Architecture</tt> field in <tt>debian/control</tt>
1825 The <tt>build</tt> target should depend on those of the
1826 targets <tt>build-arch</tt> and <tt>build-indep</tt> that
1827 are provided in the rules file.
1831 If one or both of the targets <tt>build-arch</tt> and
1832 <tt>build-indep</tt> are not provided, then invoking
1833 <file>debian/rules</file> with one of the not-provided
1834 targets as arguments should produce a exit status code
1835 of 2. Usually this is provided automatically by make
1836 if the target is missing.
1840 The <tt>build-arch</tt> and <tt>build-indep</tt> targets
1841 must not do anything that might require root privilege.
1845 <tag><tt>binary</tt>, <tt>binary-arch</tt>,
1846 <tt>binary-indep</tt>
1850 The <tt>binary</tt> target must be all that is
1851 necessary for the user to build the binary package(s)
1852 produced from this source package. It is
1853 split into two parts: <prgn>binary-arch</prgn> builds
1854 the binary packages which are specific to a particular
1855 architecture, and <tt>binary-indep</tt> builds
1856 those which are not.
1859 <tt>binary</tt> may be (and commonly is) a target with
1860 no commands which simply depends on
1861 <tt>binary-arch</tt> and <tt>binary-indep</tt>.
1864 Both <tt>binary-*</tt> targets should depend on the
1865 <tt>build</tt> target, or on the appropriate
1866 <tt>build-arch</tt> or <tt>build-indep</tt> target, if
1867 provided, so that the package is built if it has not
1868 been already. It should then create the relevant
1869 binary package(s), using <prgn>dpkg-gencontrol</prgn> to
1870 make their control files and <prgn>dpkg-deb</prgn> to
1871 build them and place them in the parent of the top
1876 Both the <tt>binary-arch</tt> and
1877 <tt>binary-indep</tt> targets <em>must</em> exist.
1878 If one of them has nothing to do (which will always be
1879 the case if the source generates only a single binary
1880 package, whether architecture-dependent or not), it
1881 must still exist and must always succeed.
1885 The <tt>binary</tt> targets must be invoked as
1887 The <prgn>fakeroot</prgn> package often allows one
1888 to build a package correctly even without being
1894 <tag><tt>clean</tt></tag>
1897 This must undo any effects that the <tt>build</tt>
1898 and <tt>binary</tt> targets may have had, except
1899 that it should leave alone any output files created in
1900 the parent directory by a run of a <tt>binary</tt>
1905 If a <tt>build</tt> file is touched at the end of
1906 the <tt>build</tt> target, as suggested above, it
1907 should be removed as the first action that
1908 <tt>clean</tt> performs, so that running
1909 <tt>build</tt> again after an interrupted
1910 <tt>clean</tt> doesn't think that everything is
1915 The <tt>clean</tt> target may need to be
1916 invoked as root if <tt>binary</tt> has been
1917 invoked since the last <tt>clean</tt>, or if
1918 <tt>build</tt> has been invoked as root (since
1919 <tt>build</tt> may create directories, for
1924 <tag><tt>get-orig-source</tt> (optional)</tag>
1927 This target fetches the most recent version of the
1928 original source package from a canonical archive site
1929 (via FTP or WWW, for example), does any necessary
1930 rearrangement to turn it into the original source
1931 tar file format described below, and leaves it in the
1936 This target may be invoked in any directory, and
1937 should take care to clean up any temporary files it
1942 This target is optional, but providing it if
1943 possible is a good idea.
1947 <tag><tt>patch</tt> (optional)</tag>
1950 This target performs whatever additional actions are
1951 required to make the source ready for editing (unpacking
1952 additional upstream archives, applying patches, etc.).
1953 It is recommended to be implemented for any package where
1954 <tt>dpkg-source -x</tt> does not result in source ready
1955 for additional modification. See
1956 <ref id="readmesource">.
1962 The <tt>build</tt>, <tt>binary</tt> and
1963 <tt>clean</tt> targets must be invoked with the current
1964 directory being the package's top-level directory.
1969 Additional targets may exist in <file>debian/rules</file>,
1970 either as published or undocumented interfaces or for the
1971 package's internal use.
1975 The architectures we build on and build for are determined
1976 by <prgn>make</prgn> variables using the utility
1977 <qref id="pkg-dpkg-architecture"><prgn>dpkg-architecture</prgn></qref>.
1978 You can determine the
1979 Debian architecture and the GNU style architecture
1980 specification string for the build machine (the machine type
1981 we are building on) as well as for the host machine (the
1982 machine type we are building for). Here is a list of
1983 supported <prgn>make</prgn> variables:
1984 <list compact="compact">
1986 <tt>DEB_*_ARCH</tt> (the Debian architecture)
1989 <tt>DEB_*_ARCH_CPU</tt> (the Debian CPU name)
1992 <tt>DEB_*_ARCH_OS</tt> (the Debian System name)
1995 <tt>DEB_*_GNU_TYPE</tt> (the GNU style architecture
1996 specification string)
1999 <tt>DEB_*_GNU_CPU</tt> (the CPU part of
2000 <tt>DEB_*_GNU_TYPE</tt>)
2003 <tt>DEB_*_GNU_SYSTEM</tt> (the System part of
2004 <tt>DEB_*_GNU_TYPE</tt>)
2006 where <tt>*</tt> is either <tt>BUILD</tt> for specification of
2007 the build machine or <tt>HOST</tt> for specification of the
2012 Backward compatibility can be provided in the rules file
2013 by setting the needed variables to suitable default
2014 values; please refer to the documentation of
2015 <prgn>dpkg-architecture</prgn> for details.
2019 It is important to understand that the <tt>DEB_*_ARCH</tt>
2020 string only determines which Debian architecture we are
2021 building on or for. It should not be used to get the CPU
2022 or system information; the <tt>DEB_*_ARCH_CPU</tt> and
2023 <tt>DEB_*_ARCH_OS</tt> variables should be used for that.
2024 GNU style variables should generally only be used with upstream
2028 <sect1 id="debianrules-options">
2029 <heading><file>debian/rules</file> and
2030 <tt>DEB_BUILD_OPTIONS</tt></heading>
2033 Supporting the standardized environment variable
2034 <tt>DEB_BUILD_OPTIONS</tt> is recommended. This variable can
2035 contain several flags to change how a package is compiled and
2036 built. Each flag must be in the form <var>flag</var> or
2037 <var>flag</var>=<var>options</var>. If multiple flags are
2038 given, they must be separated by whitespace.<footnote>
2039 Some packages support any delimiter, but whitespace is the
2040 easiest to parse inside a makefile and avoids ambiguity with
2041 flag values that contain commas.
2043 <var>flag</var> must start with a lowercase letter
2044 (<tt>a-z</tt>) and consist only of lowercase letters,
2045 numbers (<tt>0-9</tt>), and the characters
2046 <tt>-</tt> and <tt>_</tt> (hyphen and underscore).
2047 <var>options</var> must not contain whitespace. The same
2048 tag should not be given multiple times with conflicting
2049 values. Package maintainers may assume that
2050 <tt>DEB_BUILD_OPTIONS</tt> will not contain conflicting tags.
2054 The meaning of the following tags has been standardized:
2058 This tag says to not run any build-time test suite
2059 provided by the package.
2063 The presence of this tag means that the package should
2064 be compiled with a minimum of optimization. For C
2065 programs, it is best to add <tt>-O0</tt> to
2066 <tt>CFLAGS</tt> (although this is usually the default).
2067 Some programs might fail to build or run at this level
2068 of optimization; it may be necessary to use
2069 <tt>-O1</tt>, for example.
2073 This tag means that the debugging symbols should not be
2074 stripped from the binary during installation, so that
2075 debugging information may be included in the package.
2077 <tag>parallel=n</tag>
2079 This tag means that the package should be built using up
2080 to <tt>n</tt> parallel processes if the package build
2081 system supports this.<footnote>
2082 Packages built with <tt>make</tt> can often implement
2083 this by passing the <tt>-j</tt><var>n</var> option to
2086 If the package build system does not support parallel
2087 builds, this string must be ignored. If the package
2088 build system only supports a lower level of concurrency
2089 than <var>n</var>, the package should be built using as
2090 many parallel processes as the package build system
2091 supports. It is up to the package maintainer to decide
2092 whether the package build times are long enough and the
2093 package build system is robust enough to make supporting
2094 parallel builds worthwhile.
2100 Unknown flags must be ignored by <file>debian/rules</file>.
2104 The following makefile snippet is an example of how one may
2105 implement the build options; you will probably have to
2106 massage this example in order to make it work for your
2108 <example compact="compact">
2111 INSTALL_FILE = $(INSTALL) -p -o root -g root -m 644
2112 INSTALL_PROGRAM = $(INSTALL) -p -o root -g root -m 755
2113 INSTALL_SCRIPT = $(INSTALL) -p -o root -g root -m 755
2114 INSTALL_DIR = $(INSTALL) -p -d -o root -g root -m 755
2116 ifneq (,$(filter noopt,$(DEB_BUILD_OPTIONS)))
2121 ifeq (,$(filter nostrip,$(DEB_BUILD_OPTIONS)))
2122 INSTALL_PROGRAM += -s
2124 ifneq (,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
2125 NUMJOBS = $(patsubst parallel=%,%,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
2126 MAKEFLAGS += -j$(NUMJOBS)
2131 ifeq (,$(filter nocheck,$(DEB_BUILD_OPTIONS)))
2132 # Code to run the package test suite.
2139 <!-- FIXME: section pkg-srcsubstvars is the same as substvars -->
2140 <sect id="substvars">
2141 <heading>Variable substitutions: <file>debian/substvars</file></heading>
2144 When <prgn>dpkg-gencontrol</prgn>,
2145 <prgn>dpkg-genchanges</prgn> and <prgn>dpkg-source</prgn>
2146 generate control files they perform variable substitutions
2147 on their output just before writing it. Variable
2148 substitutions have the form <tt>${<var>variable</var>}</tt>.
2149 The optional file <file>debian/substvars</file> contains
2150 variable substitutions to be used; variables can also be set
2151 directly from <file>debian/rules</file> using the <tt>-V</tt>
2152 option to the source packaging commands, and certain
2153 predefined variables are also available.
2157 The <file>debian/substvars</file> file is usually generated and
2158 modified dynamically by <file>debian/rules</file> targets, in
2159 which case it must be removed by the <tt>clean</tt> target.
2163 See <manref name="deb-substvars" section="5"> for full
2164 details about source variable substitutions, including the
2165 format of <file>debian/substvars</file>.</p>
2168 <sect id="debianwatch">
2169 <heading>Optional upstream source location: <file>debian/watch</file></heading>
2172 This is an optional, recommended control file for the
2173 <tt>uscan</tt> utility which defines how to automatically
2174 scan ftp or http sites for newly available updates of the
2175 package. This is used by <url id="
2176 http://dehs.alioth.debian.org/"> and other Debian QA tools
2177 to help with quality control and maintenance of the
2178 distribution as a whole.
2183 <sect id="debianfiles">
2184 <heading>Generated files list: <file>debian/files</file></heading>
2187 This file is not a permanent part of the source tree; it
2188 is used while building packages to record which files are
2189 being generated. <prgn>dpkg-genchanges</prgn> uses it
2190 when it generates a <file>.changes</file> file.
2194 It should not exist in a shipped source package, and so it
2195 (and any backup files or temporary files such as
2196 <file>files.new</file><footnote>
2197 <file>files.new</file> is used as a temporary file by
2198 <prgn>dpkg-gencontrol</prgn> and
2199 <prgn>dpkg-distaddfile</prgn> - they write a new
2200 version of <tt>files</tt> here before renaming it,
2201 to avoid leaving a corrupted copy if an error
2203 </footnote>) should be removed by the
2204 <tt>clean</tt> target. It may also be wise to
2205 ensure a fresh start by emptying or removing it at the
2206 start of the <tt>binary</tt> target.
2210 When <prgn>dpkg-gencontrol</prgn> is run for a binary
2211 package, it adds an entry to <file>debian/files</file> for the
2212 <file>.deb</file> file that will be created when <tt>dpkg-deb
2213 --build</tt> is run for that binary package. So for most
2214 packages all that needs to be done with this file is to
2215 delete it in the <tt>clean</tt> target.
2219 If a package upload includes files besides the source
2220 package and any binary packages whose control files were
2221 made with <prgn>dpkg-gencontrol</prgn> then they should be
2222 placed in the parent of the package's top-level directory
2223 and <prgn>dpkg-distaddfile</prgn> should be called to add
2224 the file to the list in <file>debian/files</file>.</p>
2227 <sect id="embeddedfiles">
2228 <heading>Convenience copies of code</heading>
2231 Some software packages include in their distribution convenience
2232 copies of code from other software packages, generally so that
2233 users compiling from source don't have to download multiple
2234 packages. Debian packages should not make use of these
2235 convenience copies unless the included package is explicitly
2236 intended to be used in this way.<footnote>
2237 For example, parts of the GNU build system work like this.
2239 If the included code is already in the Debian archive in the
2240 form of a library, the Debian packaging should ensure that
2241 binary packages reference the libraries already in Debian and
2242 the convenience copy is not used. If the included code is not
2243 already in Debian, it should be packaged separately as a
2244 prerequisite if possible.
2246 Having multiple copies of the same code in Debian is
2247 inefficient, often creates either static linking or shared
2248 library conflicts, and, most importantly, increases the
2249 difficulty of handling security vulnerabilities in the
2255 <sect id="readmesource">
2256 <heading>Source package handling:
2257 <file>debian/README.source</file></heading>
2260 If running <prgn>dpkg-source -x</prgn> on a source package
2261 doesn't produce the source of the package, ready for editing,
2262 and allow one to make changes and run
2263 <prgn>dpkg-buildpackage</prgn> to produce a modified package
2264 without taking any additional steps, creating a
2265 <file>debian/README.source</file> documentation file is
2266 recommended. This file should explain how to do all of the
2269 <item>Generate the fully patched source, in a form ready for
2270 editing, that would be built to create Debian
2271 packages. Doing this with a <tt>patch</tt> target in
2272 <file>debian/rules</file> is recommended; see
2273 <ref id="debianrules">.</item>
2274 <item>Modify the source and save those modifications so that
2275 they will be applied when building the package.</item>
2276 <item>Remove source modifications that are currently being
2277 applied when building the package.</item>
2278 <item>Optionally, document what steps are necessary to
2279 upgrade the Debian source package to a new upstream version,
2280 if applicable.</item>
2282 This explanation should include specific commands and mention
2283 any additional required Debian packages. It should not assume
2284 familiarity with any specific Debian packaging system or patch
2289 This explanation may refer to a documentation file installed by
2290 one of the package's build dependencies provided that the
2291 referenced documentation clearly explains these tasks and is not
2292 a general reference manual.
2296 <file>debian/README.source</file> may also include any other
2297 information that would be helpful to someone modifying the
2298 source package. Even if the package doesn't fit the above
2299 description, maintainers are encouraged to document in a
2300 <file>debian/README.source</file> file any source package with a
2301 particularly complex or unintuitive source layout or build
2302 system (for example, a package that builds the same source
2303 multiple times to generate different binary packages).
2309 <chapt id="controlfields">
2310 <heading>Control files and their fields</heading>
2313 The package management system manipulates data represented in
2314 a common format, known as <em>control data</em>, stored in
2315 <em>control files</em>.
2316 Control files are used for source packages, binary packages and
2317 the <file>.changes</file> files which control the installation
2318 of uploaded files<footnote>
2319 <prgn>dpkg</prgn>'s internal databases are in a similar
2324 <sect id="controlsyntax">
2325 <heading>Syntax of control files</heading>
2328 A control file consists of one or more paragraphs of
2330 The paragraphs are also sometimes referred to as stanzas.
2332 The paragraphs are separated by blank lines. Some control
2333 files allow only one paragraph; others allow several, in
2334 which case each paragraph usually refers to a different
2335 package. (For example, in source packages, the first
2336 paragraph refers to the source package, and later paragraphs
2337 refer to binary packages generated from the source.)
2341 Each paragraph consists of a series of data fields; each
2342 field consists of the field name, followed by a colon and
2343 then the data/value associated with that field. It ends at
2344 the end of the (logical) line. Horizontal whitespace
2345 (spaces and tabs) may occur immediately before or after the
2346 value and is ignored there; it is conventional to put a
2347 single space after the colon. For example, a field might
2349 <example compact="compact">
2352 the field name is <tt>Package</tt> and the field value
2357 Many fields' values may span several lines; in this case
2358 each continuation line must start with a space or a tab.
2359 Any trailing spaces or tabs at the end of individual
2360 lines of a field value are ignored.
2364 In fields where it is specified that lines may not wrap,
2365 only a single line of data is allowed and whitespace is not
2366 significant in a field body. Whitespace must not appear
2367 inside names (of packages, architectures, files or anything
2368 else) or version numbers, or between the characters of
2369 multi-character version relationships.
2373 Field names are not case-sensitive, but it is usual to
2374 capitalize the field names using mixed case as shown below.
2378 Blank lines, or lines consisting only of spaces and tabs,
2379 are not allowed within field values or between fields - that
2380 would mean a new paragraph.
2384 All control files must be encoded in UTF-8.
2388 <sect id="sourcecontrolfiles">
2389 <heading>Source package control files -- <file>debian/control</file></heading>
2392 The <file>debian/control</file> file contains the most vital
2393 (and version-independent) information about the source package
2394 and about the binary packages it creates.
2398 The first paragraph of the control file contains information about
2399 the source package in general. The subsequent sets each describe a
2400 binary package that the source tree builds.
2404 The fields in the general paragraph (the first one, for the source
2407 <list compact="compact">
2408 <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2409 <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2410 <item><qref id="f-Uploaders"><tt>Uploaders</tt></qref></item>
2411 <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2412 <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2413 <item><qref id="sourcebinarydeps"><tt>Build-Depends</tt> et al</qref></item>
2414 <item><qref id="f-Standards-Version"><tt>Standards-Version</tt></qref> (recommended)</item>
2415 <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2420 The fields in the binary package paragraphs are:
2422 <list compact="compact">
2423 <item><qref id="f-Package"><tt>Package</tt></qref> (mandatory)</item>
2424 <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2425 <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2426 <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2427 <item><qref id="f-Essential"><tt>Essential</tt></qref></item>
2428 <item><qref id="binarydeps"><tt>Depends</tt> et al</qref></item>
2429 <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2430 <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2435 The syntax and semantics of the fields are described below.
2441 These fields are used by <prgn>dpkg-gencontrol</prgn> to
2442 generate control files for binary packages (see below), by
2443 <prgn>dpkg-genchanges</prgn> to generate the
2444 <tt>.changes</tt> file to accompany the upload, and by
2445 <prgn>dpkg-source</prgn> when it creates the
2446 <file>.dsc</file> source control file as part of a source
2447 archive. Many fields are permitted to span multiple lines in
2448 <file>debian/control</file> but not in any other control
2449 file. These tools are responsible for removing the line
2450 breaks from such fields when using fields from
2451 <file>debian/control</file> to generate other control files.
2455 The fields here may contain variable references - their
2456 values will be substituted by <prgn>dpkg-gencontrol</prgn>,
2457 <prgn>dpkg-genchanges</prgn> or <prgn>dpkg-source</prgn>
2458 when they generate output control files.
2459 See <ref id="substvars"> for details.
2463 In addition to the control file syntax described <qref
2464 id="controlsyntax">above</qref>, this file may also contain
2465 comment lines starting with <tt>#</tt> without any preceding
2466 whitespace. All such lines are ignored, even in the middle of
2467 continuation lines for a multiline field, and do not end a
2473 <sect id="binarycontrolfiles">
2474 <heading>Binary package control files -- <file>DEBIAN/control</file></heading>
2477 The <file>DEBIAN/control</file> file contains the most vital
2478 (and version-dependent) information about a binary package.
2482 The fields in this file are:
2484 <list compact="compact">
2485 <item><qref id="f-Package"><tt>Package</tt></qref> (mandatory)</item>
2486 <item><qref id="f-Source"><tt>Source</tt></qref></item>
2487 <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2488 <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2489 <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2490 <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2491 <item><qref id="f-Essential"><tt>Essential</tt></qref></item>
2492 <item><qref id="binarydeps"><tt>Depends</tt> et al</qref></item>
2493 <item><qref id="f-Installed-Size"><tt>Installed-Size</tt></qref></item>
2494 <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2495 <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2496 <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2501 <sect id="debiansourcecontrolfiles">
2502 <heading>Debian source control files -- <tt>.dsc</tt></heading>
2505 This file contains a series of fields, identified and
2506 separated just like the fields in the control file of
2507 a binary package. The fields are listed below; their
2508 syntax is described above, in <ref id="pkg-controlfields">.
2510 <list compact="compact">
2511 <item><qref id="f-Format"><tt>Format</tt></qref> (mandatory)</item>
2512 <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2513 <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2514 <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2515 <item><qref id="f-Uploaders"><tt>Uploaders</tt></qref></item>
2516 <item><qref id="f-Binary"><tt>Binary</tt></qref></item>
2517 <item><qref id="f-Architecture"><tt>Architecture</tt></qref></item>
2518 <item><qref id="sourcebinarydeps"><tt>Build-Depends</tt> et al</qref></item>
2519 <item><qref id="f-Standards-Version"><tt>Standards-Version</tt></qref> (recommended)</item>
2520 <item><qref id="f-Files"><tt>Files</tt></qref> (mandatory)</item>
2521 <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2526 The source package control file is generated by
2527 <prgn>dpkg-source</prgn> when it builds the source
2528 archive, from other files in the source package,
2529 described above. When unpacking, it is checked against
2530 the files and directories in the other parts of the
2536 <sect id="debianchangesfiles">
2537 <heading>Debian changes files -- <file>.changes</file></heading>
2540 The .changes files are used by the Debian archive maintenance
2541 software to process updates to packages. They contain one
2542 paragraph which contains information from the
2543 <tt>debian/control</tt> file and other data about the
2544 source package gathered via <tt>debian/changelog</tt>
2545 and <tt>debian/rules</tt>.
2549 The fields in this file are:
2551 <list compact="compact">
2552 <item><qref id="f-Format"><tt>Format</tt></qref> (mandatory)</item>
2553 <item><qref id="f-Date"><tt>Date</tt></qref> (mandatory)</item>
2554 <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2555 <item><qref id="f-Binary"><tt>Binary</tt></qref> (mandatory)</item>
2556 <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2557 <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2558 <item><qref id="f-Distribution"><tt>Distribution</tt></qref> (mandatory)</item>
2559 <item><qref id="f-Urgency"><tt>Urgency</tt></qref> (recommended)</item>
2560 <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2561 <item><qref id="f-Changed-By"><tt>Changed-By</tt></qref></item>
2562 <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2563 <item><qref id="f-Closes"><tt>Closes</tt></qref></item>
2564 <item><qref id="f-Changes"><tt>Changes</tt></qref> (mandatory)</item>
2565 <item><qref id="f-Files"><tt>Files</tt></qref> (mandatory)</item>
2570 <sect id="controlfieldslist">
2571 <heading>List of fields</heading>
2573 <sect1 id="f-Source">
2574 <heading><tt>Source</tt></heading>
2577 This field identifies the source package name.
2581 In <file>debian/control</file> or a <file>.dsc</file> file,
2582 this field must contain only the name of the source package.
2586 In a binary package control file or a <file>.changes</file>
2587 file, the source package name may be followed by a version
2588 number in parentheses<footnote>
2589 It is customary to leave a space after the package name
2590 if a version number is specified.
2592 This version number may be omitted (and is, by
2593 <prgn>dpkg-gencontrol</prgn>) if it has the same value as
2594 the <tt>Version</tt> field of the binary package in
2595 question. The field itself may be omitted from a binary
2596 package control file when the source package has the same
2597 name and version as the binary package.
2601 Package names must consist only of lower case letters
2602 (<tt>a-z</tt>), digits (<tt>0-9</tt>), plus (<tt>+</tt>)
2603 and minus (<tt>-</tt>) signs, and periods (<tt>.</tt>).
2604 They must be at least two characters long and must start
2605 with an alphanumeric character.
2609 <sect1 id="f-Maintainer">
2610 <heading><tt>Maintainer</tt></heading>
2613 The package maintainer's name and email address. The name
2614 should come first, then the email address inside angle
2615 brackets <tt><></tt> (in RFC822 format).
2619 If the maintainer's name contains a full stop then the
2620 whole field will not work directly as an email address due
2621 to a misfeature in the syntax specified in RFC822; a
2622 program using this field as an address must check for this
2623 and correct the problem if necessary (for example by
2624 putting the name in round brackets and moving it to the
2625 end, and bringing the email address forward).
2629 <sect1 id="f-Uploaders">
2630 <heading><tt>Uploaders</tt></heading>
2633 List of the names and email addresses of co-maintainers of
2634 the package, if any. If the package has other maintainers
2635 beside the one named in the
2636 <qref id="f-Maintainer">Maintainer field</qref>, their
2637 names and email addresses should be listed here. The
2638 format is the same as that of the Maintainer tag, and
2639 multiple entries should be comma separated. Currently,
2640 this field is restricted to a single line of data. This
2641 is an optional field.
2644 Any parser that interprets the Uploaders field in
2645 <file>debian/control</file> must permit it to span multiple
2646 lines. Line breaks in an Uploaders field that spans multiple
2647 lines are not significant and the semantics of the field are
2648 the same as if the line breaks had not been present.
2652 <sect1 id="f-Changed-By">
2653 <heading><tt>Changed-By</tt></heading>
2656 The name and email address of the person who changed the
2657 said package. Usually the name of the maintainer.
2658 All the rules for the Maintainer field apply here, too.
2662 <sect1 id="f-Section">
2663 <heading><tt>Section</tt></heading>
2666 This field specifies an application area into which the package
2667 has been classified. See <ref id="subsections">.
2671 When it appears in the <file>debian/control</file> file,
2672 it gives the value for the subfield of the same name in
2673 the <tt>Files</tt> field of the <file>.changes</file> file.
2674 It also gives the default for the same field in the binary
2679 <sect1 id="f-Priority">
2680 <heading><tt>Priority</tt></heading>
2683 This field represents how important that it is that the user
2684 have the package installed. See <ref id="priorities">.
2688 When it appears in the <file>debian/control</file> file,
2689 it gives the value for the subfield of the same name in
2690 the <tt>Files</tt> field of the <file>.changes</file> file.
2691 It also gives the default for the same field in the binary
2696 <sect1 id="f-Package">
2697 <heading><tt>Package</tt></heading>
2700 The name of the binary package.
2704 Package names must consist only of lower case letters
2705 (<tt>a-z</tt>), digits (<tt>0-9</tt>), plus (<tt>+</tt>)
2706 and minus (<tt>-</tt>) signs, and periods (<tt>.</tt>).
2707 They must be at least two characters long and must start
2708 with an alphanumeric character.
2712 <sect1 id="f-Architecture">
2713 <heading><tt>Architecture</tt></heading>
2716 Depending on context and the control file used, the
2717 <tt>Architecture</tt> field can include the following sets of
2720 <item>A unique single word identifying a Debian machine
2721 architecture as described in <ref id="arch-spec">.
2722 <item><tt>all</tt>, which indicates an
2723 architecture-independent package.
2724 <item><tt>any</tt>, which indicates a package available
2725 for building on any architecture.
2726 <item><tt>source</tt>, which indicates a source package.
2731 In the main <file>debian/control</file> file in the source
2732 package, this field may contain the special value
2733 <tt>any</tt>, the special value <tt>all</tt>, or a list of
2734 architectures separated by spaces. If <tt>any</tt> or
2735 <tt>all</tt> appear, they must be the entire contents of the
2736 field. Most packages will use either <tt>any</tt> or
2737 <tt>all</tt>. Specifying a specific list of architectures is
2738 for the minority of cases where a program is not portable or
2739 is not useful on some architectures, and where possible the
2740 program should be made portable instead.
2744 In the source package control file <file>.dsc</file>, this
2745 field may contain either the special value <tt>any</tt> or a
2746 list of architectures separated by spaces. If a list is given,
2747 it may include (or consist solely of) the special value
2748 <tt>all</tt>. In other words, in <file>.dsc</file> files
2749 unlike the <file>debian/control</file>, <tt>all</tt> may occur
2750 in combination with specific architectures. The
2751 <tt>Architecture</tt> field in the source package control file
2752 <file>.dsc</file> is generally constructed from the
2753 <tt>Architecture</tt> fields in the
2754 <file>debian/control</file> in the source package.
2758 Specifying <tt>any</tt> indicates that the source package
2759 isn't dependent on any particular architecture and should
2760 compile fine on any one. The produced binary package(s)
2761 will either be specific to whatever the current build
2762 architecture is or will be architecture-independent.
2766 Specifying only <tt>all</tt> indicates that the source package
2767 will only build architecture-independent packages. If this is
2768 the case, <tt>all</tt> must be used rather than <tt>any</tt>;
2769 <tt>any</tt> implies that the source package will build at
2770 least one architecture-dependent package.
2774 Specifying a list of architectures indicates that the source
2775 will build an architecture-dependent package, and will only
2776 work correctly on the listed architectures. If the source
2777 package also builds at least one architecture-independent
2778 package, <tt>all</tt> will also be included in the list.
2782 In a <file>.changes</file> file, the <tt>Architecture</tt>
2783 field lists the architecture(s) of the package(s)
2784 currently being uploaded. This will be a list; if the
2785 source for the package is also being uploaded, the special
2786 entry <tt>source</tt> is also present. <tt>all</tt> will be
2787 present if any architecture-independent packages are being
2788 uploaded. <tt>any</tt> may never occur in the
2789 <tt>Architecture</tt> field in the <file>.changes</file>
2794 See <ref id="debianrules"> for information how to get the
2795 architecture for the build process.
2799 <sect1 id="f-Essential">
2800 <heading><tt>Essential</tt></heading>
2803 This is a boolean field which may occur only in the
2804 control file of a binary package or in a per-package fields
2805 paragraph of a main source control data file.
2809 If set to <tt>yes</tt> then the package management system
2810 will refuse to remove the package (upgrading and replacing
2811 it is still possible). The other possible value is <tt>no</tt>,
2812 which is the same as not having the field at all.
2817 <heading>Package interrelationship fields:
2818 <tt>Depends</tt>, <tt>Pre-Depends</tt>,
2819 <tt>Recommends</tt>, <tt>Suggests</tt>,
2820 <tt>Breaks</tt>, <tt>Conflicts</tt>,
2821 <tt>Provides</tt>, <tt>Replaces</tt>, <tt>Enhances</tt>
2825 These fields describe the package's relationships with
2826 other packages. Their syntax and semantics are described
2827 in <ref id="relationships">.</p>
2830 <sect1 id="f-Standards-Version">
2831 <heading><tt>Standards-Version</tt></heading>
2834 The most recent version of the standards (the policy
2835 manual and associated texts) with which the package
2840 The version number has four components: major and minor
2841 version number and major and minor patch level. When the
2842 standards change in a way that requires every package to
2843 change the major number will be changed. Significant
2844 changes that will require work in many packages will be
2845 signaled by a change to the minor number. The major patch
2846 level will be changed for any change to the meaning of the
2847 standards, however small; the minor patch level will be
2848 changed when only cosmetic, typographical or other edits
2849 are made which neither change the meaning of the document
2850 nor affect the contents of packages.
2854 Thus only the first three components of the policy version
2855 are significant in the <em>Standards-Version</em> control
2856 field, and so either these three components or the all
2857 four components may be specified.<footnote>
2858 In the past, people specified the full version number
2859 in the Standards-Version field, for example "2.3.0.0".
2860 Since minor patch-level changes don't introduce new
2861 policy, it was thought it would be better to relax
2862 policy and only require the first 3 components to be
2863 specified, in this example "2.3.0". All four
2864 components may still be used if someone wishes to do so.
2870 <sect1 id="f-Version">
2871 <heading><tt>Version</tt></heading>
2874 The version number of a package. The format is:
2875 [<var>epoch</var><tt>:</tt>]<var>upstream_version</var>[<tt>-</tt><var>debian_revision</var>]
2879 The three components here are:
2881 <tag><var>epoch</var></tag>
2884 This is a single (generally small) unsigned integer. It
2885 may be omitted, in which case zero is assumed. If it is
2886 omitted then the <var>upstream_version</var> may not
2891 It is provided to allow mistakes in the version numbers
2892 of older versions of a package, and also a package's
2893 previous version numbering schemes, to be left behind.
2897 <tag><var>upstream_version</var></tag>
2900 This is the main part of the version number. It is
2901 usually the version number of the original ("upstream")
2902 package from which the <file>.deb</file> file has been made,
2903 if this is applicable. Usually this will be in the same
2904 format as that specified by the upstream author(s);
2905 however, it may need to be reformatted to fit into the
2906 package management system's format and comparison
2911 The comparison behavior of the package management system
2912 with respect to the <var>upstream_version</var> is
2913 described below. The <var>upstream_version</var>
2914 portion of the version number is mandatory.
2918 The <var>upstream_version</var> may contain only
2919 alphanumerics<footnote>
2920 Alphanumerics are <tt>A-Za-z0-9</tt> only.
2922 and the characters <tt>.</tt> <tt>+</tt> <tt>-</tt>
2923 <tt>:</tt> <tt>~</tt> (full stop, plus, hyphen, colon,
2924 tilde) and should start with a digit. If there is no
2925 <var>debian_revision</var> then hyphens are not allowed;
2926 if there is no <var>epoch</var> then colons are not
2931 <tag><var>debian_revision</var></tag>
2934 This part of the version number specifies the version of
2935 the Debian package based on the upstream version. It
2936 may contain only alphanumerics and the characters
2937 <tt>+</tt> <tt>.</tt> <tt>~</tt> (plus, full stop,
2938 tilde) and is compared in the same way as the
2939 <var>upstream_version</var> is.
2943 It is optional; if it isn't present then the
2944 <var>upstream_version</var> may not contain a hyphen.
2945 This format represents the case where a piece of
2946 software was written specifically to be turned into a
2947 Debian package, and so there is only one "debianisation"
2948 of it and therefore no revision indication is required.
2952 It is conventional to restart the
2953 <var>debian_revision</var> at <tt>1</tt> each time the
2954 <var>upstream_version</var> is increased.
2958 The package management system will break the version
2959 number apart at the last hyphen in the string (if there
2960 is one) to determine the <var>upstream_version</var> and
2961 <var>debian_revision</var>. The absence of a
2962 <var>debian_revision</var> is equivalent to a
2963 <var>debian_revision</var> of <tt>0</tt>.
2970 When comparing two version numbers, first the <var>epoch</var>
2971 of each are compared, then the <var>upstream_version</var> if
2972 <var>epoch</var> is equal, and then <var>debian_revision</var>
2973 if <var>upstream_version</var> is also equal.
2974 <var>epoch</var> is compared numerically. The
2975 <var>upstream_version</var> and <var>debian_revision</var>
2976 parts are compared by the package management system using the
2977 following algorithm:
2981 The strings are compared from left to right.
2985 First the initial part of each string consisting entirely of
2986 non-digit characters is determined. These two parts (one of
2987 which may be empty) are compared lexically. If a difference
2988 is found it is returned. The lexical comparison is a
2989 comparison of ASCII values modified so that all the letters
2990 sort earlier than all the non-letters and so that a tilde
2991 sorts before anything, even the end of a part. For example,
2992 the following parts are in sorted order from earliest to
2993 latest: <tt>~~</tt>, <tt>~~a</tt>, <tt>~</tt>, the empty part,
2994 <tt>a</tt>.<footnote>
2995 One common use of <tt>~</tt> is for upstream pre-releases.
2996 For example, <tt>1.0~beta1~svn1245</tt> sorts earlier than
2997 <tt>1.0~beta1</tt>, which sorts earlier than <tt>1.0</tt>.
3002 Then the initial part of the remainder of each string which
3003 consists entirely of digit characters is determined. The
3004 numerical values of these two parts are compared, and any
3005 difference found is returned as the result of the comparison.
3006 For these purposes an empty string (which can only occur at
3007 the end of one or both version strings being compared) counts
3012 These two steps (comparing and removing initial non-digit
3013 strings and initial digit strings) are repeated until a
3014 difference is found or both strings are exhausted.
3018 Note that the purpose of epochs is to allow us to leave behind
3019 mistakes in version numbering, and to cope with situations
3020 where the version numbering scheme changes. It is
3021 <em>not</em> intended to cope with version numbers containing
3022 strings of letters which the package management system cannot
3023 interpret (such as <tt>ALPHA</tt> or <tt>pre-</tt>), or with
3024 silly orderings (the author of this manual has heard of a
3025 package whose versions went <tt>1.1</tt>, <tt>1.2</tt>,
3026 <tt>1.3</tt>, <tt>1</tt>, <tt>2.1</tt>, <tt>2.2</tt>,
3027 <tt>2</tt> and so forth).
3031 <sect1 id="f-Description">
3032 <heading><tt>Description</tt></heading>
3035 In a source or binary control file, the <tt>Description</tt>
3036 field contains a description of the binary package, consisting
3037 of two parts, the synopsis or the short description, and the
3038 long description. The field's format is as follows:
3043 Description: <single line synopsis>
3044 <extended description over several lines>
3049 The lines in the extended description can have these formats:
3055 Those starting with a single space are part of a paragraph.
3056 Successive lines of this form will be word-wrapped when
3057 displayed. The leading space will usually be stripped off.
3061 Those starting with two or more spaces. These will be
3062 displayed verbatim. If the display cannot be panned
3063 horizontally, the displaying program will line wrap them "hard"
3064 (i.e., without taking account of word breaks). If it can they
3065 will be allowed to trail off to the right. None, one or two
3066 initial spaces may be deleted, but the number of spaces
3067 deleted from each line will be the same (so that you can have
3068 indenting work correctly, for example).
3072 Those containing a single space followed by a single full stop
3073 character. These are rendered as blank lines. This is the
3074 <em>only</em> way to get a blank line<footnote>
3075 Completely empty lines will not be rendered as blank lines.
3076 Instead, they will cause the parser to think you're starting
3077 a whole new record in the control file, and will therefore
3078 likely abort with an error.
3083 Those containing a space, a full stop and some more characters.
3084 These are for future expansion. Do not use them.
3090 Do not use tab characters. Their effect is not predictable.
3094 See <ref id="descriptions"> for further information on this.
3098 In a <file>.changes</file> file, the <tt>Description</tt> field
3099 contains a summary of the descriptions for the packages being
3104 The part of the field before the first newline is empty;
3105 thereafter each line has the name of a binary package and
3106 the summary description line from that binary package.
3107 Each line is indented by one space.
3112 <sect1 id="f-Distribution">
3113 <heading><tt>Distribution</tt></heading>
3116 In a <file>.changes</file> file or parsed changelog output
3117 this contains the (space-separated) name(s) of the
3118 distribution(s) where this version of the package should
3119 be installed. Valid distributions are determined by the
3120 archive maintainers.<footnote>
3121 Current distribution names are:
3122 <taglist compact="compact">
3123 <tag><em>stable</em></tag>
3125 This is the current "released" version of Debian
3126 GNU/Linux. Once the distribution is
3127 <em>stable</em> only security fixes and other
3128 major bug fixes are allowed. When changes are
3129 made to this distribution, the release number is
3130 increased (for example: 2.2r1 becomes 2.2r2 then
3134 <tag><em>unstable</em></tag>
3136 This distribution value refers to the
3137 <em>developmental</em> part of the Debian
3138 distribution tree. New packages, new upstream
3139 versions of packages and bug fixes go into the
3140 <em>unstable</em> directory tree. Download from
3141 this distribution at your own risk.
3144 <tag><em>testing</em></tag>
3146 This distribution value refers to the
3147 <em>testing</em> part of the Debian distribution
3148 tree. It receives its packages from the
3149 unstable distribution after a short time lag to
3150 ensure that there are no major issues with the
3151 unstable packages. It is less prone to breakage
3152 than unstable, but still risky. It is not
3153 possible to upload packages directly to
3157 <tag><em>frozen</em></tag>
3159 From time to time, the <em>testing</em>
3160 distribution enters a state of "code-freeze" in
3161 anticipation of release as a <em>stable</em>
3162 version. During this period of testing only
3163 fixes for existing or newly-discovered bugs will
3164 be allowed. The exact details of this stage are
3165 determined by the Release Manager.
3168 <tag><em>experimental</em></tag>
3170 The packages with this distribution value are
3171 deemed by their maintainers to be high
3172 risk. Oftentimes they represent early beta or
3173 developmental packages from various sources that
3174 the maintainers want people to try, but are not
3175 ready to be a part of the other parts of the
3176 Debian distribution tree. Download at your own
3182 You should list <em>all</em> distributions that the
3183 package should be installed into.
3187 More information is available in the Debian Developer's
3188 Reference, section "The Debian archive".
3195 <heading><tt>Date</tt></heading>
3198 This field includes the date the package was built or last edited.
3202 The value of this field is usually extracted from the
3203 <file>debian/changelog</file> file - see
3204 <ref id="dpkgchangelog">).
3208 <sect1 id="f-Format">
3209 <heading><tt>Format</tt></heading>
3212 This field specifies a format revision for the file.
3213 The most current format described in the Policy Manual
3214 is version <strong>1.5</strong>. The syntax of the
3215 format value is the same as that of a package version
3216 number except that no epoch or Debian revision is allowed
3217 - see <ref id="f-Version">.
3221 <sect1 id="f-Urgency">
3222 <heading><tt>Urgency</tt></heading>
3225 This is a description of how important it is to upgrade to
3226 this version from previous ones. It consists of a single
3227 keyword taking one of the values <tt>low</tt>,
3228 <tt>medium</tt>, <tt>high</tt>, <tt>emergency</tt>, or
3229 <tt>critical</tt><footnote>
3230 Other urgency values are supported with configuration
3231 changes in the archive software but are not used in Debian.
3232 The urgency affects how quickly a package will be considered
3233 for inclusion into the <tt>testing</tt> distribution and
3234 gives an indication of the importance of any fixes included
3235 in the upload. <tt>Emergency</tt> and <tt>critical</tt> are
3236 treated as synonymous.
3237 </footnote> (not case-sensitive) followed by an optional
3238 commentary (separated by a space) which is usually in
3239 parentheses. For example:
3242 Urgency: low (HIGH for users of diversions)
3248 The value of this field is usually extracted from the
3249 <file>debian/changelog</file> file - see
3250 <ref id="dpkgchangelog">.
3254 <sect1 id="f-Changes">
3255 <heading><tt>Changes</tt></heading>
3258 This field contains the human-readable changes data, describing
3259 the differences between the last version and the current one.
3263 There should be nothing in this field before the first
3264 newline; all the subsequent lines must be indented by at
3265 least one space; blank lines must be represented by a line
3266 consisting only of a space and a full stop.
3270 The value of this field is usually extracted from the
3271 <file>debian/changelog</file> file - see
3272 <ref id="dpkgchangelog">).
3276 Each version's change information should be preceded by a
3277 "title" line giving at least the version, distribution(s)
3278 and urgency, in a human-readable way.
3282 If data from several versions is being returned the entry
3283 for the most recent version should be returned first, and
3284 entries should be separated by the representation of a
3285 blank line (the "title" line may also be followed by the
3286 representation of blank line).
3290 <sect1 id="f-Binary">
3291 <heading><tt>Binary</tt></heading>
3294 This field is a list of binary packages.
3298 When it appears in the <file>.dsc</file> file it is the list
3299 of binary packages which a source package can produce. It
3300 does not necessarily produce all of these binary packages
3301 for every architecture. The source control file doesn't
3302 contain details of which architectures are appropriate for
3303 which of the binary packages.
3307 When it appears in a <file>.changes</file> file it lists the
3308 names of the binary packages actually being uploaded.
3312 The syntax is a list of binary packages separated by
3314 A space after each comma is conventional.
3315 </footnote>. Currently the packages must be separated using
3316 only spaces in the <file>.changes</file> file.
3320 <sect1 id="f-Installed-Size">
3321 <heading><tt>Installed-Size</tt></heading>
3324 This field appears in the control files of binary
3325 packages, and in the <file>Packages</file> files. It gives
3326 the total amount of disk space required to install the
3331 The disk space is represented in kilobytes as a simple
3336 <sect1 id="f-Files">
3337 <heading><tt>Files</tt></heading>
3340 This field contains a list of files with information about
3341 each one. The exact information and syntax varies with
3342 the context. In all cases the part of the field
3343 contents on the same line as the field name is empty. The
3344 remainder of the field is one line per file, each line
3345 being indented by one space and containing a number of
3346 sub-fields separated by spaces.
3350 In the <file>.dsc</file> file, each line contains the MD5
3351 checksum, size and filename of the tar file and (if applicable)
3352 diff file which make up the remainder of the source
3354 That is, the parts which are not the <tt>.dsc</tt>.
3356 The exact forms of the filenames are described
3357 in <ref id="pkg-sourcearchives">.
3361 In the <file>.changes</file> file this contains one line per
3362 file being uploaded. Each line contains the MD5 checksum,
3363 size, section and priority and the filename.
3364 The <qref id="f-Section">section</qref>
3365 and <qref id="f-Priority">priority</qref>
3366 are the values of the corresponding fields in
3367 the main source control file. If no section or priority is
3368 specified then <tt>-</tt> should be used, though section
3369 and priority values must be specified for new packages to
3370 be installed properly.
3374 The special value <tt>byhand</tt> for the section in a
3375 <tt>.changes</tt> file indicates that the file in question
3376 is not an ordinary package file and must by installed by
3377 hand by the distribution maintainers. If the section is
3378 <tt>byhand</tt> the priority should be <tt>-</tt>.
3382 If a new Debian revision of a package is being shipped and
3383 no new original source archive is being distributed the
3384 <tt>.dsc</tt> must still contain the <tt>Files</tt> field
3385 entry for the original source archive
3386 <file><var>package</var>-<var>upstream-version</var>.orig.tar.gz</file>,
3387 but the <file>.changes</file> file should leave it out. In
3388 this case the original source archive on the distribution
3389 site must match exactly, byte-for-byte, the original
3390 source archive which was used to generate the
3391 <file>.dsc</file> file and diff which are being uploaded.</p>
3394 <sect1 id="f-Closes">
3395 <heading><tt>Closes</tt></heading>
3398 A space-separated list of bug report numbers that the upload
3399 governed by the .changes file closes.
3403 <sect1 id="f-Homepage">
3404 <heading><tt>Homepage</tt></heading>
3407 The URL of the web site for this package, preferably (when
3408 applicable) the site from which the original source can be
3409 obtained and any additional upstream documentation or
3410 information may be found. The content of this field is a
3411 simple URL without any surrounding characters such as
3419 <heading>User-defined fields</heading>
3422 Additional user-defined fields may be added to the
3423 source package control file. Such fields will be
3424 ignored, and not copied to (for example) binary or
3425 source package control files or upload control files.
3429 If you wish to add additional unsupported fields to
3430 these output files you should use the mechanism
3435 Fields in the main source control information file with
3436 names starting <tt>X</tt>, followed by one or more of
3437 the letters <tt>BCS</tt> and a hyphen <tt>-</tt>, will
3438 be copied to the output files. Only the part of the
3439 field name after the hyphen will be used in the output
3440 file. Where the letter <tt>B</tt> is used the field
3441 will appear in binary package control files, where the
3442 letter <tt>S</tt> is used in source package control
3443 files and where <tt>C</tt> is used in upload control
3444 (<tt>.changes</tt>) files.
3448 For example, if the main source information control file
3451 XBS-Comment: I stand between the candle and the star.
3453 then the binary and source package control files will contain the
3456 Comment: I stand between the candle and the star.
3465 <chapt id="maintainerscripts">
3466 <heading>Package maintainer scripts and installation procedure</heading>
3469 <heading>Introduction to package maintainer scripts</heading>
3472 It is possible to supply scripts as part of a package which
3473 the package management system will run for you when your
3474 package is installed, upgraded or removed.
3478 These scripts are the files <prgn>preinst</prgn>,
3479 <prgn>postinst</prgn>, <prgn>prerm</prgn> and
3480 <prgn>postrm</prgn> in the control area of the package.
3481 They must be proper executable files; if they are scripts
3482 (which is recommended), they must start with the usual
3483 <tt>#!</tt> convention. They should be readable and
3484 executable by anyone, and must not be world-writable.
3488 The package management system looks at the exit status from
3489 these scripts. It is important that they exit with a
3490 non-zero status if there is an error, so that the package
3491 management system can stop its processing. For shell
3492 scripts this means that you <em>almost always</em> need to
3493 use <tt>set -e</tt> (this is usually true when writing shell
3494 scripts, in fact). It is also important, of course, that
3495 they exit with a zero status if everything went well.
3499 Additionally, packages interacting with users using
3500 <tt>debconf</tt> in the <prgn>postinst</prgn> script should
3501 install a <prgn>config</prgn> script in the control area,
3502 see <ref id="maintscriptprompt"> for details.
3506 When a package is upgraded a combination of the scripts from
3507 the old and new packages is called during the upgrade
3508 procedure. If your scripts are going to be at all
3509 complicated you need to be aware of this, and may need to
3510 check the arguments to your scripts.
3514 Broadly speaking the <prgn>preinst</prgn> is called before
3515 (a particular version of) a package is installed, and the
3516 <prgn>postinst</prgn> afterwards; the <prgn>prerm</prgn>
3517 before (a version of) a package is removed and the
3518 <prgn>postrm</prgn> afterwards.
3522 Programs called from maintainer scripts should not normally
3523 have a path prepended to them. Before installation is
3524 started, the package management system checks to see if the
3525 programs <prgn>ldconfig</prgn>,
3526 <prgn>start-stop-daemon</prgn>, <prgn>install-info</prgn>,
3527 and <prgn>update-rc.d</prgn> can be found via the
3528 <tt>PATH</tt> environment variable. Those programs, and any
3529 other program that one would expect to be in the
3530 <tt>PATH</tt>, should thus be invoked without an absolute
3531 pathname. Maintainer scripts should also not reset the
3532 <tt>PATH</tt>, though they might choose to modify it by
3533 prepending or appending package-specific directories. These
3534 considerations really apply to all shell scripts.</p>
3537 <sect id="idempotency">
3538 <heading>Maintainer scripts idempotency</heading>
3541 It is necessary for the error recovery procedures that the
3542 scripts be idempotent. This means that if it is run
3543 successfully, and then it is called again, it doesn't bomb
3544 out or cause any harm, but just ensures that everything is
3545 the way it ought to be. If the first call failed, or
3546 aborted half way through for some reason, the second call
3547 should merely do the things that were left undone the first
3548 time, if any, and exit with a success status if everything
3550 This is so that if an error occurs, the user interrupts
3551 <prgn>dpkg</prgn> or some other unforeseen circumstance
3552 happens you don't leave the user with a badly-broken
3553 package when <prgn>dpkg</prgn> attempts to repeat the
3559 <sect id="controllingterminal">
3560 <heading>Controlling terminal for maintainer scripts</heading>
3563 The maintainer scripts are guaranteed to run with a
3564 controlling terminal and can interact with the user.
3565 Because these scripts may be executed with standard output
3566 redirected into a pipe for logging purposes, Perl scripts
3567 should set unbuffered output by setting <tt>$|=1</tt> so
3568 that the output is printed immediately rather than being
3572 <sect id="exitstatus">
3573 <heading>Exit status</heading>
3576 Each script must return a zero exit status for
3577 success, or a nonzero one for failure, since the package
3578 management system looks for the exit status of these scripts
3579 and determines what action to take next based on that datum.
3583 <sect id="mscriptsinstact"><heading>Summary of ways maintainer
3588 <list compact="compact">
3590 <var>new-preinst</var> <tt>install</tt>
3593 <var>new-preinst</var> <tt>install</tt> <var>old-version</var>
3596 <var>new-preinst</var> <tt>upgrade</tt> <var>old-version</var>
3599 <var>old-preinst</var> <tt>abort-upgrade</tt>
3600 <var>new-version</var>
3605 <list compact="compact">
3607 <var>postinst</var> <tt>configure</tt>
3608 <var>most-recently-configured-version</var>
3611 <var>old-postinst</var> <tt>abort-upgrade</tt>
3612 <var>new-version</var>
3615 <var>conflictor's-postinst</var> <tt>abort-remove</tt>
3616 <tt>in-favour</tt> <var>package</var>
3617 <var>new-version</var>
3620 <var>postinst</var> <tt>abort-remove</tt>
3623 <var>deconfigured's-postinst</var>
3624 <tt>abort-deconfigure</tt> <tt>in-favour</tt>
3625 <var>failed-install-package</var> <var>version</var>
3626 [<tt>removing</tt> <var>conflicting-package</var>
3632 <list compact="compact">
3634 <var>prerm</var> <tt>remove</tt>
3637 <var>old-prerm</var> <tt>upgrade</tt>
3638 <var>new-version</var>
3641 <var>new-prerm</var> <tt>failed-upgrade</tt>
3642 <var>old-version</var>
3645 <var>conflictor's-prerm</var> <tt>remove</tt>
3646 <tt>in-favour</tt> <var>package</var>
3647 <var>new-version</var>
3650 <var>deconfigured's-prerm</var> <tt>deconfigure</tt>
3651 <tt>in-favour</tt> <var>package-being-installed</var>
3652 <var>version</var> [<tt>removing</tt>
3653 <var>conflicting-package</var>
3659 <list compact="compact">
3661 <var>postrm</var> <tt>remove</tt>
3664 <var>postrm</var> <tt>purge</tt>
3667 <var>old-postrm</var> <tt>upgrade</tt>
3668 <var>new-version</var>
3671 <var>new-postrm</var> <tt>failed-upgrade</tt>
3672 <var>old-version</var>
3675 <var>new-postrm</var> <tt>abort-install</tt>
3678 <var>new-postrm</var> <tt>abort-install</tt>
3679 <var>old-version</var>
3682 <var>new-postrm</var> <tt>abort-upgrade</tt>
3683 <var>old-version</var>
3686 <var>disappearer's-postrm</var> <tt>disappear</tt>
3687 <var>overwriter</var>
3688 <var>overwriter-version</var>
3694 <sect id="unpackphase">
3695 <heading>Details of unpack phase of installation or upgrade</heading>
3698 The procedure on installation/upgrade/overwrite/disappear
3699 (i.e., when running <tt>dpkg --unpack</tt>, or the unpack
3700 stage of <tt>dpkg --install</tt>) is as follows. In each
3701 case, if a major error occurs (unless listed below) the
3702 actions are, in general, run backwards - this means that the
3703 maintainer scripts are run with different arguments in
3704 reverse order. These are the "error unwind" calls listed
3711 If a version of the package is already installed, call
3712 <example compact="compact">
3713 <var>old-prerm</var> upgrade <var>new-version</var>
3717 If the script runs but exits with a non-zero
3718 exit status, <prgn>dpkg</prgn> will attempt:
3719 <example compact="compact">
3720 <var>new-prerm</var> failed-upgrade <var>old-version</var>
3722 If this works, the upgrade continues. If this
3723 does not work, the error unwind:
3724 <example compact="compact">
3725 <var>old-postinst</var> abort-upgrade <var>new-version</var>
3727 If this works, then the old-version is
3728 "Installed", if not, the old version is in a
3729 "Failed-Config" state.
3735 If a "conflicting" package is being removed at the same time,
3736 or if any package will be broken (due to <tt>Breaks</tt>):
3739 If <tt>--auto-deconfigure</tt> is
3740 specified, call, for each package to be deconfigured
3741 due to <tt>Breaks</tt>:
3742 <example compact="compact">
3743 <var>deconfigured's-prerm</var> deconfigure \
3744 in-favour <var>package-being-installed</var> <var>version</var>
3747 <example compact="compact">
3748 <var>deconfigured's-postinst</var> abort-deconfigure \
3749 in-favour <var>package-being-installed-but-failed</var> <var>version</var>
3751 The deconfigured packages are marked as
3752 requiring configuration, so that if
3753 <tt>--install</tt> is used they will be
3754 configured again if possible.
3757 If any packages depended on a conflicting
3758 package being removed and <tt>--auto-deconfigure</tt> is
3759 specified, call, for each such package:
3760 <example compact="compact">
3761 <var>deconfigured's-prerm</var> deconfigure \
3762 in-favour <var>package-being-installed</var> <var>version</var> \
3763 removing <var>conflicting-package</var> <var>version</var>
3766 <example compact="compact">
3767 <var>deconfigured's-postinst</var> abort-deconfigure \
3768 in-favour <var>package-being-installed-but-failed</var> <var>version</var> \
3769 removing <var>conflicting-package</var> <var>version</var>
3771 The deconfigured packages are marked as
3772 requiring configuration, so that if
3773 <tt>--install</tt> is used they will be
3774 configured again if possible.
3777 To prepare for removal of each conflicting package, call:
3778 <example compact="compact">
3779 <var>conflictor's-prerm</var> remove \
3780 in-favour <var>package</var> <var>new-version</var>
3783 <example compact="compact">
3784 <var>conflictor's-postinst</var> abort-remove \
3785 in-favour <var>package</var> <var>new-version</var>
3794 If the package is being upgraded, call:
3795 <example compact="compact">
3796 <var>new-preinst</var> upgrade <var>old-version</var>
3798 If this fails, we call:
3800 <var>new-postrm</var> abort-upgrade <var>old-version</var>
3807 <var>old-postinst</var> abort-upgrade <var>new-version</var>
3809 is called. If this works, then the old version
3810 is in an "Installed" state, or else it is left
3811 in an "Unpacked" state.
3816 If it fails, then the old version is left
3817 in an "Half-Installed" state.
3824 Otherwise, if the package had some configuration
3825 files from a previous version installed (i.e., it
3826 is in the "configuration files only" state):
3827 <example compact="compact">
3828 <var>new-preinst</var> install <var>old-version</var>
3832 <var>new-postrm</var> abort-install <var>old-version</var>
3834 If this fails, the package is left in a
3835 "Half-Installed" state, which requires a
3836 reinstall. If it works, the packages is left in
3837 a "Config Files" state.
3840 Otherwise (i.e., the package was completely purged):
3841 <example compact="compact">
3842 <var>new-preinst</var> install
3845 <example compact="compact">
3846 <var>new-postrm</var> abort-install
3848 If the error-unwind fails, the package is in a
3849 "Half Installed" phase, and requires a
3850 reinstall. If the error unwind works, the
3851 package is in a not installed state.
3858 The new package's files are unpacked, overwriting any
3859 that may be on the system already, for example any
3860 from the old version of the same package or from
3861 another package. Backups of the old files are kept
3862 temporarily, and if anything goes wrong the package
3863 management system will attempt to put them back as
3864 part of the error unwind.
3868 It is an error for a package to contain files which
3869 are on the system in another package, unless
3870 <tt>Replaces</tt> is used (see <ref id="replaces">).
3872 The following paragraph is not currently the case:
3873 Currently the <tt>- - force-overwrite</tt> flag is
3874 enabled, downgrading it to a warning, but this may not
3880 It is a more serious error for a package to contain a
3881 plain file or other kind of non-directory where another
3882 package has a directory (again, unless
3883 <tt>Replaces</tt> is used). This error can be
3884 overridden if desired using
3885 <tt>--force-overwrite-dir</tt>, but this is not
3890 Packages which overwrite each other's files produce
3891 behavior which, though deterministic, is hard for the
3892 system administrator to understand. It can easily
3893 lead to "missing" programs if, for example, a package
3894 is installed which overwrites a file from another
3895 package, and is then removed again.<footnote>
3896 Part of the problem is due to what is arguably a
3897 bug in <prgn>dpkg</prgn>.
3902 A directory will never be replaced by a symbolic link
3903 to a directory or vice versa; instead, the existing
3904 state (symlink or not) will be left alone and
3905 <prgn>dpkg</prgn> will follow the symlink if there is
3914 If the package is being upgraded, call
3915 <example compact="compact">
3916 <var>old-postrm</var> upgrade <var>new-version</var>
3920 If this fails, <prgn>dpkg</prgn> will attempt:
3921 <example compact="compact">
3922 <var>new-postrm</var> failed-upgrade <var>old-version</var>
3924 If this works, installation continues. If not,
3926 <example compact="compact">
3927 <var>old-preinst</var> abort-upgrade <var>new-version</var>
3929 If this fails, the old version is left in an
3930 "Half Installed" state. If it works, dpkg now
3932 <example compact="compact">
3933 <var>new-postrm</var> abort-upgrade <var>old-version</var>
3935 If this fails, the old version is left in an
3936 "Half Installed" state. If it works, dpkg now
3938 <example compact="compact">
3939 <var>old-postinst</var> abort-upgrade <var>new-version</var>
3941 If this fails, the old version is in an
3948 This is the point of no return - if
3949 <prgn>dpkg</prgn> gets this far, it won't back off
3950 past this point if an error occurs. This will
3951 leave the package in a fairly bad state, which
3952 will require a successful re-installation to clear
3953 up, but it's when <prgn>dpkg</prgn> starts doing
3954 things that are irreversible.
3959 Any files which were in the old version of the package
3960 but not in the new are removed.
3964 The new file list replaces the old.
3968 The new maintainer scripts replace the old.
3972 Any packages all of whose files have been overwritten
3973 during the installation, and which aren't required for
3974 dependencies, are considered to have been removed.
3975 For each such package
3978 <prgn>dpkg</prgn> calls:
3979 <example compact="compact">
3980 <var>disappearer's-postrm</var> disappear \
3981 <var>overwriter</var> <var>overwriter-version</var>
3985 The package's maintainer scripts are removed.
3988 It is noted in the status database as being in a
3989 sane state, namely not installed (any conffiles
3990 it may have are ignored, rather than being
3991 removed by <prgn>dpkg</prgn>). Note that
3992 disappearing packages do not have their prerm
3993 called, because <prgn>dpkg</prgn> doesn't know
3994 in advance that the package is going to
4001 Any files in the package we're unpacking that are also
4002 listed in the file lists of other packages are removed
4003 from those lists. (This will lobotomize the file list
4004 of the "conflicting" package if there is one.)
4008 The backup files made during installation, above, are
4014 The new package's status is now sane, and recorded as
4019 Here is another point of no return - if the
4020 conflicting package's removal fails we do not unwind
4021 the rest of the installation; the conflicting package
4022 is left in a half-removed limbo.
4027 If there was a conflicting package we go and do the
4028 removal actions (described below), starting with the
4029 removal of the conflicting package's files (any that
4030 are also in the package being installed have already
4031 been removed from the conflicting package's file list,
4032 and so do not get removed now).
4038 <sect id="configdetails"><heading>Details of configuration</heading>
4041 When we configure a package (this happens with <tt>dpkg
4042 --install</tt> and <tt>dpkg --configure</tt>), we first
4043 update any <tt>conffile</tt>s and then call:
4044 <example compact="compact">
4045 <var>postinst</var> configure <var>most-recently-configured-version</var>
4050 No attempt is made to unwind after errors during
4051 configuration. If the configuration fails, the package is in
4052 a "Failed Config" state, and an error message is generated.
4056 If there is no most recently configured version
4057 <prgn>dpkg</prgn> will pass a null argument.
4060 Historical note: Truly ancient (pre-1997) versions of
4061 <prgn>dpkg</prgn> passed <tt><unknown></tt>
4062 (including the angle brackets) in this case. Even older
4063 ones did not pass a second argument at all, under any
4064 circumstance. Note that upgrades using such an old dpkg
4065 version are unlikely to work for other reasons, even if
4066 this old argument behavior is handled by your postinst script.
4072 <sect id="removedetails"><heading>Details of removal and/or
4073 configuration purging</heading>
4079 <example compact="compact">
4080 <var>prerm</var> remove
4084 If prerm fails during replacement due to conflict
4086 <var>conflictor's-postinst</var> abort-remove \
4087 in-favour <var>package</var> <var>new-version</var>
4091 <var>postinst</var> abort-remove
4095 If this fails, the package is in a "Failed-Config"
4096 state, or else it remains "Installed".
4100 The package's files are removed (except <tt>conffile</tt>s).
4103 <example compact="compact">
4104 <var>postrm</var> remove
4108 If it fails, there's no error unwind, and the package is in
4109 an "Half-Installed" state.
4114 All the maintainer scripts except the <prgn>postrm</prgn>
4119 If we aren't purging the package we stop here. Note
4120 that packages which have no <prgn>postrm</prgn> and no
4121 <tt>conffile</tt>s are automatically purged when
4122 removed, as there is no difference except for the
4123 <prgn>dpkg</prgn> status.
4127 The <tt>conffile</tt>s and any backup files
4128 (<tt>~</tt>-files, <tt>#*#</tt> files,
4129 <tt>%</tt>-files, <tt>.dpkg-{old,new,tmp}</tt>, etc.)
4134 <example compact="compact">
4135 <var>postrm</var> purge
4139 If this fails, the package remains in a "Config-Files"
4144 The package's file list is removed.
4153 <chapt id="relationships">
4154 <heading>Declaring relationships between packages</heading>
4156 <sect id="depsyntax">
4157 <heading>Syntax of relationship fields</heading>
4160 These fields all have a uniform syntax. They are a list of
4161 package names separated by commas.
4165 In the <tt>Depends</tt>, <tt>Recommends</tt>,
4166 <tt>Suggests</tt>, <tt>Pre-Depends</tt>,
4167 <tt>Build-Depends</tt> and <tt>Build-Depends-Indep</tt>
4168 control file fields of the package, which declare
4169 dependencies on other packages, the package names listed may
4170 also include lists of alternative package names, separated
4171 by vertical bar (pipe) symbols <tt>|</tt>. In such a case,
4172 if any one of the alternative packages is installed, that
4173 part of the dependency is considered to be satisfied.
4177 All of the fields except for <tt>Provides</tt> may restrict
4178 their applicability to particular versions of each named
4179 package. This is done in parentheses after each individual
4180 package name; the parentheses should contain a relation from
4181 the list below followed by a version number, in the format
4182 described in <ref id="f-Version">.
4186 The relations allowed are <tt><<</tt>, <tt><=</tt>,
4187 <tt>=</tt>, <tt>>=</tt> and <tt>>></tt> for
4188 strictly earlier, earlier or equal, exactly equal, later or
4189 equal and strictly later, respectively. The deprecated
4190 forms <tt><</tt> and <tt>></tt> were used to mean
4191 earlier/later or equal, rather than strictly earlier/later,
4192 so they should not appear in new packages (though
4193 <prgn>dpkg</prgn> still supports them).
4197 Whitespace may appear at any point in the version
4198 specification subject to the rules in <ref
4199 id="controlsyntax">, and must appear where it's necessary to
4200 disambiguate; it is not otherwise significant. All of the
4201 relationship fields may span multiple lines. For
4202 consistency and in case of future changes to
4203 <prgn>dpkg</prgn> it is recommended that a single space be
4204 used after a version relationship and before a version
4205 number; it is also conventional to put a single space after
4206 each comma, on either side of each vertical bar, and before
4207 each open parenthesis. When wrapping a relationship field, it
4208 is conventional to do so after a comma and before the space
4209 following that comma.
4213 For example, a list of dependencies might appear as:
4214 <example compact="compact">
4217 Depends: libc6 (>= 2.2.1), exim | mail-transport-agent
4222 All fields that specify build-time relationships
4223 (<tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
4224 <tt>Build-Conflicts</tt> and <tt>Build-Conflicts-Indep</tt>)
4225 may be restricted to a certain set of architectures. This
4226 is indicated in brackets after each individual package name and
4227 the optional version specification. The brackets enclose a
4228 list of Debian architecture names separated by whitespace.
4229 Exclamation marks may be prepended to each of the names.
4230 (It is not permitted for some names to be prepended with
4231 exclamation marks while others aren't.) If the current Debian
4232 host architecture is not in this list and there are no
4233 exclamation marks in the list, or it is in the list with a
4234 prepended exclamation mark, the package name and the
4235 associated version specification are ignored completely for
4236 the purposes of defining the relationships.
4241 <example compact="compact">
4243 Build-Depends-Indep: texinfo
4244 Build-Depends: kernel-headers-2.2.10 [!hurd-i386],
4245 hurd-dev [hurd-i386], gnumach-dev [hurd-i386]
4247 requires <tt>kernel-headers-2.2.10</tt> on all architectures
4248 other than hurd-i386 and requires <tt>hurd-dev</tt> and
4249 <tt>gnumach-dev</tt> only on hurd-i386.
4253 If the architecture-restricted dependency is part of a set of
4254 alternatives using <tt>|</tt>, that alternative is ignored
4255 completely on architectures that do not match the restriction.
4257 <example compact="compact">
4258 Build-Depends: foo [!i386] | bar [!amd64]
4260 is equivalent to <tt>bar</tt> on the i386 architecture, to
4261 <tt>foo</tt> on the amd64 architecture, and to <tt>foo |
4262 bar</tt> on all other architectures.
4266 Note that the binary package relationship fields such as
4267 <tt>Depends</tt> appear in one of the binary package
4268 sections of the control file, whereas the build-time
4269 relationships such as <tt>Build-Depends</tt> appear in the
4270 source package section of the control file (which is the
4275 <sect id="binarydeps">
4276 <heading>Binary Dependencies - <tt>Depends</tt>,
4277 <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
4278 <tt>Pre-Depends</tt>
4282 Packages can declare in their control file that they have
4283 certain relationships to other packages - for example, that
4284 they may not be installed at the same time as certain other
4285 packages, and/or that they depend on the presence of others.
4289 This is done using the <tt>Depends</tt>, <tt>Pre-Depends</tt>,
4290 <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
4291 <tt>Breaks</tt> and <tt>Conflicts</tt> control file fields.
4292 <tt>Breaks</tt> is described in <ref id="breaks">, and
4293 <tt>Conflicts</tt> is described in <ref id="conflicts">. The
4294 rest are described below.
4298 These seven fields are used to declare a dependency
4299 relationship by one package on another. Except for
4300 <tt>Enhances</tt> and <tt>Breaks</tt>, they appear in the
4301 depending (binary) package's control file.
4302 (<tt>Enhances</tt> appears in the recommending package's
4303 control file, and <tt>Breaks</tt> appears in the version of
4304 depended-on package which causes the named package to
4309 A <tt>Depends</tt> field takes effect <em>only</em> when a
4310 package is to be configured. It does not prevent a package
4311 being on the system in an unconfigured state while its
4312 dependencies are unsatisfied, and it is possible to replace
4313 a package whose dependencies are satisfied and which is
4314 properly installed with a different version whose
4315 dependencies are not and cannot be satisfied; when this is
4316 done the depending package will be left unconfigured (since
4317 attempts to configure it will give errors) and will not
4318 function properly. If it is necessary, a
4319 <tt>Pre-Depends</tt> field can be used, which has a partial
4320 effect even when a package is being unpacked, as explained
4321 in detail below. (The other three dependency fields,
4322 <tt>Recommends</tt>, <tt>Suggests</tt> and
4323 <tt>Enhances</tt>, are only used by the various front-ends
4324 to <prgn>dpkg</prgn> such as <prgn>apt-get</prgn>,
4325 <prgn>aptitude</prgn>, and <prgn>dselect</prgn>.)
4329 For this reason packages in an installation run are usually
4330 all unpacked first and all configured later; this gives
4331 later versions of packages with dependencies on later
4332 versions of other packages the opportunity to have their
4333 dependencies satisfied.
4337 In case of circular dependencies, since installation or
4338 removal order honoring the dependency order can't be
4339 established, dependency loops are broken at some point
4340 (based on rules below), and some packages may not be able to
4341 rely on their dependencies being present when being
4342 installed or removed, depending on which side of the break
4343 of the circular dependency loop they happen to be on. If one
4344 of the packages in the loop has no postinst script, then the
4345 cycle will be broken at that package, so as to ensure that
4346 all postinst scripts run with the dependencies properly
4347 configured if this is possible. Otherwise the breaking point
4352 The <tt>Depends</tt> field thus allows package maintainers
4353 to impose an order in which packages should be configured.
4357 The meaning of the five dependency fields is as follows:
4359 <tag><tt>Depends</tt></tag>
4362 This declares an absolute dependency. A package will
4363 not be configured unless all of the packages listed in
4364 its <tt>Depends</tt> field have been correctly
4369 The <tt>Depends</tt> field should be used if the
4370 depended-on package is required for the depending
4371 package to provide a significant amount of
4376 The <tt>Depends</tt> field should also be used if the
4377 <prgn>postinst</prgn>, <prgn>prerm</prgn> or
4378 <prgn>postrm</prgn> scripts require the package to be
4379 present in order to run. Note, however, that the
4380 <prgn>postrm</prgn> cannot rely on any non-essential
4381 packages to be present during the <tt>purge</tt>
4385 <tag><tt>Recommends</tt></tag>
4388 This declares a strong, but not absolute, dependency.
4392 The <tt>Recommends</tt> field should list packages
4393 that would be found together with this one in all but
4394 unusual installations.
4398 <tag><tt>Suggests</tt></tag>
4400 This is used to declare that one package may be more
4401 useful with one or more others. Using this field
4402 tells the packaging system and the user that the
4403 listed packages are related to this one and can
4404 perhaps enhance its usefulness, but that installing
4405 this one without them is perfectly reasonable.
4408 <tag><tt>Enhances</tt></tag>
4410 This field is similar to Suggests but works in the
4411 opposite direction. It is used to declare that a
4412 package can enhance the functionality of another
4416 <tag><tt>Pre-Depends</tt></tag>
4419 This field is like <tt>Depends</tt>, except that it
4420 also forces <prgn>dpkg</prgn> to complete installation
4421 of the packages named before even starting the
4422 installation of the package which declares the
4423 pre-dependency, as follows:
4427 When a package declaring a pre-dependency is about to
4428 be <em>unpacked</em> the pre-dependency can be
4429 satisfied if the depended-on package is either fully
4430 configured, <em>or even if</em> the depended-on
4431 package(s) are only unpacked or half-configured,
4432 provided that they have been configured correctly at
4433 some point in the past (and not removed or partially
4434 removed since). In this case, both the
4435 previously-configured and currently unpacked or
4436 half-configured versions must satisfy any version
4437 clause in the <tt>Pre-Depends</tt> field.
4441 When the package declaring a pre-dependency is about
4442 to be <em>configured</em>, the pre-dependency will be
4443 treated as a normal <tt>Depends</tt>, that is, it will
4444 be considered satisfied only if the depended-on
4445 package has been correctly configured.
4449 <tt>Pre-Depends</tt> should be used sparingly,
4450 preferably only by packages whose premature upgrade or
4451 installation would hamper the ability of the system to
4452 continue with any upgrade that might be in progress.
4456 <tt>Pre-Depends</tt> are also required if the
4457 <prgn>preinst</prgn> script depends on the named
4458 package. It is best to avoid this situation if
4466 When selecting which level of dependency to use you should
4467 consider how important the depended-on package is to the
4468 functionality of the one declaring the dependency. Some
4469 packages are composed of components of varying degrees of
4470 importance. Such a package should list using
4471 <tt>Depends</tt> the package(s) which are required by the
4472 more important components. The other components'
4473 requirements may be mentioned as Suggestions or
4474 Recommendations, as appropriate to the components' relative
4480 <heading>Packages which break other packages - <tt>Breaks</tt></heading>
4483 When one binary package declares that it breaks another,
4484 <prgn>dpkg</prgn> will refuse to allow the package which
4485 declares <tt>Breaks</tt> be installed unless the broken
4486 package is deconfigured first, and it will refuse to
4487 allow the broken package to be reconfigured.
4491 A package will not be regarded as causing breakage merely
4492 because its configuration files are still installed; it must
4493 be at least half-installed.
4497 A special exception is made for packages which declare that
4498 they break their own package name or a virtual package which
4499 they provide (see below): this does not count as a real
4504 Normally a <tt>Breaks</tt> entry will have an "earlier than"
4505 version clause; such a <tt>Breaks</tt> is introduced in the
4506 version of an (implicit or explicit) dependency which
4507 violates an assumption or reveals a bug in earlier versions
4508 of the broken package. This use of <tt>Breaks</tt> will
4509 inform higher-level package management tools that broken
4510 package must be upgraded before the new one.
4514 If the breaking package also overwrites some files from the
4515 older package, it should use <tt>Replaces</tt> (not
4516 <tt>Conflicts</tt>) to ensure this goes smoothly.
4520 <sect id="conflicts">
4521 <heading>Conflicting binary packages - <tt>Conflicts</tt></heading>
4524 When one binary package declares a conflict with another
4525 using a <tt>Conflicts</tt> field, <prgn>dpkg</prgn> will
4526 refuse to allow them to be installed on the system at the
4531 If one package is to be installed, the other must be removed
4532 first - if the package being installed is marked as
4533 replacing (see <ref id="replaces">) the one on the system,
4534 or the one on the system is marked as deselected, or both
4535 packages are marked <tt>Essential</tt>, then
4536 <prgn>dpkg</prgn> will automatically remove the package
4537 which is causing the conflict, otherwise it will halt the
4538 installation of the new package with an error. This
4539 mechanism is specifically designed to produce an error when
4540 the installed package is <tt>Essential</tt>, but the new
4545 A package will not cause a conflict merely because its
4546 configuration files are still installed; it must be at least
4551 A special exception is made for packages which declare a
4552 conflict with their own package name, or with a virtual
4553 package which they provide (see below): this does not
4554 prevent their installation, and allows a package to conflict
4555 with others providing a replacement for it. You use this
4556 feature when you want the package in question to be the only
4557 package providing some feature.
4561 A <tt>Conflicts</tt> entry should almost never have an
4562 "earlier than" version clause. This would prevent
4563 <prgn>dpkg</prgn> from upgrading or installing the package
4564 which declared such a conflict until the upgrade or removal
4565 of the conflicted-with package had been completed. Instead,
4566 <tt>Breaks</tt> may be used.
4570 <sect id="virtual"><heading>Virtual packages - <tt>Provides</tt>
4574 As well as the names of actual ("concrete") packages, the
4575 package relationship fields <tt>Depends</tt>,
4576 <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
4577 <tt>Pre-Depends</tt>, <tt>Breaks</tt>, <tt>Conflicts</tt>,
4578 <tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
4579 <tt>Build-Conflicts</tt> and <tt>Build-Conflicts-Indep</tt>
4580 may mention "virtual packages".
4584 A <em>virtual package</em> is one which appears in the
4585 <tt>Provides</tt> control file field of another package.
4586 The effect is as if the package(s) which provide a
4587 particular virtual package name had been listed by name
4588 everywhere the virtual package name appears. (See also <ref
4593 If there are both concrete and virtual packages of the same
4594 name, then the dependency may be satisfied (or the conflict
4595 caused) by either the concrete package with the name in
4596 question or any other concrete package which provides the
4597 virtual package with the name in question. This is so that,
4598 for example, supposing we have
4599 <example compact="compact">
4602 </example> and someone else releases an enhanced version of
4603 the <tt>bar</tt> package they can say:
4604 <example compact="compact">
4608 and the <tt>bar-plus</tt> package will now also satisfy the
4609 dependency for the <tt>foo</tt> package.
4613 If a relationship field has a version number attached
4614 then only real packages will be considered to see whether
4615 the relationship is satisfied (or the prohibition violated,
4616 for a conflict or breakage) - it is assumed that a real
4617 package which provides the virtual package is not of the
4618 "right" version. So, a <tt>Provides</tt> field may not
4619 contain version numbers, and the version number of the
4620 concrete package which provides a particular virtual package
4621 will not be looked at when considering a dependency on or
4622 conflict with the virtual package name.
4626 It is likely that the ability will be added in a future
4627 release of <prgn>dpkg</prgn> to specify a version number for
4628 each virtual package it provides. This feature is not yet
4629 present, however, and is expected to be used only
4634 If you want to specify which of a set of real packages
4635 should be the default to satisfy a particular dependency on
4636 a virtual package, you should list the real package as an
4637 alternative before the virtual one.
4642 <sect id="replaces"><heading>Overwriting files and replacing
4643 packages - <tt>Replaces</tt></heading>
4646 Packages can declare in their control file that they should
4647 overwrite files in certain other packages, or completely
4648 replace other packages. The <tt>Replaces</tt> control file
4649 field has these two distinct purposes.
4652 <sect1><heading>Overwriting files in other packages</heading>
4655 Firstly, as mentioned before, it is usually an error for a
4656 package to contain files which are on the system in
4661 However, if the overwriting package declares that it
4662 <tt>Replaces</tt> the one containing the file being
4663 overwritten, then <prgn>dpkg</prgn> will replace the file
4664 from the old package with that from the new. The file
4665 will no longer be listed as "owned" by the old package.
4669 If a package is completely replaced in this way, so that
4670 <prgn>dpkg</prgn> does not know of any files it still
4671 contains, it is considered to have "disappeared". It will
4672 be marked as not wanted on the system (selected for
4673 removal) and not installed. Any <tt>conffile</tt>s
4674 details noted for the package will be ignored, as they
4675 will have been taken over by the overwriting package. The
4676 package's <prgn>postrm</prgn> script will be run with a
4677 special argument to allow the package to do any final
4678 cleanup required. See <ref id="mscriptsinstact">.
4681 Replaces is a one way relationship -- you have to
4682 install the replacing package after the replaced
4689 For this usage of <tt>Replaces</tt>, virtual packages (see
4690 <ref id="virtual">) are not considered when looking at a
4691 <tt>Replaces</tt> field - the packages declared as being
4692 replaced must be mentioned by their real names.
4696 Furthermore, this usage of <tt>Replaces</tt> only takes
4697 effect when both packages are at least partially on the
4698 system at once, so that it can only happen if they do not
4699 conflict or if the conflict has been overridden.
4704 <sect1><heading>Replacing whole packages, forcing their
4708 Secondly, <tt>Replaces</tt> allows the packaging system to
4709 resolve which package should be removed when there is a
4710 conflict - see <ref id="conflicts">. This usage only
4711 takes effect when the two packages <em>do</em> conflict,
4712 so that the two usages of this field do not interfere with
4717 In this situation, the package declared as being replaced
4718 can be a virtual package, so for example, all mail
4719 transport agents (MTAs) would have the following fields in
4720 their control files:
4721 <example compact="compact">
4722 Provides: mail-transport-agent
4723 Conflicts: mail-transport-agent
4724 Replaces: mail-transport-agent
4726 ensuring that only one MTA can be installed at any one
4731 <sect id="sourcebinarydeps">
4732 <heading>Relationships between source and binary packages -
4733 <tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
4734 <tt>Build-Conflicts</tt>, <tt>Build-Conflicts-Indep</tt>
4738 Source packages that require certain binary packages to be
4739 installed or absent at the time of building the package
4740 can declare relationships to those binary packages.
4744 This is done using the <tt>Build-Depends</tt>,
4745 <tt>Build-Depends-Indep</tt>, <tt>Build-Conflicts</tt> and
4746 <tt>Build-Conflicts-Indep</tt> control file fields.
4750 Build-dependencies on "build-essential" binary packages can be
4751 omitted. Please see <ref id="pkg-relations"> for more information.
4755 The dependencies and conflicts they define must be satisfied
4756 (as defined earlier for binary packages) in order to invoke
4757 the targets in <tt>debian/rules</tt>, as follows:<footnote>
4759 If you make "build-arch" or "binary-arch", you need
4760 Build-Depends. If you make "build-indep" or
4761 "binary-indep", you need Build-Depends and
4762 Build-Depends-Indep. If you make "build" or "binary",
4766 There is no Build-Depends-Arch; this role is essentially
4767 met with Build-Depends. Anyone building the
4768 <tt>build-indep</tt> and binary-indep<tt></tt> targets
4769 is basically assumed to be building the whole package
4770 anyway and so installs all build dependencies. The
4771 autobuilders use <tt>dpkg-buildpackage -B</tt>, which
4772 calls <tt>build</tt> (not <tt>build-arch</tt>, since it
4773 does not yet know how to check for its existence) and
4774 <tt>binary-arch</tt>.
4777 The purpose of the original split, I recall, was so that
4778 the autobuilders wouldn't need to install extra packages
4779 needed only for the binary-indep targets. But without a
4780 build-arch/build-indep split, this didn't work, since
4781 most of the work is done in the build target, not in the
4787 <tag><tt>Build-Depends</tt>, <tt>Build-Conflicts</tt></tag>
4789 The <tt>Build-Depends</tt> and
4790 <tt>Build-Conflicts</tt> fields must be satisfied when
4791 any of the following targets is invoked:
4792 <tt>build</tt>, <tt>clean</tt>, <tt>binary</tt>,
4793 <tt>binary-arch</tt>, <tt>build-arch</tt>,
4794 <tt>build-indep</tt> and <tt>binary-indep</tt>.
4796 <tag><tt>Build-Depends-Indep</tt>,
4797 <tt>Build-Conflicts-Indep</tt></tag>
4799 The <tt>Build-Depends-Indep</tt> and
4800 <tt>Build-Conflicts-Indep</tt> fields must be
4801 satisfied when any of the following targets is
4802 invoked: <tt>build</tt>, <tt>build-indep</tt>,
4803 <tt>binary</tt> and <tt>binary-indep</tt>.
4813 <chapt id="sharedlibs"><heading>Shared libraries</heading>
4816 Packages containing shared libraries must be constructed with
4817 a little care to make sure that the shared library is always
4818 available. This is especially important for packages whose
4819 shared libraries are vitally important, such as the C library
4820 (currently <tt>libc6</tt>).
4824 Packages involving shared libraries should be split up into
4825 several binary packages. This section mostly deals with how
4826 this separation is to be accomplished; rules for files within
4827 the shared library packages are in <ref id="libraries"> instead.
4830 <sect id="sharedlibs-runtime">
4831 <heading>Run-time shared libraries</heading>
4834 The run-time shared library needs to be placed in a package
4835 whose name changes whenever the shared object version
4838 Since it is common place to install several versions of a
4839 package that just provides shared libraries, it is a
4840 good idea that the library package should not
4841 contain any extraneous non-versioned files, unless they
4842 happen to be in versioned directories.</p>
4844 The most common mechanism is to place it in a package
4846 <package><var>libraryname</var><var>soversion</var></package>,
4847 where <file><var>soversion</var></file> is the version number
4848 in the soname of the shared library<footnote>
4849 The soname is the shared object name: it's the thing
4850 that has to match exactly between building an executable
4851 and running it for the dynamic linker to be able run the
4852 program. For example, if the soname of the library is
4853 <file>libfoo.so.6</file>, the library package would be
4854 called <file>libfoo6</file>.
4856 Alternatively, if it would be confusing to directly append
4857 <var>soversion</var> to <var>libraryname</var> (e.g. because
4858 <var>libraryname</var> itself ends in a number), you may use
4859 <package><var>libraryname</var>-<var>soversion</var></package> and
4860 <package><var>libraryname</var>-<var>soversion</var>-dev</package>
4865 If you have several shared libraries built from the same
4866 source tree you may lump them all together into a single
4867 shared library package, provided that you change all of
4868 their sonames at once (so that you don't get filename
4869 clashes if you try to install different versions of the
4870 combined shared libraries package).
4874 The package should install the shared libraries under
4875 their normal names. For example, the <package>libgdbm3</package>
4876 package should install <file>libgdbm.so.3.0.0</file> as
4877 <file>/usr/lib/libgdbm.so.3.0.0</file>. The files should not be
4878 renamed or re-linked by any <prgn>prerm</prgn> or
4879 <prgn>postrm</prgn> scripts; <prgn>dpkg</prgn> will take care
4880 of renaming things safely without affecting running programs,
4881 and attempts to interfere with this are likely to lead to
4886 Shared libraries should not be installed executable, since
4887 the dynamic linker does not require this and trying to
4888 execute a shared library usually results in a core dump.
4892 The run-time library package should include the symbolic link that
4893 <prgn>ldconfig</prgn> would create for the shared libraries.
4894 For example, the <package>libgdbm3</package> package should include
4895 a symbolic link from <file>/usr/lib/libgdbm.so.3</file> to
4896 <file>libgdbm.so.3.0.0</file>. This is needed so that the dynamic
4897 linker (for example <prgn>ld.so</prgn> or
4898 <prgn>ld-linux.so.*</prgn>) can find the library between the
4899 time that <prgn>dpkg</prgn> installs it and the time that
4900 <prgn>ldconfig</prgn> is run in the <prgn>postinst</prgn>
4902 The package management system requires the library to be
4903 placed before the symbolic link pointing to it in the
4904 <file>.deb</file> file. This is so that when
4905 <prgn>dpkg</prgn> comes to install the symlink
4906 (overwriting the previous symlink pointing at an older
4907 version of the library), the new shared library is already
4908 in place. In the past, this was achieved by creating the
4909 library in the temporary packaging directory before
4910 creating the symlink. Unfortunately, this was not always
4911 effective, since the building of the tar file in the
4912 <file>.deb</file> depended on the behavior of the underlying
4913 file system. Some file systems (such as reiserfs) reorder
4914 the files so that the order of creation is forgotten.
4915 Since version 1.7.0, <prgn>dpkg</prgn>
4916 reorders the files itself as necessary when building a
4917 package. Thus it is no longer important to concern
4918 oneself with the order of file creation.
4922 <sect1 id="ldconfig">
4923 <heading><tt>ldconfig</tt></heading>
4926 Any package installing shared libraries in one of the default
4927 library directories of the dynamic linker (which are currently
4928 <file>/usr/lib</file> and <file>/lib</file>) or a directory that is
4929 listed in <file>/etc/ld.so.conf</file><footnote>
4931 <list compact="compact">
4932 <item>/usr/local/lib</item>
4933 <item>/usr/lib/libc5-compat</item>
4934 <item>/lib/libc5-compat</item>
4937 must use <prgn>ldconfig</prgn> to update the shared library
4942 The package maintainer scripts must only call
4943 <prgn>ldconfig</prgn> under these circumstances:
4944 <list compact="compact">
4945 <item>When the <prgn>postinst</prgn> script is run with a
4946 first argument of <tt>configure</tt>, the script must call
4947 <prgn>ldconfig</prgn>, and may optionally invoke
4948 <prgn>ldconfig</prgn> at other times.
4950 <item>When the <prgn>postrm</prgn> script is run with a
4951 first argument of <tt>remove</tt>, the script should call
4952 <prgn>ldconfig</prgn>.
4957 During install or upgrade, the preinst is called before
4958 the new files are installed, so calling "ldconfig" is
4959 pointless. The preinst of an existing package can also be
4960 called if an upgrade fails. However, this happens during
4961 the critical time when a shared libs may exist on-disk
4962 under a temporary name. Thus, it is dangerous and
4963 forbidden by current policy to call "ldconfig" at this
4968 When a package is installed or upgraded, "postinst
4969 configure" runs after the new files are safely on-disk.
4970 Since it is perfectly safe to invoke ldconfig
4971 unconditionally in a postinst, it is OK for a package to
4972 simply put ldconfig in its postinst without checking the
4973 argument. The postinst can also be called to recover from
4974 a failed upgrade. This happens before any new files are
4975 unpacked, so there is no reason to call "ldconfig" at this
4980 For a package that is being removed, prerm is
4981 called with all the files intact, so calling ldconfig is
4982 useless. The other calls to "prerm" happen in the case of
4983 upgrade at a time when all the files of the old package
4984 are on-disk, so again calling "ldconfig" is pointless.
4988 postrm, on the other hand, is called with the "remove"
4989 argument just after the files are removed, so this is
4990 the proper time to call "ldconfig" to notify the system
4991 of the fact that the shared libraries from the package
4992 are removed. The postrm can be called at several other
4993 times. At the time of "postrm purge", "postrm
4994 abort-install", or "postrm abort-upgrade", calling
4995 "ldconfig" is useless because the shared lib files are
4996 not on-disk. However, when "postrm" is invoked with
4997 arguments "upgrade", "failed-upgrade", or "disappear", a
4998 shared lib may exist on-disk under a temporary filename.
5006 <sect id="sharedlibs-support-files">
5007 <heading>Shared library support files</heading>
5010 If your package contains files whose names do not change with
5011 each change in the library shared object version, you must not
5012 put them in the shared library package. Otherwise, several
5013 versions of the shared library cannot be installed at the same
5014 time without filename clashes, making upgrades and transitions
5015 unnecessarily difficult.
5019 It is recommended that supporting files and run-time support
5020 programs that do not need to be invoked manually by users, but
5021 are nevertheless required for the package to function, be placed
5022 (if they are binary) in a subdirectory of <file>/usr/lib</file>,
5023 preferably under <file>/usr/lib/</file><var>package-name</var>.
5024 If the program or file is architecture independent, the
5025 recommendation is for it to be placed in a subdirectory of
5026 <file>/usr/share</file> instead, preferably under
5027 <file>/usr/share/</file><var>package-name</var>. Following the
5028 <var>package-name</var> naming convention ensures that the file
5029 names change when the shared object version changes.
5033 Run-time support programs that use the shared library but are
5034 not required for the library to function or files used by the
5035 shared library that can be used by any version of the shared
5036 library package should instead be put in a separate package.
5037 This package might typically be named
5038 <package><var>libraryname</var>-tools</package>; note the
5039 absence of the <var>soversion</var> in the package name.
5043 Files and support programs only useful when compiling software
5044 against the library should be included in the development
5045 package for the library.<footnote>
5046 For example, a <file><var>package-name</var>-config</file>
5047 script or <package>pkg-config</package> configuration files.
5052 <sect id="sharedlibs-static">
5053 <heading>Static libraries</heading>
5056 The static library (<file><var>libraryname.a</var></file>)
5057 is usually provided in addition to the shared version.
5058 It is placed into the development package (see below).
5062 In some cases, it is acceptable for a library to be
5063 available in static form only; these cases include:
5065 <item>libraries for languages whose shared library support
5066 is immature or unstable</item>
5067 <item>libraries whose interfaces are in flux or under
5068 development (commonly the case when the library's
5069 major version number is zero, or where the ABI breaks
5070 across patchlevels)</item>
5071 <item>libraries which are explicitly intended to be
5072 available only in static form by their upstream
5077 <sect id="sharedlibs-dev">
5078 <heading>Development files</heading>
5081 The development files associated to a shared library need to be
5082 placed in a package called
5083 <package><var>libraryname</var><var>soversion</var>-dev</package>,
5084 or if you prefer only to support one development version at a
5085 time, <package><var>libraryname</var>-dev</package>.
5089 In case several development versions of a library exist, you may
5090 need to use <prgn>dpkg</prgn>'s Conflicts mechanism (see
5091 <ref id="conflicts">) to ensure that the user only installs one
5092 development version at a time (as different development versions are
5093 likely to have the same header files in them, which would cause a
5094 filename clash if both were installed).
5098 The development package should contain a symlink for the associated
5099 shared library without a version number. For example, the
5100 <package>libgdbm-dev</package> package should include a symlink
5101 from <file>/usr/lib/libgdbm.so</file> to
5102 <file>libgdbm.so.3.0.0</file>. This symlink is needed by the linker
5103 (<prgn>ld</prgn>) when compiling packages, as it will only look for
5104 <file>libgdbm.so</file> when compiling dynamically.
5108 <sect id="sharedlibs-intradeps">
5109 <heading>Dependencies between the packages of the same library</heading>
5112 Typically the development version should have an exact
5113 version dependency on the runtime library, to make sure that
5114 compilation and linking happens correctly. The
5115 <tt>${binary:Version}</tt> substitution variable can be
5116 useful for this purpose.
5118 Previously, <tt>${Source-Version}</tt> was used, but its name
5119 was confusing and it has been deprecated since dpkg 1.13.19.
5124 <sect id="sharedlibs-shlibdeps">
5125 <heading>Dependencies between the library and other packages -
5126 the <tt>shlibs</tt> system</heading>
5129 If a package contains a binary or library which links to a
5130 shared library, we must ensure that when the package is
5131 installed on the system, all of the libraries needed are
5132 also installed. This requirement led to the creation of the
5133 <tt>shlibs</tt> system, which is very simple in its design:
5134 any package which <em>provides</em> a shared library also
5135 provides information on the package dependencies required to
5136 ensure the presence of this library, and any package which
5137 <em>uses</em> a shared library uses this information to
5138 determine the dependencies it requires. The files which
5139 contain the mapping from shared libraries to the necessary
5140 dependency information are called <file>shlibs</file> files.
5144 Thus, when a package is built which contains any shared
5145 libraries, it must provide a <file>shlibs</file> file for other
5146 packages to use, and when a package is built which contains
5147 any shared libraries or compiled binaries, it must run
5148 <qref id="pkg-dpkg-shlibdeps"><prgn>dpkg-shlibdeps</prgn></qref>
5149 on these to determine the libraries used and hence the
5150 dependencies needed by this package.<footnote>
5152 In the past, the shared libraries linked to were
5153 determined by calling <prgn>ldd</prgn>, but now
5154 <prgn>objdump</prgn> is used to do this. The only
5155 change this makes to package building is that
5156 <prgn>dpkg-shlibdeps</prgn> must also be run on shared
5157 libraries, whereas in the past this was unnecessary.
5158 The rest of this footnote explains the advantage that
5163 We say that a binary <tt>foo</tt> <em>directly</em> uses
5164 a library <tt>libbar</tt> if it is explicitly linked
5165 with that library (that is, it uses the flag
5166 <tt>-lbar</tt> during the linking stage). Other
5167 libraries that are needed by <tt>libbar</tt> are linked
5168 <em>indirectly</em> to <tt>foo</tt>, and the dynamic
5169 linker will load them automatically when it loads
5170 <tt>libbar</tt>. A package should depend on
5171 the libraries it directly uses, and the dependencies for
5172 those libraries should automatically pull in the other
5177 Unfortunately, the <prgn>ldd</prgn> program shows both
5178 the directly and indirectly used libraries, meaning that
5179 the dependencies determined included both direct and
5180 indirect dependencies. The use of <prgn>objdump</prgn>
5181 avoids this problem by determining only the directly
5186 A good example of where this helps is the following. We
5187 could update <tt>libimlib</tt> with a new version that
5188 supports a new graphics format called dgf (but retaining
5189 the same major version number). If we used the old
5190 <prgn>ldd</prgn> method, every package that uses
5191 <tt>libimlib</tt> would need to be recompiled so it
5192 would also depend on <tt>libdgf</tt> or it wouldn't run
5193 due to missing symbols. However with the new system,
5194 packages using <tt>libimlib</tt> can rely on
5195 <tt>libimlib</tt> itself having the dependency on
5196 <tt>libdgf</tt> and so they would not need rebuilding.
5202 In the following sections, we will first describe where the
5203 various <tt>shlibs</tt> files are to be found, then how to
5204 use <prgn>dpkg-shlibdeps</prgn>, and finally the <tt>shlibs</tt>
5205 file format and how to create them if your package contains a
5210 <heading>The <tt>shlibs</tt> files present on the system</heading>
5213 There are several places where <tt>shlibs</tt> files are
5214 found. The following list gives them in the order in which
5216 <qref id="pkg-dpkg-shlibdeps"><prgn>dpkg-shlibdeps</prgn></qref>.
5217 (The first one which gives the required information is used.)
5223 <p><file>debian/shlibs.local</file></p>
5226 This lists overrides for this package. Its use is
5227 described below (see <ref id="shlibslocal">).
5232 <p><file>/etc/dpkg/shlibs.override</file></p>
5235 This lists global overrides. This list is normally
5236 empty. It is maintained by the local system
5242 <p><file>DEBIAN/shlibs</file> files in the "build directory"</p>
5245 When packages are being built, any
5246 <file>debian/shlibs</file> files are copied into the
5247 control file area of the temporary build directory and
5248 given the name <file>shlibs</file>. These files give
5249 details of any shared libraries included in the
5251 An example may help here. Let us say that the
5252 source package <tt>foo</tt> generates two binary
5253 packages, <tt>libfoo2</tt> and
5254 <tt>foo-runtime</tt>. When building the binary
5255 packages, the two packages are created in the
5256 directories <file>debian/libfoo2</file> and
5257 <file>debian/foo-runtime</file> respectively.
5258 (<file>debian/tmp</file> could be used instead of one
5259 of these.) Since <tt>libfoo2</tt> provides the
5260 <tt>libfoo</tt> shared library, it will require a
5261 <tt>shlibs</tt> file, which will be installed in
5262 <file>debian/libfoo2/DEBIAN/shlibs</file>, eventually
5264 <file>/var/lib/dpkg/info/libfoo2.shlibs</file>. Then
5265 when <prgn>dpkg-shlibdeps</prgn> is run on the
5267 <file>debian/foo-runtime/usr/bin/foo-prog</file>, it
5269 <file>debian/libfoo2/DEBIAN/shlibs</file> file to
5270 determine whether <tt>foo-prog</tt>'s library
5271 dependencies are satisfied by any of the libraries
5272 provided by <tt>libfoo2</tt>. For this reason,
5273 <prgn>dpkg-shlibdeps</prgn> must only be run once
5274 all of the individual binary packages'
5275 <tt>shlibs</tt> files have been installed into the
5282 <p><file>/var/lib/dpkg/info/*.shlibs</file></p>
5285 These are the <file>shlibs</file> files corresponding to
5286 all of the packages installed on the system, and are
5287 maintained by the relevant package maintainers.
5292 <p><file>/etc/dpkg/shlibs.default</file></p>
5295 This file lists any shared libraries whose packages
5296 have failed to provide correct <file>shlibs</file> files.
5297 It was used when the <file>shlibs</file> setup was first
5298 introduced, but it is now normally empty. It is
5299 maintained by the <tt>dpkg</tt> maintainer.
5307 <heading>How to use <prgn>dpkg-shlibdeps</prgn> and the
5308 <file>shlibs</file> files</heading>
5312 <qref id="pkg-dpkg-shlibdeps"><prgn>dpkg-shlibdeps</prgn></qref>
5313 into your <file>debian/rules</file> file. If your package
5314 contains only compiled binaries and libraries (but no scripts),
5315 you can use a command such as:
5316 <example compact="compact">
5317 dpkg-shlibdeps debian/tmp/usr/bin/* debian/tmp/usr/sbin/* \
5318 debian/tmp/usr/lib/*
5320 Otherwise, you will need to explicitly list the compiled
5321 binaries and libraries.<footnote>
5322 If you are using <tt>debhelper</tt>, the
5323 <prgn>dh_shlibdeps</prgn> program will do this work for
5324 you. It will also correctly handle multi-binary
5330 This command puts the dependency information into the
5331 <file>debian/substvars</file> file, which is then used by
5332 <prgn>dpkg-gencontrol</prgn>. You will need to place a
5333 <tt>${shlibs:Depends}</tt> variable in the <tt>Depends</tt>
5334 field in the control file for this to work.
5338 If <prgn>dpkg-shlibdeps</prgn> doesn't complain, you're
5339 done. If it does complain you might need to create your own
5340 <file>debian/shlibs.local</file> file, as explained below (see
5341 <ref id="shlibslocal">).
5345 If you have multiple binary packages, you will need to call
5346 <prgn>dpkg-shlibdeps</prgn> on each one which contains
5347 compiled libraries or binaries. In such a case, you will
5348 need to use the <tt>-T</tt> option to the <tt>dpkg</tt>
5349 utilities to specify a different <file>substvars</file> file.
5353 If you are creating a udeb for use in the Debian Installer, you
5354 will need to specify that <prgn>dpkg-shlibdeps</prgn> should use
5355 the dependency line of type <tt>udeb</tt> by adding
5356 <tt>-tudeb</tt> as option<footnote>
5357 <prgn>dh_shlibdeps</prgn> from the <tt>debhelper</tt> suite
5358 will automatically add this option if it knows it is
5360 </footnote>. If there is no dependency line of type <tt>udeb</tt>
5361 in the <file>shlibs</file> file, <prgn>dpkg-shlibdeps</prgn> will
5362 fall back to the regular dependency line.
5366 For more details on dpkg-shlibdeps, please see
5367 <ref id="pkg-dpkg-shlibdeps"> and
5368 <manref name="dpkg-shlibdeps" section="1">.
5373 <heading>The <file>shlibs</file> File Format</heading>
5376 Each <file>shlibs</file> file has the same format. Lines
5377 beginning with <tt>#</tt> are considered to be comments and
5378 are ignored. Each line is of the form:
5379 <example compact="compact">
5380 [<var>type</var>: ]<var>library-name</var> <var>soname-version</var> <var>dependencies ...</var>
5385 We will explain this by reference to the example of the
5386 <tt>zlib1g</tt> package, which (at the time of writing)
5387 installs the shared library <file>/usr/lib/libz.so.1.1.3</file>.
5391 <var>type</var> is an optional element that indicates the type
5392 of package for which the line is valid. The only type currently
5393 in use is <tt>udeb</tt>. The colon and space after the type are
5398 <var>library-name</var> is the name of the shared library,
5399 in this case <tt>libz</tt>. (This must match the name part
5400 of the soname, see below.)
5404 <var>soname-version</var> is the version part of the soname of
5405 the library. The soname is the thing that must exactly match
5406 for the library to be recognized by the dynamic linker, and is
5408 <tt><var>name</var>.so.<var>major-version</var></tt>, in our
5409 example, <tt>libz.so.1</tt>.<footnote>
5410 This can be determined using the command
5411 <example compact="compact">
5412 objdump -p /usr/lib/libz.so.1.1.3 | grep SONAME
5415 The version part is the part which comes after
5416 <tt>.so.</tt>, so in our case, it is <tt>1</tt>.
5420 <var>dependencies</var> has the same syntax as a dependency
5421 field in a binary package control file. It should give
5422 details of which packages are required to satisfy a binary
5423 built against the version of the library contained in the
5424 package. See <ref id="depsyntax"> for details.
5428 In our example, if the first version of the <tt>zlib1g</tt>
5429 package which contained a minor number of at least
5430 <tt>1.3</tt> was <var>1:1.1.3-1</var>, then the
5431 <tt>shlibs</tt> entry for this library could say:
5432 <example compact="compact">
5433 libz 1 zlib1g (>= 1:1.1.3)
5435 The version-specific dependency is to avoid warnings from
5436 the dynamic linker about using older shared libraries with
5441 As zlib1g also provides a udeb containing the shared library,
5442 there would also be a second line:
5443 <example compact="compact">
5444 udeb: libz 1 zlib1g-udeb (>= 1:1.1.3)
5450 <heading>Providing a <file>shlibs</file> file</heading>
5453 If your package provides a shared library, you need to create
5454 a <file>shlibs</file> file following the format described above.
5455 It is usual to call this file <file>debian/shlibs</file> (but if
5456 you have multiple binary packages, you might want to call it
5457 <file>debian/shlibs.<var>package</var></file> instead). Then
5458 let <file>debian/rules</file> install it in the control area:
5459 <example compact="compact">
5460 install -m644 debian/shlibs debian/tmp/DEBIAN
5462 or, in the case of a multi-binary package:
5463 <example compact="compact">
5464 install -m644 debian/shlibs.<var>package</var> debian/<var>package</var>/DEBIAN/shlibs
5466 An alternative way of doing this is to create the
5467 <file>shlibs</file> file in the control area directly from
5468 <file>debian/rules</file> without using a <file>debian/shlibs</file>
5469 file at all,<footnote>
5470 This is what <prgn>dh_makeshlibs</prgn> in the
5471 <tt>debhelper</tt> suite does. If your package also has a udeb
5472 that provides a shared library, <prgn>dh_makeshlibs</prgn> can
5473 automatically generate the <tt>udeb:</tt> lines if you specify
5474 the name of the udeb with the <tt>--add-udeb</tt> option.
5476 since the <file>debian/shlibs</file> file itself is ignored by
5477 <prgn>dpkg-shlibdeps</prgn>.
5481 As <prgn>dpkg-shlibdeps</prgn> reads the
5482 <file>DEBIAN/shlibs</file> files in all of the binary packages
5483 being built from this source package, all of the
5484 <file>DEBIAN/shlibs</file> files should be installed before
5485 <prgn>dpkg-shlibdeps</prgn> is called on any of the binary
5490 <sect1 id="shlibslocal">
5491 <heading>Writing the <file>debian/shlibs.local</file> file</heading>
5494 This file is intended only as a <em>temporary</em> fix if
5495 your binaries or libraries depend on a library whose package
5496 does not yet provide a correct <file>shlibs</file> file.
5500 We will assume that you are trying to package a binary
5501 <tt>foo</tt>. When you try running
5502 <prgn>dpkg-shlibdeps</prgn> you get the following error
5503 message (<tt>-O</tt> displays the dependency information on
5504 <tt>stdout</tt> instead of writing it to
5505 <tt>debian/substvars</tt>, and the lines have been wrapped
5506 for ease of reading):
5507 <example compact="compact">
5508 $ dpkg-shlibdeps -O debian/tmp/usr/bin/foo
5509 dpkg-shlibdeps: warning: unable to find dependency
5510 information for shared library libbar (soname 1,
5511 path /usr/lib/libbar.so.1, dependency field Depends)
5512 shlibs:Depends=libc6 (>= 2.2.2-2)
5514 You can then run <prgn>ldd</prgn> on the binary to find the
5515 full location of the library concerned:
5516 <example compact="compact">
5518 libbar.so.1 => /usr/lib/libbar.so.1 (0x4001e000)
5519 libc.so.6 => /lib/libc.so.6 (0x40032000)
5520 /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0x40000000)
5522 So the <prgn>foo</prgn> binary depends on the
5523 <prgn>libbar</prgn> shared library, but no package seems to
5524 provide a <file>*.shlibs</file> file handling
5525 <file>libbar.so.1</file> in <file>/var/lib/dpkg/info/</file>. Let's
5526 determine the package responsible:
5527 <example compact="compact">
5528 $ dpkg -S /usr/lib/libbar.so.1
5529 bar1: /usr/lib/libbar.so.1
5530 $ dpkg -s bar1 | grep Version
5533 This tells us that the <tt>bar1</tt> package, version 1.0-1,
5534 is the one we are using. Now we can file a bug against the
5535 <tt>bar1</tt> package and create our own
5536 <file>debian/shlibs.local</file> to locally fix the problem.
5537 Including the following line into your
5538 <file>debian/shlibs.local</file> file:
5539 <example compact="compact">
5540 libbar 1 bar1 (>= 1.0-1)
5542 should allow the package build to work.
5546 As soon as the maintainer of <tt>bar1</tt> provides a
5547 correct <file>shlibs</file> file, you should remove this line
5548 from your <file>debian/shlibs.local</file> file. (You should
5549 probably also then have a versioned <tt>Build-Depends</tt>
5550 on <tt>bar1</tt> to help ensure that others do not have the
5551 same problem building your package.)
5560 <chapt id="opersys"><heading>The Operating System</heading>
5563 <heading>File system hierarchy</heading>
5567 <heading>File System Structure</heading>
5570 The location of all installed files and directories must
5571 comply with the Filesystem Hierarchy Standard (FHS),
5572 version 2.3, with the exceptions noted below, and except
5573 where doing so would violate other terms of Debian
5574 Policy. The following exceptions to the FHS apply:
5579 The optional rules related to user specific
5580 configuration files for applications are stored in
5581 the user's home directory are relaxed. It is
5582 recommended that such files start with the
5583 '<tt>.</tt>' character (a "dot file"), and if an
5584 application needs to create more than one dot file
5585 then the preferred placement is in a subdirectory
5586 with a name starting with a '.' character, (a "dot
5587 directory"). In this case it is recommended the
5588 configuration files not start with the '.'
5594 The requirement for amd64 to use <file>/lib64</file>
5595 for 64 bit binaries is removed.
5600 The requirement that
5601 <file>/usr/local/share/man</file> be "synonymous"
5602 with <file>/usr/local/man</file> is relaxed to a
5607 The requirement that windowmanagers with a single
5608 configuration file call it <file>system.*wmrc</file>
5609 is removed, as is the restriction that the window
5610 manager subdirectory be named identically to the
5611 window manager name itself.
5616 The requirement that boot manager configuration
5617 files live in <file>/etc</file>, or at least are
5618 symlinked there, is relaxed to a recommendation.
5625 The version of this document referred here can be
5626 found in the <tt>debian-policy</tt> package or on <url
5627 id="http://www.debian.org/doc/packaging-manuals/fhs/"
5628 name="FHS (Debian copy)"> alongside this manual (or, if
5629 you have the <package>debian-policy</package> installed,
5631 id="file:///usr/share/doc/debian-policy/fhs/" name="FHS
5632 (local copy)">). The
5633 latest version, which may be a more recent version, may
5635 <url id="http://www.pathname.com/fhs/" name="FHS (upstream)">.
5636 Specific questions about following the standard may be
5637 asked on the <tt>debian-devel</tt> mailing list, or
5638 referred to the FHS mailing list (see the
5639 <url id="http://www.pathname.com/fhs/" name="FHS web site"> for
5645 <heading>Site-specific programs</heading>
5648 As mandated by the FHS, packages must not place any
5649 files in <file>/usr/local</file>, either by putting them in
5650 the file system archive to be unpacked by <prgn>dpkg</prgn>
5651 or by manipulating them in their maintainer scripts.
5655 However, the package may create empty directories below
5656 <file>/usr/local</file> so that the system administrator knows
5657 where to place site-specific files. These are not
5658 directories <em>in</em> <file>/usr/local</file>, but are
5659 children of directories in <file>/usr/local</file>. These
5660 directories (<file>/usr/local/*/dir/</file>)
5661 should be removed on package removal if they are
5666 Note, that this applies only to directories <em>below</em>
5667 <file>/usr/local</file>, not <em>in</em> <file>/usr/local</file>.
5668 Packages must not create sub-directories in the directory
5669 <file>/usr/local</file> itself, except those listed in FHS,
5670 section 4.5. However, you may create directories below
5671 them as you wish. You must not remove any of the
5672 directories listed in 4.5, even if you created them.
5676 Since <file>/usr/local</file> can be mounted read-only from a
5677 remote server, these directories must be created and
5678 removed by the <prgn>postinst</prgn> and <prgn>prerm</prgn>
5679 maintainer scripts and not be included in the
5680 <file>.deb</file> archive. These scripts must not fail if
5681 either of these operations fail.
5685 For example, the <tt>emacsen-common</tt> package could
5686 contain something like
5687 <example compact="compact">
5688 if [ ! -e /usr/local/share/emacs ]
5690 if mkdir /usr/local/share/emacs 2>/dev/null
5692 chown root:staff /usr/local/share/emacs
5693 chmod 2775 /usr/local/share/emacs
5697 in its <prgn>postinst</prgn> script, and
5698 <example compact="compact">
5699 rmdir /usr/local/share/emacs/site-lisp 2>/dev/null || true
5700 rmdir /usr/local/share/emacs 2>/dev/null || true
5702 in the <prgn>prerm</prgn> script. (Note that this form is
5703 used to ensure that if the script is interrupted, the
5704 directory <file>/usr/local/share/emacs</file> will still be
5709 If you do create a directory in <file>/usr/local</file> for
5710 local additions to a package, you should ensure that
5711 settings in <file>/usr/local</file> take precedence over the
5712 equivalents in <file>/usr</file>.
5716 However, because <file>/usr/local</file> and its contents are
5717 for exclusive use of the local administrator, a package
5718 must not rely on the presence or absence of files or
5719 directories in <file>/usr/local</file> for normal operation.
5723 The <file>/usr/local</file> directory itself and all the
5724 subdirectories created by the package should (by default) have
5725 permissions 2775 (group-writable and set-group-id) and be
5726 owned by <tt>root:staff</tt>.
5731 <heading>The system-wide mail directory</heading>
5733 The system-wide mail directory is <file>/var/mail</file>. This
5734 directory is part of the base system and should not owned
5735 by any particular mail agents. The use of the old
5736 location <file>/var/spool/mail</file> is deprecated, even
5737 though the spool may still be physically located there.
5743 <heading>Users and groups</heading>
5746 <heading>Introduction</heading>
5748 The Debian system can be configured to use either plain or
5753 Some user ids (UIDs) and group ids (GIDs) are reserved
5754 globally for use by certain packages. Because some
5755 packages need to include files which are owned by these
5756 users or groups, or need the ids compiled into binaries,
5757 these ids must be used on any Debian system only for the
5758 purpose for which they are allocated. This is a serious
5759 restriction, and we should avoid getting in the way of
5760 local administration policies. In particular, many sites
5761 allocate users and/or local system groups starting at 100.
5765 Apart from this we should have dynamically allocated ids,
5766 which should by default be arranged in some sensible
5767 order, but the behavior should be configurable.
5771 Packages other than <tt>base-passwd</tt> must not modify
5772 <file>/etc/passwd</file>, <file>/etc/shadow</file>,
5773 <file>/etc/group</file> or <file>/etc/gshadow</file>.
5778 <heading>UID and GID classes</heading>
5780 The UID and GID numbers are divided into classes as
5786 Globally allocated by the Debian project, the same
5787 on every Debian system. These ids will appear in
5788 the <file>passwd</file> and <file>group</file> files of all
5789 Debian systems, new ids in this range being added
5790 automatically as the <tt>base-passwd</tt> package is
5795 Packages which need a single statically allocated
5796 uid or gid should use one of these; their
5797 maintainers should ask the <tt>base-passwd</tt>
5805 Dynamically allocated system users and groups.
5806 Packages which need a user or group, but can have
5807 this user or group allocated dynamically and
5808 differently on each system, should use <tt>adduser
5809 --system</tt> to create the group and/or user.
5810 <prgn>adduser</prgn> will check for the existence of
5811 the user or group, and if necessary choose an unused
5812 id based on the ranges specified in
5813 <file>adduser.conf</file>.
5817 <tag>1000-29999:</tag>
5820 Dynamically allocated user accounts. By default
5821 <prgn>adduser</prgn> will choose UIDs and GIDs for
5822 user accounts in this range, though
5823 <file>adduser.conf</file> may be used to modify this
5828 <tag>30000-59999:</tag>
5833 <tag>60000-64999:</tag>
5836 Globally allocated by the Debian project, but only
5837 created on demand. The ids are allocated centrally
5838 and statically, but the actual accounts are only
5839 created on users' systems on demand.
5843 These ids are for packages which are obscure or
5844 which require many statically-allocated ids. These
5845 packages should check for and create the accounts in
5846 <file>/etc/passwd</file> or <file>/etc/group</file> (using
5847 <prgn>adduser</prgn> if it has this facility) if
5848 necessary. Packages which are likely to require
5849 further allocations should have a "hole" left after
5850 them in the allocation, to give them room to
5855 <tag>65000-65533:</tag>
5863 User <tt>nobody</tt>. The corresponding gid refers
5864 to the group <tt>nogroup</tt>.
5871 <tt>(uid_t)(-1) == (gid_t)(-1)</tt> <em>must
5872 not</em> be used, because it is the error return
5881 <sect id="sysvinit">
5882 <heading>System run levels and <file>init.d</file> scripts</heading>
5884 <sect1 id="/etc/init.d">
5885 <heading>Introduction</heading>
5888 The <file>/etc/init.d</file> directory contains the scripts
5889 executed by <prgn>init</prgn> at boot time and when the
5890 init state (or "runlevel") is changed (see <manref
5891 name="init" section="8">).
5895 There are at least two different, yet functionally
5896 equivalent, ways of handling these scripts. For the sake
5897 of simplicity, this document describes only the symbolic
5898 link method. However, it must not be assumed by maintainer
5899 scripts that this method is being used, and any automated
5900 manipulation of the various runlevel behaviors by
5901 maintainer scripts must be performed using
5902 <prgn>update-rc.d</prgn> as described below and not by
5903 manually installing or removing symlinks. For information
5904 on the implementation details of the other method,
5905 implemented in the <tt>file-rc</tt> package, please refer
5906 to the documentation of that package.
5910 These scripts are referenced by symbolic links in the
5911 <file>/etc/rc<var>n</var>.d</file> directories. When changing
5912 runlevels, <prgn>init</prgn> looks in the directory
5913 <file>/etc/rc<var>n</var>.d</file> for the scripts it should
5914 execute, where <tt><var>n</var></tt> is the runlevel that
5915 is being changed to, or <tt>S</tt> for the boot-up
5920 The names of the links all have the form
5921 <file>S<var>mm</var><var>script</var></file> or
5922 <file>K<var>mm</var><var>script</var></file> where
5923 <var>mm</var> is a two-digit number and <var>script</var>
5924 is the name of the script (this should be the same as the
5925 name of the actual script in <file>/etc/init.d</file>).
5929 When <prgn>init</prgn> changes runlevel first the targets
5930 of the links whose names start with a <tt>K</tt> are
5931 executed, each with the single argument <tt>stop</tt>,
5932 followed by the scripts prefixed with an <tt>S</tt>, each
5933 with the single argument <tt>start</tt>. (The links are
5934 those in the <file>/etc/rc<var>n</var>.d</file> directory
5935 corresponding to the new runlevel.) The <tt>K</tt> links
5936 are responsible for killing services and the <tt>S</tt>
5937 link for starting services upon entering the runlevel.
5941 For example, if we are changing from runlevel 2 to
5942 runlevel 3, init will first execute all of the <tt>K</tt>
5943 prefixed scripts it finds in <file>/etc/rc3.d</file>, and then
5944 all of the <tt>S</tt> prefixed scripts in that directory.
5945 The links starting with <tt>K</tt> will cause the
5946 referred-to file to be executed with an argument of
5947 <tt>stop</tt>, and the <tt>S</tt> links with an argument
5952 The two-digit number <var>mm</var> is used to determine
5953 the order in which to run the scripts: low-numbered links
5954 have their scripts run first. For example, the
5955 <tt>K20</tt> scripts will be executed before the
5956 <tt>K30</tt> scripts. This is used when a certain service
5957 must be started before another. For example, the name
5958 server <prgn>bind</prgn> might need to be started before
5959 the news server <prgn>inn</prgn> so that <prgn>inn</prgn>
5960 can set up its access lists. In this case, the script
5961 that starts <prgn>bind</prgn> would have a lower number
5962 than the script that starts <prgn>inn</prgn> so that it
5964 <example compact="compact">
5971 The two runlevels 0 (halt) and 6 (reboot) are slightly
5972 different. In these runlevels, the links with an
5973 <tt>S</tt> prefix are still called after those with a
5974 <tt>K</tt> prefix, but they too are called with the single
5975 argument <tt>stop</tt>.
5980 <heading>Writing the scripts</heading>
5983 Packages that include daemons for system services should
5984 place scripts in <file>/etc/init.d</file> to start or stop
5985 services at boot time or during a change of runlevel.
5986 These scripts should be named
5987 <file>/etc/init.d/<var>package</var></file>, and they should
5988 accept one argument, saying what to do:
5991 <tag><tt>start</tt></tag>
5992 <item>start the service,</item>
5994 <tag><tt>stop</tt></tag>
5995 <item>stop the service,</item>
5997 <tag><tt>restart</tt></tag>
5998 <item>stop and restart the service if it's already running,
5999 otherwise start the service</item>
6001 <tag><tt>reload</tt></tag>
6002 <item><p>cause the configuration of the service to be
6003 reloaded without actually stopping and restarting
6006 <tag><tt>force-reload</tt></tag>
6007 <item>cause the configuration to be reloaded if the
6008 service supports this, otherwise restart the
6012 The <tt>start</tt>, <tt>stop</tt>, <tt>restart</tt>, and
6013 <tt>force-reload</tt> options should be supported by all
6014 scripts in <file>/etc/init.d</file>, the <tt>reload</tt>
6019 The <file>init.d</file> scripts must ensure that they will
6020 behave sensibly (i.e., returning success and not starting
6021 multiple copies of a service) if invoked with <tt>start</tt>
6022 when the service is already running, or with <tt>stop</tt>
6023 when it isn't, and that they don't kill unfortunately-named
6024 user processes. The best way to achieve this is usually to
6025 use <prgn>start-stop-daemon</prgn> with the <tt>--oknodo</tt>
6030 If a service reloads its configuration automatically (as
6031 in the case of <prgn>cron</prgn>, for example), the
6032 <tt>reload</tt> option of the <file>init.d</file> script
6033 should behave as if the configuration has been reloaded
6038 The <file>/etc/init.d</file> scripts must be treated as
6039 configuration files, either (if they are present in the
6040 package, that is, in the .deb file) by marking them as
6041 <tt>conffile</tt>s, or, (if they do not exist in the .deb)
6042 by managing them correctly in the maintainer scripts (see
6043 <ref id="config-files">). This is important since we want
6044 to give the local system administrator the chance to adapt
6045 the scripts to the local system, e.g., to disable a
6046 service without de-installing the package, or to specify
6047 some special command line options when starting a service,
6048 while making sure their changes aren't lost during the next
6053 These scripts should not fail obscurely when the
6054 configuration files remain but the package has been
6055 removed, as configuration files remain on the system after
6056 the package has been removed. Only when <prgn>dpkg</prgn>
6057 is executed with the <tt>--purge</tt> option will
6058 configuration files be removed. In particular, as the
6059 <file>/etc/init.d/<var>package</var></file> script itself is
6060 usually a <tt>conffile</tt>, it will remain on the system
6061 if the package is removed but not purged. Therefore, you
6062 should include a <tt>test</tt> statement at the top of the
6064 <example compact="compact">
6065 test -f <var>program-executed-later-in-script</var> || exit 0
6070 Often there are some variables in the <file>init.d</file>
6071 scripts whose values control the behavior of the scripts,
6072 and which a system administrator is likely to want to
6073 change. As the scripts themselves are frequently
6074 <tt>conffile</tt>s, modifying them requires that the
6075 administrator merge in their changes each time the package
6076 is upgraded and the <tt>conffile</tt> changes. To ease
6077 the burden on the system administrator, such configurable
6078 values should not be placed directly in the script.
6079 Instead, they should be placed in a file in
6080 <file>/etc/default</file>, which typically will have the same
6081 base name as the <file>init.d</file> script. This extra file
6082 should be sourced by the script when the script runs. It
6083 must contain only variable settings and comments in SUSv3
6084 <prgn>sh</prgn> format. It may either be a
6085 <tt>conffile</tt> or a configuration file maintained by
6086 the package maintainer scripts. See <ref id="config-files">
6091 To ensure that vital configurable values are always
6092 available, the <file>init.d</file> script should set default
6093 values for each of the shell variables it uses, either
6094 before sourcing the <file>/etc/default/</file> file or
6095 afterwards using something like the <tt>:
6096 ${VAR:=default}</tt> syntax. Also, the <file>init.d</file>
6097 script must behave sensibly and not fail if the
6098 <file>/etc/default</file> file is deleted.
6102 <file>/var/run</file> and <file>/var/lock</file> may be mounted
6103 as temporary filesystems<footnote>
6104 For example, using the <tt>RAMRUN</tt> and <tt>RAMLOCK</tt>
6105 options in <file>/etc/default/rcS</file>.
6106 </footnote>, so the <file>init.d</file> scripts must handle this
6107 correctly. This will typically amount to creating any required
6108 subdirectories dynamically when the <file>init.d</file> script
6109 is run, rather than including them in the package and relying on
6110 <prgn>dpkg</prgn> to create them.
6115 <heading>Interfacing with the initscript system</heading>
6118 Maintainers should use the abstraction layer provided by
6119 the <prgn>update-rc.d</prgn> and <prgn>invoke-rc.d</prgn>
6120 programs to deal with initscripts in their packages'
6121 scripts such as <prgn>postinst</prgn>, <prgn>prerm</prgn>
6122 and <prgn>postrm</prgn>.
6126 Directly managing the /etc/rc?.d links and directly
6127 invoking the <file>/etc/init.d/</file> initscripts should
6128 be done only by packages providing the initscript
6129 subsystem (such as <prgn>sysv-rc</prgn> and
6130 <prgn>file-rc</prgn>).
6134 <heading>Managing the links</heading>
6137 The program <prgn>update-rc.d</prgn> is provided for
6138 package maintainers to arrange for the proper creation and
6139 removal of <file>/etc/rc<var>n</var>.d</file> symbolic links,
6140 or their functional equivalent if another method is being
6141 used. This may be used by maintainers in their packages'
6142 <prgn>postinst</prgn> and <prgn>postrm</prgn> scripts.
6146 You must not include any <file>/etc/rc<var>n</var>.d</file>
6147 symbolic links in the actual archive or manually create or
6148 remove the symbolic links in maintainer scripts; you must
6149 use the <prgn>update-rc.d</prgn> program instead. (The
6150 former will fail if an alternative method of maintaining
6151 runlevel information is being used.) You must not include
6152 the <file>/etc/rc<var>n</var>.d</file> directories themselves
6153 in the archive either. (Only the <tt>sysvinit</tt>
6158 By default <prgn>update-rc.d</prgn> will start services in
6159 each of the multi-user state runlevels (2, 3, 4, and 5)
6160 and stop them in the halt runlevel (0), the single-user
6161 runlevel (1) and the reboot runlevel (6). The system
6162 administrator will have the opportunity to customize
6163 runlevels by simply adding, moving, or removing the
6164 symbolic links in <file>/etc/rc<var>n</var>.d</file> if
6165 symbolic links are being used, or by modifying
6166 <file>/etc/runlevel.conf</file> if the <tt>file-rc</tt> method
6171 To get the default behavior for your package, put in your
6172 <prgn>postinst</prgn> script
6173 <example compact="compact">
6174 update-rc.d <var>package</var> defaults
6176 and in your <prgn>postrm</prgn>
6177 <example compact="compact">
6178 if [ "$1" = purge ]; then
6179 update-rc.d <var>package</var> remove
6181 </example>. Note that if your package changes runlevels
6182 or priority, you may have to remove and recreate the links,
6183 since otherwise the old links may persist. Refer to the
6184 documentation of <prgn>update-rc.d</prgn>.
6188 This will use a default sequence number of 20. If it does
6189 not matter when or in which order the <file>init.d</file>
6190 script is run, use this default. If it does, then you
6191 should talk to the maintainer of the <prgn>sysvinit</prgn>
6192 package or post to <tt>debian-devel</tt>, and they will
6193 help you choose a number.
6197 For more information about using <tt>update-rc.d</tt>,
6198 please consult its man page <manref name="update-rc.d"
6204 <heading>Running initscripts</heading>
6206 The program <prgn>invoke-rc.d</prgn> is provided to make
6207 it easier for package maintainers to properly invoke an
6208 initscript, obeying runlevel and other locally-defined
6209 constraints that might limit a package's right to start,
6210 stop and otherwise manage services. This program may be
6211 used by maintainers in their packages' scripts.
6215 The package maintainer scripts must use
6216 <prgn>invoke-rc.d</prgn> to invoke the
6217 <file>/etc/init.d/*</file> initscripts, instead of
6218 calling them directly.
6222 By default, <prgn>invoke-rc.d</prgn> will pass any
6223 action requests (start, stop, reload, restart...) to the
6224 <file>/etc/init.d</file> script, filtering out requests
6225 to start or restart a service out of its intended
6230 Most packages will simply need to change:
6231 <example compact="compact">/etc/init.d/<package>
6232 <action></example> in their <prgn>postinst</prgn>
6233 and <prgn>prerm</prgn> scripts to:
6234 <example compact="compact">
6235 if which invoke-rc.d >/dev/null 2>&1; then
6236 invoke-rc.d <var>package</var> <action>
6238 /etc/init.d/<var>package</var> <action>
6244 A package should register its initscript services using
6245 <prgn>update-rc.d</prgn> before it tries to invoke them
6246 using <prgn>invoke-rc.d</prgn>. Invocation of
6247 unregistered services may fail.
6251 For more information about using
6252 <prgn>invoke-rc.d</prgn>, please consult its man page
6253 <manref name="invoke-rc.d" section="8">.
6259 <heading>Boot-time initialization</heading>
6262 There used to be another directory, <file>/etc/rc.boot</file>,
6263 which contained scripts which were run once per machine
6264 boot. This has been deprecated in favour of links from
6265 <file>/etc/rcS.d</file> to files in <file>/etc/init.d</file> as
6266 described in <ref id="/etc/init.d">. Packages must not
6267 place files in <file>/etc/rc.boot</file>.
6272 <heading>Example</heading>
6275 An example on which you can base your
6276 <file>/etc/init.d</file> scripts is found in
6277 <file>/etc/init.d/skeleton</file>.
6284 <heading>Console messages from <file>init.d</file> scripts</heading>
6287 This section describes the formats to be used for messages
6288 written to standard output by the <file>/etc/init.d</file>
6289 scripts. The intent is to improve the consistency of
6290 Debian's startup and shutdown look and feel. For this
6291 reason, please look very carefully at the details. We want
6292 the messages to have the same format in terms of wording,
6293 spaces, punctuation and case of letters.
6297 Here is a list of overall rules that should be used for
6298 messages generated by <file>/etc/init.d</file> scripts.
6304 The message should fit in one line (fewer than 80
6305 characters), start with a capital letter and end with
6306 a period (<tt>.</tt>) and line feed (<tt>"\n"</tt>).
6310 If the script is performing some time consuming task in
6311 the background (not merely starting or stopping a
6312 program, for instance), an ellipsis (three dots:
6313 <tt>...</tt>) should be output to the screen, with no
6314 leading or tailing whitespace or line feeds.
6318 The messages should appear as if the computer is telling
6319 the user what it is doing (politely :-), but should not
6320 mention "it" directly. For example, instead of:
6321 <example compact="compact">
6322 I'm starting network daemons: nfsd mountd.
6324 the message should say
6325 <example compact="compact">
6326 Starting network daemons: nfsd mountd.
6333 <tt>init.d</tt> script should use the following standard
6334 message formats for the situations enumerated below.
6340 <p>When daemons are started</p>
6343 If the script starts one or more daemons, the output
6344 should look like this (a single line, no leading
6346 <example compact="compact">
6347 Starting <var>description</var>: <var>daemon-1</var> ... <var>daemon-n</var>.
6349 The <var>description</var> should describe the
6350 subsystem the daemon or set of daemons are part of,
6351 while <var>daemon-1</var> up to <var>daemon-n</var>
6352 denote each daemon's name (typically the file name of
6357 For example, the output of <file>/etc/init.d/lpd</file>
6359 <example compact="compact">
6360 Starting printer spooler: lpd.
6365 This can be achieved by saying
6366 <example compact="compact">
6367 echo -n "Starting printer spooler: lpd"
6368 start-stop-daemon --start --quiet --exec /usr/sbin/lpd
6371 in the script. If there are more than one daemon to
6372 start, the output should look like this:
6373 <example compact="compact">
6374 echo -n "Starting remote file system services:"
6375 echo -n " nfsd"; start-stop-daemon --start --quiet nfsd
6376 echo -n " mountd"; start-stop-daemon --start --quiet mountd
6377 echo -n " ugidd"; start-stop-daemon --start --quiet ugidd
6380 This makes it possible for the user to see what is
6381 happening and when the final daemon has been started.
6382 Care should be taken in the placement of white spaces:
6383 in the example above the system administrators can
6384 easily comment out a line if they don't want to start
6385 a specific daemon, while the displayed message still
6391 <p>When a system parameter is being set</p>
6394 If you have to set up different system parameters
6395 during the system boot, you should use this format:
6396 <example compact="compact">
6397 Setting <var>parameter</var> to "<var>value</var>".
6402 You can use a statement such as the following to get
6404 <example compact="compact">
6405 echo "Setting DNS domainname to \"$domainname\"."
6410 Note that the same symbol (<tt>"</tt>) is used for the left
6411 and right quotation marks. A grave accent (<tt>`</tt>) is
6412 not a quote character; neither is an apostrophe
6418 <p>When a daemon is stopped or restarted</p>
6421 When you stop or restart a daemon, you should issue a
6422 message identical to the startup message, except that
6423 <tt>Starting</tt> is replaced with <tt>Stopping</tt>
6424 or <tt>Restarting</tt> respectively.
6428 For example, stopping the printer daemon will look like
6430 <example compact="compact">
6431 Stopping printer spooler: lpd.
6437 <p>When something is executed</p>
6440 There are several examples where you have to run a
6441 program at system startup or shutdown to perform a
6442 specific task, for example, setting the system's clock
6443 using <prgn>netdate</prgn> or killing all processes
6444 when the system shuts down. Your message should look
6446 <example compact="compact">
6447 Doing something very useful...done.
6449 You should print the <tt>done.</tt> immediately after
6450 the job has been completed, so that the user is
6451 informed why they have to wait. You can get this
6453 <example compact="compact">
6454 echo -n "Doing something very useful..."
6463 <p>When the configuration is reloaded</p>
6466 When a daemon is forced to reload its configuration
6467 files you should use the following format:
6468 <example compact="compact">
6469 Reloading <var>description</var> configuration...done.
6471 where <var>description</var> is the same as in the
6472 daemon starting message.
6480 <heading>Cron jobs</heading>
6483 Packages must not modify the configuration file
6484 <file>/etc/crontab</file>, and they must not modify the files in
6485 <file>/var/spool/cron/crontabs</file>.</p>
6488 If a package wants to install a job that has to be executed
6489 via cron, it should place a file with the name of the
6490 package in one or more of the following directories:
6491 <example compact="compact">
6497 As these directory names imply, the files within them are
6498 executed on an hourly, daily, weekly, or monthly basis,
6499 respectively. The exact times are listed in
6500 <file>/etc/crontab</file>.</p>
6503 All files installed in any of these directories must be
6504 scripts (e.g., shell scripts or Perl scripts) so that they
6505 can easily be modified by the local system administrator.
6506 In addition, they must be treated as configuration files.
6510 If a certain job has to be executed at some other frequency or
6511 at a specific time, the package should install a file
6512 <file>/etc/cron.d/<var>package</var></file>. This file uses the
6513 same syntax as <file>/etc/crontab</file> and is processed by
6514 <prgn>cron</prgn> automatically. The file must also be
6515 treated as a configuration file. (Note that entries in the
6516 <file>/etc/cron.d</file> directory are not handled by
6517 <prgn>anacron</prgn>. Thus, you should only use this
6518 directory for jobs which may be skipped if the system is not
6522 The scripts or crontab entries in these directories should
6523 check if all necessary programs are installed before they
6524 try to execute them. Otherwise, problems will arise when a
6525 package was removed but not purged since configuration files
6526 are kept on the system in this situation.</p>
6530 <heading>Menus</heading>
6533 The Debian <tt>menu</tt> package provides a standard
6534 interface between packages providing applications and
6535 <em>menu programs</em> (either X window managers or
6536 text-based menu programs such as <prgn>pdmenu</prgn>).
6540 All packages that provide applications that need not be
6541 passed any special command line arguments for normal
6542 operation should register a menu entry for those
6543 applications, so that users of the <tt>menu</tt> package
6544 will automatically get menu entries in their window
6545 managers, as well in shells like <tt>pdmenu</tt>.
6549 Menu entries should follow the current menu policy.
6553 The menu policy can be found in the <tt>menu-policy</tt>
6554 files in the <tt>debian-policy</tt> package.
6555 It is also available from the Debian web mirrors at
6556 <tt><url name="/doc/packaging-manuals/menu-policy/"
6557 id="http://www.debian.org/doc/packaging-manuals/menu-policy/"></tt>.
6561 Please also refer to the <em>Debian Menu System</em>
6562 documentation that comes with the <package>menu</package>
6563 package for information about how to register your
6569 <heading>Multimedia handlers</heading>
6572 MIME (Multipurpose Internet Mail Extensions, RFCs 2045-2049)
6573 is a mechanism for encoding files and data streams and
6574 providing meta-information about them, in particular their
6575 type (e.g. audio or video) and format (e.g. PNG, HTML,
6580 Registration of MIME type handlers allows programs like mail
6581 user agents and web browsers to invoke these handlers to
6582 view, edit or display MIME types they don't support directly.
6586 Packages which provide the ability to view/show/play,
6587 compose, edit or print MIME types should register themselves
6588 as such following the current MIME support policy.
6592 The MIME support policy can be found in the <tt>mime-policy</tt>
6593 files in the <tt>debian-policy</tt> package.
6594 It is also available from the Debian web mirrors at
6595 <tt><url name="/doc/packaging-manuals/mime-policy/"
6596 id="http://www.debian.org/doc/packaging-manuals/mime-policy/"></tt>.
6602 <heading>Keyboard configuration</heading>
6605 To achieve a consistent keyboard configuration so that all
6606 applications interpret a keyboard event the same way, all
6607 programs in the Debian distribution must be configured to
6608 comply with the following guidelines.
6612 The following keys must have the specified interpretations:
6615 <tag><tt><--</tt></tag>
6616 <item>delete the character to the left of the cursor</item>
6618 <tag><tt>Delete</tt></tag>
6619 <item>delete the character to the right of the cursor</item>
6621 <tag><tt>Control+H</tt></tag>
6622 <item>emacs: the help prefix</item>
6625 The interpretation of any keyboard events should be
6626 independent of the terminal that is used, be it a virtual
6627 console, an X terminal emulator, an rlogin/telnet session,
6632 The following list explains how the different programs
6633 should be set up to achieve this:
6639 <tt><--</tt> generates <tt>KB_BackSpace</tt> in X.
6643 <tt>Delete</tt> generates <tt>KB_Delete</tt> in X.
6647 X translations are set up to make
6648 <tt>KB_Backspace</tt> generate ASCII DEL, and to make
6649 <tt>KB_Delete</tt> generate <tt>ESC [ 3 ~</tt> (this
6650 is the vt220 escape code for the "delete character"
6651 key). This must be done by loading the X resources
6652 using <prgn>xrdb</prgn> on all local X displays, not
6653 using the application defaults, so that the
6654 translation resources used correspond to the
6655 <prgn>xmodmap</prgn> settings.
6659 The Linux console is configured to make
6660 <tt><--</tt> generate DEL, and <tt>Delete</tt>
6661 generate <tt>ESC [ 3 ~</tt>.
6665 X applications are configured so that <tt><</tt>
6666 deletes left, and <tt>Delete</tt> deletes right. Motif
6667 applications already work like this.
6671 Terminals should have <tt>stty erase ^?</tt> .
6675 The <tt>xterm</tt> terminfo entry should have <tt>ESC
6676 [ 3 ~</tt> for <tt>kdch1</tt>, just as for
6677 <tt>TERM=linux</tt> and <tt>TERM=vt220</tt>.
6681 Emacs is programmed to map <tt>KB_Backspace</tt> or
6682 the <tt>stty erase</tt> character to
6683 <tt>delete-backward-char</tt>, and <tt>KB_Delete</tt>
6684 or <tt>kdch1</tt> to <tt>delete-forward-char</tt>, and
6685 <tt>^H</tt> to <tt>help</tt> as always.
6689 Other applications use the <tt>stty erase</tt>
6690 character and <tt>kdch1</tt> for the two delete keys,
6691 with ASCII DEL being "delete previous character" and
6692 <tt>kdch1</tt> being "delete character under
6700 This will solve the problem except for the following
6707 Some terminals have a <tt><--</tt> key that cannot
6708 be made to produce anything except <tt>^H</tt>. On
6709 these terminals Emacs help will be unavailable on
6710 <tt>^H</tt> (assuming that the <tt>stty erase</tt>
6711 character takes precedence in Emacs, and has been set
6712 correctly). <tt>M-x help</tt> or <tt>F1</tt> (if
6713 available) can be used instead.
6717 Some operating systems use <tt>^H</tt> for <tt>stty
6718 erase</tt>. However, modern telnet versions and all
6719 rlogin versions propagate <tt>stty</tt> settings, and
6720 almost all UNIX versions honour <tt>stty erase</tt>.
6721 Where the <tt>stty</tt> settings are not propagated
6722 correctly, things can be made to work by using
6723 <tt>stty</tt> manually.
6727 Some systems (including previous Debian versions) use
6728 <prgn>xmodmap</prgn> to arrange for both
6729 <tt><--</tt> and <tt>Delete</tt> to generate
6730 <tt>KB_Delete</tt>. We can change the behavior of
6731 their X clients using the same X resources that we use
6732 to do it for our own clients, or configure our clients
6733 using their resources when things are the other way
6734 around. On displays configured like this
6735 <tt>Delete</tt> will not work, but <tt><--</tt>
6740 Some operating systems have different <tt>kdch1</tt>
6741 settings in their <tt>terminfo</tt> database for
6742 <tt>xterm</tt> and others. On these systems the
6743 <tt>Delete</tt> key will not work correctly when you
6744 log in from a system conforming to our policy, but
6745 <tt><--</tt> will.
6752 <heading>Environment variables</heading>
6755 A program must not depend on environment variables to get
6756 reasonable defaults. (That's because these environment
6757 variables would have to be set in a system-wide
6758 configuration file like <file>/etc/profile</file>, which is not
6759 supported by all shells.)
6763 If a program usually depends on environment variables for its
6764 configuration, the program should be changed to fall back to
6765 a reasonable default configuration if these environment
6766 variables are not present. If this cannot be done easily
6767 (e.g., if the source code of a non-free program is not
6768 available), the program must be replaced by a small
6769 "wrapper" shell script which sets the environment variables
6770 if they are not already defined, and calls the original program.
6774 Here is an example of a wrapper script for this purpose:
6776 <example compact="compact">
6778 BAR=${BAR:-/var/lib/fubar}
6780 exec /usr/lib/foo/foo "$@"
6785 Furthermore, as <file>/etc/profile</file> is a configuration
6786 file of the <prgn>base-files</prgn> package, other packages must
6787 not put any environment variables or other commands into that
6792 <sect id="doc-base">
6793 <heading>Registering Documents using doc-base</heading>
6796 The <package>doc-base</package> package implements a
6797 flexible mechanism for handling and presenting
6798 documentation. The recommended practice is for every Debian
6799 package that provides online documentation (other than just
6800 manual pages) to register these documents with
6801 <package>doc-base</package> by installing a
6802 <package>doc-base</package> control file via the
6803 <prgn/install-docs/ script at installation time and
6804 de-register the manuals again when the package is removed.
6807 Please refer to the documentation that comes with the
6808 <package>doc-base</package> package for information and
6817 <heading>Files</heading>
6820 <heading>Binaries</heading>
6823 Two different packages must not install programs with
6824 different functionality but with the same filenames. (The
6825 case of two programs having the same functionality but
6826 different implementations is handled via "alternatives" or
6827 the "Conflicts" mechanism. See <ref id="maintscripts"> and
6828 <ref id="conflicts"> respectively.) If this case happens,
6829 one of the programs must be renamed. The maintainers should
6830 report this to the <tt>debian-devel</tt> mailing list and
6831 try to find a consensus about which program will have to be
6832 renamed. If a consensus cannot be reached, <em>both</em>
6833 programs must be renamed.
6837 By default, when a package is being built, any binaries
6838 created should include debugging information, as well as
6839 being compiled with optimization. You should also turn on
6840 as many reasonable compilation warnings as possible; this
6841 makes life easier for porters, who can then look at build
6842 logs for possible problems. For the C programming language,
6843 this means the following compilation parameters should be
6845 <example compact="compact">
6847 CFLAGS = -O2 -g -Wall # sane warning options vary between programs
6849 INSTALL = install -s # (or use strip on the files in debian/tmp)
6854 Note that by default all installed binaries should be stripped,
6855 either by using the <tt>-s</tt> flag to
6856 <prgn>install</prgn>, or by calling <prgn>strip</prgn> on
6857 the binaries after they have been copied into
6858 <file>debian/tmp</file> but before the tree is made into a
6863 Although binaries in the build tree should be compiled with
6864 debugging information by default, it can often be difficult to
6865 debug programs if they are also subjected to compiler
6866 optimization. For this reason, it is recommended to support the
6867 standardized environment variable <tt>DEB_BUILD_OPTIONS</tt>
6868 (see <ref id="debianrules-options">). This variable can contain
6869 several flags to change how a package is compiled and built.
6873 It is up to the package maintainer to decide what
6874 compilation options are best for the package. Certain
6875 binaries (such as computationally-intensive programs) will
6876 function better with certain flags (<tt>-O3</tt>, for
6877 example); feel free to use them. Please use good judgment
6878 here. Don't use flags for the sake of it; only use them
6879 if there is good reason to do so. Feel free to override
6880 the upstream author's ideas about which compilation
6881 options are best: they are often inappropriate for our
6887 <sect id="libraries">
6888 <heading>Libraries</heading>
6891 If the package is <strong>architecture: any</strong>, then
6892 the shared library compilation and linking flags must have
6893 <tt>-fPIC</tt>, or the package shall not build on some of
6894 the supported architectures<footnote>
6896 If you are using GCC, <tt>-fPIC</tt> produces code with
6897 relocatable position independent code, which is required for
6898 most architectures to create a shared library, with i386 and
6899 perhaps some others where non position independent code is
6900 permitted in a shared library.
6903 Position independent code may have a performance penalty,
6904 especially on <tt>i386</tt>. However, in most cases the
6905 speed penalty must be measured against the memory wasted on
6906 the few architectures where non position independent code is
6909 </footnote>. Any exception to this rule must be discussed on
6910 the mailing list <em>debian-devel@lists.debian.org</em>, and
6911 a rough consensus obtained. The reasons for not compiling
6912 with <tt>-fPIC</tt> flag must be recorded in the file
6913 <tt>README.Debian</tt>, and care must be taken to either
6914 restrict the architecture or arrange for <tt>-fPIC</tt> to
6915 be used on architectures where it is required.<footnote>
6917 Some of the reasons why this might be required is if the
6918 library contains hand crafted assembly code that is not
6919 relocatable, the speed penalty is excessive for compute
6920 intensive libs, and similar reasons.
6925 As to the static libraries, the common case is not to have
6926 relocatable code, since there is no benefit, unless in specific
6927 cases; therefore the static version must not be compiled
6928 with the <tt>-fPIC</tt> flag. Any exception to this rule
6929 should be discussed on the mailing list
6930 <em>debian-devel@lists.debian.org</em>, and the reasons for
6931 compiling with the <tt>-fPIC</tt> flag must be recorded in
6932 the file <tt>README.Debian</tt>. <footnote>
6934 Some of the reasons for linking static libraries with
6935 the <tt>-fPIC</tt> flag are if, for example, one needs a
6936 Perl API for a library that is under rapid development,
6937 and has an unstable API, so shared libraries are
6938 pointless at this phase of the library's development. In
6939 that case, since Perl needs a library with relocatable
6940 code, it may make sense to create a static library with
6941 relocatable code. Another reason cited is if you are
6942 distilling various libraries into a common shared
6943 library, like <tt>mklibs</tt> does in the Debian
6949 In other words, if both a shared and a static library is
6950 being built, each source unit (<tt>*.c</tt>, for example,
6951 for C files) will need to be compiled twice, for the normal
6955 You must specify the gcc option <tt>-D_REENTRANT</tt>
6956 when building a library (either static or shared) to make
6957 the library compatible with LinuxThreads.
6961 Although not enforced by the build tools, shared libraries
6962 must be linked against all libraries that they use symbols from
6963 in the same way that binaries are. This ensures the correct
6964 functioning of the <qref id="sharedlibs-shlibdeps">shlibs</qref>
6965 system and guarantees that all libraries can be safely opened
6966 with <tt>dlopen()</tt>. Packagers may wish to use the gcc
6967 option <tt>-Wl,-z,defs</tt> when building a shared library.
6968 Since this option enforces symbol resolution at build time,
6969 a missing library reference will be caught early as a fatal
6974 All installed shared libraries should be stripped with
6975 <example compact="compact">
6976 strip --strip-unneeded <var>your-lib</var>
6978 (The option <tt>--strip-unneeded</tt> makes
6979 <prgn>strip</prgn> remove only the symbols which aren't
6980 needed for relocation processing.) Shared libraries can
6981 function perfectly well when stripped, since the symbols for
6982 dynamic linking are in a separate part of the ELF object
6984 You might also want to use the options
6985 <tt>--remove-section=.comment</tt> and
6986 <tt>--remove-section=.note</tt> on both shared libraries
6987 and executables, and <tt>--strip-debug</tt> on static
6993 Note that under some circumstances it may be useful to
6994 install a shared library unstripped, for example when
6995 building a separate package to support debugging.
6999 Shared object files (often <file>.so</file> files) that are not
7000 public libraries, that is, they are not meant to be linked
7001 to by third party executables (binaries of other packages),
7002 should be installed in subdirectories of the
7003 <file>/usr/lib</file> directory. Such files are exempt from the
7004 rules that govern ordinary shared libraries, except that
7005 they must not be installed executable and should be
7007 A common example are the so-called "plug-ins",
7008 internal shared objects that are dynamically loaded by
7009 programs using <manref name="dlopen" section="3">.
7014 Packages containing shared libraries that may be linked to
7015 by other packages' binaries, but which for some
7016 <em>compelling</em> reason can not be installed in
7017 <file>/usr/lib</file> directory, may install the shared library
7018 files in subdirectories of the <file>/usr/lib</file> directory,
7019 in which case they should arrange to add that directory in
7020 <file>/etc/ld.so.conf</file> in the package's post-installation
7021 script, and remove it in the package's post-removal script.
7025 An ever increasing number of packages are using
7026 <prgn>libtool</prgn> to do their linking. The latest GNU
7027 libtools (>= 1.3a) can take advantage of the metadata in the
7028 installed <prgn>libtool</prgn> archive files (<file>*.la</file>
7029 files). The main advantage of <prgn>libtool</prgn>'s
7030 <file>.la</file> files is that it allows <prgn>libtool</prgn> to
7031 store and subsequently access metadata with respect to the
7032 libraries it builds. <prgn>libtool</prgn> will search for
7033 those files, which contain a lot of useful information about
7034 a library (such as library dependency information for static
7035 linking). Also, they're <em>essential</em> for programs
7036 using <tt>libltdl</tt>.<footnote>
7037 Although <prgn>libtool</prgn> is fully capable of
7038 linking against shared libraries which don't have
7039 <tt>.la</tt> files, as it is a mere shell script it can
7040 add considerably to the build time of a
7041 <prgn>libtool</prgn>-using package if that shell script
7042 has to derive all this information from first principles
7043 for each library every time it is linked. With the
7044 advent of <prgn>libtool</prgn> version 1.4 (and to a
7045 lesser extent <prgn>libtool</prgn> version 1.3), the
7046 <file>.la</file> files also store information about
7047 inter-library dependencies which cannot necessarily be
7048 derived after the <file>.la</file> file is deleted.
7053 Packages that use <prgn>libtool</prgn> to create shared
7054 libraries should include the <file>.la</file> files in the
7055 <tt>-dev</tt> package, unless the package relies on
7056 <tt>libtool</tt>'s <tt>libltdl</tt> library, in which case
7057 the <tt>.la</tt> files must go in the run-time library
7062 You must make sure that you use only released versions of
7063 shared libraries to build your packages; otherwise other
7064 users will not be able to run your binaries
7065 properly. Producing source packages that depend on
7066 unreleased compilers is also usually a bad
7073 <heading>Shared libraries</heading>
7075 This section has moved to <ref id="sharedlibs">.
7081 <heading>Scripts</heading>
7084 All command scripts, including the package maintainer
7085 scripts inside the package and used by <prgn>dpkg</prgn>,
7086 should have a <tt>#!</tt> line naming the shell to be used
7091 In the case of Perl scripts this should be
7092 <tt>#!/usr/bin/perl</tt>.
7096 When scripts are installed into a directory in the system
7097 PATH, the script name should not include an extension such
7098 as <tt>.sh</tt> or <tt>.pl</tt> that denotes the scripting
7099 language currently used to implement it.
7102 Shell scripts (<prgn>sh</prgn> and <prgn>bash</prgn>)
7103 should almost certainly start with <tt>set -e</tt> so that
7104 errors are detected. Every script should use
7105 <tt>set -e</tt> or check the exit status of <em>every</em>
7110 Scripts may assume that <file>/bin/sh</file> implements the
7111 SUSv3 Shell Command Language<footnote>
7112 Single UNIX Specification, version 3, which is also IEEE
7113 1003.1-2004 (POSIX), and is available on the World Wide Web
7114 from <url id="http://www.unix.org/version3/online.html"
7115 name="The Open Group"> after free
7116 registration.</footnote>
7117 plus the following additional features not mandated by
7119 These features are in widespread use in the Linux community
7120 and are implemented in all of bash, dash, and ksh, the most
7121 common shells users may wish to use as <file>/bin/sh</file>.
7124 <item><tt>echo -n</tt>, if implemented as a shell built-in,
7125 must not generate a newline.</item>
7126 <item><tt>test</tt>, if implemented as a shell built-in, must
7127 support <tt>-a</tt> and <tt>-o</tt> as binary logical
7129 <item><tt>local</tt> to create a scoped variable must be
7130 supported, including listing multiple variables in a single
7131 local command and assigning a value to a variable at the
7132 same time as localizing it. <tt>local</tt> may or
7133 may not preserve the variable value from an outer scope if
7134 no assignment is present. Uses such as:
7138 # ... use a, b, c, d ...
7141 must be supported and must set the value of <tt>c</tt> to
7145 If a shell script requires non-SUSv3 features from the shell
7146 interpreter other than those listed above, the appropriate shell
7147 must be specified in the first line of the script (e.g.,
7148 <tt>#!/bin/bash</tt>) and the package must depend on the package
7149 providing the shell (unless the shell package is marked
7150 "Essential", as in the case of <prgn>bash</prgn>).
7154 You may wish to restrict your script to SUSv3 features plus the
7155 above set when possible so that it may use <file>/bin/sh</file>
7156 as its interpreter. If your script works with <prgn>dash</prgn>
7157 (originally called <prgn>ash</prgn>), it probably complies with
7158 the above requirements, but if you are in doubt, use
7159 <file>/bin/bash</file>.
7163 Perl scripts should check for errors when making any
7164 system calls, including <tt>open</tt>, <tt>print</tt>,
7165 <tt>close</tt>, <tt>rename</tt> and <tt>system</tt>.
7169 <prgn>csh</prgn> and <prgn>tcsh</prgn> should be avoided as
7170 scripting languages. See <em>Csh Programming Considered
7171 Harmful</em>, one of the <tt>comp.unix.*</tt> FAQs, which
7172 can be found at <url id="http://www.faqs.org/faqs/unix-faq/shell/csh-whynot/">.
7173 If an upstream package comes with <prgn>csh</prgn> scripts
7174 then you must make sure that they start with
7175 <tt>#!/bin/csh</tt> and make your package depend on the
7176 <prgn>c-shell</prgn> virtual package.
7180 Any scripts which create files in world-writeable
7181 directories (e.g., in <file>/tmp</file>) must use a
7182 mechanism which will fail atomically if a file with the same
7183 name already exists.
7187 The Debian base system provides the <prgn>tempfile</prgn>
7188 and <prgn>mktemp</prgn> utilities for use by scripts for
7195 <heading>Symbolic links</heading>
7198 In general, symbolic links within a top-level directory
7199 should be relative, and symbolic links pointing from one
7200 top-level directory into another should be absolute. (A
7201 top-level directory is a sub-directory of the root
7202 directory <file>/</file>.)
7206 In addition, symbolic links should be specified as short as
7207 possible, i.e., link targets like <file>foo/../bar</file> are
7212 Note that when creating a relative link using
7213 <prgn>ln</prgn> it is not necessary for the target of the
7214 link to exist relative to the working directory you're
7215 running <prgn>ln</prgn> from, nor is it necessary to change
7216 directory to the directory where the link is to be made.
7217 Simply include the string that should appear as the target
7218 of the link (this will be a pathname relative to the
7219 directory in which the link resides) as the first argument
7224 For example, in your <prgn>Makefile</prgn> or
7225 <file>debian/rules</file>, you can do things like:
7226 <example compact="compact">
7227 ln -fs gcc $(prefix)/bin/cc
7228 ln -fs gcc debian/tmp/usr/bin/cc
7229 ln -fs ../sbin/sendmail $(prefix)/bin/runq
7230 ln -fs ../sbin/sendmail debian/tmp/usr/bin/runq
7235 A symbolic link pointing to a compressed file should always
7236 have the same file extension as the referenced file. (For
7237 example, if a file <file>foo.gz</file> is referenced by a
7238 symbolic link, the filename of the link has to end with
7239 "<file>.gz</file>" too, as in <file>bar.gz</file>.)
7244 <heading>Device files</heading>
7247 Packages must not include device files in the package file
7252 If a package needs any special device files that are not
7253 included in the base system, it must call
7254 <prgn>MAKEDEV</prgn> in the <prgn>postinst</prgn> script,
7255 after notifying the user<footnote>
7256 This notification could be done via a (low-priority)
7257 debconf message, or an echo (printf) statement.
7262 Packages must not remove any device files in the
7263 <prgn>postrm</prgn> or any other script. This is left to the
7264 system administrator.
7268 Debian uses the serial devices
7269 <file>/dev/ttyS*</file>. Programs using the old
7270 <file>/dev/cu*</file> devices should be changed to use
7271 <file>/dev/ttyS*</file>.
7275 <sect id="config-files">
7276 <heading>Configuration files</heading>
7279 <heading>Definitions</heading>
7283 <tag>configuration file</tag>
7285 A file that affects the operation of a program, or
7286 provides site- or host-specific information, or
7287 otherwise customizes the behavior of a program.
7288 Typically, configuration files are intended to be
7289 modified by the system administrator (if needed or
7290 desired) to conform to local policy or to provide
7291 more useful site-specific behavior.
7294 <tag><tt>conffile</tt></tag>
7296 A file listed in a package's <tt>conffiles</tt>
7297 file, and is treated specially by <prgn>dpkg</prgn>
7298 (see <ref id="configdetails">).
7304 The distinction between these two is important; they are
7305 not interchangeable concepts. Almost all
7306 <tt>conffile</tt>s are configuration files, but many
7307 configuration files are not <tt>conffiles</tt>.
7311 As noted elsewhere, <file>/etc/init.d</file> scripts,
7312 <file>/etc/default</file> files, scripts installed in
7313 <file>/etc/cron.{hourly,daily,weekly,monthly}</file>, and cron
7314 configuration installed in <file>/etc/cron.d</file> must be
7315 treated as configuration files. In general, any script that
7316 embeds configuration information is de-facto a configuration
7317 file and should be treated as such.
7322 <heading>Location</heading>
7325 Any configuration files created or used by your package
7326 must reside in <file>/etc</file>. If there are several,
7327 consider creating a subdirectory of <file>/etc</file>
7328 named after your package.
7332 If your package creates or uses configuration files
7333 outside of <file>/etc</file>, and it is not feasible to modify
7334 the package to use <file>/etc</file> directly, put the files
7335 in <file>/etc</file> and create symbolic links to those files
7336 from the location that the package requires.
7341 <heading>Behavior</heading>
7344 Configuration file handling must conform to the following
7346 <list compact="compact">
7348 local changes must be preserved during a package
7352 configuration files must be preserved when the
7353 package is removed, and only deleted when the
7360 The easy way to achieve this behavior is to make the
7361 configuration file a <tt>conffile</tt>. This is
7362 appropriate only if it is possible to distribute a default
7363 version that will work for most installations, although
7364 some system administrators may choose to modify it. This
7365 implies that the default version will be part of the
7366 package distribution, and must not be modified by the
7367 maintainer scripts during installation (or at any other
7372 In order to ensure that local changes are preserved
7373 correctly, no package may contain or make hard links to
7374 conffiles.<footnote>
7375 Rationale: There are two problems with hard links.
7376 The first is that some editors break the link while
7377 editing one of the files, so that the two files may
7378 unwittingly become unlinked and different. The second
7379 is that <prgn>dpkg</prgn> might break the hard link
7380 while upgrading <tt>conffile</tt>s.
7385 The other way to do it is via the maintainer scripts. In
7386 this case, the configuration file must not be listed as a
7387 <tt>conffile</tt> and must not be part of the package
7388 distribution. If the existence of a file is required for
7389 the package to be sensibly configured it is the
7390 responsibility of the package maintainer to provide
7391 maintainer scripts which correctly create, update and
7392 maintain the file and remove it on purge. (See <ref
7393 id="maintainerscripts"> for more information.) These
7394 scripts must be idempotent (i.e., must work correctly if
7395 <prgn>dpkg</prgn> needs to re-run them due to errors
7396 during installation or removal), must cope with all the
7397 variety of ways <prgn>dpkg</prgn> can call maintainer
7398 scripts, must not overwrite or otherwise mangle the user's
7399 configuration without asking, must not ask unnecessary
7400 questions (particularly during upgrades), and must
7401 otherwise be good citizens.
7405 The scripts are not required to configure every possible
7406 option for the package, but only those necessary to get
7407 the package running on a given system. Ideally the
7408 sysadmin should not have to do any configuration other
7409 than that done (semi-)automatically by the
7410 <prgn>postinst</prgn> script.
7414 A common practice is to create a script called
7415 <file><var>package</var>-configure</file> and have the
7416 package's <prgn>postinst</prgn> call it if and only if the
7417 configuration file does not already exist. In certain
7418 cases it is useful for there to be an example or template
7419 file which the maintainer scripts use. Such files should
7420 be in <file>/usr/share/<var>package</var></file> or
7421 <file>/usr/lib/<var>package</var></file> (depending on whether
7422 they are architecture-independent or not). There should
7423 be symbolic links to them from
7424 <file>/usr/share/doc/<var>package</var>/examples</file> if
7425 they are examples, and should be perfectly ordinary
7426 <prgn>dpkg</prgn>-handled files (<em>not</em>
7427 configuration files).
7431 These two styles of configuration file handling must
7432 not be mixed, for that way lies madness:
7433 <prgn>dpkg</prgn> will ask about overwriting the file
7434 every time the package is upgraded.
7439 <heading>Sharing configuration files</heading>
7442 Packages which specify the same file as a
7443 <tt>conffile</tt> must be tagged as <em>conflicting</em>
7444 with each other. (This is an instance of the general rule
7445 about not sharing files. Note that neither alternatives
7446 nor diversions are likely to be appropriate in this case;
7447 in particular, <prgn>dpkg</prgn> does not handle diverted
7448 <tt>conffile</tt>s well.)
7452 The maintainer scripts must not alter a <tt>conffile</tt>
7453 of <em>any</em> package, including the one the scripts
7458 If two or more packages use the same configuration file
7459 and it is reasonable for both to be installed at the same
7460 time, one of these packages must be defined as
7461 <em>owner</em> of the configuration file, i.e., it will be
7462 the package which handles that file as a configuration
7463 file. Other packages that use the configuration file must
7464 depend on the owning package if they require the
7465 configuration file to operate. If the other package will
7466 use the configuration file if present, but is capable of
7467 operating without it, no dependency need be declared.
7471 If it is desirable for two or more related packages to
7472 share a configuration file <em>and</em> for all of the
7473 related packages to be able to modify that configuration
7474 file, then the following should be done:
7475 <enumlist compact="compact">
7477 One of the related packages (the "owning" package)
7478 will manage the configuration file with maintainer
7479 scripts as described in the previous section.
7482 The owning package should also provide a program
7483 that the other packages may use to modify the
7487 The related packages must use the provided program
7488 to make any desired modifications to the
7489 configuration file. They should either depend on
7490 the core package to guarantee that the configuration
7491 modifier program is available or accept gracefully
7492 that they cannot modify the configuration file if it
7493 is not. (This is in addition to the fact that the
7494 configuration file may not even be present in the
7501 Sometimes it's appropriate to create a new package which
7502 provides the basic infrastructure for the other packages
7503 and which manages the shared configuration files. (The
7504 <tt>sgml-base</tt> package is a good example.)
7509 <heading>User configuration files ("dotfiles")</heading>
7512 The files in <file>/etc/skel</file> will automatically be
7513 copied into new user accounts by <prgn>adduser</prgn>.
7514 No other program should reference the files in
7515 <file>/etc/skel</file>.
7519 Therefore, if a program needs a dotfile to exist in
7520 advance in <file>$HOME</file> to work sensibly, that dotfile
7521 should be installed in <file>/etc/skel</file> and treated as a
7526 However, programs that require dotfiles in order to
7527 operate sensibly are a bad thing, unless they do create
7528 the dotfiles themselves automatically.
7532 Furthermore, programs should be configured by the Debian
7533 default installation to behave as closely to the upstream
7534 default behavior as possible.
7538 Therefore, if a program in a Debian package needs to be
7539 configured in some way in order to operate sensibly, that
7540 should be done using a site-wide configuration file placed
7541 in <file>/etc</file>. Only if the program doesn't support a
7542 site-wide default configuration and the package maintainer
7543 doesn't have time to add it may a default per-user file be
7544 placed in <file>/etc/skel</file>.
7548 <file>/etc/skel</file> should be as empty as we can make it.
7549 This is particularly true because there is no easy (or
7550 necessarily desirable) mechanism for ensuring that the
7551 appropriate dotfiles are copied into the accounts of
7552 existing users when a package is installed.
7558 <heading>Log files</heading>
7560 Log files should usually be named
7561 <file>/var/log/<var>package</var>.log</file>. If you have many
7562 log files, or need a separate directory for permission
7563 reasons (<file>/var/log</file> is writable only by
7564 <file>root</file>), you should usually create a directory named
7565 <file>/var/log/<var>package</var></file> and place your log
7570 Log files must be rotated occasionally so that they don't
7571 grow indefinitely; the best way to do this is to drop a log
7572 rotation configuration file into the directory
7573 <file>/etc/logrotate.d</file> and use the facilities provided by
7574 logrotate.<footnote>
7576 The traditional approach to log files has been to set up
7577 <em>ad hoc</em> log rotation schemes using simple shell
7578 scripts and cron. While this approach is highly
7579 customizable, it requires quite a lot of sysadmin work.
7580 Even though the original Debian system helped a little
7581 by automatically installing a system which can be used
7582 as a template, this was deemed not enough.
7586 The use of <prgn>logrotate</prgn>, a program developed
7587 by Red Hat, is better, as it centralizes log management.
7588 It has both a configuration file
7589 (<file>/etc/logrotate.conf</file>) and a directory where
7590 packages can drop their individual log rotation
7591 configurations (<file>/etc/logrotate.d</file>).
7594 Here is a good example for a logrotate config
7595 file (for more information see <manref name="logrotate"
7597 <example compact="compact">
7598 /var/log/foo/*.log {
7603 /etc/init.d/foo force-reload
7607 This rotates all files under <file>/var/log/foo</file>, saves 12
7608 compressed generations, and forces the daemon to reload its
7609 configuration information after the log rotation.
7613 Log files should be removed when the package is
7614 purged (but not when it is only removed). This should be
7615 done by the <prgn>postrm</prgn> script when it is called
7616 with the argument <tt>purge</tt> (see <ref
7617 id="removedetails">).
7622 <heading>Permissions and owners</heading>
7625 The rules in this section are guidelines for general use.
7626 If necessary you may deviate from the details below.
7627 However, if you do so you must make sure that what is done
7628 is secure and you should try to be as consistent as possible
7629 with the rest of the system. You should probably also
7630 discuss it on <prgn>debian-devel</prgn> first.
7634 Files should be owned by <tt>root:root</tt>, and made
7635 writable only by the owner and universally readable (and
7636 executable, if appropriate), that is mode 644 or 755.
7640 Directories should be mode 755 or (for group-writability)
7641 mode 2775. The ownership of the directory should be
7642 consistent with its mode: if a directory is mode 2775, it
7643 should be owned by the group that needs write access to
7646 When a package is upgraded, and the owner or permissions
7647 of a file included in the package has changed, dpkg
7648 arranges for the ownership and permissions to be
7649 correctly set upon installation. However, this does not
7650 extend to directories; the permissions and ownership of
7651 directories already on the system does not change on
7652 install or upgrade of packages. This makes sense, since
7653 otherwise common directories like <tt>/usr</tt> would
7654 always be in flux. To correctly change permissions of a
7655 directory the package owns, explicit action is required,
7656 usually in the <tt>postinst</tt> script. Care must be
7657 taken to handle downgrades as well, in that case.
7664 Setuid and setgid executables should be mode 4755 or 2755
7665 respectively, and owned by the appropriate user or group.
7666 They should not be made unreadable (modes like 4711 or
7667 2711 or even 4111); doing so achieves no extra security,
7668 because anyone can find the binary in the freely available
7669 Debian package; it is merely inconvenient. For the same
7670 reason you should not restrict read or execute permissions
7671 on non-set-id executables.
7675 Some setuid programs need to be restricted to particular
7676 sets of users, using file permissions. In this case they
7677 should be owned by the uid to which they are set-id, and by
7678 the group which should be allowed to execute them. They
7679 should have mode 4754; again there is no point in making
7680 them unreadable to those users who must not be allowed to
7685 It is possible to arrange that the system administrator can
7686 reconfigure the package to correspond to their local
7687 security policy by changing the permissions on a binary:
7688 they can do this by using <prgn>dpkg-statoverride</prgn>, as
7689 described below.<footnote>
7690 Ordinary files installed by <prgn>dpkg</prgn> (as
7691 opposed to <tt>conffile</tt>s and other similar objects)
7692 normally have their permissions reset to the distributed
7693 permissions when the package is reinstalled. However,
7694 the use of <prgn>dpkg-statoverride</prgn> overrides this
7695 default behavior. If you use this method, you should
7696 remember to describe <prgn>dpkg-statoverride</prgn> in
7697 the package documentation; being a relatively new
7698 addition to Debian, it is probably not yet well-known.
7700 Another method you should consider is to create a group for
7701 people allowed to use the program(s) and make any setuid
7702 executables executable only by that group.
7706 If you need to create a new user or group for your package
7707 there are two possibilities. Firstly, you may need to
7708 make some files in the binary package be owned by this
7709 user or group, or you may need to compile the user or
7710 group id (rather than just the name) into the binary
7711 (though this latter should be avoided if possible, as in
7712 this case you need a statically allocated id).</p>
7715 If you need a statically allocated id, you must ask for a
7716 user or group id from the <tt>base-passwd</tt> maintainer,
7717 and must not release the package until you have been
7718 allocated one. Once you have been allocated one you must
7719 either make the package depend on a version of the
7720 <tt>base-passwd</tt> package with the id present in
7721 <file>/etc/passwd</file> or <file>/etc/group</file>, or arrange for
7722 your package to create the user or group itself with the
7723 correct id (using <tt>adduser</tt>) in its
7724 <prgn>preinst</prgn> or <prgn>postinst</prgn>. (Doing it in
7725 the <prgn>postinst</prgn> is to be preferred if it is
7726 possible, otherwise a pre-dependency will be needed on the
7727 <tt>adduser</tt> package.)
7731 On the other hand, the program might be able to determine
7732 the uid or gid from the user or group name at runtime, so
7733 that a dynamically allocated id can be used. In this case
7734 you should choose an appropriate user or group name,
7735 discussing this on <prgn>debian-devel</prgn> and checking
7736 with the <package/base-passwd/ maintainer that it is unique and that
7737 they do not wish you to use a statically allocated id
7738 instead. When this has been checked you must arrange for
7739 your package to create the user or group if necessary using
7740 <prgn>adduser</prgn> in the <prgn>preinst</prgn> or
7741 <prgn>postinst</prgn> script (again, the latter is to be
7742 preferred if it is possible).
7746 Note that changing the numeric value of an id associated
7747 with a name is very difficult, and involves searching the
7748 file system for all appropriate files. You need to think
7749 carefully whether a static or dynamic id is required, since
7750 changing your mind later will cause problems.
7753 <sect1><heading>The use of <prgn>dpkg-statoverride</prgn></heading>
7755 This section is not intended as policy, but as a
7756 description of the use of <prgn>dpkg-statoverride</prgn>.
7760 If a system administrator wishes to have a file (or
7761 directory or other such thing) installed with owner and
7762 permissions different from those in the distributed Debian
7763 package, they can use the <prgn>dpkg-statoverride</prgn>
7764 program to instruct <prgn>dpkg</prgn> to use the different
7765 settings every time the file is installed. Thus the
7766 package maintainer should distribute the files with their
7767 normal permissions, and leave it for the system
7768 administrator to make any desired changes. For example, a
7769 daemon which is normally required to be setuid root, but
7770 in certain situations could be used without being setuid,
7771 should be installed setuid in the <tt>.deb</tt>. Then the
7772 local system administrator can change this if they wish.
7773 If there are two standard ways of doing it, the package
7774 maintainer can use <tt>debconf</tt> to find out the
7775 preference, and call <prgn>dpkg-statoverride</prgn> in the
7776 maintainer script if necessary to accommodate the system
7777 administrator's choice. Care must be taken during
7778 upgrades to not override an existing setting.
7782 Given the above, <prgn>dpkg-statoverride</prgn> is
7783 essentially a tool for system administrators and would not
7784 normally be needed in the maintainer scripts. There is
7785 one type of situation, though, where calls to
7786 <prgn>dpkg-statoverride</prgn> would be needed in the
7787 maintainer scripts, and that involves packages which use
7788 dynamically allocated user or group ids. In such a
7789 situation, something like the following idiom can be very
7790 helpful in the package's <prgn>postinst</prgn>, where
7791 <tt>sysuser</tt> is a dynamically allocated id:
7793 for i in /usr/bin/foo /usr/sbin/bar
7795 # only do something when no setting exists
7796 if ! dpkg-statoverride --list $i >/dev/null 2>&1
7798 #include: debconf processing, question about foo and bar
7799 if [ "$RET" = "true" ] ; then
7800 dpkg-statoverride --update --add sysuser root 4755 $i
7805 The corresponding <tt>dpkg-statoverride --remove</tt>
7806 calls can then be made unconditionally when the package is
7814 <chapt id="customized-programs">
7815 <heading>Customized programs</heading>
7817 <sect id="arch-spec">
7818 <heading>Architecture specification strings</heading>
7821 If a program needs to specify an <em>architecture specification
7822 string</em> in some place, it should select one of the
7823 strings provided by <tt>dpkg-architecture -L</tt>. The
7824 strings are in the format
7825 <tt><var>os</var>-<var>arch</var></tt>, though the OS part
7826 is sometimes elided, as when the OS is Linux.<footnote>
7827 <p>Currently, the strings are:
7828 i386 ia64 alpha amd64 armeb arm hppa m32r m68k mips
7829 mipsel powerpc ppc64 s390 s390x sh3 sh3eb sh4 sh4eb
7830 sparc darwin-i386 darwin-ia64 darwin-alpha darwin-amd64
7831 darwin-armeb darwin-arm darwin-hppa darwin-m32r
7832 darwin-m68k darwin-mips darwin-mipsel darwin-powerpc
7833 darwin-ppc64 darwin-s390 darwin-s390x darwin-sh3
7834 darwin-sh3eb darwin-sh4 darwin-sh4eb darwin-sparc
7835 freebsd-i386 freebsd-ia64 freebsd-alpha freebsd-amd64
7836 freebsd-armeb freebsd-arm freebsd-hppa freebsd-m32r
7837 freebsd-m68k freebsd-mips freebsd-mipsel freebsd-powerpc
7838 freebsd-ppc64 freebsd-s390 freebsd-s390x freebsd-sh3
7839 freebsd-sh3eb freebsd-sh4 freebsd-sh4eb freebsd-sparc
7840 kfreebsd-i386 kfreebsd-ia64 kfreebsd-alpha
7841 kfreebsd-amd64 kfreebsd-armeb kfreebsd-arm kfreebsd-hppa
7842 kfreebsd-m32r kfreebsd-m68k kfreebsd-mips
7843 kfreebsd-mipsel kfreebsd-powerpc kfreebsd-ppc64
7844 kfreebsd-s390 kfreebsd-s390x kfreebsd-sh3 kfreebsd-sh3eb
7845 kfreebsd-sh4 kfreebsd-sh4eb kfreebsd-sparc knetbsd-i386
7846 knetbsd-ia64 knetbsd-alpha knetbsd-amd64 knetbsd-armeb
7847 knetbsd-arm knetbsd-hppa knetbsd-m32r knetbsd-m68k
7848 knetbsd-mips knetbsd-mipsel knetbsd-powerpc
7849 knetbsd-ppc64 knetbsd-s390 knetbsd-s390x knetbsd-sh3
7850 knetbsd-sh3eb knetbsd-sh4 knetbsd-sh4eb knetbsd-sparc
7851 netbsd-i386 netbsd-ia64 netbsd-alpha netbsd-amd64
7852 netbsd-armeb netbsd-arm netbsd-hppa netbsd-m32r
7853 netbsd-m68k netbsd-mips netbsd-mipsel netbsd-powerpc
7854 netbsd-ppc64 netbsd-s390 netbsd-s390x netbsd-sh3
7855 netbsd-sh3eb netbsd-sh4 netbsd-sh4eb netbsd-sparc
7856 openbsd-i386 openbsd-ia64 openbsd-alpha openbsd-amd64
7857 openbsd-armeb openbsd-arm openbsd-hppa openbsd-m32r
7858 openbsd-m68k openbsd-mips openbsd-mipsel openbsd-powerpc
7859 openbsd-ppc64 openbsd-s390 openbsd-s390x openbsd-sh3
7860 openbsd-sh3eb openbsd-sh4 openbsd-sh4eb openbsd-sparc
7861 hurd-i386 hurd-ia64 hurd-alpha hurd-amd64 hurd-armeb
7862 hurd-arm hurd-hppa hurd-m32r hurd-m68k hurd-mips
7863 hurd-mipsel hurd-powerpc hurd-ppc64 hurd-s390 hurd-s390x
7864 hurd-sh3 hurd-sh3eb hurd-sh4 hurd-sh4eb hurd-sparc
7870 Note that we don't want to use
7871 <tt><var>arch</var>-debian-linux</tt> to apply to the rule
7872 <tt><var>architecture</var>-<var>vendor</var>-<var>os</var></tt>
7873 since this would make our programs incompatible with other
7874 Linux distributions. We also don't use something like
7875 <tt><var>arch</var>-unknown-linux</tt>, since the
7876 <tt>unknown</tt> does not look very good.
7881 <heading>Daemons</heading>
7884 The configuration files <file>/etc/services</file>,
7885 <file>/etc/protocols</file>, and <file>/etc/rpc</file> are managed
7886 by the <prgn>netbase</prgn> package and must not be modified
7891 If a package requires a new entry in one of these files, the
7892 maintainer should get in contact with the
7893 <prgn>netbase</prgn> maintainer, who will add the entries
7894 and release a new version of the <prgn>netbase</prgn>
7899 The configuration file <file>/etc/inetd.conf</file> must not be
7900 modified by the package's scripts except via the
7901 <prgn>update-inetd</prgn> script or the
7902 <file>DebianNet.pm</file> Perl module. See their documentation
7903 for details on how to add entries.
7907 If a package wants to install an example entry into
7908 <file>/etc/inetd.conf</file>, the entry must be preceded with
7909 exactly one hash character (<tt>#</tt>). Such lines are
7910 treated as "commented out by user" by the
7911 <prgn>update-inetd</prgn> script and are not changed or
7912 activated during package updates.
7917 <heading>Using pseudo-ttys and modifying wtmp, utmp and
7921 Some programs need to create pseudo-ttys. This should be done
7922 using Unix98 ptys if the C library supports it. The resulting
7923 program must not be installed setuid root, unless that
7924 is required for other functionality.
7928 The files <file>/var/run/utmp</file>, <file>/var/log/wtmp</file> and
7929 <file>/var/log/lastlog</file> must be installed writable by
7930 group <tt>utmp</tt>. Programs which need to modify those
7931 files must be installed setgid <tt>utmp</tt>.
7936 <heading>Editors and pagers</heading>
7939 Some programs have the ability to launch an editor or pager
7940 program to edit or display a text document. Since there are
7941 lots of different editors and pagers available in the Debian
7942 distribution, the system administrator and each user should
7943 have the possibility to choose their preferred editor and
7948 In addition, every program should choose a good default
7949 editor/pager if none is selected by the user or system
7954 Thus, every program that launches an editor or pager must
7955 use the EDITOR or PAGER environment variable to determine
7956 the editor or pager the user wishes to use. If these
7957 variables are not set, the programs <file>/usr/bin/editor</file>
7958 and <file>/usr/bin/pager</file> should be used, respectively.
7962 These two files are managed through the <prgn>dpkg</prgn>
7963 "alternatives" mechanism. Thus every package providing an
7964 editor or pager must call the
7965 <prgn>update-alternatives</prgn> script to register these
7970 If it is very hard to adapt a program to make use of the
7971 EDITOR or PAGER variables, that program may be configured to
7972 use <file>/usr/bin/sensible-editor</file> and
7973 <file>/usr/bin/sensible-pager</file> as the editor or pager
7974 program respectively. These are two scripts provided in the
7975 Debian base system that check the EDITOR and PAGER variables
7976 and launch the appropriate program, and fall back to
7977 <file>/usr/bin/editor</file> and <file>/usr/bin/pager</file> if the
7978 variable is not set.
7982 A program may also use the VISUAL environment variable to
7983 determine the user's choice of editor. If it exists, it
7984 should take precedence over EDITOR. This is in fact what
7985 <file>/usr/bin/sensible-editor</file> does.
7989 It is not required for a package to depend on
7990 <tt>editor</tt> and <tt>pager</tt>, nor is it required for a
7991 package to provide such virtual packages.<footnote>
7992 The Debian base system already provides an editor and a
7998 <sect id="web-appl">
7999 <heading>Web servers and applications</heading>
8002 This section describes the locations and URLs that should
8003 be used by all web servers and web applications in the
8010 Cgi-bin executable files are installed in the
8012 <example compact="compact">
8013 /usr/lib/cgi-bin/<var>cgi-bin-name</var>
8015 and should be referred to as
8016 <example compact="compact">
8017 http://localhost/cgi-bin/<var>cgi-bin-name</var>
8023 <p>Access to HTML documents</p>
8026 HTML documents for a package are stored in
8027 <file>/usr/share/doc/<var>package</var></file>
8028 and can be referred to as
8029 <example compact="compact">
8030 http://localhost/doc/<var>package</var>/<var>filename</var>
8035 The web server should restrict access to the document
8036 tree so that only clients on the same host can read
8037 the documents. If the web server does not support such
8038 access controls, then it should not provide access at
8039 all, or ask about providing access during installation.
8044 <p>Access to images</p>
8046 It is recommended that images for a package be stored
8047 in <tt>/usr/share/images/<var>package</var></tt> and
8048 may be referred to through an alias <tt>/images/</tt>
8051 http://localhost/images/<package>/<filename>
8058 <p>Web Document Root</p>
8061 Web Applications should try to avoid storing files in
8062 the Web Document Root. Instead they should use the
8063 /usr/share/doc/<var>package</var> directory for
8064 documents and register the Web Application via the
8065 <package>doc-base</package> package. If access to the
8066 web document root is unavoidable then use
8067 <example compact="compact">
8070 as the Document Root. This might be just a symbolic
8071 link to the location where the system administrator
8072 has put the real document root.
8075 <item><p>Providing httpd and/or httpd-cgi</p>
8077 All web servers should provide the virtual package
8078 <tt>httpd</tt>. If a web server has CGI support it should
8079 provide <tt>httpd-cgi</tt> additionally.
8082 All web applications which do not contain CGI scripts should
8083 depend on <tt>httpd</tt>, all those web applications which
8084 <tt>do</tt> contain CGI scripts, should depend on
8092 <sect id="mail-transport-agents">
8093 <heading>Mail transport, delivery and user agents</heading>
8096 Debian packages which process electronic mail, whether mail
8097 user agents (MUAs) or mail transport agents (MTAs), must
8098 ensure that they are compatible with the configuration
8099 decisions below. Failure to do this may result in lost
8100 mail, broken <tt>From:</tt> lines, and other serious brain
8105 The mail spool is <file>/var/mail</file> and the interface to
8106 send a mail message is <file>/usr/sbin/sendmail</file> (as per
8107 the FHS). On older systems, the mail spool may be
8108 physically located in <file>/var/spool/mail</file>, but all
8109 access to the mail spool should be via the
8110 <file>/var/mail</file> symlink. The mail spool is part of the
8111 base system and not part of the MTA package.
8115 All Debian MUAs, MTAs, MDAs and other mailbox accessing
8116 programs (such as IMAP daemons) must lock the mailbox in an
8117 NFS-safe way. This means that <tt>fcntl()</tt> locking must
8118 be combined with dot locking. To avoid deadlocks, a program
8119 should use <tt>fcntl()</tt> first and dot locking after
8120 this, or alternatively implement the two locking methods in
8121 a non blocking way<footnote>
8122 If it is not possible to establish both locks, the
8123 system shouldn't wait for the second lock to be
8124 established, but remove the first lock, wait a (random)
8125 time, and start over locking again.
8126 </footnote>. Using the functions <tt>maillock</tt> and
8127 <tt>mailunlock</tt> provided by the
8128 <tt>liblockfile*</tt><footnote>
8129 You will need to depend on <tt>liblockfile1 (>>1.01)</tt>
8130 to use these functions.
8131 </footnote> packages is the recommended way to realize this.
8135 Mailboxes are generally either mode 600 and owned by
8136 <var>user</var> or mode 660 and owned by
8137 <tt><var>user</var>:mail</tt><footnote>
8138 There are two traditional permission schemes for mail spools:
8139 mode 600 with all mail delivery done by processes running as
8140 the destination user, or mode 660 and owned by group mail with
8141 mail delivery done by a process running as a system user in
8142 group mail. Historically, Debian required mode 660 mail
8143 spools to enable the latter model, but that model has become
8144 increasingly uncommon and the principle of least privilege
8145 indicates that mail systems that use the first model should
8146 use permissions of 600. If delivery to programs is permitted,
8147 it's easier to keep the mail system secure if the delivery
8148 agent runs as the destination user. Debian Policy therefore
8149 permits either scheme.
8150 </footnote>. The local system administrator may choose a
8151 different permission scheme; packages should not make
8152 assumptions about the permission and ownership of mailboxes
8153 unless required (such as when creating a new mailbox). A MUA
8154 may remove a mailbox (unless it has nonstandard permissions) in
8155 which case the MTA or another MUA must recreate it if needed.
8159 The mail spool is 2775 <tt>root:mail</tt>, and MUAs should
8160 be setgid mail to do the locking mentioned above (and
8161 must obviously avoid accessing other users' mailboxes
8162 using this privilege).</p>
8165 <file>/etc/aliases</file> is the source file for the system mail
8166 aliases (e.g., postmaster, usenet, etc.), it is the one
8167 which the sysadmin and <prgn>postinst</prgn> scripts may
8168 edit. After <file>/etc/aliases</file> is edited the program or
8169 human editing it must call <prgn>newaliases</prgn>. All MTA
8170 packages must come with a <prgn>newaliases</prgn> program,
8171 even if it does nothing, but older MTA packages did not do
8172 this so programs should not fail if <prgn>newaliases</prgn>
8173 cannot be found. Note that because of this, all MTA
8174 packages must have <tt>Provides</tt>, <tt>Conflicts</tt> and
8175 <tt>Replaces: mail-transport-agent</tt> control file
8180 The convention of writing <tt>forward to
8181 <var>address</var></tt> in the mailbox itself is not
8182 supported. Use a <tt>.forward</tt> file instead.</p>
8185 The <prgn>rmail</prgn> program used by UUCP
8186 for incoming mail should be <file>/usr/sbin/rmail</file>.
8187 Likewise, <prgn>rsmtp</prgn>, for receiving
8188 batch-SMTP-over-UUCP, should be <file>/usr/sbin/rsmtp</file> if it
8192 If your package needs to know what hostname to use on (for
8193 example) outgoing news and mail messages which are generated
8194 locally, you should use the file <file>/etc/mailname</file>. It
8195 will contain the portion after the username and <tt>@</tt>
8196 (at) sign for email addresses of users on the machine
8197 (followed by a newline).
8201 Such a package should check for the existence of this file
8202 when it is being configured. If it exists, it should be
8203 used without comment, although an MTA's configuration script
8204 may wish to prompt the user even if it finds that this file
8205 exists. If the file does not exist, the package should
8206 prompt the user for the value (preferably using
8207 <prgn>debconf</prgn>) and store it in <file>/etc/mailname</file>
8208 as well as using it in the package's configuration. The
8209 prompt should make it clear that the name will not just be
8210 used by that package. For example, in this situation the
8211 <tt>inn</tt> package could say something like:
8212 <example compact="compact">
8213 Please enter the "mail name" of your system. This is the
8214 hostname portion of the address to be shown on outgoing
8215 news and mail messages. The default is
8216 <var>syshostname</var>, your system's host name. Mail
8217 name ["<var>syshostname</var>"]:
8219 where <var>syshostname</var> is the output of <tt>hostname
8225 <heading>News system configuration</heading>
8228 All the configuration files related to the NNTP (news)
8229 servers and clients should be located under
8230 <file>/etc/news</file>.</p>
8233 There are some configuration issues that apply to a number
8234 of news clients and server packages on the machine. These
8238 <tag><file>/etc/news/organization</file></tag>
8240 A string which should appear as the
8241 organization header for all messages posted
8242 by NNTP clients on the machine
8245 <tag><file>/etc/news/server</file></tag>
8247 Contains the FQDN of the upstream NNTP
8248 server, or localhost if the local machine is
8253 Other global files may be added as required for cross-package news
8260 <heading>Programs for the X Window System</heading>
8263 <heading>Providing X support and package priorities</heading>
8266 Programs that can be configured with support for the X
8267 Window System must be configured to do so and must declare
8268 any package dependencies necessary to satisfy their
8269 runtime requirements when using the X Window System. If
8270 such a package is of higher priority than the X packages
8271 on which it depends, it is required that either the
8272 X-specific components be split into a separate package, or
8273 that an alternative version of the package, which includes
8274 X support, be provided, or that the package's priority be
8280 <heading>Packages providing an X server</heading>
8283 Packages that provide an X server that, directly or
8284 indirectly, communicates with real input and display
8285 hardware should declare in their control data that they
8286 provide the virtual package <tt>xserver</tt>.<footnote>
8287 This implements current practice, and provides an
8288 actual policy for usage of the <tt>xserver</tt>
8289 virtual package which appears in the virtual packages
8290 list. In a nutshell, X servers that interface
8291 directly with the display and input hardware or via
8292 another subsystem (e.g., GGI) should provide
8293 <tt>xserver</tt>. Things like <tt>Xvfb</tt>,
8294 <tt>Xnest</tt>, and <tt>Xprt</tt> should not.
8300 <heading>Packages providing a terminal emulator</heading>
8303 Packages that provide a terminal emulator for the X Window
8304 System which meet the criteria listed below should declare
8305 in their control data that they provide the virtual
8306 package <tt>x-terminal-emulator</tt>. They should also
8307 register themselves as an alternative for
8308 <file>/usr/bin/x-terminal-emulator</file>, with a priority of
8313 To be an <tt>x-terminal-emulator</tt>, a program must:
8314 <list compact="compact">
8316 Be able to emulate a DEC VT100 terminal, or a
8317 compatible terminal.
8321 Support the command-line option <tt>-e
8322 <var>command</var></tt>, which creates a new
8323 terminal window<footnote>
8324 "New terminal window" does not necessarily mean
8325 a new top-level X window directly parented by
8326 the window manager; it could, if the terminal
8327 emulator application were so coded, be a new
8328 "view" in a multiple-document interface (MDI).
8330 and runs the specified <var>command</var>,
8331 interpreting the entirety of the rest of the command
8332 line as a command to pass straight to exec, in the
8333 manner that <tt>xterm</tt> does.
8337 Support the command-line option <tt>-T
8338 <var>title</var></tt>, which creates a new terminal
8339 window with the window title <var>title</var>.
8346 <heading>Packages providing a window manager</heading>
8349 Packages that provide a window manager should declare in
8350 their control data that they provide the virtual package
8351 <tt>x-window-manager</tt>. They should also register
8352 themselves as an alternative for
8353 <file>/usr/bin/x-window-manager</file>, with a priority
8354 calculated as follows:
8355 <list compact="compact">
8357 Start with a priority of 20.
8361 If the window manager supports the Debian menu
8362 system, add 20 points if this support is available
8363 in the package's default configuration (i.e., no
8364 configuration files belonging to the system or user
8365 have to be edited to activate the feature); if
8366 configuration files must be modified, add only 10
8372 If the window manager complies with <url
8373 id="http://www.freedesktop.org/Standards/wm-spec"
8374 name="The Window Manager Specification Project">,
8375 written by the <url id="http://www.freedesktop.org/"
8376 name="Free Desktop Group">, add 40 points.
8380 If the window manager permits the X session to be
8381 restarted using a <em>different</em> window manager
8382 (without killing the X server) in its default
8383 configuration, add 10 points; otherwise add none.
8390 <heading>Packages providing fonts</heading>
8393 Packages that provide fonts for the X Window
8395 For the purposes of Debian Policy, a "font for the X
8396 Window System" is one which is accessed via X protocol
8397 requests. Fonts for the Linux console, for PostScript
8398 renderer, or any other purpose, do not fit this
8399 definition. Any tool which makes such fonts available
8400 to the X Window System, however, must abide by this
8403 must do a number of things to ensure that they are both
8404 available without modification of the X or font server
8405 configuration, and that they do not corrupt files used by
8406 other font packages to register information about
8410 Fonts of any type supported by the X Window System
8411 must be in a separate binary package from any
8412 executables, libraries, or documentation (except
8413 that specific to the fonts shipped, such as their
8414 license information). If one or more of the fonts
8415 so packaged are necessary for proper operation of
8416 the package with which they are associated the font
8417 package may be Recommended; if the fonts merely
8418 provide an enhancement, a Suggests relationship may
8419 be used. Packages must not Depend on font
8421 This is because the X server may retrieve fonts
8422 from the local file system or over the network
8423 from an X font server; the Debian package system
8424 is empowered to deal only with the local
8430 BDF fonts must be converted to PCF fonts with the
8431 <prgn>bdftopcf</prgn> utility (available in the
8432 <tt>xfonts-utils</tt> package, <prgn>gzip</prgn>ped, and
8433 placed in a directory that corresponds to their
8435 <list compact="compact">
8437 100 dpi fonts must be placed in
8438 <file>/usr/share/fonts/X11/100dpi/</file>.
8442 75 dpi fonts must be placed in
8443 <file>/usr/share/fonts/X11/75dpi/</file>.
8447 Character-cell fonts, cursor fonts, and other
8448 low-resolution fonts must be placed in
8449 <file>/usr/share/fonts/X11/misc/</file>.
8455 Type 1 fonts must be placed in
8456 <file>/usr/share/fonts/X11/Type1/</file>. If font
8457 metric files are available, they must be placed here
8462 Subdirectories of <file>/usr/share/fonts/X11/</file>
8463 other than those listed above must be neither
8464 created nor used. (The <file>PEX</file>, <file>CID</file>,
8465 <file>Speedo</file>, and <file>cyrillic</file> directories
8466 are excepted for historical reasons, but installation of
8467 files into these directories remains discouraged.)
8471 Font packages may, instead of placing files directly
8472 in the X font directories listed above, provide
8473 symbolic links in that font directory pointing to
8474 the files' actual location in the filesystem. Such
8475 a location must comply with the FHS.
8479 Font packages should not contain both 75dpi and
8480 100dpi versions of a font. If both are available,
8481 they should be provided in separate binary packages
8482 with <tt>-75dpi</tt> or <tt>-100dpi</tt> appended to
8483 the names of the packages containing the
8484 corresponding fonts.
8488 Fonts destined for the <file>misc</file> subdirectory
8489 should not be included in the same package as 75dpi
8490 or 100dpi fonts; instead, they should be provided in
8491 a separate package with <tt>-misc</tt> appended to
8496 Font packages must not provide the files
8497 <file>fonts.dir</file>, <file>fonts.alias</file>, or
8498 <file>fonts.scale</file> in a font directory:
8501 <file>fonts.dir</file> files must not be provided at all.
8505 <file>fonts.alias</file> and <file>fonts.scale</file>
8506 files, if needed, should be provided in the
8508 <file>/etc/X11/fonts/<var>fontdir</var>/<var>package</var>.<var>extension</var></file>,
8509 where <var>fontdir</var> is the name of the
8511 <file>/usr/share/fonts/X11/</file> where the
8512 package's corresponding fonts are stored
8513 (e.g., <tt>75dpi</tt> or <tt>misc</tt>),
8514 <var>package</var> is the name of the package
8515 that provides these fonts, and
8516 <var>extension</var> is either <tt>scale</tt>
8517 or <tt>alias</tt>, whichever corresponds to
8524 Font packages must declare a dependency on
8525 <tt>xfonts-utils</tt> in their control
8530 Font packages that provide one or more
8531 <file>fonts.scale</file> files as described above must
8532 invoke <prgn>update-fonts-scale</prgn> on each
8533 directory into which they installed fonts
8534 <em>before</em> invoking
8535 <prgn>update-fonts-dir</prgn> on that directory.
8536 This invocation must occur in both the
8537 <prgn>postinst</prgn> (for all arguments) and
8538 <prgn>postrm</prgn> (for all arguments except
8539 <tt>upgrade</tt>) scripts.
8543 Font packages that provide one or more
8544 <file>fonts.alias</file> files as described above must
8545 invoke <prgn>update-fonts-alias</prgn> on each
8546 directory into which they installed fonts. This
8547 invocation must occur in both the
8548 <prgn>postinst</prgn> (for all arguments) and
8549 <prgn>postrm</prgn> (for all arguments except
8550 <tt>upgrade</tt>) scripts.
8554 Font packages must invoke
8555 <prgn>update-fonts-dir</prgn> on each directory into
8556 which they installed fonts. This invocation must
8557 occur in both the <prgn>postinst</prgn> (for all
8558 arguments) and <prgn>postrm</prgn> (for all
8559 arguments except <tt>upgrade</tt>) scripts.
8563 Font packages must not provide alias names for the
8564 fonts they include which collide with alias names
8565 already in use by fonts already packaged.
8569 Font packages must not provide fonts with the same
8570 XLFD registry name as another font already packaged.
8577 <heading>Application defaults files</heading>
8580 Application defaults files must be installed in the
8581 directory <file>/etc/X11/app-defaults/</file> (use of a
8582 localized subdirectory of <file>/etc/X11/</file> as described
8583 in the <em>X Toolkit Intrinsics - C Language
8584 Interface</em> manual is also permitted). They must be
8585 registered as <tt>conffile</tt>s or handled as
8586 configuration files.
8590 Customization of programs' X resources may also be
8591 supported with the provision of a file with the same name
8592 as that of the package placed in the
8593 <file>/etc/X11/Xresources/</file> directory, which must
8594 registered as a <tt>conffile</tt> or handled as a
8595 configuration file.<footnote>
8596 Note that this mechanism is not the same as using
8597 app-defaults; app-defaults are tied to the client
8598 binary on the local file system, whereas X resources
8599 are stored in the X server and affect all connecting
8606 <heading>Installation directory issues</heading>
8609 Packages using the X Window System should not be
8610 configured to install files under the
8611 <file>/usr/X11R6/</file> directory. The
8612 <file>/usr/X11R6/</file> directory hierarchy should be
8613 regarded as obsolete.
8617 Programs that use GNU <prgn>autoconf</prgn> and
8618 <prgn>automake</prgn> are usually easily configured at
8619 compile time to use <file>/usr/</file> instead of
8620 <file>/usr/X11R6/</file>, and this should be done whenever
8621 possible. Configuration files for window managers and
8622 display managers should be placed in a subdirectory of
8623 <file>/etc/X11/</file> corresponding to the package name due
8624 to these programs' tight integration with the mechanisms
8625 of the X Window System. Application-level programs should
8626 use the <file>/etc/</file> directory unless otherwise mandated
8631 The installation of files into subdirectories
8632 of <file>/usr/X11R6/include/X11/</file> and
8633 <file>/usr/X11R6/lib/X11/</file> is now prohibited;
8634 package maintainers should determine if subdirectories of
8635 <file>/usr/lib/</file> and <file>/usr/share/</file> can be used
8640 Packages should install any relevant files into the
8641 directories <file>/usr/include/X11/</file> and
8642 <file>/usr/lib/X11/</file>, but if they do so, they must
8643 pre-depend on <tt>x11-common (>=
8644 1:7.0.0)</tt><footnote>
8646 These libraries used to be all symbolic
8647 links. However, with <tt>X11R7</tt>,
8648 <tt>/usr/include/X11</tt> and <tt>/usr/lib/X11</tt>
8649 are now real directories, and packages
8650 <strong>should</strong> ship their files here instead
8651 of in <tt>/usr/X11R6/{include,lib}/X11</tt>.
8652 <tt>x11-common (>= 1:7.0.0) </tt> is the package
8653 responsible for converting these symlinks into
8661 <heading>The OSF/Motif and OpenMotif libraries</heading>
8664 <em>Programs that require the non-DFSG-compliant OSF/Motif or
8665 OpenMotif libraries</em><footnote>
8666 OSF/Motif and OpenMotif are collectively referred to as
8667 "Motif" in this policy document.
8669 should be compiled against and tested with LessTif (a free
8670 re-implementation of Motif) instead. If the maintainer
8671 judges that the program or programs do not work
8672 sufficiently well with LessTif to be distributed and
8673 supported, but do so when compiled against Motif, then two
8674 versions of the package should be created; one linked
8675 statically against Motif and with <tt>-smotif</tt>
8676 appended to the package name, and one linked dynamically
8677 against Motif and with <tt>-dmotif</tt> appended to the
8682 Both Motif-linked versions are dependent
8683 upon non-DFSG-compliant software and thus cannot be
8684 uploaded to the <em>main</em> distribution; if the
8685 software is itself DFSG-compliant it may be uploaded to
8686 the <em>contrib</em> distribution. While known existing
8687 versions of Motif permit unlimited redistribution of
8688 binaries linked against the library (whether statically or
8689 dynamically), it is the package maintainer's
8690 responsibility to determine whether this is permitted by
8691 the license of the copy of Motif in their possession.
8697 <heading>Perl programs and modules</heading>
8700 Perl programs and modules should follow the current Perl policy.
8704 The Perl policy can be found in the <tt>perl-policy</tt>
8705 files in the <tt>debian-policy</tt> package.
8706 It is also available from the Debian web mirrors at
8707 <tt><url name="/doc/packaging-manuals/perl-policy/"
8708 id="http://www.debian.org/doc/packaging-manuals/perl-policy/"></tt>.
8713 <heading>Emacs lisp programs</heading>
8716 Please refer to the "Debian Emacs Policy" for details of how to
8717 package emacs lisp programs.
8721 The Emacs policy is available in
8722 <file>debian-emacs-policy.gz</file> of the
8723 <package>emacsen-common</package> package.
8724 It is also available from the Debian web mirrors at
8725 <tt><url name="/doc/packaging-manuals/debian-emacs-policy"
8726 id="http://www.debian.org/doc/packaging-manuals/debian-emacs-policy"></tt>.
8731 <heading>Games</heading>
8734 The permissions on <file>/var/games</file> are mode 755, owner
8735 <tt>root</tt> and group <tt>root</tt>.
8739 Each game decides on its own security policy.</p>
8742 Games which require protected, privileged access to
8743 high-score files, saved games, etc., may be made
8744 set-<em>group</em>-id (mode 2755) and owned by
8745 <tt>root:games</tt>, and use files and directories with
8746 appropriate permissions (770 <tt>root:games</tt>, for
8747 example). They must not be made
8748 set-<em>user</em>-id, as this causes security problems. (If
8749 an attacker can subvert any set-user-id game they can
8750 overwrite the executable of any other, causing other players
8751 of these games to run a Trojan horse program. With a
8752 set-group-id game the attacker only gets access to less
8753 important game data, and if they can get at the other
8754 players' accounts at all it will take considerably more
8758 Some packages, for example some fortune cookie programs, are
8759 configured by the upstream authors to install with their
8760 data files or other static information made unreadable so
8761 that they can only be accessed through set-id programs
8762 provided. You should not do this in a Debian package: anyone can
8763 download the <file>.deb</file> file and read the data from it,
8764 so there is no point making the files unreadable. Not
8765 making the files unreadable also means that you don't have
8766 to make so many programs set-id, which reduces the risk of a
8770 As described in the FHS, binaries of games should be
8771 installed in the directory <file>/usr/games</file>. This also
8772 applies to games that use the X Window System. Manual pages
8773 for games (X and non-X games) should be installed in
8774 <file>/usr/share/man/man6</file>.</p>
8780 <heading>Documentation</heading>
8783 <heading>Manual pages</heading>
8786 You should install manual pages in <prgn>nroff</prgn> source
8787 form, in appropriate places under <file>/usr/share/man</file>.
8788 You should only use sections 1 to 9 (see the FHS for more
8789 details). You must not install a pre-formatted "cat page".
8793 Each program, utility, and function should have an
8794 associated manual page included in the same package. It is
8795 suggested that all configuration files also have a manual
8796 page included as well. Manual pages for protocols and other
8797 auxiliary things are optional.
8801 If no manual page is available, this is considered as a bug
8802 and should be reported to the Debian Bug Tracking System (the
8803 maintainer of the package is allowed to write this bug report
8804 themselves, if they so desire). Do not close the bug report
8805 until a proper man page is available.<footnote>
8806 It is not very hard to write a man page. See the
8807 <url id="http://www.schweikhardt.net/man_page_howto.html"
8808 name="Man-Page-HOWTO">,
8809 <manref name="man" section="7">, the examples
8810 created by <prgn>debmake</prgn> or <prgn>dh_make</prgn>,
8811 the helper programs <prgn>help2man</prgn>, or the
8812 directory <file>/usr/share/doc/man-db/examples</file>.
8817 You may forward a complaint about a missing man page to the
8818 upstream authors, and mark the bug as forwarded in the
8819 Debian bug tracking system. Even though the GNU Project do
8820 not in general consider the lack of a man page to be a bug,
8821 we do; if they tell you that they don't consider it a bug
8822 you should leave the bug in our bug tracking system open
8827 Manual pages should be installed compressed using <tt>gzip -9</tt>.
8831 If one man page needs to be accessible via several names it
8832 is better to use a symbolic link than the <file>.so</file>
8833 feature, but there is no need to fiddle with the relevant
8834 parts of the upstream source to change from <file>.so</file> to
8835 symlinks: don't do it unless it's easy. You should not
8836 create hard links in the manual page directories, nor put
8837 absolute filenames in <file>.so</file> directives. The filename
8838 in a <file>.so</file> in a man page should be relative to the
8839 base of the man page tree (usually
8840 <file>/usr/share/man</file>). If you do not create any links
8841 (whether symlinks, hard links, or <tt>.so</tt> directives)
8842 in the file system to the alternate names of the man page,
8843 then you should not rely on <prgn>man</prgn> finding your
8844 man page under those names based solely on the information in
8845 the man page's header.<footnote>
8846 Supporting this in <prgn>man</prgn> often requires
8847 unreasonable processing time to find a manual page or to
8848 report that none exists, and moves knowledge into man's
8849 database that would be better left in the file system.
8850 This support is therefore deprecated and will cease to
8851 be present in the future.
8856 Manual pages in locale-specific subdirectories of
8857 <file>/usr/share/man</file> should use either UTF-8 or the usual
8858 legacy encoding for that language (normally the one corresponding
8859 to the shortest relevant locale name in
8860 <file>/usr/share/i18n/SUPPORTED</file>). For example, pages under
8861 <file>/usr/share/man/fr</file> should use either UTF-8 or
8862 ISO-8859-1.<footnote>
8863 <prgn>man</prgn> will automatically detect whether UTF-8 is in
8864 use. In future, all manual pages will be required to use
8870 A country name (the <tt>DE</tt> in <tt>de_DE</tt>) should not be
8871 included in the subdirectory name unless it indicates a
8872 significant difference in the language, as this excludes
8873 speakers of the language in other countries.<footnote>
8874 At the time of writing, Chinese and Portuguese are the main
8875 languages with such differences, so <file>pt_BR</file>,
8876 <file>zh_CN</file>, and <file>zh_TW</file> are all allowed.
8881 Due to limitations in current implementations, all characters
8882 in the manual page source should be representable in the usual
8883 legacy encoding for that language, even if the file is
8884 actually encoded in UTF-8. Safe alternative ways to write many
8885 characters outside that range may be found in
8886 <manref name="groff_char" section="7">.
8891 <heading>Info documents</heading>
8894 Info documents should be installed in <file>/usr/share/info</file>.
8895 They should be compressed with <tt>gzip -9</tt>.
8899 Your package should call <prgn>install-info</prgn> to update
8900 the Info <file>dir</file> file in its <prgn>postinst</prgn>
8901 script when called with a <tt>configure</tt> argument, for
8903 <example compact="compact">
8904 install-info --quiet --section Development Development \
8905 /usr/share/info/foobar.info
8909 It is a good idea to specify a section for the location of
8910 your program; this is done with the <tt>--section</tt>
8911 switch. To determine which section to use, you should look
8912 at <file>/usr/share/info/dir</file> on your system and choose the most
8913 relevant (or create a new section if none of the current
8914 sections are relevant). Note that the <tt>--section</tt>
8915 flag takes two arguments; the first is a regular expression
8916 to match (case-insensitively) against an existing section,
8917 the second is used when creating a new one.</p>
8920 You should remove the entries in the <prgn>prerm</prgn>
8921 script when called with a <tt>remove</tt> argument:
8922 <example compact="compact">
8923 install-info --quiet --remove /usr/share/info/foobar.info
8927 If <prgn>install-info</prgn> cannot find a description entry
8928 in the Info file you must supply one. See <manref
8929 name="install-info" section="8"> for details.</p>
8933 <heading>Additional documentation</heading>
8936 Any additional documentation that comes with the package may
8937 be installed at the discretion of the package maintainer.
8938 Plain text documentation should be installed in the directory
8939 <file>/usr/share/doc/<var>package</var></file>, where
8940 <var>package</var> is the name of the package, and
8941 compressed with <tt>gzip -9</tt> unless it is small.
8945 If a package comes with large amounts of documentation which
8946 many users of the package will not require you should create
8947 a separate binary package to contain it, so that it does not
8948 take up disk space on the machines of users who do not need
8949 or want it installed.</p>
8952 It is often a good idea to put text information files
8953 (<file>README</file>s, changelogs, and so forth) that come with
8954 the source package in <file>/usr/share/doc/<var>package</var></file>
8955 in the binary package. However, you don't need to install
8956 the instructions for building and installing the package, of
8960 Packages must not require the existence of any files in
8961 <file>/usr/share/doc/</file> in order to function
8963 The system administrator should be able to
8964 delete files in <file>/usr/share/doc/</file> without causing
8965 any programs to break.
8967 Any files that are referenced by programs but are also
8968 useful as stand alone documentation should be installed under
8969 <file>/usr/share/<var>package</var>/</file> with symbolic links from
8970 <file>/usr/share/doc/<var>package</var></file>.
8974 <file>/usr/share/doc/<var>package</var></file> may be a symbolic
8975 link to another directory in <file>/usr/share/doc</file> only if
8976 the two packages both come from the same source and the
8977 first package Depends on the second.<footnote>
8979 Please note that this does not override the section on
8980 changelog files below, so the file
8981 <file>/usr/share/<var>package</var>/changelog.Debian.gz</file>
8982 must refer to the changelog for the current version of
8983 <var>package</var> in question. In practice, this means
8984 that the sources of the target and the destination of the
8985 symlink must be the same (same source package and
8992 Former Debian releases placed all additional documentation
8993 in <file>/usr/doc/<var>package</var></file>. This has been
8994 changed to <file>/usr/share/doc/<var>package</var></file>,
8995 and packages must not put documentation in the directory
8996 <file>/usr/doc/<var>package</var></file>. <footnote>
8997 At this phase of the transition, we no longer require a
8998 symbolic link in <file>/usr/doc/</file>. At a later point,
8999 policy shall change to make the symbolic links a bug.
9005 <heading>Preferred documentation formats</heading>
9008 The unification of Debian documentation is being carried out
9012 If your package comes with extensive documentation in a
9013 markup format that can be converted to various other formats
9014 you should if possible ship HTML versions in a binary
9015 package, in the directory
9016 <file>/usr/share/doc/<var>appropriate-package</var></file> or
9017 its subdirectories.<footnote>
9018 The rationale: The important thing here is that HTML
9019 docs should be available in <em>some</em> package, not
9020 necessarily in the main binary package.
9025 Other formats such as PostScript may be provided at the
9026 package maintainer's discretion.
9030 <sect id="copyrightfile">
9031 <heading>Copyright information</heading>
9034 Every package must be accompanied by a verbatim copy of its
9035 copyright and distribution license in the file
9036 <file>/usr/share/doc/<var>package</var>/copyright</file>. This
9037 file must neither be compressed nor be a symbolic link.
9041 In addition, the copyright file must say where the upstream
9042 sources (if any) were obtained. It should name the original
9043 authors of the package and the Debian maintainer(s) who were
9044 involved with its creation.
9048 Packages in the <em>contrib</em> or <em>non-free</em> archive
9049 areas should state in the copyright file that the package is not
9050 part of the Debian GNU/Linux distribution and briefly explain
9055 A copy of the file which will be installed in
9056 <file>/usr/share/doc/<var>package</var>/copyright</file> should
9057 be in <file>debian/copyright</file> in the source package.
9061 <file>/usr/share/doc/<var>package</var></file> may be a symbolic
9062 link to another directory in <file>/usr/share/doc</file> only if
9063 the two packages both come from the same source and the
9064 first package Depends on the second. These rules are
9065 important because copyrights must be extractable by
9070 Packages distributed under the UCB BSD license, the Apache
9071 license (version 2.0), the Artistic license, the GNU GPL
9072 (version 2 or 3), the GNU LGPL (versions 2, 2.1, or 3), and the
9073 GNU FDL (versions 1.2 or 1.3) should refer to the corresponding
9074 files under <file>/usr/share/common-licenses</file>,<footnote>
9077 <file>/usr/share/common-licenses/BSD</file>,
9078 <file>/usr/share/common-licenses/Apache-2.0</file>,
9079 <file>/usr/share/common-licenses/Artistic</file>,
9080 <file>/usr/share/common-licenses/GPL-2</file>,
9081 <file>/usr/share/common-licenses/GPL-3</file>,
9082 <file>/usr/share/common-licenses/LGPL-2</file>,
9083 <file>/usr/share/common-licenses/LGPL-2.1</file>,
9084 <file>/usr/share/common-licenses/LGPL-3</file>,
9085 <file>/usr/share/common-licenses/GFDL-1.2</file>, and
9086 <file>/usr/share/common-licenses/GFDL-1.3</file>
9089 </footnote> rather than quoting them in the copyright
9094 You should not use the copyright file as a general <file>README</file>
9095 file. If your package has such a file it should be
9096 installed in <file>/usr/share/doc/<var>package</var>/README</file> or
9097 <file>README.Debian</file> or some other appropriate place.</p>
9101 <heading>Examples</heading>
9104 Any examples (configurations, source files, whatever),
9105 should be installed in a directory
9106 <file>/usr/share/doc/<var>package</var>/examples</file>. These
9107 files should not be referenced by any program: they're there
9108 for the benefit of the system administrator and users as
9109 documentation only. Architecture-specific example files
9110 should be installed in a directory
9111 <file>/usr/lib/<var>package</var>/examples</file> with symbolic
9113 <file>/usr/share/doc/<var>package</var>/examples</file>, or the
9114 latter directory itself may be a symbolic link to the
9119 If the purpose of a package is to provide examples, then the
9120 example files may be installed into
9121 <file>/usr/share/doc/<var>package</var></file>.
9125 <sect id="changelogs">
9126 <heading>Changelog files</heading>
9129 Packages that are not Debian-native must contain a
9130 compressed copy of the <file>debian/changelog</file> file from
9131 the Debian source tree in
9132 <file>/usr/share/doc/<var>package</var></file> with the name
9133 <file>changelog.Debian.gz</file>.
9137 If an upstream changelog is available, it should be accessible as
9138 <file>/usr/share/doc/<var>package</var>/changelog.gz</file> in
9139 plain text. If the upstream changelog is distributed in
9140 HTML, it should be made available in that form as
9141 <file>/usr/share/doc/<var>package</var>/changelog.html.gz</file>
9142 and a plain text <file>changelog.gz</file> should be generated
9143 from it using, for example, <tt>lynx -dump -nolist</tt>. If
9144 the upstream changelog files do not already conform to this
9145 naming convention, then this may be achieved either by
9146 renaming the files, or by adding a symbolic link, at the
9147 maintainer's discretion.<footnote>
9148 Rationale: People should not have to look in places for
9149 upstream changelogs merely because they are given
9150 different names or are distributed in HTML format.
9155 All of these files should be installed compressed using
9156 <tt>gzip -9</tt>, as they will become large with time even
9157 if they start out small.
9161 If the package has only one changelog which is used both as
9162 the Debian changelog and the upstream one because there is
9163 no separate upstream maintainer then that changelog should
9164 usually be installed as
9165 <file>/usr/share/doc/<var>package</var>/changelog.gz</file>; if
9166 there is a separate upstream maintainer, but no upstream
9167 changelog, then the Debian changelog should still be called
9168 <file>changelog.Debian.gz</file>.
9172 For details about the format and contents of the Debian
9173 changelog file, please see <ref id="dpkgchangelog">.
9178 <appendix id="pkg-scope">
9179 <heading>Introduction and scope of these appendices</heading>
9182 These appendices are taken essentially verbatim from the
9183 now-deprecated Packaging Manual, version 3.2.1.0. They are
9184 the chapters which are likely to be of use to package
9185 maintainers and which have not already been included in the
9186 policy document itself. Most of these sections are very likely
9187 not relevant to policy; they should be treated as
9188 documentation for the packaging system. Please note that these
9189 appendices are included for convenience, and for historical
9190 reasons: they used to be part of policy package, and they have
9191 not yet been incorporated into dpkg documentation. However,
9192 they still have value, and hence they are presented here.
9196 They have not yet been checked to ensure that they are
9197 compatible with the contents of policy, and if there are any
9198 contradictions, the version in the main policy document takes
9199 precedence. The remaining chapters of the old Packaging
9200 Manual have also not been read in detail to ensure that there
9201 are not parts which have been left out. Both of these will be
9206 Certain parts of the Packaging manual were integrated into the
9207 Policy Manual proper, and removed from the appendices. Links
9208 have been placed from the old locations to the new ones.
9212 <prgn>dpkg</prgn> is a suite of programs for creating binary
9213 package files and installing and removing them on Unix
9215 <prgn>dpkg</prgn> is targeted primarily at Debian
9216 GNU/Linux, but may work on or be ported to other
9222 The binary packages are designed for the management of
9223 installed executable programs (usually compiled binaries) and
9224 their associated data, though source code examples and
9225 documentation are provided as part of some packages.</p>
9228 This manual describes the technical aspects of creating Debian
9229 binary packages (<file>.deb</file> files). It documents the
9230 behavior of the package management programs
9231 <prgn>dpkg</prgn>, <prgn>dselect</prgn> et al. and the way
9232 they interact with packages.</p>
9235 It also documents the interaction between
9236 <prgn>dselect</prgn>'s core and the access method scripts it
9237 uses to actually install the selected packages, and describes
9238 how to create a new access method.</p>
9241 This manual does not go into detail about the options and
9242 usage of the package building and installation tools. It
9243 should therefore be read in conjunction with those programs'
9248 The utility programs which are provided with <prgn>dpkg</prgn>
9249 for managing various system configuration and similar issues,
9250 such as <prgn>update-rc.d</prgn> and
9251 <prgn>install-info</prgn>, are not described in detail here -
9252 please see their man pages.
9256 It is assumed that the reader is reasonably familiar with the
9257 <prgn>dpkg</prgn> System Administrators' manual.
9258 Unfortunately this manual does not yet exist.
9262 The Debian version of the FSF's GNU hello program is provided
9263 as an example for people wishing to create Debian
9264 packages. The Debian <prgn>debmake</prgn> package is
9265 recommended as a very helpful tool in creating and maintaining
9266 Debian packages. However, while the tools and examples are
9267 helpful, they do not replace the need to read and follow the
9268 Policy and Programmer's Manual.</p>
9271 <appendix id="pkg-binarypkg">
9272 <heading>Binary packages (from old Packaging Manual)</heading>
9275 The binary package has two main sections. The first part
9276 consists of various control information files and scripts used
9277 by <prgn>dpkg</prgn> when installing and removing. See <ref
9278 id="pkg-controlarea">.
9282 The second part is an archive containing the files and
9283 directories to be installed.
9287 In the future binary packages may also contain other
9288 components, such as checksums and digital signatures. The
9289 format for the archive is described in full in the
9290 <file>deb(5)</file> man page.
9294 <sect id="pkg-bincreating"><heading>Creating package files -
9295 <prgn>dpkg-deb</prgn>
9299 All manipulation of binary package files is done by
9300 <prgn>dpkg-deb</prgn>; it's the only program that has
9301 knowledge of the format. (<prgn>dpkg-deb</prgn> may be
9302 invoked by calling <prgn>dpkg</prgn>, as <prgn>dpkg</prgn>
9303 will spot that the options requested are appropriate to
9304 <prgn>dpkg-deb</prgn> and invoke that instead with the same
9309 In order to create a binary package you must make a
9310 directory tree which contains all the files and directories
9311 you want to have in the file system data part of the package.
9312 In Debian-format source packages this directory is usually
9313 <file>debian/tmp</file>, relative to the top of the package's
9318 They should have the locations (relative to the root of the
9319 directory tree you're constructing) ownerships and
9320 permissions which you want them to have on the system when
9325 With current versions of <prgn>dpkg</prgn> the uid/username
9326 and gid/groupname mappings for the users and groups being
9327 used should be the same on the system where the package is
9328 built and the one where it is installed.
9332 You need to add one special directory to the root of the
9333 miniature file system tree you're creating:
9334 <prgn>DEBIAN</prgn>. It should contain the control
9335 information files, notably the binary package control file
9336 (see <ref id="pkg-controlfile">).
9340 The <prgn>DEBIAN</prgn> directory will not appear in the
9341 file system archive of the package, and so won't be installed
9342 by <prgn>dpkg</prgn> when the package is installed.
9346 When you've prepared the package, you should invoke:
9348 dpkg --build <var>directory</var>
9353 This will build the package in
9354 <file><var>directory</var>.deb</file>. (<prgn>dpkg</prgn> knows
9355 that <tt>--build</tt> is a <prgn>dpkg-deb</prgn> option, so
9356 it invokes <prgn>dpkg-deb</prgn> with the same arguments to
9361 See the man page <manref name="dpkg-deb" section="8"> for details of how
9362 to examine the contents of this newly-created file. You may find the
9363 output of following commands enlightening:
9365 dpkg-deb --info <var>filename</var>.deb
9366 dpkg-deb --contents <var>filename</var>.deb
9367 dpkg --contents <var>filename</var>.deb
9369 To view the copyright file for a package you could use this command:
9371 dpkg --fsys-tarfile <var>filename</var>.deb | tar xOf - --wildcards \*/copyright | pager
9376 <sect id="pkg-controlarea">
9377 <heading>Package control information files</heading>
9380 The control information portion of a binary package is a
9381 collection of files with names known to <prgn>dpkg</prgn>.
9382 It will treat the contents of these files specially - some
9383 of them contain information used by <prgn>dpkg</prgn> when
9384 installing or removing the package; others are scripts which
9385 the package maintainer wants <prgn>dpkg</prgn> to run.
9389 It is possible to put other files in the package control
9390 area, but this is not generally a good idea (though they
9391 will largely be ignored).
9395 Here is a brief list of the control info files supported by
9396 <prgn>dpkg</prgn> and a summary of what they're used for.
9401 <tag><tt>control</tt>
9404 This is the key description file used by
9405 <prgn>dpkg</prgn>. It specifies the package's name
9406 and version, gives its description for the user,
9407 states its relationships with other packages, and so
9408 forth. See <ref id="sourcecontrolfiles"> and
9409 <ref id="binarycontrolfiles">.
9413 It is usually generated automatically from information
9414 in the source package by the
9415 <prgn>dpkg-gencontrol</prgn> program, and with
9416 assistance from <prgn>dpkg-shlibdeps</prgn>.
9417 See <ref id="pkg-sourcetools">.
9421 <tag><tt>postinst</tt>, <tt>preinst</tt>, <tt>postrm</tt>,
9426 These are executable files (usually scripts) which
9427 <prgn>dpkg</prgn> runs during installation, upgrade
9428 and removal of packages. They allow the package to
9429 deal with matters which are particular to that package
9430 or require more complicated processing than that
9431 provided by <prgn>dpkg</prgn>. Details of when and
9432 how they are called are in <ref id="maintainerscripts">.
9436 It is very important to make these scripts idempotent.
9437 See <ref id="idempotency">.
9441 The maintainer scripts are guaranteed to run with a
9442 controlling terminal and can interact with the user.
9443 See <ref id="controllingterminal">.
9447 <tag><tt>conffiles</tt>
9450 This file contains a list of configuration files which
9451 are to be handled automatically by <prgn>dpkg</prgn>
9452 (see <ref id="pkg-conffiles">). Note that not necessarily
9453 every configuration file should be listed here.
9456 <tag><tt>shlibs</tt>
9459 This file contains a list of the shared libraries
9460 supplied by the package, with dependency details for
9461 each. This is used by <prgn>dpkg-shlibdeps</prgn>
9462 when it determines what dependencies are required in a
9463 package control file. The <tt>shlibs</tt> file format
9464 is described on <ref id="shlibs">.
9469 <sect id="pkg-controlfile">
9470 <heading>The main control information file: <tt>control</tt></heading>
9473 The most important control information file used by
9474 <prgn>dpkg</prgn> when it installs a package is
9475 <tt>control</tt>. It contains all the package's "vital
9480 The binary package control files of packages built from
9481 Debian sources are made by a special tool,
9482 <prgn>dpkg-gencontrol</prgn>, which reads
9483 <file>debian/control</file> and <file>debian/changelog</file> to
9484 find the information it needs. See <ref id="pkg-sourcepkg"> for
9489 The fields in binary package control files are listed in
9490 <ref id="binarycontrolfiles">.
9494 A description of the syntax of control files and the purpose
9495 of the fields is available in <ref id="controlfields">.
9500 <heading>Time Stamps</heading>
9503 See <ref id="timestamps">.
9508 <appendix id="pkg-sourcepkg">
9509 <heading>Source packages (from old Packaging Manual) </heading>
9512 The Debian binary packages in the distribution are generated
9513 from Debian sources, which are in a special format to assist
9514 the easy and automatic building of binaries.
9517 <sect id="pkg-sourcetools">
9518 <heading>Tools for processing source packages</heading>
9521 Various tools are provided for manipulating source packages;
9522 they pack and unpack sources and help build of binary
9523 packages and help manage the distribution of new versions.
9527 They are introduced and typical uses described here; see
9528 <manref name="dpkg-source" section="1"> for full
9529 documentation about their arguments and operation.
9533 For examples of how to construct a Debian source package,
9534 and how to use those utilities that are used by Debian
9535 source packages, please see the <prgn>hello</prgn> example
9539 <sect1 id="pkg-dpkg-source">
9541 <prgn>dpkg-source</prgn> - packs and unpacks Debian source
9546 This program is frequently used by hand, and is also
9547 called from package-independent automated building scripts
9548 such as <prgn>dpkg-buildpackage</prgn>.
9552 To unpack a package it is typically invoked with
9554 dpkg-source -x <var>.../path/to/filename</var>.dsc
9559 with the <file><var>filename</var>.tar.gz</file> and
9560 <file><var>filename</var>.diff.gz</file> (if applicable) in
9561 the same directory. It unpacks into
9562 <file><var>package</var>-<var>version</var></file>, and if
9564 <file><var>package</var>-<var>version</var>.orig</file>, in
9565 the current directory.
9569 To create a packed source archive it is typically invoked:
9571 dpkg-source -b <var>package</var>-<var>version</var>
9576 This will create the <file>.dsc</file>, <file>.tar.gz</file> and
9577 <file>.diff.gz</file> (if appropriate) in the current
9578 directory. <prgn>dpkg-source</prgn> does not clean the
9579 source tree first - this must be done separately if it is
9584 See also <ref id="pkg-sourcearchives">.</p>
9588 <sect1 id="pkg-dpkg-buildpackage">
9590 <prgn>dpkg-buildpackage</prgn> - overall package-building
9595 <prgn>dpkg-buildpackage</prgn> is a script which invokes
9596 <prgn>dpkg-source</prgn>, the <file>debian/rules</file>
9597 targets <tt>clean</tt>, <tt>build</tt> and
9598 <tt>binary</tt>, <prgn>dpkg-genchanges</prgn> and
9599 <prgn>gpg</prgn> (or <prgn>pgp</prgn>) to build a signed
9600 source and binary package upload.
9604 It is usually invoked by hand from the top level of the
9605 built or unbuilt source directory. It may be invoked with
9606 no arguments; useful arguments include:
9607 <taglist compact="compact">
9608 <tag><tt>-uc</tt>, <tt>-us</tt></tag>
9611 Do not sign the <tt>.changes</tt> file or the
9612 source package <tt>.dsc</tt> file, respectively.</p>
9614 <tag><tt>-p<var>sign-command</var></tt></tag>
9617 Invoke <var>sign-command</var> instead of finding
9618 <tt>gpg</tt> or <tt>pgp</tt> on the <prgn>PATH</prgn>.
9619 <var>sign-command</var> must behave just like
9620 <prgn>gpg</prgn> or <tt>pgp</tt>.</p>
9622 <tag><tt>-r<var>root-command</var></tt></tag>
9625 When root privilege is required, invoke the command
9626 <var>root-command</var>. <var>root-command</var>
9627 should invoke its first argument as a command, from
9628 the <prgn>PATH</prgn> if necessary, and pass its
9629 second and subsequent arguments to the command it
9630 calls. If no <var>root-command</var> is supplied
9631 then <var>dpkg-buildpackage</var> will take no
9632 special action to gain root privilege, so that for
9633 most packages it will have to be invoked as root to
9636 <tag><tt>-b</tt>, <tt>-B</tt></tag>
9639 Two types of binary-only build and upload - see
9640 <manref name="dpkg-source" section="1">.
9647 <sect1 id="pkg-dpkg-gencontrol">
9649 <prgn>dpkg-gencontrol</prgn> - generates binary package
9654 This program is usually called from <file>debian/rules</file>
9655 (see <ref id="pkg-sourcetree">) in the top level of the source
9660 This is usually done just before the files and directories in the
9661 temporary directory tree where the package is being built have their
9662 permissions and ownerships set and the package is constructed using
9663 <prgn>dpkg-deb/</prgn>
9665 This is so that the control file which is produced has
9666 the right permissions
9671 <prgn>dpkg-gencontrol</prgn> must be called after all the
9672 files which are to go into the package have been placed in
9673 the temporary build directory, so that its calculation of
9674 the installed size of a package is correct.
9678 It is also necessary for <prgn>dpkg-gencontrol</prgn> to
9679 be run after <prgn>dpkg-shlibdeps</prgn> so that the
9680 variable substitutions created by
9681 <prgn>dpkg-shlibdeps</prgn> in <file>debian/substvars</file>
9686 For a package which generates only one binary package, and
9687 which builds it in <file>debian/tmp</file> relative to the top
9688 of the source package, it is usually sufficient to call
9689 <prgn>dpkg-gencontrol</prgn>.
9693 Sources which build several binaries will typically need
9696 dpkg-gencontrol -Pdebian/tmp-<var>pkg</var> -p<var>package</var>
9697 </example> The <tt>-P</tt> tells
9698 <prgn>dpkg-gencontrol</prgn> that the package is being
9699 built in a non-default directory, and the <tt>-p</tt>
9700 tells it which package's control file should be generated.
9704 <prgn>dpkg-gencontrol</prgn> also adds information to the
9705 list of files in <file>debian/files</file>, for the benefit of
9706 (for example) a future invocation of
9707 <prgn>dpkg-genchanges</prgn>.</p>
9710 <sect1 id="pkg-dpkg-shlibdeps">
9712 <prgn>dpkg-shlibdeps</prgn> - calculates shared library
9717 This program is usually called from <file>debian/rules</file>
9718 just before <prgn>dpkg-gencontrol</prgn> (see <ref
9719 id="pkg-sourcetree">), in the top level of the source tree.
9723 Its arguments are executables and shared libraries
9726 They may be specified either in the locations in the
9727 source tree where they are created or in the locations
9728 in the temporary build tree where they are installed
9729 prior to binary package creation.
9731 </footnote> for which shared library dependencies should
9732 be included in the binary package's control file.
9736 If some of the found shared libraries should only
9737 warrant a <tt>Recommends</tt> or <tt>Suggests</tt>, or if
9738 some warrant a <tt>Pre-Depends</tt>, this can be achieved
9739 by using the <tt>-d<var>dependency-field</var></tt> option
9740 before those executable(s). (Each <tt>-d</tt> option
9741 takes effect until the next <tt>-d</tt>.)
9745 <prgn>dpkg-shlibdeps</prgn> does not directly cause the
9746 output control file to be modified. Instead by default it
9747 adds to the <file>debian/substvars</file> file variable
9748 settings like <tt>shlibs:Depends</tt>. These variable
9749 settings must be referenced in dependency fields in the
9750 appropriate per-binary-package sections of the source
9755 For example, a package that generates an essential part
9756 which requires dependencies, and optional parts that
9757 which only require a recommendation, would separate those
9758 two sets of dependencies into two different fields.<footnote>
9759 At the time of writing, an example for this was the
9760 <package/xmms/ package, with Depends used for the xmms
9761 executable, Recommends for the plug-ins and Suggests for
9762 even more optional features provided by unzip.
9764 It can say in its <file>debian/rules</file>:
9766 dpkg-shlibdeps -dDepends <var>program anotherprogram ...</var> \
9767 -dRecommends <var>optionalpart anotheroptionalpart</var>
9769 and then in its main control file <file>debian/control</file>:
9772 Depends: ${shlibs:Depends}
9773 Recommends: ${shlibs:Recommends}
9779 Sources which produce several binary packages with
9780 different shared library dependency requirements can use
9781 the <tt>-p<var>varnameprefix</var></tt> option to override
9782 the default <tt>shlibs:</tt> prefix (one invocation of
9783 <prgn>dpkg-shlibdeps</prgn> per setting of this option).
9784 They can thus produce several sets of dependency
9785 variables, each of the form
9786 <tt><var>varnameprefix</var>:<var>dependencyfield</var></tt>,
9787 which can be referred to in the appropriate parts of the
9788 binary package control files.
9793 <sect1 id="pkg-dpkg-distaddfile">
9795 <prgn>dpkg-distaddfile</prgn> - adds a file to
9796 <file>debian/files</file>
9800 Some packages' uploads need to include files other than
9801 the source and binary package files.
9805 <prgn>dpkg-distaddfile</prgn> adds a file to the
9806 <file>debian/files</file> file so that it will be included in
9807 the <file>.changes</file> file when
9808 <prgn>dpkg-genchanges</prgn> is run.
9812 It is usually invoked from the <tt>binary</tt> target of
9813 <file>debian/rules</file>:
9815 dpkg-distaddfile <var>filename</var> <var>section</var> <var>priority</var>
9817 The <var>filename</var> is relative to the directory where
9818 <prgn>dpkg-genchanges</prgn> will expect to find it - this
9819 is usually the directory above the top level of the source
9820 tree. The <file>debian/rules</file> target should put the
9821 file there just before or just after calling
9822 <prgn>dpkg-distaddfile</prgn>.
9826 The <var>section</var> and <var>priority</var> are passed
9827 unchanged into the resulting <file>.changes</file> file.
9832 <sect1 id="pkg-dpkg-genchanges">
9834 <prgn>dpkg-genchanges</prgn> - generates a <file>.changes</file>
9839 This program is usually called by package-independent
9840 automatic building scripts such as
9841 <prgn>dpkg-buildpackage</prgn>, but it may also be called
9846 It is usually called in the top level of a built source
9847 tree, and when invoked with no arguments will print out a
9848 straightforward <file>.changes</file> file based on the
9849 information in the source package's changelog and control
9850 file and the binary and source packages which should have
9856 <sect1 id="pkg-dpkg-parsechangelog">
9858 <prgn>dpkg-parsechangelog</prgn> - produces parsed
9859 representation of a changelog
9863 This program is used internally by
9864 <prgn>dpkg-source</prgn> et al. It may also occasionally
9865 be useful in <file>debian/rules</file> and elsewhere. It
9866 parses a changelog, <file>debian/changelog</file> by default,
9867 and prints a control-file format representation of the
9868 information in it to standard output.
9872 <sect1 id="pkg-dpkg-architecture">
9874 <prgn>dpkg-architecture</prgn> - information about the build and
9879 This program can be used manually, but is also invoked by
9880 <tt>dpkg-buildpackage</tt> or <file>debian/rules</file> to set
9881 environment or make variables which specify the build and host
9882 architecture for the package building process.
9887 <sect id="pkg-sourcetree">
9888 <heading>The Debianised source tree</heading>
9891 The source archive scheme described later is intended to
9892 allow a Debianised source tree with some associated control
9893 information to be reproduced and transported easily. The
9894 Debianised source tree is a version of the original program
9895 with certain files added for the benefit of the
9896 Debianisation process, and with any other changes required
9897 made to the rest of the source code and installation
9902 The extra files created for Debian are in the subdirectory
9903 <file>debian</file> of the top level of the Debianised source
9904 tree. They are described below.
9907 <sect1 id="pkg-debianrules">
9908 <heading><file>debian/rules</file> - the main building script</heading>
9911 See <ref id="debianrules">.
9916 <sect1 id="pkg-dpkgchangelog">
9917 <heading><file>debian/changelog</file></heading>
9920 See <ref id="dpkgchangelog">.
9923 <sect2><heading>Defining alternative changelog formats
9927 It is possible to use a different format to the standard
9928 one, by providing a parser for the format you wish to
9933 In order to have <tt>dpkg-parsechangelog</tt> run your
9934 parser, you must include a line within the last 40 lines
9935 of your file matching the Perl regular expression:
9936 <tt>\schangelog-format:\s+([0-9a-z]+)\W</tt> The part in
9937 parentheses should be the name of the format. For
9938 example, you might say:
9940 @@@ changelog-format: joebloggs @@@
9942 Changelog format names are non-empty strings of alphanumerics.
9946 If such a line exists then <tt>dpkg-parsechangelog</tt>
9947 will look for the parser as
9948 <file>/usr/lib/dpkg/parsechangelog/<var>format-name</var></file>
9950 <file>/usr/local/lib/dpkg/parsechangelog/<var>format-name</var></file>;
9951 it is an error for it not to find it, or for it not to
9952 be an executable program. The default changelog format
9953 is <tt>dpkg</tt>, and a parser for it is provided with
9954 the <tt>dpkg</tt> package.
9958 The parser will be invoked with the changelog open on
9959 standard input at the start of the file. It should read
9960 the file (it may seek if it wishes) to determine the
9961 information required and return the parsed information
9962 to standard output in the form of a series of control
9963 fields in the standard format. By default it should
9964 return information about only the most recent version in
9965 the changelog; it should accept a
9966 <tt>-v<var>version</var></tt> option to return changes
9967 information from all versions present <em>strictly
9968 after</em> <var>version</var>, and it should then be an
9969 error for <var>version</var> not to be present in the
9975 <list compact="compact">
9976 <item><qref id="f-Source"><tt>Source</tt></qref></item>
9977 <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
9978 <item><qref id="f-Distribution"><tt>Distribution</tt></qref> (mandatory)</item>
9979 <item><qref id="f-Urgency"><tt>Urgency</tt></qref> (mandatory)</item>
9980 <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
9981 <item><qref id="f-Date"><tt>Date</tt></qref></item>
9982 <item><qref id="f-Changes"><tt>Changes</tt></qref> (mandatory)</item>
9987 If several versions are being returned (due to the use
9988 of <tt>-v</tt>), the urgency value should be of the
9989 highest urgency code listed at the start of any of the
9990 versions requested followed by the concatenated
9991 (space-separated) comments from all the versions
9992 requested; the maintainer, version, distribution and
9993 date should always be from the most recent version.
9997 For the format of the <tt>Changes</tt> field see
9998 <ref id="f-Changes">.
10002 If the changelog format which is being parsed always or
10003 almost always leaves a blank line between individual
10004 change notes these blank lines should be stripped out,
10005 so as to make the resulting output compact.
10009 If the changelog format does not contain date or package
10010 name information this information should be omitted from
10011 the output. The parser should not attempt to synthesize
10012 it or find it from other sources.
10016 If the changelog does not have the expected format the
10017 parser should exit with a nonzero exit status, rather
10018 than trying to muddle through and possibly generating
10023 A changelog parser may not interact with the user at
10029 <sect1 id="pkg-srcsubstvars">
10030 <heading><file>debian/substvars</file> and variable substitutions</heading>
10033 See <ref id="substvars">.
10039 <heading><file>debian/files</file></heading>
10042 See <ref id="debianfiles">.
10046 <sect1><heading><file>debian/tmp</file>
10050 This is the canonical temporary location for the
10051 construction of binary packages by the <tt>binary</tt>
10052 target. The directory <file>tmp</file> serves as the root of
10053 the file system tree as it is being constructed (for
10054 example, by using the package's upstream makefiles install
10055 targets and redirecting the output there), and it also
10056 contains the <tt>DEBIAN</tt> subdirectory. See <ref
10057 id="pkg-bincreating">.
10061 If several binary packages are generated from the same
10062 source tree it is usual to use several
10063 <file>debian/tmp<var>something</var></file> directories, for
10064 example <file>tmp-a</file> or <file>tmp-doc</file>.
10068 Whatever <file>tmp</file> directories are created and used by
10069 <tt>binary</tt> must of course be removed by the
10070 <tt>clean</tt> target.</p></sect1>
10074 <sect id="pkg-sourcearchives"><heading>Source packages as archives
10078 As it exists on the FTP site, a Debian source package
10079 consists of three related files. You must have the right
10080 versions of all three to be able to use them.
10085 <tag>Debian source control file - <tt>.dsc</tt></tag>
10087 This file is a control file used by <prgn>dpkg-source</prgn>
10088 to extract a source package.
10089 See <ref id="debiansourcecontrolfiles">.
10093 Original source archive -
10095 <var>package</var>_<var>upstream-version</var>.orig.tar.gz
10101 This is a compressed (with <tt>gzip -9</tt>)
10102 <prgn>tar</prgn> file containing the source code from
10103 the upstream authors of the program.
10108 Debianisation diff -
10110 <var>package</var>_<var>upstream_version-revision</var>.diff.gz
10116 This is a unified context diff (<tt>diff -u</tt>)
10117 giving the changes which are required to turn the
10118 original source into the Debian source. These changes
10119 may only include editing and creating plain files.
10120 The permissions of files, the targets of symbolic
10121 links and the characteristics of special files or
10122 pipes may not be changed and no files may be removed
10127 All the directories in the diff must exist, except the
10128 <file>debian</file> subdirectory of the top of the source
10129 tree, which will be created by
10130 <prgn>dpkg-source</prgn> if necessary when unpacking.
10134 The <prgn>dpkg-source</prgn> program will
10135 automatically make the <file>debian/rules</file> file
10136 executable (see below).</p></item>
10141 If there is no original source code - for example, if the
10142 package is specially prepared for Debian or the Debian
10143 maintainer is the same as the upstream maintainer - the
10144 format is slightly different: then there is no diff, and the
10146 <file><var>package</var>_<var>version</var>.tar.gz</file>,
10147 and preferably contains a directory named
10148 <file><var>package</var>-<var>version</var></file>.
10153 <heading>Unpacking a Debian source package without <prgn>dpkg-source</prgn></heading>
10156 <tt>dpkg-source -x</tt> is the recommended way to unpack a
10157 Debian source package. However, if it is not available it
10158 is possible to unpack a Debian source archive as follows:
10159 <enumlist compact="compact">
10162 Untar the tarfile, which will create a <file>.orig</file>
10166 <p>Rename the <file>.orig</file> directory to
10167 <file><var>package</var>-<var>version</var></file>.</p>
10171 Create the subdirectory <file>debian</file> at the top of
10172 the source tree.</p>
10174 <item><p>Apply the diff using <tt>patch -p0</tt>.</p>
10176 <item><p>Untar the tarfile again if you want a copy of the original
10177 source code alongside the Debianised version.</p>
10182 It is not possible to generate a valid Debian source archive
10183 without using <prgn>dpkg-source</prgn>. In particular,
10184 attempting to use <prgn>diff</prgn> directly to generate the
10185 <file>.diff.gz</file> file will not work.
10189 <heading>Restrictions on objects in source packages</heading>
10192 The source package may not contain any hard links
10194 This is not currently detected when building source
10195 packages, but only when extracting
10199 Hard links may be permitted at some point in the
10200 future, but would require a fair amount of
10202 </footnote>, device special files, sockets or setuid or
10205 Setgid directories are allowed.
10210 The source packaging tools manage the changes between the
10211 original and Debianised source using <prgn>diff</prgn> and
10212 <prgn>patch</prgn>. Turning the original source tree as
10213 included in the <file>.orig.tar.gz</file> into the debianised
10214 source must not involve any changes which cannot be
10215 handled by these tools. Problematic changes which cause
10216 <prgn>dpkg-source</prgn> to halt with an error when
10217 building the source package are:
10218 <list compact="compact">
10219 <item><p>Adding or removing symbolic links, sockets or pipes.</p>
10221 <item><p>Changing the targets of symbolic links.</p>
10223 <item><p>Creating directories, other than <file>debian</file>.</p>
10225 <item><p>Changes to the contents of binary files.</p></item>
10226 </list> Changes which cause <prgn>dpkg-source</prgn> to
10227 print a warning but continue anyway are:
10228 <list compact="compact">
10231 Removing files, directories or symlinks.
10233 Renaming a file is not treated specially - it is
10234 seen as the removal of the old file (which
10235 generates a warning, but is otherwise ignored),
10236 and the creation of the new one.
10242 Changed text files which are missing the usual final
10243 newline (either in the original or the modified
10248 Changes which are not represented, but which are not detected by
10249 <prgn>dpkg-source</prgn>, are:
10250 <list compact="compact">
10251 <item><p>Changing the permissions of files (other than
10252 <file>debian/rules</file>) and directories.</p></item>
10257 The <file>debian</file> directory and <file>debian/rules</file>
10258 are handled specially by <prgn>dpkg-source</prgn> - before
10259 applying the changes it will create the <file>debian</file>
10260 directory, and afterwards it will make
10261 <file>debian/rules</file> world-executable.
10267 <appendix id="pkg-controlfields">
10268 <heading>Control files and their fields (from old Packaging Manual)</heading>
10271 Many of the tools in the <prgn>dpkg</prgn> suite manipulate
10272 data in a common format, known as control files. Binary and
10273 source packages have control data as do the <file>.changes</file>
10274 files which control the installation of uploaded files, and
10275 <prgn>dpkg</prgn>'s internal databases are in a similar
10280 <heading>Syntax of control files</heading>
10283 See <ref id="controlsyntax">.
10287 It is important to note that there are several fields which
10288 are optional as far as <prgn>dpkg</prgn> and the related
10289 tools are concerned, but which must appear in every Debian
10290 package, or whose omission may cause problems.
10295 <heading>List of fields</heading>
10298 See <ref id="controlfieldslist">.
10302 This section now contains only the fields that didn't belong
10303 to the Policy manual.
10306 <sect1 id="pkg-f-Filename">
10307 <heading><tt>Filename</tt> and <tt>MSDOS-Filename</tt></heading>
10310 These fields in <tt>Packages</tt> files give the
10311 filename(s) of (the parts of) a package in the
10312 distribution directories, relative to the root of the
10313 Debian hierarchy. If the package has been split into
10314 several parts the parts are all listed in order, separated
10319 <sect1 id="pkg-f-Size">
10320 <heading><tt>Size</tt> and <tt>MD5sum</tt></heading>
10323 These fields in <file>Packages</file> files give the size (in
10324 bytes, expressed in decimal) and MD5 checksum of the
10325 file(s) which make(s) up a binary package in the
10326 distribution. If the package is split into several parts
10327 the values for the parts are listed in order, separated by
10332 <sect1 id="pkg-f-Status">
10333 <heading><tt>Status</tt></heading>
10336 This field in <prgn>dpkg</prgn>'s status file records
10337 whether the user wants a package installed, removed or
10338 left alone, whether it is broken (requiring
10339 re-installation) or not and what its current state on the
10340 system is. Each of these pieces of information is a
10345 <sect1 id="pkg-f-Config-Version">
10346 <heading><tt>Config-Version</tt></heading>
10349 If a package is not installed or not configured, this
10350 field in <prgn>dpkg</prgn>'s status file records the last
10351 version of the package which was successfully
10356 <sect1 id="pkg-f-Conffiles">
10357 <heading><tt>Conffiles</tt></heading>
10360 This field in <prgn>dpkg</prgn>'s status file contains
10361 information about the automatically-managed configuration
10362 files held by a package. This field should <em>not</em>
10363 appear anywhere in a package!
10368 <heading>Obsolete fields</heading>
10371 These are still recognized by <prgn>dpkg</prgn> but should
10372 not appear anywhere any more.
10374 <taglist compact="compact">
10376 <tag><tt>Revision</tt></tag>
10377 <tag><tt>Package-Revision</tt></tag>
10378 <tag><tt>Package_Revision</tt></tag>
10380 The Debian revision part of the package version was
10381 at one point in a separate control file field. This
10382 field went through several names.
10385 <tag><tt>Recommended</tt></tag>
10386 <item>Old name for <tt>Recommends</tt>.</item>
10388 <tag><tt>Optional</tt></tag>
10389 <item>Old name for <tt>Suggests</tt>.</item>
10391 <tag><tt>Class</tt></tag>
10392 <item>Old name for <tt>Priority</tt>.</item>
10401 <appendix id="pkg-conffiles">
10402 <heading>Configuration file handling (from old Packaging Manual)</heading>
10405 <prgn>dpkg</prgn> can do a certain amount of automatic
10406 handling of package configuration files.
10410 Whether this mechanism is appropriate depends on a number of
10411 factors, but basically there are two approaches to any
10412 particular configuration file.
10416 The easy method is to ship a best-effort configuration in the
10417 package, and use <prgn>dpkg</prgn>'s conffile mechanism to
10418 handle updates. If the user is unlikely to want to edit the
10419 file, but you need them to be able to without losing their
10420 changes, and a new package with a changed version of the file
10421 is only released infrequently, this is a good approach.
10425 The hard method is to build the configuration file from
10426 scratch in the <prgn>postinst</prgn> script, and to take the
10427 responsibility for fixing any mistakes made in earlier
10428 versions of the package automatically. This will be
10429 appropriate if the file is likely to need to be different on
10433 <sect><heading>Automatic handling of configuration files by
10438 A package may contain a control area file called
10439 <tt>conffiles</tt>. This file should be a list of filenames
10440 of configuration files needing automatic handling, separated
10441 by newlines. The filenames should be absolute pathnames,
10442 and the files referred to should actually exist in the
10447 When a package is upgraded <prgn>dpkg</prgn> will process
10448 the configuration files during the configuration stage,
10449 shortly before it runs the package's <prgn>postinst</prgn>
10454 For each file it checks to see whether the version of the
10455 file included in the package is the same as the one that was
10456 included in the last version of the package (the one that is
10457 being upgraded from); it also compares the version currently
10458 installed on the system with the one shipped with the last
10463 If neither the user nor the package maintainer has changed
10464 the file, it is left alone. If one or the other has changed
10465 their version, then the changed version is preferred - i.e.,
10466 if the user edits their file, but the package maintainer
10467 doesn't ship a different version, the user's changes will
10468 stay, silently, but if the maintainer ships a new version
10469 and the user hasn't edited it the new version will be
10470 installed (with an informative message). If both have
10471 changed their version the user is prompted about the problem
10472 and must resolve the differences themselves.
10476 The comparisons are done by calculating the MD5 message
10477 digests of the files, and storing the MD5 of the file as it
10478 was included in the most recent version of the package.
10482 When a package is installed for the first time
10483 <prgn>dpkg</prgn> will install the file that comes with it,
10484 unless that would mean overwriting a file already on the
10489 However, note that <prgn>dpkg</prgn> will <em>not</em>
10490 replace a conffile that was removed by the user (or by a
10491 script). This is necessary because with some programs a
10492 missing file produces an effect hard or impossible to
10493 achieve in another way, so that a missing file needs to be
10494 kept that way if the user did it.
10498 Note that a package should <em>not</em> modify a
10499 <prgn>dpkg</prgn>-handled conffile in its maintainer
10500 scripts. Doing this will lead to <prgn>dpkg</prgn> giving
10501 the user confusing and possibly dangerous options for
10502 conffile update when the package is upgraded.</p>
10505 <sect><heading>Fully-featured maintainer script configuration
10510 For files which contain site-specific information such as
10511 the hostname and networking details and so forth, it is
10512 better to create the file in the package's
10513 <prgn>postinst</prgn> script.
10517 This will typically involve examining the state of the rest
10518 of the system to determine values and other information, and
10519 may involve prompting the user for some information which
10520 can't be obtained some other way.
10524 When using this method there are a couple of important
10525 issues which should be considered:
10529 If you discover a bug in the program which generates the
10530 configuration file, or if the format of the file changes
10531 from one version to the next, you will have to arrange for
10532 the postinst script to do something sensible - usually this
10533 will mean editing the installed configuration file to remove
10534 the problem or change the syntax. You will have to do this
10535 very carefully, since the user may have changed the file,
10536 perhaps to fix the very problem that your script is trying
10537 to deal with - you will have to detect these situations and
10538 deal with them correctly.
10542 If you do go down this route it's probably a good idea to
10543 make the program that generates the configuration file(s) a
10544 separate program in <file>/usr/sbin</file>, by convention called
10545 <file><var>package</var>config</file> and then run that if
10546 appropriate from the post-installation script. The
10547 <tt><var>package</var>config</tt> program should not
10548 unquestioningly overwrite an existing configuration - if its
10549 mode of operation is geared towards setting up a package for
10550 the first time (rather than any arbitrary reconfiguration
10551 later) you should have it check whether the configuration
10552 already exists, and require a <tt>--force</tt> flag to
10553 overwrite it.</p></sect>
10556 <appendix id="pkg-alternatives"><heading>Alternative versions of
10557 an interface - <prgn>update-alternatives</prgn> (from old
10562 When several packages all provide different versions of the
10563 same program or file it is useful to have the system select a
10564 default, but to allow the system administrator to change it
10565 and have their decisions respected.
10569 For example, there are several versions of the <prgn>vi</prgn>
10570 editor, and there is no reason to prevent all of them from
10571 being installed at once, each under their own name
10572 (<prgn>nvi</prgn>, <prgn>vim</prgn> or whatever).
10573 Nevertheless it is desirable to have the name <tt>vi</tt>
10574 refer to something, at least by default.
10578 If all the packages involved cooperate, this can be done with
10579 <prgn>update-alternatives</prgn>.
10583 Each package provides its own version under its own name, and
10584 calls <prgn>update-alternatives</prgn> in its postinst to
10585 register its version (and again in its prerm to deregister
10590 See the man page <manref name="update-alternatives"
10591 section="8"> for details.
10595 If <prgn>update-alternatives</prgn> does not seem appropriate
10596 you may wish to consider using diversions instead.</p>
10599 <appendix id="pkg-diversions"><heading>Diversions - overriding a
10600 package's version of a file (from old Packaging Manual)
10604 It is possible to have <prgn>dpkg</prgn> not overwrite a file
10605 when it reinstalls the package it belongs to, and to have it
10606 put the file from the package somewhere else instead.
10610 This can be used locally to override a package's version of a
10611 file, or by one package to override another's version (or
10612 provide a wrapper for it).
10616 Before deciding to use a diversion, read <ref
10617 id="pkg-alternatives"> to see if you really want a diversion
10618 rather than several alternative versions of a program.
10622 There is a diversion list, which is read by <prgn>dpkg</prgn>,
10623 and updated by a special program <prgn>dpkg-divert</prgn>.
10624 Please see <manref name="dpkg-divert" section="8"> for full
10625 details of its operation.
10629 When a package wishes to divert a file from another, it should
10630 call <prgn>dpkg-divert</prgn> in its preinst to add the
10631 diversion and rename the existing file. For example,
10632 supposing that a <prgn>smailwrapper</prgn> package wishes to
10633 install a wrapper around <file>/usr/sbin/smail</file>:
10635 dpkg-divert --package smailwrapper --add --rename \
10636 --divert /usr/sbin/smail.real /usr/sbin/smail
10637 </example> The <tt>--package smailwrapper</tt> ensures that
10638 <prgn>smailwrapper</prgn>'s copy of <file>/usr/sbin/smail</file>
10639 can bypass the diversion and get installed as the true version.
10640 It's safe to add the diversion unconditionally on upgrades since
10641 it will be left unchanged if it already exists, but
10642 <prgn>dpkg-divert</prgn> will display a message. To suppress that
10643 message, make the command conditional on the version from which
10644 the package is being upgraded:
10646 if [ upgrade != "$1" ] || dpkg --compare-versions "$2" lt 1.0-2; then
10647 dpkg-divert --package smailwrapper --add --rename \
10648 --divert /usr/sbin/smail.real /usr/sbin/smail
10650 </example> where <tt>1.0-2</tt> is the version at which the
10651 diversion was first added to the package. Running the command
10652 during abort-upgrade is pointless but harmless.
10656 The postrm has to do the reverse:
10658 if [ remove = "$1" -o abort-install = "$1" -o disappear = "$1" ]; then
10659 dpkg-divert --package smailwrapper --remove --rename \
10660 --divert /usr/sbin/smail.real /usr/sbin/smail
10662 </example> If the diversion was added at a particular version, the
10663 postrm should also handle the failure case of upgrading from an
10664 older version (unless the older version is so old that direct
10665 upgrades are no longer supported):
10667 if [ abort-upgrade = "$1" ] && dpkg --compare-versions "$2" lt 1.0-2; then
10668 dpkg-divert --package smailwrapper --remove --rename \
10669 --divert /usr/sbin/smail.real /usr/sbin/smail
10671 </example> where <tt>1.02-2</tt> is the version at which the
10672 diversion was first added to the package. The postrm should not
10673 remove the diversion on upgrades both because there's no reason to
10674 remove the diversion only to immediately re-add it and since the
10675 postrm of the old package is run after unpacking so the removal of
10676 the diversion will fail.
10680 Do not attempt to divert a file which is vitally important for
10681 the system's operation - when using <prgn>dpkg-divert</prgn>
10682 there is a time, after it has been diverted but before
10683 <prgn>dpkg</prgn> has installed the new version, when the file
10684 does not exist.</p>
10689 <!-- Local variables: -->
10690 <!-- indent-tabs-mode: t -->
10692 <!-- vim:set ai et sts=2 sw=2 tw=76: -->