]> git.donarmstrong.com Git - debian/debian-policy.git/blob - policy.sgml
bf959f1250ebb1ace0393af83da4c9999eda2b41
[debian/debian-policy.git] / policy.sgml
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;
5 <!-- current Debian changes file format -->
6 <!entity changesversion "1.8">
7 ]>
8 <debiandoc>
9
10   <book>
11     <titlepag>
12       <title>Debian Policy Manual</title>
13       <author><qref id="authors">The Debian Policy Mailing List</qref></author>
14       <version>version &version;, &date;</version>
15
16       <abstract>
17         This manual describes the policy requirements for the Debian
18         distribution.  This includes the structure and
19         contents of the Debian archive and several design issues of
20         the operating system, as well as technical requirements that
21         each package must satisfy to be included in the distribution.
22       </abstract>
23
24       <copyright>
25         <copyrightsummary>
26           Copyright &copy; 1996,1997,1998 Ian Jackson
27           and Christian Schwarz.
28         </copyrightsummary>
29         <p>
30           These are the copyright dates of the original Policy manual.
31           Since then, this manual has been updated by many others.  No
32           comprehensive collection of copyright notices for subsequent
33           work exists.
34         </p>
35
36         <p>
37           This manual is free software; you may redistribute it and/or
38           modify it under the terms of the GNU General Public License
39           as published by the Free Software Foundation; either version
40           2, or (at your option) any later version.
41         </p>
42
43         <p>
44           This is distributed in the hope that it will be useful, but
45           <em>without any warranty</em>; without even the implied
46           warranty of merchantability or fitness for a particular
47           purpose.  See the GNU General Public License for more
48           details.
49         </p>
50
51         <p>
52           A copy of the GNU General Public License is available as
53           <file>/usr/share/common-licenses/GPL</file> in the Debian
54           distribution or on the World Wide Web at
55           <url id="http://www.gnu.org/copyleft/gpl.html"
56                name="the GNU General Public Licence">. You can also
57           obtain it by writing to the Free Software Foundation, Inc.,
58           51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
59         </p>
60       </copyright>
61     </titlepag>
62
63     <toc detail="sect1">
64
65     <chapt id="scope">
66       <heading>About this manual</heading>
67       <sect>
68         <heading>Scope</heading>
69         <p>
70           This manual describes the policy requirements for the Debian
71           distribution. This includes the structure and
72           contents of the Debian archive and several design issues of the
73           operating system, as well as technical requirements that
74           each package must satisfy to be included in the
75           distribution.
76         </p>
77
78         <p>
79           This manual also describes Debian policy as it relates to
80           creating Debian packages. It is not a tutorial on how to build
81           packages, nor is it exhaustive where it comes to describing
82           the behavior of the packaging system. Instead, this manual
83           attempts to define the interface to the package management
84           system that the developers have to be conversant with.<footnote>
85               Informally, the criteria used for inclusion is that the
86               material meet one of the following requirements:
87               <taglist compact="compact">
88                 <tag>Standard interfaces</tag>
89                 <item>
90                     The material presented represents an interface to
91                     the packaging system that is mandated for use, and
92                     is used by, a significant number of packages, and
93                     therefore should not be changed without peer
94                     review. Package maintainers can then rely on this
95                     interface not changing, and the package management
96                     software authors need to ensure compatibility with
97                     this interface definition. (Control file and
98                     changelog file formats are examples.)
99                 </item>
100                 <tag>Chosen Convention</tag>
101                 <item>
102                     If there are a number of technically viable choices
103                     that can be made, but one needs to select one of
104                     these options for inter-operability. The version
105                     number format is one example.
106                 </item>
107               </taglist>
108               Please note that these are not mutually exclusive;
109               selected conventions often become parts of standard
110               interfaces.
111           </footnote>
112         </p>
113
114         <p>
115           The footnotes present in this manual are
116           merely informative, and are not part of Debian policy itself.
117         </p>
118
119         <p>
120           The appendices to this manual are not necessarily normative,
121           either. Please see <ref id="pkg-scope"> for more information.
122         </p>
123
124         <p>
125           In the normative part of this manual,
126           the words <em>must</em>, <em>should</em> and
127           <em>may</em>, and the adjectives <em>required</em>,
128           <em>recommended</em> and <em>optional</em>, are used to
129           distinguish the significance of the various guidelines in
130           this policy document. Packages that do not conform to the
131           guidelines denoted by <em>must</em> (or <em>required</em>)
132           will generally not be considered acceptable for the Debian
133           distribution. Non-conformance with guidelines denoted by
134           <em>should</em> (or <em>recommended</em>) will generally be
135           considered a bug, but will not necessarily render a package
136           unsuitable for distribution. Guidelines denoted by
137           <em>may</em> (or <em>optional</em>) are truly optional and
138           adherence is left to the maintainer's discretion.
139         </p>
140
141         <p>
142           These classifications are roughly equivalent to the bug
143           severities <em>serious</em> (for <em>must</em> or
144           <em>required</em> directive violations), <em>minor</em>,
145           <em>normal</em> or <em>important</em>
146           (for <em>should</em> or <em>recommended</em> directive
147           violations) and <em>wishlist</em> (for <em>optional</em>
148           items).
149           <footnote>
150                 Compare RFC 2119.  Note, however, that these words are
151                 used in a different way in this document.
152           </footnote>
153         </p>
154
155         <p>
156           Much of the information presented in this manual will be
157           useful even when building a package which is to be
158           distributed in some other way or is intended for local use
159           only.
160         </p>
161
162         <p>
163           udebs (stripped-down binary packages used by the Debian Installer) do
164           not comply with all of the requirements discussed here.  See the
165           <url name="Debian Installer internals manual"
166           id="http://d-i.alioth.debian.org/doc/internals/ch03.html"> for more
167           information about them.
168         </p>
169       </sect>
170
171       <sect>
172         <heading>New versions of this document</heading>
173
174         <p>
175           This manual is distributed via the Debian package
176           <package><url name="debian-policy"
177               id="http://packages.debian.org/debian-policy"></package> 
178           (<httpsite>packages.debian.org</httpsite> 
179           <httppath>/debian-policy</httppath>).
180         </p>
181
182         <p>
183           The current version of this document is also available from
184           the Debian web mirrors at
185           <tt><url name="/doc/debian-policy/"
186                 id="http://www.debian.org/doc/debian-policy/"></tt>.
187           (
188           <httpsite>www.debian.org</httpsite>
189           <httppath>/doc/debian-policy/</httppath>)
190           Also available from the same directory are several other
191           formats: <file>policy.html.tar.gz</file>
192           (<httppath>/doc/debian-policy/policy.html.tar.gz</httppath>),
193           <file>policy.pdf.gz</file> 
194           (<httppath>/doc/debian-policy/policy.pdf.gz</httppath>)
195           and <file>policy.ps.gz</file>
196           (<httppath>/doc/debian-policy/policy.ps.gz</httppath>).
197         </p>
198
199         <p>
200           The <package>debian-policy</package> package also includes the file
201           <file>upgrading-checklist.txt.gz</file> which indicates policy
202           changes between versions of this document.
203         </p>
204       </sect>
205
206       <sect id="authors">
207         <heading>Authors and Maintainers</heading>
208
209         <p>
210           Originally called "Debian GNU/Linux Policy Manual", this
211           manual was initially written in 1996 by Ian Jackson.
212           It was revised on November 27th, 1996 by David A. Morris.
213           Christian Schwarz added new sections on March 15th, 1997,
214           and reworked/restructured it in April-July 1997.
215           Christoph Lameter contributed the "Web Standard".
216           Julian Gilbey largely restructured it in 2001.
217         </p>
218
219         <p>
220           Since September 1998, the responsibility for the contents of
221           this document lies on the <url name="debian-policy mailing list"
222           id="mailto:debian-policy@lists.debian.org">. Proposals
223           are discussed there and inserted into policy after a certain
224           consensus is established.
225           <!-- insert shameless policy-process plug here eventually -->
226           The actual editing is done by a group of maintainers that have
227           no editorial powers. These are the current maintainers:
228
229           <enumlist>
230             <item>Russ Allbery</item>
231             <item>Bill Allombert</item>
232             <item>Andrew McMillan</item>
233             <item>Manoj Srivastava</item>
234             <item>Colin Watson</item>
235           </enumlist>
236         </p>
237
238         <p>
239           While the authors of this document have tried hard to avoid
240           typos and other errors, these do still occur. If you discover
241           an error in this manual or if you want to give any
242           comments, suggestions, or criticisms please send an email to
243           the Debian Policy List,
244           <email>debian-policy@lists.debian.org</email>, or submit a
245           bug report against the <tt>debian-policy</tt> package.
246         </p>
247
248         <p>
249           Please do not try to reach the individual authors or maintainers
250           of the Policy Manual regarding changes to the Policy.
251         </p>
252       </sect>
253
254       <sect id="related">
255         <heading>Related documents</heading>
256
257         <p>
258           There are several other documents other than this Policy Manual
259           that are necessary to fully understand some Debian policies and
260           procedures.
261         </p>
262
263         <p>
264           The external "sub-policy" documents are referred to in:
265           <list compact="compact">
266             <item><ref id="fhs"></item>
267             <item><ref id="virtual_pkg"></item>
268             <item><ref id="menus"></item>
269             <item><ref id="perl"></item>
270             <item><ref id="maintscriptprompt"></item>
271             <item><ref id="emacs"></item>
272           </list>
273         </p>
274
275         <p>
276           In addition to those, which carry the weight of policy, there
277           is the Debian Developer's Reference. This document describes
278           procedures and resources for Debian developers, but it is
279           <em>not</em> normative; rather, it includes things that don't
280           belong in the Policy, such as best practices for developers.
281         </p>
282
283         <p>
284           The Developer's Reference is available in the
285           <package>developers-reference</package> package.
286           It's also available from the Debian web mirrors at
287           <tt><url name="/doc/developers-reference/"
288                 id="http://www.debian.org/doc/developers-reference/"></tt>.
289         </p>
290
291         <p>
292           Finally, a <qref id="copyrightformat">specification for
293           machine-readable copyright files</qref> is maintained as part of
294           the <package>debian-policy</package> package using the same
295           procedure as the other policy documents.  Use of this format is
296           optional.
297         </p>
298       </sect>
299
300       <sect id="definitions">
301         <heading>Definitions</heading>
302
303         <p>
304           The following terms are used in this Policy Manual:
305           <taglist>
306             <tag>ASCII</tag>
307             <item>
308               The character encoding specified by ANSI X3.4-1986 and its
309               predecessor standards, referred to in MIME as US-ASCII, and
310               corresponding to an encoding in eight bits per character of
311               the first 128 <url id="http://www.unicode.org/"
312               name="Unicode"> characters, with the eighth bit always zero.
313             </item>
314             <tag>UTF-8</tag>
315             <item>
316               The transformation format (sometimes called encoding) of
317               <url id="http://www.unicode.org/" name="Unicode"> defined by
318               <url id="http://www.rfc-editor.org/rfc/rfc3629.txt"
319               name="RFC 3629">.  UTF-8 has the useful property of having
320               ASCII as a subset, so any text encoded in ASCII is trivially
321               also valid UTF-8.
322             </item>
323           </taglist>
324         </p>
325       </sect>
326     </chapt>
327
328
329     <chapt id="archive">
330       <heading>The Debian Archive</heading>
331
332       <p>
333         The Debian system is maintained and distributed as a
334         collection of <em>packages</em>. Since there are so many of
335         them (currently well over 15000), they are split into
336         <em>sections</em> and given <em>priorities</em> to simplify
337         the handling of them.
338       </p>
339
340       <p>
341         The effort of the Debian project is to build a free operating
342         system, but not every package we want to make accessible is
343         <em>free</em> in our sense (see the Debian Free Software
344         Guidelines, below), or may be imported/exported without
345         restrictions. Thus, the archive is split into areas<footnote>
346           The Debian archive software uses the term "component" internally
347           and in the Release file format to refer to the division of an
348           archive.  The Debian Social Contract simply refers to "areas."
349           This document uses terminology similar to the Social Contract.
350         </footnote> based on their licenses and other restrictions.
351       </p>
352
353       <p>
354         The aims of this are:
355
356         <list compact="compact">
357           <item>to allow us to make as much software available as we can</item>
358           <item>to allow us to encourage everyone to write free software,
359                 and</item>
360           <item>to allow us to make it easy for people to produce
361                 CD-ROMs of our system without violating any licenses,
362                 import/export restrictions, or any other laws.</item>
363         </list>
364       </p>
365
366       <p>
367         The <em>main</em> archive area forms the <em>Debian distribution</em>.
368       </p>
369
370       <p>
371         Packages in the other archive areas (<tt>contrib</tt>,
372         <tt>non-free</tt>) are not considered to be part of the Debian
373         distribution, although we support their use and provide
374         infrastructure for them (such as our bug-tracking system and
375         mailing lists). This Debian Policy Manual applies to these
376         packages as well.
377       </p>
378
379       <sect id="dfsg">
380         <heading>The Debian Free Software Guidelines</heading>
381         <p>
382           The Debian Free Software Guidelines (DFSG) form our
383           definition of "free software".  These are:
384             <taglist>
385               <tag>1. Free Redistribution
386               </tag>
387               <item>
388                   The license of a Debian component may not restrict any
389                   party from selling or giving away the software as a
390                   component of an aggregate software distribution
391                   containing programs from several different
392                   sources. The license may not require a royalty or
393                   other fee for such sale.
394               </item>
395               <tag>2. Source Code
396               </tag>
397               <item>
398                   The program must include source code, and must allow
399                   distribution in source code as well as compiled form.
400               </item>
401               <tag>3. Derived Works
402               </tag>
403               <item>
404                   The license must allow modifications and derived
405                   works, and must allow them to be distributed under the
406                   same terms as the license of the original software.
407               </item>
408               <tag>4. Integrity of The Author's Source Code
409               </tag>
410               <item>
411                   The license may restrict source-code from being
412                   distributed in modified form <em>only</em> if the
413                   license allows the distribution of "patch files"
414                   with the source code for the purpose of modifying the
415                   program at build time. The license must explicitly
416                   permit distribution of software built from modified
417                   source code. The license may require derived works to
418                   carry a different name or version number from the
419                   original software.  (This is a compromise. The Debian
420                   Project encourages all authors to not restrict any
421                   files, source or binary, from being modified.)
422               </item>
423               <tag>5. No Discrimination Against Persons or Groups
424               </tag>
425               <item>
426                   The license must not discriminate against any person
427                   or group of persons.
428               </item>
429               <tag>6. No Discrimination Against Fields of Endeavor
430               </tag>
431               <item>
432                   The license must not restrict anyone from making use
433                   of the program in a specific field of endeavor. For
434                   example, it may not restrict the program from being
435                   used in a business, or from being used for genetic
436                   research.
437               </item>
438               <tag>7. Distribution of License
439               </tag>
440               <item>
441                   The rights attached to the program must apply to all
442                   to whom the program is redistributed without the need
443                   for execution of an additional license by those
444                   parties.
445               </item>
446               <tag>8. License Must Not Be Specific to Debian
447               </tag>
448               <item>
449                   The rights attached to the program must not depend on
450                   the program's being part of a Debian system. If the
451                   program is extracted from Debian and used or
452                   distributed without Debian but otherwise within the
453                   terms of the program's license, all parties to whom
454                   the program is redistributed must have the same
455                   rights as those that are granted in conjunction with
456                   the Debian system.
457               </item>
458               <tag>9. License Must Not Contaminate Other Software
459               </tag>
460               <item>
461                   The license must not place restrictions on other
462                   software that is distributed along with the licensed
463                   software. For example, the license must not insist
464                   that all other programs distributed on the same medium
465                   must be free software.
466               </item>
467               <tag>10. Example Licenses
468               </tag>
469               <item>
470                   The "GPL," "BSD," and "Artistic" licenses are examples of
471                   licenses that we consider <em>free</em>.
472               </item>
473             </taglist>
474         </p>
475       </sect>
476
477       <sect id="sections">
478         <heading>Archive areas</heading>
479
480         <sect1 id="main">
481           <heading>The main archive area</heading>
482
483           <p>
484             The <em>main</em> archive area comprises the Debian
485             distribution.  Only the packages in this area are considered
486             part of the distribution.  None of the packages in
487             the <em>main</em> archive area require software outside of
488             that area to function.  Anyone may use, share, modify and
489             redistribute the packages in this archive area
490             freely<footnote>
491               See <url id="http://www.debian.org/intro/free"
492                        name="What Does Free Mean?"> for
493               more about what we mean by free software.
494             </footnote>.
495           </p>
496
497           <p>
498             Every package in <em>main</em> must comply with the DFSG
499             (Debian Free Software Guidelines).
500           </p>
501
502           <p>
503             In addition, the packages in <em>main</em>
504             <list compact="compact">
505               <item>
506                   must not require or recommend a package outside
507                   of <em>main</em> for compilation or execution (thus, the
508                   package must not declare a "Pre-Depends", "Depends",
509                   "Recommends", "Build-Depends", or "Build-Depends-Indep"
510                   relationship on a non-<em>main</em> package),
511               </item>
512               <item>
513                   must not be so buggy that we refuse to support them,
514                   and
515               </item>
516               <item>
517                   must meet all policy requirements presented in this
518                   manual.
519               </item>
520             </list>
521           </p>
522
523         </sect1>
524
525         <sect1 id="contrib">
526           <heading>The contrib archive area</heading>
527
528           <p>
529             The <em>contrib</em> archive area contains supplemental
530             packages intended to work with the Debian distribution, but
531             which require software outside of the distribution to either
532             build or function.
533           </p>
534
535           <p>
536             Every package in <em>contrib</em> must comply with the DFSG.
537           </p>
538
539           <p>
540             In addition, the packages in <em>contrib</em>
541             <list compact="compact">
542               <item>
543                   must not be so buggy that we refuse to support them,
544                   and
545               </item>
546               <item>
547                   must meet all policy requirements presented in this
548                   manual.
549               </item>
550             </list>
551           </p>
552
553           <p>
554             Examples of packages which would be included in
555             <em>contrib</em> are:
556             <list compact="compact">
557               <item>
558                   free packages which require <em>contrib</em>,
559                   <em>non-free</em> packages or packages which are not
560                   in our archive at all for compilation or execution,
561                   and
562               </item>
563               <item>
564                   wrapper packages or other sorts of free accessories for
565                   non-free programs.
566               </item>
567             </list>
568           </p>
569         </sect1>
570
571         <sect1 id="non-free">
572           <heading>The non-free archive area</heading>
573
574           <p>
575             The <em>non-free</em> archive area contains supplemental
576             packages intended to work with the Debian distribution that do
577             not comply with the DFSG or have other problems that make
578             their distribution problematic.  They may not comply with all
579             of the policy requirements in this manual due to restrictions
580             on modifications or other limitations.
581           </p>
582
583           <p>
584             Packages must be placed in <em>non-free</em> if they are
585             not compliant with the DFSG or are encumbered by patents
586             or other legal issues that make their distribution
587             problematic.
588           </p>
589
590           <p>
591             In addition, the packages in <em>non-free</em>
592             <list compact="compact">
593               <item>
594                   must not be so buggy that we refuse to support them,
595                   and
596               </item>
597               <item>
598                   must meet all policy requirements presented in this
599                   manual that it is possible for them to meet.
600                   <footnote>
601                       It is possible that there are policy
602                       requirements which the package is unable to
603                       meet, for example, if the source is
604                       unavailable.  These situations will need to be
605                       handled on a case-by-case basis.
606                   </footnote>
607               </item>
608             </list>
609           </p>
610         </sect1>
611
612       </sect>
613
614       <sect id="pkgcopyright">
615         <heading>Copyright considerations</heading>
616
617         <p>
618           Every package must be accompanied by a verbatim copy of its
619           copyright information and distribution license in the file
620           <file>/usr/share/doc/<var>package</var>/copyright</file>
621           (see <ref id="copyrightfile"> for further details).
622         </p>
623
624         <p>
625           We reserve the right to restrict files from being included
626           anywhere in our archives if
627           <list compact="compact">
628             <item>
629                   their use or distribution would break a law,
630             </item>
631             <item>
632                   there is an ethical conflict in their distribution or
633                   use,
634             </item>
635             <item>
636                   we would have to sign a license for them, or
637             </item>
638             <item>
639                   their distribution would conflict with other project
640                   policies.
641             </item>
642           </list>
643         </p>
644
645         <p>
646           Programs whose authors encourage the user to make
647           donations are fine for the main distribution, provided
648           that the authors do not claim that not donating is
649           immoral, unethical, illegal or something similar; in such
650           a case they must go in <em>non-free</em>.
651         </p>
652
653         <p>
654           Packages whose copyright permission notices (or patent
655           problems) do not even allow redistribution of binaries
656           only, and where no special permission has been obtained,
657           must not be placed on the Debian FTP site and its mirrors
658           at all.
659         </p>
660
661         <p>
662           Note that under international copyright law (this applies
663           in the United States, too), <em>no</em> distribution or
664           modification of a work is allowed without an explicit
665           notice saying so.  Therefore a program without a copyright
666           notice <em>is</em> copyrighted and you may not do anything
667           to it without risking being sued! Likewise if a program
668           has a copyright notice but no statement saying what is
669           permitted then nothing is permitted.
670         </p>
671
672         <p>
673           Many authors are unaware of the problems that restrictive
674           copyrights (or lack of copyright notices) can cause for
675           the users of their supposedly-free software.  It is often
676           worthwhile contacting such authors diplomatically to ask
677           them to modify their license terms. However, this can be a
678           politically difficult thing to do and you should ask for
679           advice on the <tt>debian-legal</tt> mailing list first, as
680           explained below.
681         </p>
682
683         <p>
684           When in doubt about a copyright, send mail to
685           <email>debian-legal@lists.debian.org</email>.  Be prepared
686           to provide us with the copyright statement.  Software
687           covered by the GPL, public domain software and BSD-like
688           copyrights are safe; be wary of the phrases "commercial
689           use prohibited" and "distribution restricted".
690         </p>
691       </sect>
692
693       <sect id="subsections">
694         <heading>Sections</heading>
695
696         <p>
697           The packages in the archive areas <em>main</em>,
698           <em>contrib</em> and <em>non-free</em> are grouped further into
699           <em>sections</em> to simplify handling.
700         </p>
701
702         <p>
703           The archive area and section for each package should be
704           specified in the package's <tt>Section</tt> control record (see
705           <ref id="f-Section">).  However, the maintainer of the Debian
706           archive may override this selection to ensure the consistency of
707           the Debian distribution.  The <tt>Section</tt> field should be
708           of the form:
709           <list compact="compact">
710             <item>
711                   <em>section</em> if the package is in the
712                   <em>main</em> archive area,
713             </item>
714             <item>
715                   <em>area/section</em> if the package is in
716                   the <em>contrib</em> or <em>non-free</em>
717                   archive areas.
718             </item>
719           </list>
720         </p>
721
722         <p>
723           The Debian archive maintainers provide the authoritative
724           list of sections.  At present, they are:
725 admin,
726 cli-mono,
727 comm,
728 database,
729 debug,
730 devel,
731 doc,
732 editors,
733 education,
734 electronics,
735 embedded,
736 fonts,
737 games,
738 gnome,
739 gnu-r,
740 gnustep,
741 graphics,
742 hamradio,
743 haskell,
744 httpd,
745 interpreters,
746 introspection,
747 java,
748 kde,
749 kernel,
750 libdevel,
751 libs,
752 lisp,
753 localization,
754 mail,
755 math,
756 metapackages,
757 misc,
758 net,
759 news,
760 ocaml,
761 oldlibs,
762 otherosfs,
763 perl,
764 php,
765 python,
766 ruby,
767 science,
768 shells,
769 sound,
770 tasks,
771 tex,
772 text,
773 utils,
774 vcs,
775 video,
776 web,
777 x11,
778 xfce,
779 zope.
780           The additional section <em>debian-installer</em>
781           contains special packages used by the installer and is not used
782           for normal Debian packages.
783         </p>
784
785         <p>
786           For more information about the sections and their definitions,
787           see the <url id="http://packages.debian.org/unstable/"
788                        name="list of sections in unstable">.
789         </p>
790       </sect>
791
792       <sect id="priorities">
793         <heading>Priorities</heading>
794
795         <p>
796           Each package should have a <em>priority</em> value, which is
797           included in the package's <em>control record</em>
798           (see <ref id="f-Priority">).
799           This information is used by the Debian package management tools to
800           separate high-priority packages from less-important packages.
801         </p>
802
803         <p>
804           The following <em>priority levels</em> are recognized by the
805           Debian package management tools.
806           <taglist>
807             <tag><tt>required</tt></tag>
808             <item>
809                 Packages which are necessary for the proper
810                 functioning of the system (usually, this means that
811                 dpkg functionality depends on these packages).
812                 Removing a <tt>required</tt> package may cause your
813                 system to become totally broken and you may not even
814                 be able to use <prgn>dpkg</prgn> to put things back,
815                 so only do so if you know what you are doing.  Systems
816                 with only the <tt>required</tt> packages are probably
817                 unusable, but they do have enough functionality to
818                 allow the sysadmin to boot and install more software.
819             </item>
820             <tag><tt>important</tt></tag>
821             <item>
822                 Important programs, including those which one would
823                 expect to find on any Unix-like system.  If the
824                 expectation is that an experienced Unix person who
825                 found it missing would say "What on earth is going on,
826                 where is <prgn>foo</prgn>?", it must be an
827                 <tt>important</tt> package.<footnote>
828                     This is an important criterion because we are
829                     trying to produce, amongst other things, a free
830                     Unix.
831                 </footnote>
832                 Other packages without which the system will not run
833                 well or be usable must also have priority
834                 <tt>important</tt>.  This does
835                 <em>not</em> include Emacs, the X Window System, TeX
836                 or any other large applications.  The
837                 <tt>important</tt> packages are just a bare minimum of
838                 commonly-expected and necessary tools.
839             </item>
840             <tag><tt>standard</tt></tag>
841             <item>
842                 These packages provide a reasonably small but not too
843                 limited character-mode system.  This is what will be
844                 installed by default if the user doesn't select anything
845                 else.  It doesn't include many large applications.
846             </item>
847             <tag><tt>optional</tt></tag>
848             <item>
849                 (In a sense everything that isn't required is
850                 optional, but that's not what is meant here.) This is
851                 all the software that you might reasonably want to
852                 install if you didn't know what it was and don't have
853                 specialized requirements. This is a much larger system
854                 and includes the X Window System, a full TeX
855                 distribution, and many applications. Note that
856                 optional packages should not conflict with each other.
857             </item>
858             <tag><tt>extra</tt></tag>
859             <item>
860                 This contains all packages that conflict with others
861                 with required, important, standard or optional
862                 priorities, or are only likely to be useful if you
863                 already know what they are or have specialized
864                 requirements (such as packages containing only detached
865                 debugging symbols).
866             </item>
867           </taglist>
868         </p>
869
870         <p>
871           Packages must not depend on packages with lower priority
872           values (excluding build-time dependencies).  In order to
873           ensure this, the priorities of one or more packages may need
874           to be adjusted.
875         </p>
876       </sect>
877
878     </chapt>
879
880
881     <chapt id="binary">
882       <heading>Binary packages</heading>
883
884       <p>
885         The Debian distribution is based on the Debian
886         package management system, called <prgn>dpkg</prgn>. Thus,
887         all packages in the Debian distribution must be provided
888         in the <tt>.deb</tt> file format.
889       </p>
890
891       <p>
892         A <tt>.deb</tt> package contains two sets of files: a set of files
893         to install on the system when the package is installed, and a set
894         of files that provide additional metadata about the package or
895         which are executed when the package is installed or removed.  This
896         second set of files is called <em>control information files</em>.
897         Among those files are the package maintainer scripts
898         and <file>control</file>, the <qref id="binarycontrolfiles">binary
899         package control file</qref> that contains the control fields for
900         the package.  Other control information files include
901         the <qref id="sharedlibs-symbols"><file>symbols</file> file</qref>
902         or <qref id="sharedlibs-shlibdeps"><file>shlibs</file> file</qref>
903         used to store shared library dependency information and
904         the <file>conffiles</file> file that lists the package's
905         configuration files (described in <ref id="config-files">).
906       </p>
907
908       <p>
909         There is unfortunately a collision of terminology here between
910         control information files and files in the Debian control file
911         format.  Throughout this document, a <em>control file</em> refers
912         to a file in the Debian control file format.  These files are
913         documented in <ref id="controlfields">.  Only files referred to
914         specifically as <em>control information files</em> are the files
915         included in the control information file member of
916         the <file>.deb</file> file format used by binary packages.  Most
917         control information files are not in the Debian control file
918         format.
919       </p>
920
921       <sect>
922         <heading>The package name</heading>
923
924         <p>
925           Every package must have a name that's unique within the Debian
926           archive.
927         </p>
928
929         <p>
930           The package name is included in the control field
931           <tt>Package</tt>, the format of which is described
932           in <ref id="f-Package">.
933           The package name is also included as a part of the file name
934           of the <tt>.deb</tt> file.
935         </p>
936       </sect>
937
938       <sect id="versions">
939         <heading>The version of a package</heading>
940
941         <p>
942           Every package has a version number recorded in its
943           <tt>Version</tt> control file field, described in
944           <ref id="f-Version">.
945         </p>
946
947         <p>
948           The package management system imposes an ordering on version
949           numbers, so that it can tell whether packages are being up- or
950           downgraded and so that package system front end applications
951           can tell whether a package it finds available is newer than
952           the one installed on the system.  The version number format
953           has the most significant parts (as far as comparison is
954           concerned) at the beginning.
955         </p>
956
957         <p>
958           If an upstream package has problematic version numbers they
959           should be converted to a sane form for use in the
960           <tt>Version</tt> field.
961         </p>
962
963         <sect1>
964           <heading>Version numbers based on dates</heading>
965
966           <p>
967             In general, Debian packages should use the same version
968             numbers as the upstream sources.  However, upstream version
969             numbers based on some date formats (sometimes used for
970             development or "snapshot" releases) will not be ordered
971             correctly by the package management software.  For
972             example, <prgn>dpkg</prgn> will consider "96May01" to be
973             greater than "96Dec24".
974           </p>
975
976           <p>
977             To prevent having to use epochs for every new upstream
978             version, the date-based portion of any upstream version number
979             should be given in a way that sorts correctly: four-digit year
980             first, followed by a two-digit numeric month, followed by a
981             two-digit numeric date, possibly with punctuation between the
982             components.
983           </p>
984
985           <p>
986             Native Debian packages (i.e., packages which have been written
987             especially for Debian) whose version numbers include dates
988             should also follow these rules.  If punctuation is desired
989             between the date components, remember that hyphen (<tt>-</tt>)
990             cannot be used in native package versions.  Period
991             (<tt>.</tt>) is normally a good choice.
992           </p>
993         </sect1>
994
995       </sect>
996
997       <sect id="maintainer">
998         <heading>The maintainer of a package</heading>
999
1000         <p>
1001           Every package must have a maintainer, except for orphaned
1002           packages as described below.  The maintainer may be one person
1003           or a group of people reachable from a common email address, such
1004           as a mailing list.  The maintainer is responsible for
1005           maintaining the Debian packaging files, evaluating and
1006           responding appropriately to reported bugs, uploading new
1007           versions of the package (either directly or through a sponsor),
1008           ensuring that the package is placed in the appropriate archive
1009           area and included in Debian releases as appropriate for the
1010           stability and utility of the package, and requesting removal of
1011           the package from the Debian distribution if it is no longer
1012           useful or maintainable.
1013         </p>
1014
1015         <p>
1016           The maintainer must be specified in the <tt>Maintainer</tt>
1017           control field with their correct name and a working email
1018           address.  The email address given in the <tt>Maintainer</tt>
1019           control field must accept mail from those role accounts in
1020           Debian used to send automated mails regarding the package.  This
1021           includes non-spam mail from the bug-tracking system, all mail
1022           from the Debian archive maintenance software, and other role
1023           accounts or automated processes that are commonly agreed on by
1024           the project.<footnote>
1025             A sample implementation of such a whitelist written for the
1026             Mailman mailing list management software is used for mailing
1027             lists hosted by alioth.debian.org.
1028           </footnote>
1029           If one person or team maintains several packages, they should
1030           use the same form of their name and email address in
1031           the <tt>Maintainer</tt> fields of those packages.
1032         </p>
1033
1034         <p>
1035           The format of the <tt>Maintainer</tt> control field is
1036           described in <ref id="f-Maintainer">.
1037         </p>
1038
1039         <p>
1040           If the maintainer of the package is a team of people with a
1041           shared email address, the <tt>Uploaders</tt> control field must
1042           be present and must contain at least one human with their
1043           personal email address.  See <ref id="f-Uploaders"> for the
1044           syntax of that field.
1045         </p>
1046
1047         <p>
1048           An orphaned package is one with no current maintainer.  Orphaned
1049           packages should have their <tt>Maintainer</tt> control field set
1050           to <tt>Debian QA Group &lt;packages@qa.debian.org&gt;</tt>.
1051           These packages are considered maintained by the Debian project
1052           as a whole until someone else volunteers to take over
1053           maintenance.<footnote>
1054             The detailed procedure for gracefully orphaning a package can
1055             be found in the Debian Developer's Reference
1056             (see <ref id="related">).
1057           </footnote>
1058         </p>
1059       </sect>
1060
1061       <sect id="descriptions">
1062         <heading>The description of a package</heading>
1063
1064         <p>
1065           Every Debian package must have a <tt>Description</tt> control
1066           field which contains a synopsis and extended description of the
1067           package.  Technical information about the format of the
1068           <tt>Description</tt> field is in <ref id="f-Description">.
1069         </p>
1070
1071         <p>
1072           The description should describe the package (the program) to a
1073           user (system administrator) who has never met it before so that
1074           they have enough information to decide whether they want to
1075           install it. This description should not just be copied verbatim
1076           from the program's documentation.
1077         </p>
1078
1079         <p>
1080           Put important information first, both in the synopsis and
1081           extended description.  Sometimes only the first part of the
1082           synopsis or of the description will be displayed.  You can
1083           assume that there will usually be a way to see the whole
1084           extended description.
1085         </p>
1086
1087         <p>
1088           The description should also give information about the
1089           significant dependencies and conflicts between this package
1090           and others, so that the user knows why these dependencies and
1091           conflicts have been declared.
1092         </p>
1093
1094         <p>
1095           Instructions for configuring or using the package should
1096           not be included (that is what installation scripts,
1097           manual pages, info files, etc., are for).  Copyright
1098           statements and other administrivia should not be included
1099           either (that is what the copyright file is for).
1100         </p>
1101
1102         <sect1 id="synopsis"><heading>The single line synopsis</heading>
1103
1104           <p>
1105             The single line synopsis should be kept brief - certainly
1106             under 80 characters.
1107           </p>
1108
1109           <p>
1110             Do not include the package name in the synopsis line.  The
1111             display software knows how to display this already, and you
1112             do not need to state it.  Remember that in many situations
1113             the user may only see the synopsis line - make it as
1114             informative as you can.
1115           </p>
1116
1117         </sect1>
1118
1119         <sect1 id="extendeddesc"><heading>The extended description</heading>
1120
1121           <p>
1122             Do not try to continue the single line synopsis into the
1123             extended description.  This will not work correctly when
1124             the full description is displayed, and makes no sense
1125             where only the summary (the single line synopsis) is
1126             available.
1127           </p>
1128
1129           <p>
1130             The extended description should describe what the package
1131             does and how it relates to the rest of the system (in terms
1132             of, for example, which subsystem it is which part of).
1133           </p>
1134
1135           <p>
1136             The description field needs to make sense to anyone, even
1137             people who have no idea about any of the things the
1138             package deals with.<footnote>
1139                 The blurb that comes with a program in its
1140                 announcements and/or <prgn>README</prgn> files is
1141                 rarely suitable for use in a description.  It is
1142                 usually aimed at people who are already in the
1143                 community where the package is used.
1144             </footnote>
1145           </p>
1146
1147         </sect1>
1148
1149       </sect>
1150
1151       <sect id="dependencies">
1152         <heading>Dependencies</heading>
1153
1154         <p>
1155           Every package must specify the dependency information
1156           about other packages that are required for the first to
1157           work correctly.
1158         </p>
1159
1160         <p>
1161           For example, a dependency entry must be provided for any
1162           shared libraries required by a dynamically-linked executable
1163           binary in a package.
1164         </p>
1165
1166         <p>
1167           Packages are not required to declare any dependencies they
1168           have on other packages which are marked <tt>Essential</tt>
1169           (see below), and should not do so unless they depend on a
1170           particular version of that package.<footnote>
1171             <p>
1172               Essential is needed in part to avoid unresolvable dependency
1173               loops on upgrade.  If packages add unnecessary dependencies
1174               on packages in this set, the chances that there
1175               <strong>will</strong> be an unresolvable dependency loop
1176               caused by forcing these Essential packages to be configured
1177               first before they need to be is greatly increased.  It also
1178               increases the chances that frontends will be unable to
1179               <strong>calculate</strong> an upgrade path, even if one
1180               exists.
1181             </p>
1182             <p>
1183               Also, functionality is rarely ever removed from the
1184               Essential set, but <em>packages</em> have been removed from
1185               the Essential set when the functionality moved to a
1186               different package. So depending on these packages <em>just
1187               in case</em> they stop being essential does way more harm
1188               than good.
1189             </p>
1190           </footnote>
1191         </p>
1192
1193         <p>
1194           Sometimes, unpacking one package requires that another package
1195           be first unpacked <em>and</em> configured.  In this case, the
1196           depending package must specify this dependency in
1197           the <tt>Pre-Depends</tt> control field.
1198         </p>
1199
1200         <p>
1201           You should not specify a <tt>Pre-Depends</tt> entry for a
1202           package before this has been discussed on the
1203           <tt>debian-devel</tt> mailing list and a consensus about
1204           doing that has been reached.
1205         </p>
1206
1207         <p>
1208           The format of the package interrelationship control fields is
1209           described in <ref id="relationships">.
1210         </p>
1211       </sect>
1212
1213       <sect id="virtual_pkg">
1214         <heading>Virtual packages</heading>
1215
1216         <p>
1217           Sometimes, there are several packages which offer
1218           more-or-less the same functionality. In this case, it's
1219           useful to define a <em>virtual package</em> whose name
1220           describes that common functionality.  (The virtual
1221           packages only exist logically, not physically; that's why
1222           they are called <em>virtual</em>.) The packages with this
1223           particular function will then <em>provide</em> the virtual
1224           package. Thus, any other package requiring that function
1225           can simply depend on the virtual package without having to
1226           specify all possible packages individually.
1227         </p>
1228
1229         <p>
1230           All packages should use virtual package names where
1231           appropriate, and arrange to create new ones if necessary.
1232           They should not use virtual package names (except privately,
1233           amongst a cooperating group of packages) unless they have
1234           been agreed upon and appear in the list of virtual package
1235           names. (See also <ref id="virtual">)
1236         </p>
1237
1238         <p>
1239           The latest version of the authoritative list of virtual
1240           package names can be found in the <tt>debian-policy</tt> package.
1241           It is also available from the Debian web mirrors at
1242           <tt><url name="/doc/packaging-manuals/virtual-package-names-list.txt"
1243                 id="http://www.debian.org/doc/packaging-manuals/virtual-package-names-list.txt"></tt>.
1244         </p>
1245
1246         <p>
1247           The procedure for updating the list is described in the preface
1248           to the list.
1249         </p>
1250
1251       </sect>
1252
1253       <sect>
1254         <heading>Base system</heading>
1255
1256         <p>
1257           The <tt>base system</tt> is a minimum subset of the Debian
1258           system that is installed before everything else
1259           on a new system. Only very few packages are allowed to form
1260           part of the base system, in order to keep the required disk
1261           usage very small.
1262         </p>
1263
1264         <p>
1265           The base system consists of all those packages with priority
1266           <tt>required</tt> or <tt>important</tt>. Many of them will
1267           be tagged <tt>essential</tt> (see below).
1268         </p>
1269       </sect>
1270
1271       <sect>
1272         <heading>Essential packages</heading>
1273
1274         <p>
1275           Essential is defined as the minimal set of functionality that
1276           must be available and usable on the system at all times, even
1277           when packages are in the "Unpacked" state.
1278           Packages are tagged <tt>essential</tt> for a system using the
1279           <tt>Essential</tt> control field.  The format of the
1280           <tt>Essential</tt> control field is described in <ref
1281           id="f-Essential">.
1282         </p>
1283
1284         <p>
1285           Since these packages cannot be easily removed (one has to
1286           specify an extra <em>force option</em> to
1287           <prgn>dpkg</prgn> to do so), this flag must not be used
1288           unless absolutely necessary.  A shared library package
1289           must not be tagged <tt>essential</tt>; dependencies will
1290           prevent its premature removal, and we need to be able to
1291           remove it when it has been superseded.
1292         </p>
1293
1294         <p>
1295           Since dpkg will not prevent upgrading of other packages
1296           while an <tt>essential</tt> package is in an unconfigured
1297             state, all <tt>essential</tt> packages must supply all of
1298             their core functionality even when unconfigured. If the
1299             package cannot satisfy this requirement it must not be
1300             tagged as essential, and any packages depending on this
1301             package must instead have explicit dependency fields as
1302             appropriate.
1303         </p>
1304
1305         <p>
1306           Maintainers should take great care in adding any programs,
1307           interfaces, or functionality to <tt>essential</tt> packages.
1308           Packages may assume that functionality provided by
1309           <tt>essential</tt> packages is always available without
1310           declaring explicit dependencies, which means that removing
1311           functionality from the Essential set is very difficult and is
1312           almost never done.  Any capability added to an
1313           <tt>essential</tt> package therefore creates an obligation to
1314           support that capability as part of the Essential set in
1315           perpetuity.
1316         </p>
1317
1318         <p>
1319           You must not tag any packages <tt>essential</tt> before
1320           this has been discussed on the <tt>debian-devel</tt>
1321           mailing list and a consensus about doing that has been
1322           reached.
1323         </p>
1324       </sect>
1325
1326       <sect id="maintscripts">
1327         <heading>Maintainer Scripts</heading>
1328
1329         <p>
1330           The package installation scripts should avoid producing
1331           output which is unnecessary for the user to see and
1332           should rely on <prgn>dpkg</prgn> to stave off boredom on
1333           the part of a user installing many packages. This means,
1334           amongst other things, not passing the <tt>--verbose</tt>
1335           option to <prgn>update-alternatives</prgn>.
1336         </p>
1337
1338         <p>
1339           Errors which occur during the execution of an installation
1340           script must be checked and the installation must not
1341           continue after an error.
1342         </p>
1343
1344         <p>
1345           Note that in general <ref id="scripts"> applies to package
1346           maintainer scripts, too.
1347         </p>
1348
1349         <p>
1350           You should not use <prgn>dpkg-divert</prgn> on a file belonging
1351           to another package without consulting the maintainer of that
1352           package first.  When adding or removing diversions, package
1353           maintainer scripts must provide the <tt>--package</tt> flag
1354           to <prgn>dpkg-divert</prgn> and must not use <tt>--local</tt>.
1355         </p>
1356
1357         <p>
1358           All packages which supply an instance of a common command
1359           name (or, in general, filename) should generally use
1360           <prgn>update-alternatives</prgn>, so that they may be
1361           installed together.  If <prgn>update-alternatives</prgn>
1362           is not used, then each package must use
1363           <tt>Conflicts</tt> to ensure that other packages are
1364           removed.  (In this case, it may be appropriate to
1365           specify a conflict against earlier versions of something
1366           that previously did not use
1367           <prgn>update-alternatives</prgn>; this is an exception to
1368           the usual rule that versioned conflicts should be
1369           avoided.)
1370         </p>
1371
1372         <sect1 id="maintscriptprompt">
1373           <heading>Prompting in maintainer scripts</heading>
1374           <p>
1375             Package maintainer scripts may prompt the user if
1376             necessary. Prompting must be done by communicating
1377             through a program, such as <prgn>debconf</prgn>, which
1378             conforms to the Debian Configuration Management
1379             Specification, version 2 or higher.
1380           </p>
1381
1382           <p>
1383             Packages which are essential, or which are dependencies of
1384             essential packages, may fall back on another prompting method
1385             if no such interface is available when they are executed.
1386           </p>
1387
1388           <p>
1389             The Debian Configuration Management Specification is included
1390             in the <file>debconf_specification</file> files in the
1391             <package>debian-policy</package> package.
1392             It is also available from the Debian web mirrors at
1393             <tt><url name="/doc/packaging-manuals/debconf_specification.html"
1394                 id="http://www.debian.org/doc/packaging-manuals/debconf_specification.html"></tt>.
1395           </p>
1396
1397           <p>
1398             Packages which use the Debian Configuration Management
1399             Specification may contain the additional control information
1400             files <file>config</file>
1401             and <file>templates</file>.  <file>config</file> is an
1402             additional maintainer script used for package configuration,
1403             and <file>templates</file> contains templates used for user
1404             prompting.  The <prgn>config</prgn> script might be run before
1405             the <prgn>preinst</prgn> script and before the package is
1406             unpacked or any of its dependencies or pre-dependencies are
1407             satisfied.  Therefore it must work using only the tools
1408             present in <em>essential</em> packages.<footnote>
1409                   <package>Debconf</package> or another tool that
1410                   implements the Debian Configuration Management
1411                   Specification will also be installed, and any
1412                   versioned dependencies on it will be satisfied
1413                   before preconfiguration begins.
1414             </footnote>
1415           </p>
1416
1417           <p>
1418             Packages which use the Debian Configuration Management
1419             Specification must allow for translation of their user-visible
1420             messages by using a gettext-based system such as the one
1421             provided by the <package>po-debconf</package> package.
1422           </p>
1423
1424           <p>
1425             Packages should try to minimize the amount of prompting
1426             they need to do, and they should ensure that the user
1427             will only ever be asked each question once.  This means
1428             that packages should try to use appropriate shared
1429             configuration files (such as <file>/etc/papersize</file> and
1430             <file>/etc/news/server</file>), and shared
1431             <package>debconf</package> variables rather than each
1432             prompting for their own list of required pieces of
1433             information.
1434           </p>
1435
1436           <p>
1437             It also means that an upgrade should not ask the same
1438             questions again, unless the user has used
1439             <tt>dpkg --purge</tt> to remove the package's configuration.
1440             The answers to configuration questions should be stored in an
1441             appropriate place in <file>/etc</file> so that the user can
1442             modify them, and how this has been done should be
1443             documented.
1444           </p>
1445
1446           <p>
1447             If a package has a vitally important piece of
1448             information to pass to the user (such as "don't run me
1449             as I am, you must edit the following configuration files
1450             first or you risk your system emitting badly-formatted
1451             messages"), it should display this in the
1452             <prgn>config</prgn> or <prgn>postinst</prgn> script and
1453             prompt the user to hit return to acknowledge the
1454             message.  Copyright messages do not count as vitally
1455             important (they belong in
1456             <file>/usr/share/doc/<var>package</var>/copyright</file>);
1457             neither do instructions on how to use a program (these
1458             should be in on-line documentation, where all the users
1459             can see them).
1460           </p>
1461
1462           <p>
1463             Any necessary prompting should almost always be confined
1464             to the <prgn>config</prgn> or <prgn>postinst</prgn>
1465             script. If it is done in the <prgn>postinst</prgn>, it
1466             should be protected with a conditional so that
1467             unnecessary prompting doesn't happen if a package's
1468             installation fails and the <prgn>postinst</prgn> is
1469             called with <tt>abort-upgrade</tt>,
1470             <tt>abort-remove</tt> or <tt>abort-deconfigure</tt>.
1471           </p>
1472         </sect1>
1473
1474       </sect>
1475
1476     </chapt>
1477
1478
1479     <chapt id="source">
1480       <heading>Source packages</heading>
1481
1482       <sect id="standardsversion">
1483         <heading>Standards conformance</heading>
1484
1485         <p>
1486           Source packages should specify the most recent version number
1487           of this policy document with which your package complied
1488           when it was last updated.
1489         </p>
1490
1491         <p>
1492           This information may be used to file bug reports
1493           automatically if your package becomes too much out of date.
1494         </p>
1495
1496         <p>
1497           The version is specified in the <tt>Standards-Version</tt>
1498           control field.
1499           The format of the <tt>Standards-Version</tt> field is
1500           described in <ref id="f-Standards-Version">.
1501         </p>
1502
1503         <p>
1504           You should regularly, and especially if your package has
1505           become out of date, check for the newest Policy Manual
1506           available and update your package, if necessary. When your
1507           package complies with the new standards you should update the
1508           <tt>Standards-Version</tt> source package field and
1509           release it.<footnote>
1510                 See the file <file>upgrading-checklist</file> for
1511                 information about policy which has changed between
1512                 different versions of this document.
1513           </footnote>
1514         </p>
1515
1516       </sect>
1517
1518       <sect id="pkg-relations">
1519         <heading>Package relationships</heading>
1520
1521         <p>
1522           Source packages should specify which binary packages they
1523           require to be installed or not to be installed in order to
1524           build correctly.  For example, if building a package
1525           requires a certain compiler, then the compiler should be
1526           specified as a build-time dependency.
1527         </p>
1528
1529         <p>
1530           It is not necessary to explicitly specify build-time
1531           relationships on a minimal set of packages that are always
1532           needed to compile, link and put in a Debian package a
1533           standard "Hello World!" program written in C or C++.  The
1534           required packages are called <em>build-essential</em>, and
1535           an informational list can be found in
1536           <file>/usr/share/doc/build-essential/list</file> (which is
1537           contained in the <tt>build-essential</tt>
1538           package).<footnote>
1539             Rationale:
1540                 <list compact="compact">
1541                   <item>
1542                       This allows maintaining the list separately
1543                       from the policy documents (the list does not
1544                       need the kind of control that the policy
1545                       documents do).
1546                   </item>
1547                   <item>
1548                       Having a separate package allows one to install
1549                       the build-essential packages on a machine, as
1550                       well as allowing other packages such as tasks to
1551                       require installation of the build-essential
1552                       packages using the depends relation.
1553                   </item>
1554                   <item>
1555                       The separate package allows bug reports against
1556                       the list to be categorized separately from
1557                       the policy management process in the BTS.
1558                   </item>
1559                 </list>
1560           </footnote>
1561         </p>
1562
1563         <p>
1564           When specifying the set of build-time dependencies, one
1565           should list only those packages explicitly required by the
1566           build.  It is not necessary to list packages which are
1567           required merely because some other package in the list of
1568           build-time dependencies depends on them.<footnote>
1569                 The reason for this is that dependencies change, and
1570                 you should list all those packages, and <em>only</em>
1571                 those packages that <em>you</em> need directly.  What
1572                 others need is their business.  For example, if you
1573                 only link against <file>libimlib</file>, you will need to
1574                 build-depend on <package>libimlib2-dev</package> but
1575                 not against any <tt>libjpeg*</tt> packages, even
1576                 though <tt>libimlib2-dev</tt> currently depends on
1577                 them: installation of <package>libimlib2-dev</package>
1578                 will automatically ensure that all of its run-time
1579                 dependencies are satisfied.
1580           </footnote>
1581         </p>
1582
1583         <p>
1584           If build-time dependencies are specified, it must be
1585           possible to build the package and produce working binaries
1586           on a system with only essential and build-essential
1587           packages installed and also those required to satisfy the
1588           build-time relationships (including any implied
1589           relationships).  In particular, this means that version
1590           clauses should be used rigorously in build-time
1591           relationships so that one cannot produce bad or
1592           inconsistently configured packages when the relationships
1593           are properly satisfied.
1594         </p>
1595
1596         <p>
1597           <ref id="relationships"> explains the technical details.
1598         </p>
1599       </sect>
1600
1601       <sect>
1602         <heading>Changes to the upstream sources</heading>
1603
1604         <p>
1605           If changes to the source code are made that are not
1606           specific to the needs of the Debian system, they should be
1607           sent to the upstream authors in whatever form they prefer
1608           so as to be included in the upstream version of the
1609           package.
1610         </p>
1611
1612         <p>
1613           If you need to configure the package differently for
1614           Debian or for Linux, and the upstream source doesn't
1615           provide a way to do so, you should add such configuration
1616           facilities (for example, a new <prgn>autoconf</prgn> test
1617           or <tt>#define</tt>) and send the patch to the upstream
1618           authors, with the default set to the way they originally
1619           had it.  You can then easily override the default in your
1620           <file>debian/rules</file> or wherever is appropriate.
1621         </p>
1622
1623         <p>
1624           You should make sure that the <prgn>configure</prgn> utility
1625           detects the correct architecture specification string
1626           (refer to <ref id="arch-spec"> for details).
1627         </p>
1628
1629         <p>
1630           If you need to edit a <prgn>Makefile</prgn> where GNU-style
1631           <prgn>configure</prgn> scripts are used, you should edit the
1632           <file>.in</file> files rather than editing the
1633           <prgn>Makefile</prgn> directly.  This allows the user to
1634           reconfigure the package if necessary.  You should
1635           <em>not</em> configure the package and edit the generated
1636           <prgn>Makefile</prgn>!  This makes it impossible for someone
1637           else to later reconfigure the package without losing the
1638           changes you made.
1639         </p>
1640
1641       </sect>
1642
1643       <sect id="dpkgchangelog">
1644         <heading>Debian changelog: <file>debian/changelog</file></heading>
1645
1646         <p>
1647           Changes in the Debian version of the package should be
1648           briefly explained in the Debian changelog file
1649           <file>debian/changelog</file>.<footnote>
1650             <p>
1651               Mistakes in changelogs are usually best rectified by
1652               making a new changelog entry rather than "rewriting
1653               history" by editing old changelog entries.
1654             </p>
1655           </footnote>
1656           This includes modifications
1657           made in the Debian package compared to the upstream one
1658           as well as other changes and updates to the package.
1659           <footnote>
1660               Although there is nothing stopping an author who is also
1661               the Debian maintainer from using this changelog for all
1662               their changes, it will have to be renamed if the Debian
1663               and upstream maintainers become different people. In such
1664               a case, however, it might be better to maintain the package
1665               as a non-native package.
1666           </footnote>
1667         </p>
1668
1669         <p>
1670           The format of the <file>debian/changelog</file> allows the
1671           package building tools to discover which version of the package
1672           is being built and find out other release-specific information.
1673         </p>
1674
1675         <p>
1676           That format is a series of entries like this:
1677
1678 <example compact="compact">
1679 <var>package</var> (<var>version</var>) <var>distribution(s)</var>; urgency=<var>urgency</var>
1680             <var>
1681               [optional blank line(s), stripped]
1682             </var>
1683   * <var>change details</var>
1684     <var>more change details</var>
1685             <var>
1686               [blank line(s), included in output of dpkg-parsechangelog]
1687             </var>
1688   * <var>even more change details</var>
1689             <var>
1690               [optional blank line(s), stripped]
1691             </var>
1692  -- <var>maintainer name</var> &lt;<var>email address</var>&gt;<var>[two spaces]</var>  <var>date</var>
1693 </example>
1694         </p>
1695
1696         <p>
1697           <var>package</var> and <var>version</var> are the source
1698           package name and version number.
1699         </p>
1700
1701         <p>
1702           <var>distribution(s)</var> lists the distributions where
1703           this version should be installed when it is uploaded - it
1704           is copied to the <tt>Distribution</tt> field in the
1705           <file>.changes</file> file.  See <ref id="f-Distribution">.
1706         </p>
1707
1708         <p>
1709           <var>urgency</var> is the value for the <tt>Urgency</tt>
1710           field in the <file>.changes</file> file for the upload
1711           (see <ref id="f-Urgency">). It is not possible to specify
1712           an urgency containing commas; commas are used to separate
1713           <tt><var>keyword</var>=<var>value</var></tt> settings in the
1714           <prgn>dpkg</prgn> changelog format (though there is
1715           currently only one useful <var>keyword</var>,
1716           <tt>urgency</tt>).
1717         </p>
1718
1719         <p>
1720           The change details may in fact be any series of lines
1721           starting with at least two spaces, but conventionally each
1722           change starts with an asterisk and a separating space and
1723           continuation lines are indented so as to bring them in
1724           line with the start of the text above.  Blank lines may be
1725           used here to separate groups of changes, if desired.
1726         </p>
1727
1728         <p>
1729           If this upload resolves bugs recorded in the Bug Tracking
1730           System (BTS), they may be automatically closed on the
1731           inclusion of this package into the Debian archive by
1732           including the string: <tt>closes: Bug#<var>nnnnn</var></tt>
1733           in the change details.<footnote>
1734               To be precise, the string should match the following
1735               Perl regular expression:
1736               <example>
1737 /closes:\s*(?:bug)?\#?\s?\d+(?:,\s*(?:bug)?\#?\s?\d+)*/i
1738               </example>
1739               Then all of the bug numbers listed will be closed by the
1740               archive maintenance software (<prgn>dak</prgn>) using the
1741               <var>version</var> of the changelog entry.
1742           </footnote>
1743           This information is conveyed via the <tt>Closes</tt> field
1744           in the <tt>.changes</tt> file (see <ref id="f-Closes">).
1745         </p>
1746
1747         <p>
1748           The maintainer name and email address used in the changelog
1749           should be the details of the person uploading <em>this</em>
1750           version.  They are <em>not</em> necessarily those of the
1751           usual package maintainer.<footnote>
1752             If the developer uploading the package is not one of the usual
1753             maintainers of the package (as listed in
1754             the <qref id="f-Maintainer"><tt>Maintainer</tt></qref>
1755             or <qref id="f-Uploaders"><tt>Uploaders</tt></qref> control
1756             fields of the package), the first line of the changelog is
1757             conventionally used to explain why a non-maintainer is
1758             uploading the package.  The Debian Developer's Reference
1759             (see <ref id="related">) documents the conventions
1760             used.</footnote>
1761           The information here will be copied to the <tt>Changed-By</tt>
1762           field in the <tt>.changes</tt> file
1763           (see <ref id="f-Changed-By">), and then later used to send an
1764           acknowledgement when the upload has been installed.
1765         </p>
1766
1767         <p>
1768           The <var>date</var> has the following format<footnote>
1769               This is the same as the format generated by <tt>date
1770               -R</tt>.
1771           </footnote> (compatible and with the same semantics of
1772           RFC 2822 and RFC 5322):
1773           <example>day-of-week, dd month yyyy hh:mm:ss +zzzz</example>
1774           where:
1775           <list compact="compact">
1776             <item>
1777               day-of week is one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun
1778             </item>
1779             <item>
1780               dd is a one- or two-digit day of the month (01-31)
1781             </item>
1782             <item>
1783               month is one of: Jan, Feb, Mar, Apr, May, Jun, Jul, Aug,
1784               Sep, Oct, Nov, Dec
1785             </item>
1786             <item>yyyy is the four-digit year (e.g. 2010)</item>
1787             <item>hh is the two-digit hour (00-23)</item>
1788             <item>mm is the two-digit minutes (00-59)</item>
1789             <item>ss is the two-digit seconds (00-60)</item>
1790             <item>
1791               +zzzz or -zzzz is the the time zone offset from Coordinated
1792               Universal Time (UTC).  "+" indicates that the time is ahead
1793               of (i.e., east of) UTC and "-" indicates that the time is
1794               behind (i.e., west of) UTC.  The first two digits indicate
1795               the hour difference from UTC and the last two digits
1796               indicate the number of additional minutes difference from
1797               UTC.  The last two digits must be in the range 00-59.
1798             </item>
1799           </list>
1800         </p>
1801
1802         <p>
1803           The first "title" line with the package name must start
1804           at the left hand margin.  The "trailer" line with the
1805           maintainer and date details must be preceded by exactly
1806           one space.  The maintainer details and the date must be
1807           separated by exactly two spaces.
1808         </p>
1809
1810         <p>
1811           The entire changelog must be encoded in UTF-8.
1812         </p>
1813
1814         <p>
1815           For more information on placement of the changelog files
1816           within binary packages, please see <ref id="changelogs">.
1817         </p>
1818       </sect>
1819
1820       <sect id="dpkgcopyright">
1821         <heading>Copyright: <file>debian/copyright</file></heading>
1822         <p>
1823           Every package must be accompanied by a verbatim copy of its
1824           copyright information and distribution license in the file
1825           <file>/usr/share/doc/<var>package</var>/copyright</file>
1826           (see <ref id="copyrightfile"> for further details). Also see
1827           <ref id="pkgcopyright"> for further considerations related
1828           to copyrights for packages.
1829         </p>
1830       </sect>
1831       <sect>
1832         <heading>Error trapping in makefiles</heading>
1833
1834         <p>
1835           When <prgn>make</prgn> invokes a command in a makefile
1836           (including your package's upstream makefiles and
1837           <file>debian/rules</file>), it does so using <prgn>sh</prgn>.  This
1838           means that <prgn>sh</prgn>'s usual bad error handling
1839           properties apply: if you include a miniature script as one
1840           of the commands in your makefile you'll find that if you
1841           don't do anything about it then errors are not detected
1842           and <prgn>make</prgn> will blithely continue after
1843           problems.
1844         </p>
1845
1846         <p>
1847           Every time you put more than one shell command (this
1848           includes using a loop) in a makefile command you
1849           must make sure that errors are trapped.  For
1850           simple compound commands, such as changing directory and
1851           then running a program, using <tt>&amp;&amp;</tt> rather
1852           than semicolon as a command separator is sufficient.  For
1853           more complex commands including most loops and
1854           conditionals you should include a separate <tt>set -e</tt>
1855           command at the start of every makefile command that's
1856           actually one of these miniature shell scripts.
1857         </p>
1858       </sect>
1859
1860       <sect id="timestamps">
1861         <heading>Time Stamps</heading>
1862         <p>
1863           Maintainers should preserve the modification times of the
1864           upstream source files in a package, as far as is reasonably
1865           possible.<footnote>
1866               The rationale is that there is some information conveyed
1867               by knowing the age of the file, for example, you could
1868               recognize that some documentation is very old by looking
1869               at the modification time, so it would be nice if the
1870               modification time of the upstream source would be
1871               preserved.
1872           </footnote>
1873         </p>
1874       </sect>
1875
1876       <sect id="restrictions">
1877         <heading>Restrictions on objects in source packages</heading>
1878
1879         <p>
1880           The source package may not contain any hard links<footnote>
1881             <p>
1882               This is not currently detected when building source
1883               packages, but only when extracting
1884               them.
1885             </p>
1886             <p>
1887               Hard links may be permitted at some point in the
1888               future, but would require a fair amount of
1889               work.
1890             </p>
1891           </footnote>, device special files, sockets or setuid or
1892           setgid files.<footnote>
1893               Setgid directories are allowed.
1894           </footnote>
1895         </p>
1896       </sect>
1897
1898       <sect id="debianrules">
1899         <heading>Main building script: <file>debian/rules</file></heading>
1900
1901         <p>
1902           This file must be an executable makefile, and contains the
1903           package-specific recipes for compiling the package and
1904           building binary package(s) from the source.
1905         </p>
1906
1907         <p>
1908           It must start with the line <tt>#!/usr/bin/make -f</tt>,
1909           so that it can be invoked by saying its name rather than
1910           invoking <prgn>make</prgn> explicitly. That is, invoking
1911           either of <tt>make -f debian/rules <em>args...</em></tt>
1912           or <tt>./debian/rules <em>args...</em></tt> must result in
1913           identical behavior.
1914         </p>
1915
1916         <p>
1917           The following targets are required and must be implemented
1918           by <file>debian/rules</file>: <tt>clean</tt>, <tt>binary</tt>,
1919           <tt>binary-arch</tt>, <tt>binary-indep</tt>, <tt>build</tt>,
1920           <tt>build-arch</tt> and <tt>build-indep</tt>.
1921           These are the targets called by <prgn>dpkg-buildpackage</prgn>.
1922         </p>
1923
1924         <p>
1925           Since an interactive <file>debian/rules</file> script makes it
1926           impossible to auto-compile that package and also makes it hard
1927           for other people to reproduce the same binary package, all
1928           required targets must be non-interactive.  It also follows that
1929           any target that these targets depend on must also be
1930           non-interactive.
1931         </p>
1932
1933         <p>
1934           The targets are as follows:
1935           <taglist>
1936             <tag><tt>build</tt> (required)</tag>
1937             <item>
1938               <p>
1939                 The <tt>build</tt> target should perform all the
1940                 configuration and compilation of the package.
1941                 If a package has an interactive pre-build
1942                 configuration routine, the Debian source package
1943                 must either be built after this has taken place (so
1944                 that the binary package can be built without rerunning
1945                 the configuration) or the configuration routine
1946                 modified to become non-interactive.  (The latter is
1947                 preferable if there are architecture-specific features
1948                 detected by the configuration routine.)
1949               </p>
1950
1951               <p>
1952                 For some packages, notably ones where the same
1953                 source tree is compiled in different ways to produce
1954                 two binary packages, the <tt>build</tt> target
1955                 does not make much sense.  For these packages it is
1956                 good enough to provide two (or more) targets
1957                 (<tt>build-a</tt> and <tt>build-b</tt> or whatever)
1958                 for each of the ways of building the package, and a
1959                 <tt>build</tt> target that does nothing.  The
1960                 <tt>binary</tt> target will have to build the
1961                 package in each of the possible ways and make the
1962                 binary package out of each.
1963               </p>
1964
1965               <p>
1966                 The <tt>build</tt> target must not do anything
1967                 that might require root privilege.
1968               </p>
1969
1970               <p>
1971                 The <tt>build</tt> target may need to run the
1972                 <tt>clean</tt> target first - see below.
1973               </p>
1974
1975               <p>
1976                 When a package has a configuration and build routine
1977                 which takes a long time, or when the makefiles are
1978                 poorly designed, or when <tt>build</tt> needs to
1979                 run <tt>clean</tt> first, it is a good idea to
1980                 <tt>touch build</tt> when the build process is
1981                 complete.  This will ensure that if <tt>debian/rules
1982                 build</tt> is run again it will not rebuild the whole
1983                 program.<footnote>
1984                     Another common way to do this is for <tt>build</tt>
1985                     to depend on <prgn>build-stamp</prgn> and to do
1986                     nothing else, and for the <prgn>build-stamp</prgn>
1987                     target to do the building and to <tt>touch
1988                     build-stamp</tt> on completion.  This is
1989                     especially useful if the build routine creates a
1990                     file or directory called <tt>build</tt>; in such a
1991                     case, <tt>build</tt> will need to be listed as
1992                     a phony target (i.e., as a dependency of the
1993                     <tt>.PHONY</tt> target).  See the documentation of
1994                     <prgn>make</prgn> for more information on phony
1995                     targets.
1996                 </footnote>
1997               </p>
1998             </item>
1999
2000             <tag><tt>build-arch</tt> (required),
2001                  <tt>build-indep</tt> (required)
2002             </tag>
2003             <item>
2004               <p>
2005                 The <tt>build-arch</tt> target must
2006                 perform all the configuration and compilation required for
2007                 producing all architecture-dependant binary packages
2008                 (those packages for which the body of the
2009                 <tt>Architecture</tt> field in <tt>debian/control</tt> is
2010                 not <tt>all</tt>).  Similarly, the <tt>build-indep</tt>
2011                 target must perform all the configuration
2012                 and compilation required for producing all
2013                 architecture-independent binary packages (those packages
2014                 for which the body of the <tt>Architecture</tt> field
2015                 in <tt>debian/control</tt> is <tt>all</tt>).
2016                 The <tt>build</tt> target
2017                 should either depend on those targets or take the same
2018                 actions as invoking those targets would perform.<footnote>
2019                   This split allows binary-only builds to not install the
2020                   dependencies required for the <tt>build-indep</tt>
2021                   target and skip any resource-intensive build tasks that
2022                   are only required when building architecture-independent
2023                   binary packages.
2024                 </footnote>
2025               </p>
2026
2027               <p>
2028                 The <tt>build-arch</tt> and <tt>build-indep</tt> targets
2029                 must not do anything that might require root privilege.
2030               </p>
2031             </item>
2032
2033             <tag><tt>binary</tt> (required), <tt>binary-arch</tt>
2034               (required), <tt>binary-indep</tt> (required)
2035             </tag>
2036             <item>
2037               <p>
2038                 The <tt>binary</tt> target must be all that is
2039                 necessary for the user to build the binary package(s)
2040                 produced from this source package.  It is
2041                 split into two parts: <prgn>binary-arch</prgn> builds
2042                 the binary packages which are specific to a particular
2043                 architecture, and <tt>binary-indep</tt> builds
2044                 those which are not.
2045               </p>
2046               <p>
2047                 <tt>binary</tt> may be (and commonly is) a target with
2048                 no commands which simply depends on
2049                 <tt>binary-arch</tt> and <tt>binary-indep</tt>.
2050               </p>
2051               <p>
2052                 Both <tt>binary-*</tt> targets should depend on the
2053                 <tt>build</tt> target, or on the appropriate
2054                 <tt>build-arch</tt> or <tt>build-indep</tt> target, if
2055                 provided, so that the package is built if it has not
2056                 been already.  It should then create the relevant
2057                 binary package(s), using <prgn>dpkg-gencontrol</prgn> to
2058                 make their control files and <prgn>dpkg-deb</prgn> to
2059                 build them and place them in the parent of the top
2060                 level directory.
2061               </p>
2062
2063               <p>
2064                 Both the <tt>binary-arch</tt> and
2065                 <tt>binary-indep</tt> targets <em>must</em> exist.
2066                 If one of them has nothing to do (which will always be
2067                 the case if the source generates only a single binary
2068                 package, whether architecture-dependent or not), it
2069                 must still exist and must always succeed.
2070               </p>
2071
2072               <p>
2073                 The <tt>binary</tt> targets must be invoked as
2074                 root.<footnote>
2075                     The <prgn>fakeroot</prgn> package often allows one
2076                     to build a package correctly even without being
2077                     root.
2078                 </footnote>
2079               </p>
2080             </item>
2081
2082             <tag><tt>clean</tt> (required)</tag>
2083             <item>
2084               <p>
2085                 This must undo any effects that the <tt>build</tt>
2086                 and <tt>binary</tt> targets may have had, except
2087                 that it should leave alone any output files created in
2088                 the parent directory by a run of a <tt>binary</tt>
2089                 target.
2090               </p>
2091
2092               <p>
2093                 If a <tt>build</tt> file is touched at the end of
2094                 the <tt>build</tt> target, as suggested above, it
2095                 should be removed as the first action that
2096                 <tt>clean</tt> performs, so that running
2097                 <tt>build</tt> again after an interrupted
2098                 <tt>clean</tt> doesn't think that everything is
2099                 already done.
2100               </p>
2101
2102               <p>
2103                 The <tt>clean</tt> target may need to be
2104                 invoked as root if <tt>binary</tt> has been
2105                 invoked since the last <tt>clean</tt>, or if
2106                 <tt>build</tt> has been invoked as root (since
2107                 <tt>build</tt> may create directories, for
2108                 example).
2109               </p>
2110             </item>
2111
2112             <tag><tt>get-orig-source</tt> (optional)</tag>
2113             <item>
2114               <p>
2115                 This target fetches the most recent version of the
2116                 original source package from a canonical archive site
2117                 (via FTP or WWW, for example), does any necessary
2118                 rearrangement to turn it into the original source
2119                 tar file format described below, and leaves it in the
2120                 current directory.
2121               </p>
2122
2123               <p>
2124                 This target may be invoked in any directory, and
2125                 should take care to clean up any temporary files it
2126                 may have left.
2127               </p>
2128
2129               <p>
2130                 This target is optional, but providing it if
2131                 possible is a good idea.
2132               </p>
2133             </item>
2134
2135             <tag><tt>patch</tt> (optional)</tag>
2136             <item>
2137               <p>
2138                 This target performs whatever additional actions are
2139                 required to make the source ready for editing (unpacking
2140                 additional upstream archives, applying patches, etc.).
2141                 It is recommended to be implemented for any package where
2142                 <tt>dpkg-source -x</tt> does not result in source ready
2143                 for additional modification.  See
2144                 <ref id="readmesource">.
2145               </p>
2146             </item>
2147           </taglist>
2148
2149         <p>
2150           The <tt>build</tt>, <tt>binary</tt> and
2151           <tt>clean</tt> targets must be invoked with the current
2152           directory being the package's top-level directory.
2153         </p>
2154
2155
2156         <p>
2157           Additional targets may exist in <file>debian/rules</file>,
2158           either as published or undocumented interfaces or for the
2159           package's internal use.
2160         </p>
2161
2162         <p>
2163           The architectures we build on and build for are determined
2164           by <prgn>make</prgn> variables using the
2165           utility <prgn>dpkg-architecture</prgn>.
2166           You can determine the Debian architecture and the GNU style
2167           architecture specification string for the build architecture as
2168           well as for the host architecture.  The build architecture is
2169           the architecture on which <file>debian/rules</file> is run and
2170           the package build is performed.  The host architecture is the
2171           architecture on which the resulting package will be installed
2172           and run.  These are normally the same, but may be different in
2173           the case of cross-compilation (building packages for one
2174           architecture on machines of a different architecture).
2175         </p>
2176
2177         <p>
2178           Here is a list of supported <prgn>make</prgn> variables:
2179           <list compact="compact">
2180             <item>
2181                 <tt>DEB_*_ARCH</tt> (the Debian architecture)
2182             </item>
2183             <item>
2184                 <tt>DEB_*_ARCH_CPU</tt> (the Debian CPU name)
2185             </item>
2186             <item>
2187                 <tt>DEB_*_ARCH_OS</tt> (the Debian System name)
2188             </item>
2189             <item>
2190                 <tt>DEB_*_GNU_TYPE</tt> (the GNU style architecture
2191                 specification string)
2192             </item>
2193             <item>
2194                 <tt>DEB_*_GNU_CPU</tt> (the CPU part of
2195                 <tt>DEB_*_GNU_TYPE</tt>)
2196             </item>
2197             <item>
2198                 <tt>DEB_*_GNU_SYSTEM</tt> (the System part of
2199                 <tt>DEB_*_GNU_TYPE</tt>)
2200           </list>
2201           where <tt>*</tt> is either <tt>BUILD</tt> for specification of
2202           the build architecture or <tt>HOST</tt> for specification of the
2203           host architecture.
2204         </p>
2205
2206         <p>
2207           Backward compatibility can be provided in the rules file
2208           by setting the needed variables to suitable default
2209           values; please refer to the documentation of
2210           <prgn>dpkg-architecture</prgn> for details.
2211         </p>
2212
2213         <p>
2214           It is important to understand that the <tt>DEB_*_ARCH</tt>
2215           string only determines which Debian architecture we are
2216           building on or for. It should not be used to get the CPU
2217           or system information; the <tt>DEB_*_ARCH_CPU</tt> and
2218           <tt>DEB_*_ARCH_OS</tt> variables should be used for that.
2219           GNU style variables should generally only be used with upstream
2220           build systems.
2221         </p>
2222
2223         <sect1 id="debianrules-options">
2224           <heading><file>debian/rules</file> and
2225             <tt>DEB_BUILD_OPTIONS</tt></heading>
2226
2227           <p>
2228             Supporting the standardized environment variable
2229             <tt>DEB_BUILD_OPTIONS</tt> is recommended.  This variable can
2230             contain several flags to change how a package is compiled and
2231             built.  Each flag must be in the form <var>flag</var> or
2232             <var>flag</var>=<var>options</var>.  If multiple flags are
2233             given, they must be separated by whitespace.<footnote>
2234               Some packages support any delimiter, but whitespace is the
2235               easiest to parse inside a makefile and avoids ambiguity with
2236               flag values that contain commas.
2237             </footnote>
2238             <var>flag</var> must start with a lowercase letter
2239             (<tt>a-z</tt>) and consist only of lowercase letters,
2240             numbers (<tt>0-9</tt>), and the characters
2241             <tt>-</tt> and <tt>_</tt> (hyphen and underscore).
2242             <var>options</var> must not contain whitespace.  The same
2243             tag should not be given multiple times with conflicting
2244             values.  Package maintainers may assume that
2245             <tt>DEB_BUILD_OPTIONS</tt> will not contain conflicting tags.
2246           </p>
2247
2248           <p>
2249             The meaning of the following tags has been standardized:
2250             <taglist>
2251               <tag>nocheck</tag>
2252               <item>
2253                   This tag says to not run any build-time test suite
2254                   provided by the package.
2255               </item>
2256               <tag>noopt</tag>
2257               <item>
2258                   The presence of this tag means that the package should
2259                   be compiled with a minimum of optimization.  For C
2260                   programs, it is best to add <tt>-O0</tt> to
2261                   <tt>CFLAGS</tt> (although this is usually the default).
2262                   Some programs might fail to build or run at this level
2263                   of optimization; it may be necessary to use
2264                   <tt>-O1</tt>, for example.
2265               </item>
2266               <tag>nostrip</tag>
2267               <item>
2268                   This tag means that the debugging symbols should not be
2269                   stripped from the binary during installation, so that
2270                   debugging information may be included in the package.
2271               </item>
2272               <tag>parallel=n</tag>
2273               <item>
2274                   This tag means that the package should be built using up
2275                   to <tt>n</tt> parallel processes if the package build
2276                   system supports this.<footnote>
2277                       Packages built with <tt>make</tt> can often implement
2278                       this by passing the <tt>-j</tt><var>n</var> option to
2279                       <tt>make</tt>.
2280                   </footnote>
2281                   If the package build system does not support parallel
2282                   builds, this string must be ignored.  If the package
2283                   build system only supports a lower level of concurrency
2284                   than <var>n</var>, the package should be built using as
2285                   many parallel processes as the package build system
2286                   supports.  It is up to the package maintainer to decide
2287                   whether the package build times are long enough and the
2288                   package build system is robust enough to make supporting
2289                   parallel builds worthwhile.
2290                </item>
2291             </taglist>
2292           </p>
2293
2294           <p>
2295             Unknown flags must be ignored by <file>debian/rules</file>.
2296           </p>
2297
2298           <p>
2299             The following makefile snippet is an example of how one may
2300             implement the build options; you will probably have to
2301             massage this example in order to make it work for your
2302             package.
2303             <example compact="compact">
2304 CFLAGS = -Wall -g
2305 INSTALL = install
2306 INSTALL_FILE    = $(INSTALL) -p    -o root -g root  -m  644
2307 INSTALL_PROGRAM = $(INSTALL) -p    -o root -g root  -m  755
2308 INSTALL_SCRIPT  = $(INSTALL) -p    -o root -g root  -m  755
2309 INSTALL_DIR     = $(INSTALL) -p -d -o root -g root  -m  755
2310
2311 ifneq (,$(filter noopt,$(DEB_BUILD_OPTIONS)))
2312     CFLAGS += -O0
2313 else
2314     CFLAGS += -O2
2315 endif
2316 ifeq (,$(filter nostrip,$(DEB_BUILD_OPTIONS)))
2317     INSTALL_PROGRAM += -s
2318 endif
2319 ifneq (,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
2320     NUMJOBS = $(patsubst parallel=%,%,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
2321     MAKEFLAGS += -j$(NUMJOBS)
2322 endif
2323
2324 build:
2325         # ...
2326 ifeq (,$(filter nocheck,$(DEB_BUILD_OPTIONS)))
2327         # Code to run the package test suite.
2328 endif
2329             </example>
2330           </p>
2331         </sect1>
2332       </sect>
2333
2334 <!-- FIXME: section pkg-srcsubstvars is the same as substvars -->
2335       <sect id="substvars">
2336         <heading>Variable substitutions: <file>debian/substvars</file></heading>
2337
2338         <p>
2339           When <prgn>dpkg-gencontrol</prgn>
2340           generates <qref id="binarycontrolfiles">binary package control
2341           files</qref> (<file>DEBIAN/control</file>), it performs variable
2342           substitutions on its output just before writing it.  Variable
2343           substitutions have the form <tt>${<var>variable</var>}</tt>.
2344           The optional file <file>debian/substvars</file> contains
2345           variable substitutions to be used; variables can also be set
2346           directly from <file>debian/rules</file> using the <tt>-V</tt>
2347           option to the source packaging commands, and certain predefined
2348           variables are also available.
2349         </p>
2350
2351         <p>
2352           The <file>debian/substvars</file> file is usually generated and
2353           modified dynamically by <file>debian/rules</file> targets, in
2354           which case it must be removed by the <tt>clean</tt> target.
2355         </p>
2356
2357         <p>
2358           See <manref name="deb-substvars" section="5"> for full
2359           details about source variable substitutions, including the
2360           format of <file>debian/substvars</file>.</p>
2361       </sect>
2362
2363       <sect id="debianwatch">
2364         <heading>Optional upstream source location: <file>debian/watch</file></heading>
2365
2366         <p>
2367           This is an optional, recommended configuration file for the
2368           <tt>uscan</tt> utility which defines how to automatically scan
2369           ftp or http sites for newly available updates of the
2370           package. This is used Debian QA
2371           tools to help with quality control and maintenance of the
2372           distribution as a whole.
2373         </p>
2374
2375       </sect>
2376
2377       <sect id="debianfiles">
2378         <heading>Generated files list: <file>debian/files</file></heading>
2379
2380         <p>
2381           This file is not a permanent part of the source tree; it
2382           is used while building packages to record which files are
2383           being generated.  <prgn>dpkg-genchanges</prgn> uses it
2384           when it generates a <file>.changes</file> file.
2385         </p>
2386
2387         <p>
2388           It should not exist in a shipped source package, and so it
2389           (and any backup files or temporary files such as
2390           <file>files.new</file><footnote>
2391               <file>files.new</file> is used as a temporary file by
2392               <prgn>dpkg-gencontrol</prgn> and
2393               <prgn>dpkg-distaddfile</prgn> - they write a new
2394               version of <tt>files</tt> here before renaming it,
2395               to avoid leaving a corrupted copy if an error
2396               occurs.
2397           </footnote>) should be removed by the
2398           <tt>clean</tt> target.  It may also be wise to
2399           ensure a fresh start by emptying or removing it at the
2400           start of the <tt>binary</tt> target.
2401         </p>
2402
2403         <p>
2404           When <prgn>dpkg-gencontrol</prgn> is run for a binary
2405           package, it adds an entry to <file>debian/files</file> for the
2406           <file>.deb</file> file that will be created when <tt>dpkg-deb
2407           --build</tt> is run for that binary package.  So for most
2408           packages all that needs to be done with this file is to
2409           delete it in the <tt>clean</tt> target.
2410         </p>
2411
2412         <p>
2413           If a package upload includes files besides the source
2414           package and any binary packages whose control files were
2415           made with <prgn>dpkg-gencontrol</prgn> then they should be
2416           placed in the parent of the package's top-level directory
2417           and <prgn>dpkg-distaddfile</prgn> should be called to add
2418           the file to the list in <file>debian/files</file>.</p>
2419       </sect>
2420
2421       <sect id="embeddedfiles">
2422         <heading>Convenience copies of code</heading>
2423
2424         <p>
2425           Some software packages include in their distribution convenience
2426           copies of code from other software packages, generally so that
2427           users compiling from source don't have to download multiple
2428           packages.  Debian packages should not make use of these
2429           convenience copies unless the included package is explicitly
2430           intended to be used in this way.<footnote>
2431             For example, parts of the GNU build system work like this.
2432           </footnote>
2433           If the included code is already in the Debian archive in the
2434           form of a library, the Debian packaging should ensure that
2435           binary packages reference the libraries already in Debian and
2436           the convenience copy is not used.  If the included code is not
2437           already in Debian, it should be packaged separately as a
2438           prerequisite if possible.
2439           <footnote>
2440             Having multiple copies of the same code in Debian is
2441             inefficient, often creates either static linking or shared
2442             library conflicts, and, most importantly, increases the
2443             difficulty of handling security vulnerabilities in the
2444             duplicated code.
2445           </footnote>
2446         </p>
2447       </sect>
2448
2449       <sect id="readmesource">
2450         <heading>Source package handling:
2451           <file>debian/README.source</file></heading>
2452
2453         <p>
2454           If running <prgn>dpkg-source -x</prgn> on a source package
2455           doesn't produce the source of the package, ready for editing,
2456           and allow one to make changes and run
2457           <prgn>dpkg-buildpackage</prgn> to produce a modified package
2458           without taking any additional steps, creating a
2459           <file>debian/README.source</file> documentation file is
2460           recommended.  This file should explain how to do all of the
2461           following:
2462             <enumlist>
2463               <item>Generate the fully patched source, in a form ready for
2464               editing, that would be built to create Debian
2465               packages.  Doing this with a <tt>patch</tt> target in
2466               <file>debian/rules</file> is recommended; see
2467               <ref id="debianrules">.</item>
2468               <item>Modify the source and save those modifications so that
2469               they will be applied when building the package.</item>
2470               <item>Remove source modifications that are currently being
2471               applied when building the package.</item>
2472               <item>Optionally, document what steps are necessary to
2473               upgrade the Debian source package to a new upstream version,
2474               if applicable.</item>
2475             </enumlist>
2476           This explanation should include specific commands and mention
2477           any additional required Debian packages.  It should not assume
2478           familiarity with any specific Debian packaging system or patch
2479           management tools.
2480         </p>
2481
2482         <p>
2483           This explanation may refer to a documentation file installed by
2484           one of the package's build dependencies provided that the
2485           referenced documentation clearly explains these tasks and is not
2486           a general reference manual.
2487         </p>
2488
2489         <p>
2490           <file>debian/README.source</file> may also include any other
2491           information that would be helpful to someone modifying the
2492           source package.  Even if the package doesn't fit the above
2493           description, maintainers are encouraged to document in a
2494           <file>debian/README.source</file> file any source package with a
2495           particularly complex or unintuitive source layout or build
2496           system (for example, a package that builds the same source
2497           multiple times to generate different binary packages).
2498         </p>
2499       </sect>
2500     </chapt>
2501
2502
2503     <chapt id="controlfields">
2504       <heading>Control files and their fields</heading>
2505
2506       <p>
2507         The package management system manipulates data represented in
2508         a common format, known as <em>control data</em>, stored in
2509         <em>control files</em>.
2510         Control files are used for source packages, binary packages and
2511         the <file>.changes</file> files which control the installation
2512         of uploaded files<footnote>
2513             <prgn>dpkg</prgn>'s internal databases are in a similar
2514             format.
2515         </footnote>.
2516       </p>
2517
2518       <sect id="controlsyntax">
2519         <heading>Syntax of control files</heading>
2520
2521         <p>
2522           A control file consists of one or more paragraphs of
2523           fields<footnote>
2524                 The paragraphs are also sometimes referred to as stanzas.
2525           </footnote>.
2526           The paragraphs are separated by empty lines.  Parsers may accept
2527           lines consisting solely of spaces and tabs as paragraph
2528           separators, but control files should use empty lines.  Some control
2529           files allow only one paragraph; others allow several, in
2530           which case each paragraph usually refers to a different
2531           package.  (For example, in source packages, the first
2532           paragraph refers to the source package, and later paragraphs
2533           refer to binary packages generated from the source.)  The
2534           ordering of the paragraphs in control files is significant.
2535         </p>
2536
2537         <p>
2538           Each paragraph consists of a series of data fields.  Each field
2539           consists of the field name followed by a colon and then the
2540           data/value associated with that field.  The field name is
2541           composed of US-ASCII characters excluding control characters,
2542           space, and colon (i.e., characters in the ranges 33-57 and
2543           59-126, inclusive).  Field names must not begin with the comment
2544           character, <tt>#</tt>, nor with the hyphen character, <tt>-</tt>.
2545         </p>
2546
2547         <p>
2548           The field ends at the end of the line or at the end of the last
2549           continuation line (see below).  Horizontal whitespace (spaces
2550           and tabs) may occur immediately before or after the value and is
2551           ignored there; it is conventional to put a single space after
2552           the colon.  For example, a field might be:
2553           <example compact="compact">
2554 Package: libc6
2555           </example>
2556           the field name is <tt>Package</tt> and the field value
2557           <tt>libc6</tt>.
2558         </p>
2559
2560         <p>
2561           A paragraph must not contain more than one instance of a
2562           particular field name.
2563         </p>
2564
2565         <p>
2566           There are three types of fields:
2567           <taglist>
2568             <tag>simple</tag>
2569             <item>
2570               The field, including its value, must be a single line.  Folding
2571               of the field is not permitted.  This is the default field type
2572               if the definition of the field does not specify a different
2573               type.
2574             </item>
2575             <tag>folded</tag>
2576             <item>
2577               The value of a folded field is a logical line that may span
2578               several lines.  The lines after the first are called
2579               continuation lines and must start with a space or a tab.
2580               Whitespace, including any newlines, is not significant in the
2581               field values of folded fields.<footnote>
2582                 This folding method is similar to RFC 5322, allowing control
2583                 files that contain only one paragraph and no multiline fields
2584                 to be read by parsers written for RFC 5322.
2585               </footnote>
2586             </item>
2587             <tag>multiline</tag>
2588             <item>
2589               The value of a multiline field may comprise multiple continuation
2590               lines.  The first line of the value, the part on the same line as
2591               the field name, often has special significance or may have to be
2592               empty.  Other lines are added following the same syntax as the
2593               continuation lines of the folded fields.  Whitespace, including newlines,
2594               is significant in the values of multiline fields.
2595             </item>
2596           </taglist>
2597         </p>
2598
2599         <p>
2600           Whitespace must not appear
2601           inside names (of packages, architectures, files or anything
2602           else) or version numbers, or between the characters of
2603           multi-character version relationships.
2604         </p>
2605
2606         <p>
2607           The presence and purpose of a field, and the syntax of its
2608           value may differ between types of control files.
2609         </p>
2610
2611         <p>
2612           Field names are not case-sensitive, but it is usual to
2613           capitalize the field names using mixed case as shown below.
2614           Field values are case-sensitive unless the description of the
2615           field says otherwise.
2616         </p>
2617
2618         <p>
2619           Paragraph separators (empty lines) and lines consisting only of
2620           spaces and tabs are not allowed within field values or between
2621           fields.  Empty lines in field values are usually escaped by
2622           representing them by a space followed by a dot.
2623         </p>
2624
2625         <p>
2626           Lines starting with # without any preceding whitespace are comments
2627           lines that are only permitted in source package control files
2628           (<file>debian/control</file>).  These comment lines are ignored, even
2629           between two continuation lines.  They do not end logical lines.
2630         </p>
2631
2632         <p>
2633           All control files must be encoded in UTF-8.
2634         </p>
2635       </sect>
2636
2637       <sect id="sourcecontrolfiles">
2638         <heading>Source package control files -- <file>debian/control</file></heading>
2639
2640         <p>
2641           The <file>debian/control</file> file contains the most vital
2642           (and version-independent) information about the source package
2643           and about the binary packages it creates.
2644         </p>
2645
2646         <p>
2647           The first paragraph of the control file contains information about
2648           the source package in general. The subsequent sets each describe a
2649           binary package that the source tree builds.
2650         </p>
2651
2652         <p>
2653           The fields in the general paragraph (the first one, for the source
2654           package) are:
2655
2656           <list compact="compact">
2657             <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2658             <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2659             <item><qref id="f-Uploaders"><tt>Uploaders</tt></qref></item>
2660             <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2661             <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2662             <item><qref id="sourcebinarydeps"><tt>Build-Depends</tt> et al</qref></item>
2663             <item><qref id="f-Standards-Version"><tt>Standards-Version</tt></qref> (recommended)</item>
2664             <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2665             <item><qref id="f-VCS-fields"><tt>Vcs-Browser</tt>, <tt>Vcs-Git</tt>, et al.</qref></item>
2666           </list>
2667         </p>
2668
2669         <p>
2670           The fields in the binary package paragraphs are:
2671
2672           <list compact="compact">
2673             <item><qref id="f-Package"><tt>Package</tt></qref> (mandatory)</item>
2674             <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2675             <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2676             <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2677             <item><qref id="f-Essential"><tt>Essential</tt></qref></item>
2678             <item><qref id="binarydeps"><tt>Depends</tt> et al</qref></item>
2679             <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2680             <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2681             <item><qref id="built-using"><tt>Built-Using</tt></qref></item>
2682             <item><qref id="f-Package-Type"><tt>Package-Type</tt></qref></item>
2683           </list>
2684         </p>
2685
2686         <p>
2687           The syntax and semantics of the fields are described below.
2688         </p>
2689
2690         <p>
2691           These fields are used by <prgn>dpkg-gencontrol</prgn> to
2692           generate control files for binary packages (see below), by
2693           <prgn>dpkg-genchanges</prgn> to generate the
2694           <file>.changes</file> file to accompany the upload, and by
2695           <prgn>dpkg-source</prgn> when it creates the
2696           <file>.dsc</file> source control file as part of a source
2697           archive.  Some fields are folded in <file>debian/control</file>,
2698           but not in any other control
2699           file. These tools are responsible for removing the line
2700           breaks from such fields when using fields from
2701           <file>debian/control</file> to generate other control files.
2702         </p>
2703
2704         <p>
2705           The fields here may contain variable references - their
2706           values will be substituted by <prgn>dpkg-gencontrol</prgn>,
2707           <prgn>dpkg-genchanges</prgn> or <prgn>dpkg-source</prgn>
2708           when they generate output control files.
2709           See <ref id="substvars"> for details.
2710         </p>
2711       </sect>
2712
2713       <sect id="binarycontrolfiles">
2714         <heading>Binary package control files -- <file>DEBIAN/control</file></heading>
2715
2716         <p>
2717           The <file>DEBIAN/control</file> file contains the most vital
2718           (and version-dependent) information about a binary package.  It
2719           consists of a single paragraph.
2720         </p>
2721
2722         <p>
2723           The fields in this file are:
2724
2725           <list compact="compact">
2726             <item><qref id="f-Package"><tt>Package</tt></qref> (mandatory)</item>
2727             <item><qref id="f-Source"><tt>Source</tt></qref></item>
2728             <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2729             <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2730             <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2731             <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2732             <item><qref id="f-Essential"><tt>Essential</tt></qref></item>
2733             <item><qref id="binarydeps"><tt>Depends</tt> et al</qref></item>
2734             <item><qref id="f-Installed-Size"><tt>Installed-Size</tt></qref></item>
2735             <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2736             <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2737             <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2738             <item><qref id="built-using"><tt>Built-Using</tt></qref></item>
2739           </list>
2740         </p>
2741       </sect>
2742
2743       <sect id="debiansourcecontrolfiles">
2744         <heading>Debian source control files -- <tt>.dsc</tt></heading>
2745
2746         <p>
2747           This file consists of a single paragraph, possibly surrounded by
2748           a PGP signature. The fields of that paragraph are listed below.
2749           Their syntax is described above, in <ref id="controlsyntax">.
2750
2751         <list compact="compact">
2752           <item><qref id="f-Format"><tt>Format</tt></qref> (mandatory)</item>
2753           <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2754           <item><qref id="f-Binary"><tt>Binary</tt></qref></item>
2755           <item><qref id="f-Architecture"><tt>Architecture</tt></qref></item>
2756           <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2757           <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2758           <item><qref id="f-Uploaders"><tt>Uploaders</tt></qref></item>
2759           <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2760           <item><qref id="f-VCS-fields"><tt>Vcs-Browser</tt>, <tt>Vcs-Git</tt>, et al.</qref></item>
2761           <item><qref id="f-Dgit"><tt>Dgit</tt></qref></item>
2762           <item><qref id="f-Standards-Version"><tt>Standards-Version</tt></qref> (recommended)</item>
2763           <item><qref id="sourcebinarydeps"><tt>Build-Depends</tt> et al</qref></item>
2764           <item><qref id="f-Package-List"><tt>Package-List</tt></qref> (recommended)</item>
2765           <item><qref id="f-Checksums"><tt>Checksums-Sha1</tt>
2766               and <tt>Checksums-Sha256</tt></qref> (mandatory)</item>
2767           <item><qref id="f-Files"><tt>Files</tt></qref> (mandatory)</item>
2768         </list>
2769         </p>
2770
2771         <p>
2772           The Debian source control file is generated by
2773           <prgn>dpkg-source</prgn> when it builds the source
2774           archive, from other files in the source package,
2775           described above.  When unpacking, it is checked against
2776           the files and directories in the other parts of the
2777           source package.
2778         </p>
2779
2780       </sect>
2781
2782       <sect id="debianchangesfiles">
2783         <heading>Debian changes files -- <file>.changes</file></heading>
2784
2785         <p>
2786           The <file>.changes</file> files are used by the Debian archive
2787           maintenance software to process updates to packages. They
2788           consist of a single paragraph, possibly surrounded by a PGP
2789           signature. That paragraph contains information from the
2790           <file>debian/control</file> file and other data about the
2791           source package gathered via <file>debian/changelog</file>
2792           and <file>debian/rules</file>.
2793         </p>
2794
2795         <p>
2796           <file>.changes</file> files have a format version that is
2797           incremented whenever the documented fields or their meaning
2798           change.  This document describes format &changesversion;.
2799         </p>
2800
2801         <p>
2802           The fields in this file are:
2803
2804           <list compact="compact">
2805             <item><qref id="f-Format"><tt>Format</tt></qref> (mandatory)</item>
2806             <item><qref id="f-Date"><tt>Date</tt></qref> (mandatory)</item>
2807             <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2808             <item><qref id="f-Binary"><tt>Binary</tt></qref> (mandatory)</item>
2809             <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2810             <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2811             <item><qref id="f-Distribution"><tt>Distribution</tt></qref> (mandatory)</item>
2812             <item><qref id="f-Urgency"><tt>Urgency</tt></qref> (recommended)</item>
2813             <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2814             <item><qref id="f-Changed-By"><tt>Changed-By</tt></qref></item>
2815             <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2816             <item><qref id="f-Closes"><tt>Closes</tt></qref></item>
2817             <item><qref id="f-Changes"><tt>Changes</tt></qref> (mandatory)</item>
2818             <item><qref id="f-Checksums"><tt>Checksums-Sha1</tt>
2819                 and <tt>Checksums-Sha256</tt></qref> (mandatory)</item>
2820             <item><qref id="f-Files"><tt>Files</tt></qref> (mandatory)</item>
2821           </list>
2822         </p>
2823       </sect>
2824
2825       <sect id="controlfieldslist">
2826         <heading>List of fields</heading>
2827
2828         <sect1 id="f-Source">
2829           <heading><tt>Source</tt></heading>
2830
2831           <p>
2832             This field identifies the source package name.
2833           </p>
2834
2835           <p>
2836             In <file>debian/control</file> or a <file>.dsc</file> file,
2837             this field must contain only the name of the source package.
2838           </p>
2839
2840           <p>
2841             In a binary package control file or a <file>.changes</file>
2842             file, the source package name may be followed by a version
2843             number in parentheses<footnote>
2844                 It is customary to leave a space after the package name
2845                 if a version number is specified.
2846             </footnote>.
2847             This version number may be omitted (and is, by
2848             <prgn>dpkg-gencontrol</prgn>) if it has the same value as
2849             the <tt>Version</tt> field of the binary package in
2850             question.  The field itself may be omitted from a binary
2851             package control file when the source package has the same
2852             name and version as the binary package.
2853           </p>
2854
2855           <p>
2856             Package names (both source and binary,
2857             see <ref id="f-Package">) must consist only of lower case
2858             letters (<tt>a-z</tt>), digits (<tt>0-9</tt>), plus
2859             (<tt>+</tt>) and minus (<tt>-</tt>) signs, and periods
2860             (<tt>.</tt>).  They must be at least two characters long and
2861             must start with an alphanumeric character.
2862           </p>
2863         </sect1>
2864
2865         <sect1 id="f-Maintainer">
2866           <heading><tt>Maintainer</tt></heading>
2867
2868           <p>
2869             The package maintainer's name and email address.  The name
2870             must come first, then the email address inside angle
2871             brackets <tt>&lt;&gt;</tt> (in RFC822 format).
2872           </p>
2873
2874           <p>
2875             If the maintainer's name contains a full stop then the
2876             whole field will not work directly as an email address due
2877             to a misfeature in the syntax specified in RFC822; a
2878             program using this field as an address must check for this
2879             and correct the problem if necessary (for example by
2880             putting the name in round brackets and moving it to the
2881             end, and bringing the email address forward).
2882           </p>
2883
2884           <p>
2885             See <ref id="maintainer"> for additional requirements and
2886             information about package maintainers.
2887           </p>
2888         </sect1>
2889
2890         <sect1 id="f-Uploaders">
2891           <heading><tt>Uploaders</tt></heading>
2892
2893           <p>
2894             List of the names and email addresses of co-maintainers of the
2895             package, if any. If the package has other maintainers besides
2896             the one named in the <qref id="f-Maintainer">Maintainer
2897             field</qref>, their names and email addresses should be listed
2898             here. The format of each entry is the same as that of the
2899             Maintainer field, and multiple entries must be comma
2900             separated.
2901           </p>
2902
2903           <p>
2904             This is normally an optional field, but if
2905             the <tt>Maintainer</tt> control field names a group of people
2906             and a shared email address, the <tt>Uploaders</tt> field must
2907             be present and must contain at least one human with their
2908             personal email address.
2909           </p>
2910
2911           <p>
2912             The Uploaders field in <file>debian/control</file> can be folded.
2913           </p>
2914         </sect1>
2915
2916         <sect1 id="f-Changed-By">
2917           <heading><tt>Changed-By</tt></heading>
2918
2919           <p>
2920             The name and email address of the person who prepared this
2921             version of the package, usually a maintainer.  The syntax is
2922             the same as for the <qref id="f-Maintainer">Maintainer
2923             field</qref>.
2924           </p>
2925         </sect1>
2926
2927         <sect1 id="f-Section">
2928           <heading><tt>Section</tt></heading>
2929
2930           <p>
2931             This field specifies an application area into which the package
2932             has been classified. See <ref id="subsections">.
2933           </p>
2934
2935           <p>
2936             When it appears in the <file>debian/control</file> file,
2937             it gives the value for the subfield of the same name in
2938             the <tt>Files</tt> field of the <file>.changes</file> file.
2939             It also gives the default for the same field in the binary
2940             packages.
2941           </p>
2942         </sect1>
2943
2944         <sect1 id="f-Priority">
2945           <heading><tt>Priority</tt></heading>
2946
2947           <p>
2948             This field represents how important it is that the user
2949             have the package installed. See <ref id="priorities">.
2950           </p>
2951
2952           <p>
2953             When it appears in the <file>debian/control</file> file,
2954             it gives the value for the subfield of the same name in
2955             the <tt>Files</tt> field of the <file>.changes</file> file.
2956             It also gives the default for the same field in the binary
2957             packages.
2958           </p>
2959         </sect1>
2960
2961         <sect1 id="f-Package">
2962           <heading><tt>Package</tt></heading>
2963
2964           <p>
2965             The name of the binary package.
2966           </p>
2967
2968           <p>
2969             Binary package names must follow the same syntax and
2970             restrictions as source package names.  See <ref id="f-Source">
2971             for the details.
2972           </p>
2973         </sect1>
2974
2975         <sect1 id="f-Architecture">
2976           <heading><tt>Architecture</tt></heading>
2977
2978           <p>
2979             Depending on context and the control file used, the
2980             <tt>Architecture</tt> field can include the following sets of
2981             values:
2982             <list>
2983                 <item>
2984                   A unique single word identifying a Debian machine
2985                   architecture as described in <ref id="arch-spec">.
2986                 </item>
2987                 <item>
2988                   An architecture wildcard identifying a set of Debian
2989                   machine architectures, see <ref id="arch-wildcard-spec">.
2990                   <tt>any</tt> matches all Debian machine architectures
2991                   and is the most frequently used.
2992                 </item>
2993                 <item>
2994                   <tt>all</tt>, which indicates an
2995                   architecture-independent package.
2996                 </item>
2997                 <item>
2998                   <tt>source</tt>, which indicates a source package.
2999                 </item>
3000             </list>
3001           </p>
3002
3003           <p>
3004             In the main <file>debian/control</file> file in the source
3005             package, this field may contain the special
3006             value <tt>all</tt>, the special architecture
3007             wildcard <tt>any</tt>, or a list of specific and wildcard
3008             architectures separated by spaces.  If <tt>all</tt>
3009             or <tt>any</tt> appears, that value must be the entire
3010             contents of the field.  Most packages will use
3011             either <tt>all</tt> or <tt>any</tt>.
3012           </p>
3013
3014           <p>
3015             Specifying a specific list of architectures indicates that the
3016             source will build an architecture-dependent package only on
3017             architectures included in the list.  Specifying a list of
3018             architecture wildcards indicates that the source will build an
3019             architecture-dependent package on only those architectures
3020             that match any of the specified architecture wildcards.
3021             Specifying a list of architectures or architecture wildcards
3022             other than <tt>any</tt> is for the minority of cases where a
3023             program is not portable or is not useful on some
3024             architectures.  Where possible, the program should be made
3025             portable instead.
3026           </p>
3027
3028           <p>
3029             In the Debian source control file <file>.dsc</file>, this
3030             field contains a list of architectures and architecture
3031             wildcards separated by spaces. When the list contains the
3032             architecture wildcard <tt>any</tt>, the only other value
3033             allowed in the list is <tt>all</tt>.
3034           </p>
3035
3036           <p>
3037             The list may include (or consist solely of) the special
3038             value <tt>all</tt>.  In other words, in <file>.dsc</file>
3039             files unlike the <file>debian/control</file>, <tt>all</tt> may
3040             occur in combination with specific architectures.
3041             The <tt>Architecture</tt> field in the Debian source control
3042             file <file>.dsc</file> is generally constructed from
3043             the <tt>Architecture</tt> fields in
3044             the <file>debian/control</file> in the source package.
3045           </p>
3046
3047           <p>
3048             Specifying only <tt>any</tt> indicates that the source package
3049             isn't dependent on any particular architecture and should
3050             compile fine on any one. The produced binary package(s)
3051             will be specific to whatever the current build architecture is.
3052           </p>
3053
3054           <p>
3055             Specifying only <tt>all</tt> indicates that the source package
3056             will only build architecture-independent packages.
3057           </p>
3058
3059           <p>
3060             Specifying <tt>any all</tt> indicates that the source package
3061             isn't dependent on any particular architecture. The set of
3062             produced binary packages will include at least one
3063             architecture-dependant package and one architecture-independent
3064             package.
3065           </p>
3066
3067           <p>
3068             Specifying a list of architectures or architecture wildcards
3069             indicates that the source will build an architecture-dependent
3070             package, and will only work correctly on the listed or
3071             matching architectures.  If the source package also builds at
3072             least one architecture-independent package, <tt>all</tt> will
3073             also be included in the list.
3074           </p>
3075
3076           <p>
3077             In a <file>.changes</file> file, the <tt>Architecture</tt>
3078             field lists the architecture(s) of the package(s) currently
3079             being uploaded.  This will be a list; if the source for the
3080             package is also being uploaded, the special
3081             entry <tt>source</tt> is also present.  <tt>all</tt> will be
3082             present if any architecture-independent packages are being
3083             uploaded.  Architecture wildcards such as <tt>any</tt> must
3084             never occur in the <tt>Architecture</tt> field in
3085             the <file>.changes</file> file.
3086           </p>
3087
3088           <p>
3089             See <ref id="debianrules"> for information on how to get
3090             the architecture for the build process.
3091           </p>
3092         </sect1>
3093
3094         <sect1 id="f-Essential">
3095           <heading><tt>Essential</tt></heading>
3096
3097           <p>
3098             This is a boolean field which may occur only in the
3099             control file of a binary package or in a per-package fields
3100             paragraph of a source package control file.
3101           </p>
3102
3103           <p>
3104             If set to <tt>yes</tt> then the package management system
3105             will refuse to remove the package (upgrading and replacing
3106             it is still possible). The other possible value is <tt>no</tt>,
3107             which is the same as not having the field at all.
3108           </p>
3109         </sect1>
3110
3111         <sect1>
3112           <heading>Package interrelationship fields:
3113             <tt>Depends</tt>, <tt>Pre-Depends</tt>,
3114             <tt>Recommends</tt>, <tt>Suggests</tt>,
3115             <tt>Breaks</tt>, <tt>Conflicts</tt>,
3116             <tt>Provides</tt>, <tt>Replaces</tt>, <tt>Enhances</tt>
3117           </heading>
3118
3119           <p>
3120             These fields describe the package's relationships with
3121             other packages.  Their syntax and semantics are described
3122             in <ref id="relationships">.</p>
3123         </sect1>
3124
3125         <sect1 id="f-Standards-Version">
3126           <heading><tt>Standards-Version</tt></heading>
3127
3128           <p>
3129             The most recent version of the standards (the policy
3130             manual and associated texts) with which the package
3131             complies.
3132           </p>
3133
3134           <p>
3135             The version number has four components: major and minor
3136             version number and major and minor patch level.  When the
3137             standards change in a way that requires every package to
3138             change the major number will be changed.  Significant
3139             changes that will require work in many packages will be
3140             signaled by a change to the minor number.  The major patch
3141             level will be changed for any change to the meaning of the
3142             standards, however small; the minor patch level will be
3143             changed when only cosmetic, typographical or other edits
3144             are made which neither change the meaning of the document
3145             nor affect the contents of packages.
3146           </p>
3147
3148           <p>
3149             Thus only the first three components of the policy version
3150             are significant in the <em>Standards-Version</em> control
3151             field, and so either these three components or all four
3152             components may be specified.<footnote>
3153                 In the past, people specified the full version number
3154                 in the Standards-Version field, for example "2.3.0.0".
3155                 Since minor patch-level changes don't introduce new
3156                 policy, it was thought it would be better to relax
3157                 policy and only require the first 3 components to be
3158                 specified, in this example "2.3.0".  All four
3159                 components may still be used if someone wishes to do so.
3160             </footnote>
3161           </p>
3162
3163         </sect1>
3164
3165         <sect1 id="f-Version">
3166           <heading><tt>Version</tt></heading>
3167
3168           <p>
3169             The version number of a package. The format is:
3170             [<var>epoch</var><tt>:</tt>]<var>upstream_version</var>[<tt>-</tt><var>debian_revision</var>]
3171           </p>
3172
3173           <p>
3174             The three components here are:
3175             <taglist>
3176               <tag><var>epoch</var></tag>
3177               <item>
3178                 <p>
3179                   This is a single (generally small) unsigned integer.  It
3180                   may be omitted, in which case zero is assumed.  If it is
3181                   omitted then the <var>upstream_version</var> may not
3182                   contain any colons.
3183                 </p>
3184
3185                 <p>
3186                   It is provided to allow mistakes in the version numbers
3187                   of older versions of a package, and also a package's
3188                   previous version numbering schemes, to be left behind.
3189                 </p>
3190               </item>
3191
3192               <tag><var>upstream_version</var></tag>
3193               <item>
3194                 <p>
3195                   This is the main part of the version number.  It is
3196                   usually the version number of the original ("upstream")
3197                   package from which the <file>.deb</file> file has been made,
3198                   if this is applicable.  Usually this will be in the same
3199                   format as that specified by the upstream author(s);
3200                   however, it may need to be reformatted to fit into the
3201                   package management system's format and comparison
3202                   scheme.
3203                 </p>
3204
3205                 <p>
3206                   The comparison behavior of the package management system
3207                   with respect to the <var>upstream_version</var> is
3208                   described below.  The <var>upstream_version</var>
3209                   portion of the version number is mandatory.
3210                 </p>
3211
3212                 <p>
3213                   The <var>upstream_version</var> may contain only
3214                   alphanumerics<footnote>
3215                         Alphanumerics are <tt>A-Za-z0-9</tt> only.
3216                   </footnote>
3217                   and the characters <tt>.</tt> <tt>+</tt> <tt>-</tt>
3218                   <tt>:</tt> <tt>~</tt> (full stop, plus, hyphen, colon,
3219                   tilde) and should start with a digit.  If there is no
3220                   <var>debian_revision</var> then hyphens are not allowed;
3221                   if there is no <var>epoch</var> then colons are not
3222                   allowed.
3223                 </p>
3224               </item>
3225
3226               <tag><var>debian_revision</var></tag>
3227               <item>
3228                 <p>
3229                   This part of the version number specifies the version of
3230                   the Debian package based on the upstream version.  It
3231                   may contain only alphanumerics and the characters
3232                   <tt>+</tt> <tt>.</tt> <tt>~</tt> (plus, full stop,
3233                   tilde) and is compared in the same way as the
3234                   <var>upstream_version</var> is.
3235                 </p>
3236
3237                 <p>
3238                   It is optional; if it isn't present then the
3239                   <var>upstream_version</var> may not contain a hyphen.
3240                   This format represents the case where a piece of
3241                   software was written specifically to be a Debian
3242                   package, where the Debian package source must always
3243                   be identical to the pristine source and therefore no
3244                   revision indication is required.
3245                 </p>
3246
3247                 <p>
3248                   It is conventional to restart the
3249                   <var>debian_revision</var> at <tt>1</tt> each time the
3250                   <var>upstream_version</var> is increased.
3251                 </p>
3252
3253                 <p>
3254                   The package management system will break the version
3255                   number apart at the last hyphen in the string (if there
3256                   is one) to determine the <var>upstream_version</var> and
3257                   <var>debian_revision</var>.  The absence of a
3258                   <var>debian_revision</var> is equivalent to a
3259                   <var>debian_revision</var> of <tt>0</tt>.
3260                 </p>
3261               </item>
3262             </taglist>
3263           </p>
3264
3265           <p>
3266             When comparing two version numbers, first the <var>epoch</var>
3267             of each are compared, then the <var>upstream_version</var> if
3268             <var>epoch</var> is equal, and then <var>debian_revision</var>
3269             if <var>upstream_version</var> is also equal.
3270             <var>epoch</var> is compared numerically.  The
3271             <var>upstream_version</var> and <var>debian_revision</var>
3272             parts are compared by the package management system using the
3273             following algorithm:
3274           </p>
3275
3276           <p>
3277             The strings are compared from left to right.
3278           </p>
3279
3280           <p>
3281             First the initial part of each string consisting entirely of
3282             non-digit characters is determined.  These two parts (one of
3283             which may be empty) are compared lexically.  If a difference
3284             is found it is returned.  The lexical comparison is a
3285             comparison of ASCII values modified so that all the letters
3286             sort earlier than all the non-letters and so that a tilde
3287             sorts before anything, even the end of a part.  For example,
3288             the following parts are in sorted order from earliest to
3289             latest: <tt>~~</tt>, <tt>~~a</tt>, <tt>~</tt>, the empty part,
3290             <tt>a</tt>.<footnote>
3291               One common use of <tt>~</tt> is for upstream pre-releases.
3292               For example, <tt>1.0~beta1~svn1245</tt> sorts earlier than
3293               <tt>1.0~beta1</tt>, which sorts earlier than <tt>1.0</tt>.
3294             </footnote>
3295           </p>
3296
3297           <p>
3298             Then the initial part of the remainder of each string which
3299             consists entirely of digit characters is determined.  The
3300             numerical values of these two parts are compared, and any
3301             difference found is returned as the result of the comparison.
3302             For these purposes an empty string (which can only occur at
3303             the end of one or both version strings being compared) counts
3304             as zero.
3305           </p>
3306
3307           <p>
3308             These two steps (comparing and removing initial non-digit
3309             strings and initial digit strings) are repeated until a
3310             difference is found or both strings are exhausted.
3311           </p>
3312
3313           <p>
3314             Note that the purpose of epochs is to allow us to leave behind
3315             mistakes in version numbering, and to cope with situations
3316             where the version numbering scheme changes.  It is
3317             <em>not</em> intended to cope with version numbers containing
3318             strings of letters which the package management system cannot
3319             interpret (such as <tt>ALPHA</tt> or <tt>pre-</tt>), or with
3320             silly orderings.<footnote>
3321               The author of this manual has heard of a package whose
3322               versions went <tt>1.1</tt>, <tt>1.2</tt>, <tt>1.3</tt>,
3323               <tt>1</tt>, <tt>2.1</tt>, <tt>2.2</tt>, <tt>2</tt> and so
3324               forth.
3325             </footnote>
3326           </p>
3327         </sect1>
3328
3329         <sect1 id="f-Description">
3330           <heading><tt>Description</tt></heading>
3331
3332           <p>
3333             In a source or binary control file, the <tt>Description</tt>
3334             field contains a description of the binary package, consisting
3335             of two parts, the synopsis or the short description, and the
3336             long description.  It is a multiline field with the following
3337             format:
3338           </p>
3339
3340           <p>
3341 <example>
3342         Description: &lt;single line synopsis&gt;
3343          &lt;extended description over several lines&gt;
3344 </example>
3345           </p>
3346
3347           <p>
3348             The lines in the extended description can have these formats:
3349           </p>
3350
3351           <p><list>
3352
3353             <item>
3354               Those starting with a single space are part of a paragraph.
3355               Successive lines of this form will be word-wrapped when
3356               displayed. The leading space will usually be stripped off.
3357               The line must contain at least one non-whitespace character.
3358             </item>
3359
3360             <item>
3361               Those starting with two or more spaces. These will be
3362               displayed verbatim. If the display cannot be panned
3363               horizontally, the displaying program will line wrap them "hard"
3364               (i.e., without taking account of word breaks). If it can they
3365               will be allowed to trail off to the right. None, one or two
3366               initial spaces may be deleted, but the number of spaces
3367               deleted from each line will be the same (so that you can have
3368               indenting work correctly, for example).  The line must
3369               contain at least one non-whitespace character.
3370             </item>
3371
3372             <item>
3373               Those containing a single space followed by a single full stop
3374               character. These are rendered as blank lines. This is the
3375               <em>only</em> way to get a blank line<footnote>
3376                 Completely empty lines will not be rendered as blank lines.
3377                 Instead, they will cause the parser to think you're starting
3378                 a whole new record in the control file, and will therefore
3379                 likely abort with an error.
3380               </footnote>.
3381             </item>
3382
3383             <item>
3384               Those containing a space, a full stop and some more characters.
3385               These are for future expansion. Do not use them.
3386             </item>
3387
3388           </list></p>
3389
3390           <p>
3391             Do not use tab characters.  Their effect is not predictable.
3392           </p>
3393
3394           <p>
3395             See <ref id="descriptions"> for further information on this.
3396           </p>
3397
3398           <p>
3399             In a <file>.changes</file> file, the <tt>Description</tt>
3400             field contains a summary of the descriptions for the packages
3401             being uploaded.  For this case, the first line of the field
3402             value (the part on the same line as <tt>Description:</tt>) is
3403             always empty.  It is a multiline field, with one
3404             line per package.  Each line is
3405             indented by one space and contains the name of a binary
3406             package, a space, a hyphen (<tt>-</tt>), a space, and the
3407             short description line from that package.
3408           </p>
3409         </sect1>
3410
3411         <sect1 id="f-Distribution">
3412           <heading><tt>Distribution</tt></heading>
3413
3414           <p>
3415             In a <file>.changes</file> file or parsed changelog output
3416             this contains the (space-separated) name(s) of the
3417             distribution(s) where this version of the package should
3418             be installed.  Valid distributions are determined by the
3419             archive maintainers.<footnote>
3420               Example distribution names in the Debian archive used in
3421               <file>.changes</file> files are:
3422                 <taglist compact="compact">
3423                   <tag><em>unstable</em></tag>
3424                   <item>
3425                     This distribution value refers to the
3426                     <em>developmental</em> part of the Debian distribution
3427                     tree.  Most new packages, new upstream versions of
3428                     packages and bug fixes go into the <em>unstable</em>
3429                     directory tree.
3430                   </item>
3431
3432                   <tag><em>experimental</em></tag>
3433                   <item>
3434                     The packages with this distribution value are deemed
3435                     by their maintainers to be high risk.  Oftentimes they
3436                     represent early beta or developmental packages from
3437                     various sources that the maintainers want people to
3438                     try, but are not ready to be a part of the other parts
3439                     of the Debian distribution tree.
3440                   </item>
3441                 </taglist>
3442
3443                 <p>
3444                   Others are used for updating stable releases or for
3445                   security uploads.  More information is available in the
3446                   Debian Developer's Reference, section "The Debian
3447                   archive".
3448                 </p>
3449             </footnote>
3450             The Debian archive software only supports listing a single
3451             distribution.  Migration of packages to other distributions is
3452             handled outside of the upload process.
3453           </p>
3454         </sect1>
3455
3456         <sect1 id="f-Date">
3457           <heading><tt>Date</tt></heading>
3458
3459           <p>
3460             This field includes the date the package was built or last
3461             edited.  It must be in the same format as the <var>date</var>
3462             in a <file>debian/changelog</file> entry.
3463           </p>
3464
3465           <p>
3466             The value of this field is usually extracted from the
3467             <file>debian/changelog</file> file - see
3468             <ref id="dpkgchangelog">).
3469           </p>
3470         </sect1>
3471
3472         <sect1 id="f-Format">
3473           <heading><tt>Format</tt></heading>
3474
3475           <p>
3476             In <qref id="debianchangesfiles"><file>.changes</file></qref>
3477             files, this field declares the format version of that file.
3478             The syntax of the field value is the same as that of
3479             a <qref id="f-Version">package version number</qref> except
3480             that no epoch or Debian revision is allowed.  The format
3481             described in this document is <tt>&changesversion;</tt>.
3482           </p>
3483
3484           <p>
3485             In <qref id="debiansourcecontrolfiles"><file>.dsc</file>
3486             Debian source control</qref> files, this field declares the
3487             format of the source package.  The field value is used by
3488             programs acting on a source package to interpret the list of
3489             files in the source package and determine how to unpack it.
3490             The syntax of the field value is a numeric major revision, a
3491             period, a numeric minor revision, and then an optional subtype
3492             after whitespace, which if specified is an alphanumeric word
3493             in parentheses.  The subtype is optional in the syntax but may
3494             be mandatory for particular source format revisions.
3495             <footnote>
3496               The source formats currently supported by the Debian archive
3497               software are <tt>1.0</tt>, <tt>3.0 (native)</tt>,
3498               and <tt>3.0 (quilt)</tt>.
3499             </footnote>
3500           </p>
3501         </sect1>
3502
3503         <sect1 id="f-Urgency">
3504           <heading><tt>Urgency</tt></heading>
3505
3506           <p>
3507             This is a description of how important it is to upgrade to
3508             this version from previous ones.  It consists of a single
3509             keyword taking one of the values <tt>low</tt>,
3510             <tt>medium</tt>, <tt>high</tt>, <tt>emergency</tt>, or
3511             <tt>critical</tt><footnote>
3512               Other urgency values are supported with configuration
3513               changes in the archive software but are not used in Debian.
3514               The urgency affects how quickly a package will be considered
3515               for inclusion into the <tt>testing</tt> distribution and
3516               gives an indication of the importance of any fixes included
3517               in the upload.  <tt>Emergency</tt> and <tt>critical</tt> are
3518               treated as synonymous.
3519             </footnote> (not case-sensitive) followed by an optional
3520             commentary (separated by a space) which is usually in
3521             parentheses.  For example:
3522
3523             <example>
3524   Urgency: low (HIGH for users of diversions)
3525             </example>
3526
3527           </p>
3528
3529           <p>
3530             The value of this field is usually extracted from the
3531             <file>debian/changelog</file> file - see
3532             <ref id="dpkgchangelog">.
3533           </p>
3534         </sect1>
3535
3536         <sect1 id="f-Changes">
3537           <heading><tt>Changes</tt></heading>
3538
3539           <p>
3540             This multiline field contains the human-readable changes data, describing
3541             the differences between the last version and the current one.
3542           </p>
3543
3544           <p>
3545             The first line of the field value (the part on the same line
3546             as <tt>Changes:</tt>) is always empty.  The content of the
3547             field is expressed as continuation lines, with each line
3548             indented by at least one space.  Blank lines must be
3549             represented by a line consisting only of a space and a full
3550             stop (<tt>.</tt>).
3551           </p>
3552
3553           <p>
3554             The value of this field is usually extracted from the
3555             <file>debian/changelog</file> file - see
3556             <ref id="dpkgchangelog">).
3557           </p>
3558
3559           <p>
3560             Each version's change information should be preceded by a
3561             "title" line giving at least the version, distribution(s)
3562             and urgency, in a human-readable way.
3563           </p>
3564
3565           <p>
3566             If data from several versions is being returned the entry
3567             for the most recent version should be returned first, and
3568             entries should be separated by the representation of a
3569             blank line (the "title" line may also be followed by the
3570             representation of a blank line).
3571           </p>
3572         </sect1>
3573
3574         <sect1 id="f-Binary">
3575           <heading><tt>Binary</tt></heading>
3576
3577           <p>
3578             This folded field is a list of binary packages.  Its syntax and
3579             meaning varies depending on the control file in which it
3580             appears.
3581           </p>
3582
3583           <p>
3584             When it appears in the <file>.dsc</file> file, it lists binary
3585             packages which a source package can produce, separated by
3586             commas<footnote>
3587                 A space after each comma is conventional.
3588             </footnote>.  The source package
3589             does not necessarily produce all of these binary packages for
3590             every architecture.  The source control file doesn't contain
3591             details of which architectures are appropriate for which of
3592             the binary packages.
3593           </p>
3594
3595           <p>
3596             When it appears in a <file>.changes</file> file, it lists the
3597             names of the binary packages being uploaded, separated by
3598             whitespace (not commas).
3599           </p>
3600         </sect1>
3601
3602         <sect1 id="f-Installed-Size">
3603           <heading><tt>Installed-Size</tt></heading>
3604
3605           <p>
3606             This field appears in the control files of binary packages,
3607             and in the <file>Packages</file> files.  It gives an estimate
3608             of the total amount of disk space required to install the
3609             named package.  Actual installed size may vary based on block
3610             size, file system properties, or actions taken by package
3611             maintainer scripts.
3612           </p>
3613
3614           <p>
3615             The disk space is given as the integer value of the estimated
3616             installed size in bytes, divided by 1024 and rounded up.
3617           </p>
3618         </sect1>
3619
3620         <sect1 id="f-Files">
3621           <heading><tt>Files</tt></heading>
3622
3623           <p>
3624             This field contains a list of files with information about
3625             each one.  The exact information and syntax varies with
3626             the context.
3627           </p>
3628
3629           <p>
3630             In all cases, Files is a multiline field.  The first line of
3631             the field value (the part on the same line as <tt>Files:</tt>)
3632             is always empty.  The content of the field is expressed as
3633             continuation lines, one line per file.  Each line must be
3634             indented by one space and contain a number of sub-fields,
3635             separated by spaces, as described below.
3636           </p>
3637
3638           <p>
3639             In the <file>.dsc</file> file, each line contains the MD5
3640             checksum, size and filename of the tar file and (if
3641             applicable) diff file which make up the remainder of the
3642             source package<footnote>
3643               That is, the parts which are not the <tt>.dsc</tt>.
3644             </footnote>.  For example:
3645             <example>
3646 Files:
3647  c6f698f19f2a2aa07dbb9bbda90a2754 571925 example_1.2.orig.tar.gz
3648  938512f08422f3509ff36f125f5873ba 6220 example_1.2-1.diff.gz
3649             </example>
3650             The exact forms of the filenames are described
3651             in <ref id="pkg-sourcearchives">.
3652           </p>
3653
3654           <p>
3655             In the <file>.changes</file> file this contains one line per
3656             file being uploaded.  Each line contains the MD5 checksum,
3657             size, section and priority and the filename.  For example:
3658             <example>
3659 Files:
3660  4c31ab7bfc40d3cf49d7811987390357 1428 text extra example_1.2-1.dsc
3661  c6f698f19f2a2aa07dbb9bbda90a2754 571925 text extra example_1.2.orig.tar.gz
3662  938512f08422f3509ff36f125f5873ba 6220 text extra example_1.2-1.diff.gz
3663  7c98fe853b3bbb47a00e5cd129b6cb56 703542 text extra example_1.2-1_i386.deb
3664             </example>
3665             The <qref id="f-Section">section</qref>
3666             and <qref id="f-Priority">priority</qref> are the values of
3667             the corresponding fields in the main source control file.  If
3668             no section or priority is specified then <tt>-</tt> should be
3669             used, though section and priority values must be specified for
3670             new packages to be installed properly.
3671           </p>
3672
3673           <p>
3674             The special value <tt>byhand</tt> for the section in a
3675             <tt>.changes</tt> file indicates that the file in question
3676             is not an ordinary package file and must by installed by
3677             hand by the distribution maintainers.  If the section is
3678             <tt>byhand</tt> the priority should be <tt>-</tt>.
3679           </p>
3680
3681           <p>
3682             If a new Debian revision of a package is being shipped and
3683             no new original source archive is being distributed the
3684             <tt>.dsc</tt> must still contain the <tt>Files</tt> field
3685             entry for the original source archive
3686             <file><var>package</var>_<var>upstream-version</var>.orig.tar.gz</file>,
3687             but the <file>.changes</file> file should leave it out.  In
3688             this case the original source archive on the distribution
3689             site must match exactly, byte-for-byte, the original
3690             source archive which was used to generate the
3691             <file>.dsc</file> file and diff which are being uploaded.</p>
3692         </sect1>
3693
3694         <sect1 id="f-Closes">
3695           <heading><tt>Closes</tt></heading>
3696
3697           <p>
3698             A space-separated list of bug report numbers that the upload
3699             governed by the .changes file closes.
3700           </p>
3701         </sect1>
3702
3703         <sect1 id="f-Homepage">
3704           <heading><tt>Homepage</tt></heading>
3705
3706           <p>
3707             The URL of the web site for this package, preferably (when
3708             applicable) the site from which the original source can be
3709             obtained and any additional upstream documentation or
3710             information may be found.  The content of this field is a
3711             simple URL without any surrounding characters such as
3712             <tt>&lt;&gt;</tt>.
3713           </p>
3714         </sect1>
3715
3716         <sect1 id="f-Checksums">
3717           <heading><tt>Checksums-Sha1</tt>
3718             and <tt>Checksums-Sha256</tt></heading>
3719
3720           <p>
3721             These multiline fields contain a list of files with a checksum and size
3722             for each one.  Both <tt>Checksums-Sha1</tt>
3723             and <tt>Checksums-Sha256</tt> have the same syntax and differ
3724             only in the checksum algorithm used: SHA-1
3725             for <tt>Checksums-Sha1</tt> and SHA-256
3726             for <tt>Checksums-Sha256</tt>.
3727           </p>
3728
3729           <p>
3730             <tt>Checksums-Sha1</tt> and <tt>Checksums-Sha256</tt> are
3731             multiline fields.  The first line of the field value (the part
3732             on the same line as <tt>Checksums-Sha1:</tt>
3733             or <tt>Checksums-Sha256:</tt>) is always empty.  The content
3734             of the field is expressed as continuation lines, one line per
3735             file.  Each line consists of the checksum, a space, the file
3736             size, a space, and the file name.  For example (from
3737             a <file>.changes</file> file):
3738             <example>
3739 Checksums-Sha1:
3740  1f418afaa01464e63cc1ee8a66a05f0848bd155c 1276 example_1.0-1.dsc
3741  a0ed1456fad61116f868b1855530dbe948e20f06 171602 example_1.0.orig.tar.gz
3742  5e86ecf0671e113b63388dac81dd8d00e00ef298 6137 example_1.0-1.debian.tar.gz
3743  71a0ff7da0faaf608481195f9cf30974b142c183 548402 example_1.0-1_i386.deb
3744 Checksums-Sha256:
3745  ac9d57254f7e835bed299926fd51bf6f534597cc3fcc52db01c4bffedae81272 1276 example_1.0-1.dsc
3746  0d123be7f51e61c4bf15e5c492b484054be7e90f3081608a5517007bfb1fd128 171602 example_1.0.orig.tar.gz
3747  f54ae966a5f580571ae7d9ef5e1df0bd42d63e27cb505b27957351a495bc6288 6137 example_1.0-1.debian.tar.gz
3748  3bec05c03974fdecd11d020fc2e8250de8404867a8a2ce865160c250eb723664 548402 example_1.0-1_i386.deb
3749             </example>
3750           </p>
3751
3752           <p>
3753             In the <file>.dsc</file> file, these fields list all
3754             files that make up the source package.  In
3755             the <file>.changes</file> file, these fields list all
3756             files being uploaded.  The list of files in these fields
3757             must match the list of files in the <tt>Files</tt> field.
3758           </p>
3759         </sect1>
3760
3761         <sect1>
3762           <heading><tt>DM-Upload-Allowed</tt></heading>
3763
3764           <p>
3765             Obsolete, see <qref id="f-DM-Upload-Allowed">below</qref>.
3766           </p>
3767         </sect1>
3768
3769         <sect1 id="f-VCS-fields">
3770           <heading>Version Control System (VCS) fields</heading>
3771
3772           <p>
3773             Debian source packages are increasingly developed using VCSs.  The
3774             purpose of the following fields is to indicate a publicly accessible
3775             repository where the Debian source package is developed.
3776
3777             <taglist>
3778               <tag><tt>Vcs-Browser</tt></tag>
3779               <item>
3780                 <p>
3781                   URL of a web interface for browsing the repository.
3782                 </p>
3783               </item>
3784
3785               <tag>
3786                 <tt>Vcs-Arch</tt>, <tt>Vcs-Bzr</tt> (Bazaar), <tt>Vcs-Cvs</tt>,
3787                 <tt>Vcs-Darcs</tt>, <tt>Vcs-Git</tt>, <tt>Vcs-Hg</tt>
3788                 (Mercurial), <tt>Vcs-Mtn</tt> (Monotone), <tt>Vcs-Svn</tt>
3789                 (Subversion)
3790               </tag>
3791               <item>
3792                 <p>
3793                   The field name identifies the VCS. The field's value uses the
3794                   version control system's conventional syntax for describing
3795                   repository locations and should be sufficient to locate the
3796                   repository used for packaging. Ideally, it also locates the
3797                   branch used for development of new versions of the Debian
3798                   package.
3799                 </p>
3800                 <p>
3801                   In the case of Git, the value consists of a URL, optionally
3802                   followed by the word <tt>-b</tt> and the name of a branch in
3803                   the indicated repository, following the syntax of the
3804                   <tt>git clone</tt> command.  If no branch is specified, the
3805                   packaging should be on the default branch.
3806                 </p>
3807                 <p>
3808                   More than one different VCS may be specified for the same
3809                   package.
3810                 </p>
3811               </item>
3812             </taglist>
3813           </p>
3814         </sect1>
3815
3816         <sect1 id="f-Package-List">
3817           <heading><tt>Package-List</tt></heading>
3818
3819           <p>
3820             Multiline field listing all the packages that can be built from
3821             the source package, considering every architecture.  The first line
3822             of the field value is empty.  Each one of the next lines describes
3823             one binary package, by listing its name, type, section and priority
3824             separated by spaces.  Fifth and subsequent space-separated items
3825             may be present and parsers must allow them.  See the
3826             <qref id="f-Package-Type">Package-Type</qref> field for a list of
3827             package types.
3828           </p>
3829         </sect1>
3830
3831         <sect1 id="f-Package-Type">
3832           <heading><tt>Package-Type</tt></heading>
3833
3834           <p>
3835             Simple field containing a word indicating the type of package:
3836             <tt>deb</tt> for binary packages and <tt>udeb</tt> for micro binary
3837             packages.  Other types not defined here may be indicated.  In
3838             source package control files, the <tt>Package-Type</tt> field
3839             should be omitted instead of giving it a value of <tt>deb</tt>, as
3840             this value is assumed for paragraphs lacking this field.
3841           </p>
3842         </sect1>
3843
3844         <sect1 id="f-Dgit">
3845           <heading><tt>Dgit</tt></heading>
3846
3847           <p>
3848             Folded field containing a single git commit hash, presented in
3849             full, followed optionally by whitespace and other data to be
3850             defined in future extensions.
3851           </p>
3852
3853           <p>
3854             Declares that the source package corresponds exactly to a
3855             referenced commit in a Git repository available at the canonical
3856             location called <em>dgit-repos</em>, used by <prgn>dgit</prgn>, a
3857             bidirectional gateway between the Debian archive and Git.  The
3858             commit is reachable from at least one reference whose name matches
3859             <tt>refs/dgit/*</tt>.  See the manual page of <prgn>dgit</prgn> for
3860             further details.
3861           </p>
3862         </sect1>
3863       </sect>
3864
3865       <sect>
3866         <heading>User-defined fields</heading>
3867
3868         <p>
3869           Additional user-defined fields may be added to the
3870           source package control file.  Such fields will be
3871           ignored, and not copied to (for example) binary or
3872           Debian source control files or upload control files.
3873         </p>
3874
3875         <p>
3876           If you wish to add additional unsupported fields to
3877           these output files you should use the mechanism
3878           described here.
3879         </p>
3880
3881         <p>
3882           Fields in the main source control information file with
3883           names starting <tt>X</tt>, followed by one or more of
3884           the letters <tt>BCS</tt> and a hyphen <tt>-</tt>, will
3885           be copied to the output files.  Only the part of the
3886           field name after the hyphen will be used in the output
3887           file.  Where the letter <tt>B</tt> is used the field
3888           will appear in binary package control files, where the
3889           letter <tt>S</tt> is used in Debian source control
3890           files and where <tt>C</tt> is used in upload control
3891           (<tt>.changes</tt>) files.
3892         </p>
3893
3894         <p>
3895           For example, if the main source information control file
3896           contains the field
3897           <example>
3898   XBS-Comment: I stand between the candle and the star.
3899           </example>
3900           then the binary and Debian source control files will contain the
3901           field
3902           <example>
3903   Comment: I stand between the candle and the star.
3904           </example>
3905         </p>
3906
3907       </sect>
3908
3909       <sect id="obsolete-control-data-fields">
3910         <heading>Obsolete fields</heading>
3911
3912         <p>
3913           The following fields have been obsoleted and may be found in packages
3914           conforming with previous versions of the Policy.
3915         </p>
3916
3917         <sect1 id="f-DM-Upload-Allowed">
3918           <heading><tt>DM-Upload-Allowed</tt></heading>
3919
3920           <p>
3921             Indicates that Debian Maintainers may upload this package to
3922             the Debian archive.  The only valid value is <tt>yes</tt>.  This
3923             field was used to regulate uploads by Debian Maintainers, See the
3924             General Resolution <url id="http://www.debian.org/vote/2007/vote_003"
3925             name="Endorse the concept of Debian Maintainers"> for more details.
3926           </p>
3927         </sect1>
3928
3929       </sect>
3930
3931     </chapt>
3932
3933
3934     <chapt id="maintainerscripts">
3935       <heading>Package maintainer scripts and installation procedure</heading>
3936
3937       <sect>
3938         <heading>Introduction to package maintainer scripts</heading>
3939
3940         <p>
3941           It is possible to supply scripts as part of a package which
3942           the package management system will run for you when your
3943           package is installed, upgraded or removed.
3944         </p>
3945
3946         <p>
3947           These scripts are the control information
3948           files <prgn>preinst</prgn>, <prgn>postinst</prgn>, <prgn>prerm</prgn>
3949           and <prgn>postrm</prgn>.  They must be proper executable files;
3950           if they are scripts (which is recommended), they must start with
3951           the usual <tt>#!</tt> convention.  They should be readable and
3952           executable by anyone, and must not be world-writable.
3953         </p>
3954
3955         <p>
3956           The package management system looks at the exit status from
3957           these scripts.  It is important that they exit with a
3958           non-zero status if there is an error, so that the package
3959           management system can stop its processing.  For shell
3960           scripts this means that you <em>almost always</em> need to
3961           use <tt>set -e</tt> (this is usually true when writing shell
3962           scripts, in fact).  It is also important, of course, that
3963           they exit with a zero status if everything went well.
3964         </p>
3965
3966         <p>
3967           Additionally, packages interacting with users
3968           using <prgn>debconf</prgn> in the <prgn>postinst</prgn> script
3969           should install a <prgn>config</prgn> script as a control
3970           information file.  See <ref id="maintscriptprompt"> for details.
3971         </p>
3972
3973         <p>
3974           When a package is upgraded a combination of the scripts from
3975           the old and new packages is called during the upgrade
3976           procedure.  If your scripts are going to be at all
3977           complicated you need to be aware of this, and may need to
3978           check the arguments to your scripts.
3979         </p>
3980
3981         <p>
3982           Broadly speaking the <prgn>preinst</prgn> is called before
3983           (a particular version of) a package is unpacked, and the
3984           <prgn>postinst</prgn> afterwards; the <prgn>prerm</prgn>
3985           before (a version of) a package is removed and the
3986           <prgn>postrm</prgn> afterwards.
3987         </p>
3988
3989         <p>
3990           Programs called from maintainer scripts should not normally
3991           have a path prepended to them. Before installation is
3992           started, the package management system checks to see if the
3993           programs <prgn>ldconfig</prgn>, <prgn>start-stop-daemon</prgn>,
3994           and <prgn>update-rc.d</prgn> can be found via the
3995           <tt>PATH</tt> environment variable. Those programs, and any
3996           other program that one would expect to be in the
3997           <tt>PATH</tt>, should thus be invoked without an absolute
3998           pathname. Maintainer scripts should also not reset the
3999           <tt>PATH</tt>, though they might choose to modify it by
4000           prepending or appending package-specific directories. These
4001           considerations really apply to all shell scripts.</p>
4002       </sect>
4003
4004       <sect id="idempotency">
4005         <heading>Maintainer scripts idempotency</heading>
4006
4007         <p>
4008           It is necessary for the error recovery procedures that the
4009           scripts be idempotent.  This means that if it is run
4010           successfully, and then it is called again, it doesn't bomb
4011           out or cause any harm, but just ensures that everything is
4012           the way it ought to be.  If the first call failed, or
4013           aborted half way through for some reason, the second call
4014           should merely do the things that were left undone the first
4015           time, if any, and exit with a success status if everything
4016           is OK.<footnote>
4017               This is so that if an error occurs, the user interrupts
4018               <prgn>dpkg</prgn> or some other unforeseen circumstance
4019               happens you don't leave the user with a badly-broken
4020               package when <prgn>dpkg</prgn> attempts to repeat the
4021               action.
4022           </footnote>
4023         </p>
4024       </sect>
4025
4026       <sect id="controllingterminal">
4027         <heading>Controlling terminal for maintainer scripts</heading>
4028
4029         <p>
4030           Maintainer scripts are not guaranteed to run with a controlling
4031           terminal and may not be able to interact with the user.  They
4032           must be able to fall back to noninteractive behavior if no
4033           controlling terminal is available.  Maintainer scripts that
4034           prompt via a program conforming to the Debian Configuration
4035           Management Specification (see <ref id="maintscriptprompt">) may
4036           assume that program will handle falling back to noninteractive
4037           behavior.
4038         </p>
4039
4040         <p>
4041           For high-priority prompts without a reasonable default answer,
4042           maintainer scripts may abort if there is no controlling
4043           terminal.  However, this situation should be avoided if at all
4044           possible, since it prevents automated or unattended installs.
4045           In most cases, users will consider this to be a bug in the
4046           package.
4047         </p>
4048       </sect>
4049
4050       <sect id="exitstatus">
4051         <heading>Exit status</heading>
4052
4053         <p>
4054           Each script must return a zero exit status for
4055           success, or a nonzero one for failure, since the package
4056           management system looks for the exit status of these scripts
4057           and determines what action to take next based on that datum.
4058         </p>
4059       </sect>
4060
4061       <sect id="mscriptsinstact"><heading>Summary of ways maintainer
4062           scripts are called
4063         </heading>
4064
4065         <p>
4066           What follows is a summary of all the ways in which maintainer
4067           scripts may be called along with what facilities those scripts
4068           may rely on being available at that time.  Script names preceded
4069           by <var>new-</var> are the scripts from the new version of a
4070           package being installed, upgraded to, or downgraded to.  Script
4071           names preceded by <var>old-</var> are the scripts from the old
4072           version of a package that is being upgraded from or downgraded
4073           from.
4074         </p>
4075
4076         <p>
4077           The <prgn>preinst</prgn> script may be called in the following
4078           ways:
4079           <taglist>
4080             <tag><var>new-preinst</var> <tt>install</tt></tag>
4081             <tag><var>new-preinst</var> <tt>install</tt>
4082               <var>old-version</var></tag>
4083             <tag><var>new-preinst</var> <tt>upgrade</tt>
4084               <var>old-version</var></tag>
4085             <item>
4086               The package will not yet be unpacked, so
4087               the <prgn>preinst</prgn> script cannot rely on any files
4088               included in its package.  Only essential packages and
4089               pre-dependencies (<tt>Pre-Depends</tt>) may be assumed to be
4090               available.  Pre-dependencies will have been configured at
4091               least once, but at the time the <prgn>preinst</prgn> is
4092               called they may only be in an "Unpacked" or "Half-Configured"
4093               state if a previous version of the pre-dependency was
4094               completely configured and has not been removed since then.
4095             </item>
4096
4097             <tag><var>old-preinst</var> <tt>abort-upgrade</tt>
4098               <var>new-version</var></tag>
4099             <item>
4100               Called during error handling of an upgrade that failed after
4101               unpacking the new package because the <tt>postrm
4102               upgrade</tt> action failed.  The unpacked files may be
4103               partly from the new version or partly missing, so the script
4104               cannot rely on files included in the package.  Package
4105               dependencies may not be available.  Pre-dependencies will be
4106               at least "Unpacked" following the same rules as above, except
4107               they may be only "Half-Installed" if an upgrade of the
4108               pre-dependency failed.<footnote>
4109                 This can happen if the new version of the package no
4110                 longer pre-depends on a package that had been partially
4111                 upgraded.
4112               </footnote>
4113             </item>
4114           </taglist>
4115         </p>
4116
4117         <p>
4118           The <prgn>postinst</prgn> script may be called in the following
4119           ways:
4120           <taglist>
4121             <tag><var>postinst</var> <tt>configure</tt>
4122               <var>most-recently-configured-version</var></tag>
4123             <item>
4124               The files contained in the package will be unpacked.  All
4125               package dependencies will at least be "Unpacked".  If there
4126               are no circular dependencies involved, all package
4127               dependencies will be configured.  For behavior in the case
4128               of circular dependencies, see the discussion
4129               in <ref id="binarydeps">.
4130             </item>
4131
4132             <tag><var>old-postinst</var> <tt>abort-upgrade</tt>
4133               <var>new-version</var></tag>
4134             <tag><var>conflictor's-postinst</var> <tt>abort-remove</tt>
4135               <tt>in-favour</tt> <var>package</var>
4136               <var>new-version</var></tag>
4137             <tag><var>postinst</var> <tt>abort-remove</tt></tag>
4138             <tag><var>deconfigured's-postinst</var>
4139               <tt>abort-deconfigure</tt> <tt>in-favour</tt>
4140               <var>failed-install-package</var> <var>version</var>
4141               [<tt>removing</tt> <var>conflicting-package</var>
4142               <var>version</var>]</tag>
4143             <item>
4144               The files contained in the package will be unpacked.  All
4145               package dependencies will at least be "Half-Installed" and
4146               will have previously been configured and not removed.
4147               However, dependencies may not be configured or even fully
4148               unpacked in some error situations.<footnote>
4149                 For example, suppose packages foo and bar are "Installed"
4150                 with foo depending on bar.  If an upgrade of bar were
4151                 started and then aborted, and then an attempt to remove
4152                 foo failed because its <prgn>prerm</prgn> script failed,
4153                 foo's <tt>postinst abort-remove</tt> would be called with
4154                 bar only "Half-Installed".
4155               </footnote>
4156               The <prgn>postinst</prgn> should still attempt any actions
4157               for which its dependencies are required, since they will
4158               normally be available, but consider the correct error
4159               handling approach if those actions fail.  Aborting
4160               the <prgn>postinst</prgn> action if commands or facilities
4161               from the package dependencies are not available is often the
4162               best approach.
4163             </item>
4164           </taglist>
4165         </p>
4166
4167         <p>
4168           The <prgn>prerm</prgn> script may be called in the following
4169           ways:
4170           <taglist>
4171             <tag><var>prerm</var> <tt>remove</tt></tag>
4172             <tag><var>old-prerm</var>
4173               <tt>upgrade</tt><var>new-version</var></tag>
4174             <tag><var>conflictor's-prerm</var> <tt>remove</tt>
4175               <tt>in-favour</tt> <var>package</var>
4176               <var>new-version</var></tag>
4177             <tag><var>deconfigured's-prerm</var> <tt>deconfigure</tt>
4178               <tt>in-favour</tt> <var>package-being-installed</var>
4179               <var>version</var> [<tt>removing</tt>
4180               <var>conflicting-package</var> <var>version</var>]</tag>
4181             <item>
4182               The package whose <prgn>prerm</prgn> is being called will be
4183               at least "Half-Installed".  All package dependencies will at
4184               least be "Half-Installed" and will have previously been
4185               configured and not removed.  If there was no error, all
4186               dependencies will at least be "Unpacked", but these actions
4187               may be called in various error states where dependencies are
4188               only "Half-Installed" due to a partial upgrade.
4189             </item>
4190
4191             <tag><var>new-prerm</var> <tt>failed-upgrade</tt>
4192               <var>old-version</var></tag>
4193             <item>
4194               Called during error handling when <tt>prerm upgrade</tt>
4195               fails.  The new package will not yet be unpacked, and all
4196               the same constraints as for <tt>preinst upgrade</tt> apply.
4197             </item>
4198           </taglist>
4199         </p>
4200
4201         <p>
4202           The <prgn>postrm</prgn> script may be called in the following
4203           ways:
4204           <taglist>
4205             <tag><var>postrm</var> <tt>remove</tt></tag>
4206             <tag><var>postrm</var> <tt>purge</tt></tag>
4207             <tag><var>old-postrm</var> <tt>upgrade</tt>
4208               <var>new-version</var></tag>
4209             <tag><var>disappearer's-postrm</var> <tt>disappear</tt>
4210                 <var>overwriter</var> <var>overwriter-version</var></tag>
4211             <item>
4212               The <prgn>postrm</prgn> script is called after the package's
4213               files have been removed or replaced.  The package
4214               whose <prgn>postrm</prgn> is being called may have
4215               previously been deconfigured and only be "Unpacked", at which
4216               point subsequent package changes do not consider its
4217               dependencies.  Therefore, all <prgn>postrm</prgn> actions
4218               may only rely on essential packages and must gracefully skip
4219               any actions that require the package's dependencies if those
4220               dependencies are unavailable.<footnote>
4221                 This is often done by checking whether the command or
4222                 facility the <prgn>postrm</prgn> intends to call is
4223                 available before calling it.  For example:
4224 <example>
4225 if [ "$1" = purge ] && [ -e /usr/share/debconf/confmodule ]; then
4226         . /usr/share/debconf/confmodule
4227         db_purge
4228 fi
4229 </example>
4230                 in <prgn>postrm</prgn> purges the <prgn>debconf</prgn>
4231                 configuration for the package
4232                 if <package>debconf</package> is installed.
4233               </footnote>
4234             </item>
4235
4236             <tag><var>new-postrm</var> <tt>failed-upgrade</tt>
4237               <var>old-version</var></tag>
4238             <item>
4239               Called when the old <tt>postrm upgrade</tt> action fails.
4240               The new package will be unpacked, but only essential
4241               packages and pre-dependencies can be relied on.
4242               Pre-dependencies will either be configured or will be
4243               "Unpacked" or "Half-Configured" but previously had been
4244               configured and was never removed.
4245             </item>
4246
4247             <tag><var>new-postrm</var> <tt>abort-install</tt></tag>
4248             <tag><var>new-postrm</var> <tt>abort-install</tt>
4249               <var>old-version</var></tag>
4250             <tag><var>new-postrm</var> <tt>abort-upgrade</tt>
4251               <var>old-version</var></tag>
4252             <item>
4253               Called before unpacking the new package as part of the
4254               error handling of <prgn>preinst</prgn> failures.  May assume
4255               the same state as <prgn>preinst</prgn> can assume.
4256             </item>
4257           </taglist>
4258         </p>
4259       </sect>
4260
4261       <sect id="unpackphase">
4262         <heading>Details of unpack phase of installation or upgrade</heading>
4263
4264         <p>
4265           The procedure on installation/upgrade/overwrite/disappear
4266           (i.e., when running <tt>dpkg --unpack</tt>, or the unpack
4267           stage of <tt>dpkg --install</tt>) is as follows.  In each
4268           case, if a major error occurs (unless listed below) the
4269           actions are, in general, run backwards - this means that the
4270           maintainer scripts are run with different arguments in
4271           reverse order.  These are the "error unwind" calls listed
4272           below.
4273
4274           <enumlist>
4275             <item>
4276                 <enumlist>
4277                   <item>
4278                       If a version of the package is already "Installed", call
4279                       <example compact="compact">
4280 <var>old-prerm</var> upgrade <var>new-version</var>
4281                       </example>
4282                   </item>
4283                   <item>
4284                       If the script runs but exits with a non-zero
4285                       exit status, <prgn>dpkg</prgn> will attempt:
4286                       <example compact="compact">
4287 <var>new-prerm</var> failed-upgrade <var>old-version</var>
4288                       </example>
4289                       If this works, the upgrade continues. If this
4290                       does not work, the error unwind:
4291                       <example compact="compact">
4292 <var>old-postinst</var> abort-upgrade <var>new-version</var>
4293                       </example>
4294                       If this works, then the old-version is
4295                       "Installed", if not, the old version is in a
4296                       "Half-Configured" state.
4297                   </item>
4298                 </enumlist>
4299             </item>
4300
4301             <item>
4302                 If a "conflicting" package is being removed at the same time,
4303                 or if any package will be broken (due to <tt>Breaks</tt>):
4304                 <enumlist>
4305                   <item>
4306                       If <tt>--auto-deconfigure</tt> is
4307                       specified, call, for each package to be deconfigured
4308                       due to <tt>Breaks</tt>:
4309                       <example compact="compact">
4310 <var>deconfigured's-prerm</var> deconfigure \
4311   in-favour <var>package-being-installed</var> <var>version</var>
4312                       </example>
4313                       Error unwind:
4314                       <example compact="compact">
4315 <var>deconfigured's-postinst</var> abort-deconfigure \
4316   in-favour <var>package-being-installed-but-failed</var> <var>version</var>
4317                       </example>
4318                       The deconfigured packages are marked as
4319                       requiring configuration, so that if
4320                       <tt>--install</tt> is used they will be
4321                       configured again if possible.
4322                   </item>
4323                   <item>
4324                       If any packages depended on a conflicting
4325                       package being removed and <tt>--auto-deconfigure</tt> is
4326                       specified, call, for each such package:
4327                       <example compact="compact">
4328 <var>deconfigured's-prerm</var> deconfigure \
4329   in-favour <var>package-being-installed</var> <var>version</var> \
4330     removing <var>conflicting-package</var> <var>version</var>
4331                       </example>
4332                       Error unwind:
4333                       <example compact="compact">
4334 <var>deconfigured's-postinst</var> abort-deconfigure \
4335   in-favour <var>package-being-installed-but-failed</var> <var>version</var> \
4336     removing <var>conflicting-package</var> <var>version</var>
4337                       </example>
4338                       The deconfigured packages are marked as
4339                       requiring configuration, so that if
4340                       <tt>--install</tt> is used they will be
4341                       configured again if possible.
4342                   </item>
4343                   <item>
4344                       To prepare for removal of each conflicting package, call:
4345                       <example compact="compact">
4346 <var>conflictor's-prerm</var> remove \
4347   in-favour <var>package</var> <var>new-version</var>
4348                       </example>
4349                       Error unwind:
4350                       <example compact="compact">
4351 <var>conflictor's-postinst</var> abort-remove \
4352   in-favour <var>package</var> <var>new-version</var>
4353                       </example>
4354                   </item>
4355                 </enumlist>
4356             </item>
4357
4358             <item>
4359                 <enumlist>
4360                   <item>
4361                       If the package is being upgraded, call:
4362                       <example compact="compact">
4363 <var>new-preinst</var> upgrade <var>old-version</var>
4364                       </example>
4365                       If this fails, we call:
4366                       <example>
4367 <var>new-postrm</var> abort-upgrade <var>old-version</var>
4368                       </example>
4369                       <enumlist>
4370                         <item>
4371                           <p>
4372                             If that works, then
4373                             <example>
4374 <var>old-postinst</var> abort-upgrade <var>new-version</var>
4375                             </example>
4376                             is called. If this works, then the old version
4377                             is in an "Installed" state, or else it is left
4378                             in an "Unpacked" state.
4379                           </p>
4380                         </item>
4381                         <item>
4382                           <p>
4383                             If it fails, then the old version is left
4384                             in an "Half-Installed" state.
4385                           </p>
4386                         </item>
4387                       </enumlist>
4388                       
4389                   </item>
4390                   <item>
4391                       Otherwise, if the package had some configuration
4392                       files from a previous version installed (i.e., it
4393                       is in the "Config-Files" state):
4394                       <example compact="compact">
4395 <var>new-preinst</var> install <var>old-version</var>
4396                       </example>
4397                       Error unwind:
4398                       <example>
4399 <var>new-postrm</var> abort-install <var>old-version</var>
4400                       </example>
4401                       If this fails, the package is left in a
4402                       "Half-Installed" state, which requires a
4403                       reinstall. If it works, the packages is left in
4404                       a "Config-Files" state.
4405                   </item>
4406                   <item>
4407                       Otherwise (i.e., the package was completely purged):
4408                       <example compact="compact">
4409 <var>new-preinst</var> install
4410                       </example>
4411                       Error unwind:
4412                       <example compact="compact">
4413 <var>new-postrm</var> abort-install
4414                       </example>
4415                       If the error-unwind fails, the package is in a
4416                       "Half-Installed" phase, and requires a
4417                       reinstall. If the error unwind works, the
4418                       package is in the "Not-Installed" state.
4419                   </item>
4420                 </enumlist>
4421             </item>
4422
4423             <item>
4424               <p>
4425                 The new package's files are unpacked, overwriting any
4426                 that may be on the system already, for example any
4427                 from the old version of the same package or from
4428                 another package.  Backups of the old files are kept
4429                 temporarily, and if anything goes wrong the package
4430                 management system will attempt to put them back as
4431                 part of the error unwind.
4432               </p>
4433
4434               <p>
4435                 It is an error for a package to contain files which
4436                 are on the system in another package, unless
4437                 <tt>Replaces</tt> is used (see <ref id="replaces">).
4438                 <!--
4439                 The following paragraph is not currently the case:
4440                 Currently the <tt>- - force-overwrite</tt> flag is
4441                 enabled, downgrading it to a warning, but this may not
4442                 always be the case.
4443                 -->
4444               </p>
4445
4446               <p>
4447                 It is a more serious error for a package to contain a
4448                 plain file or other kind of non-directory where another
4449                 package has a directory (again, unless
4450                 <tt>Replaces</tt> is used).  This error can be
4451                 overridden if desired using
4452                 <tt>--force-overwrite-dir</tt>, but this is not
4453                 advisable.
4454               </p>
4455
4456               <p>
4457                 Packages which overwrite each other's files produce
4458                 behavior which, though deterministic, is hard for the
4459                 system administrator to understand.  It can easily
4460                 lead to "missing" programs if, for example, a package
4461                 is unpacked which overwrites a file from another
4462                 package, and is then removed again.<footnote>
4463                     Part of the problem is due to what is arguably a
4464                     bug in <prgn>dpkg</prgn>.
4465                 </footnote>
4466               </p>
4467
4468               <p>
4469                 A directory will never be replaced by a symbolic link
4470                 to a directory or vice versa; instead, the existing
4471                 state (symlink or not) will be left alone and
4472                 <prgn>dpkg</prgn> will follow the symlink if there is
4473                 one.
4474               </p>
4475             </item>
4476
4477             <item>
4478               <p>
4479                 <enumlist>
4480                   <item>
4481                       If the package is being upgraded, call
4482                       <example compact="compact">
4483 <var>old-postrm</var> upgrade <var>new-version</var>
4484                       </example>
4485                   </item>
4486                   <item>
4487                       If this fails, <prgn>dpkg</prgn> will attempt:
4488                       <example compact="compact">
4489 <var>new-postrm</var> failed-upgrade <var>old-version</var>
4490                       </example>
4491                       If this works, installation continues. If not, 
4492                       Error unwind:
4493                       <example compact="compact">
4494 <var>old-preinst</var> abort-upgrade <var>new-version</var>
4495                       </example>
4496                       If this fails, the old version is left in a
4497                       "Half-Installed" state. If it works, dpkg now
4498                       calls:
4499                       <example compact="compact">
4500 <var>new-postrm</var> abort-upgrade <var>old-version</var>
4501                       </example>
4502                       If this fails, the old version is left in a
4503                       "Half-Installed" state. If it works, dpkg now
4504                       calls:
4505                       <example compact="compact">
4506 <var>old-postinst</var> abort-upgrade <var>new-version</var>
4507                       </example>
4508                       If this fails, the old version is in an
4509                       "Unpacked" state.
4510                   </item>
4511                 </enumlist>
4512               </p>
4513
4514               <p>
4515                 This is the point of no return - if
4516                 <prgn>dpkg</prgn> gets this far, it won't back off
4517                 past this point if an error occurs.  This will
4518                 leave the package in a fairly bad state, which
4519                 will require a successful re-installation to clear
4520                 up, but it's when <prgn>dpkg</prgn> starts doing
4521                 things that are irreversible.
4522               </p>
4523             </item>
4524
4525             <item>
4526                 Any files which were in the old version of the package
4527                 but not in the new are removed.
4528             </item>
4529
4530             <item>
4531                 The new file list replaces the old.
4532             </item>
4533
4534             <item>
4535                 The new maintainer scripts replace the old.
4536             </item>
4537
4538             <item>
4539                 Any packages all of whose files have been overwritten
4540                 during the installation, and which aren't required for
4541                 dependencies, are considered to have been removed.
4542                 For each such package
4543                 <enumlist>
4544                   <item>
4545                       <prgn>dpkg</prgn> calls:
4546                       <example compact="compact">
4547 <var>disappearer's-postrm</var> disappear \
4548   <var>overwriter</var> <var>overwriter-version</var>
4549                       </example>
4550                   </item>
4551                   <item>
4552                       The package's maintainer scripts are removed.
4553                   </item>
4554                   <item>
4555                       It is noted in the status database as being in a
4556                       sane state, namely "Not-Installed" (any conffiles
4557                       it may have are ignored, rather than being
4558                       removed by <prgn>dpkg</prgn>).  Note that
4559                       disappearing packages do not have their prerm
4560                       called, because <prgn>dpkg</prgn> doesn't know
4561                       in advance that the package is going to
4562                       vanish.
4563                   </item>
4564                 </enumlist>
4565             </item>
4566
4567             <item>
4568                 Any files in the package we're unpacking that are also
4569                 listed in the file lists of other packages are removed
4570                 from those lists.  (This will lobotomize the file list
4571                 of the "conflicting" package if there is one.)
4572             </item>
4573
4574             <item>
4575                 The backup files made during installation, above, are
4576                 deleted.
4577             </item>
4578
4579             <item>
4580               <p>
4581                 The new package's status is now sane, and recorded as
4582                 "Unpacked".
4583               </p>
4584
4585               <p>
4586                 Here is another point of no return - if the
4587                 conflicting package's removal fails we do not unwind
4588                 the rest of the installation; the conflicting package
4589                 is left in a half-removed limbo.
4590               </p>
4591             </item>
4592
4593             <item>
4594                 If there was a conflicting package we go and do the
4595                 removal actions (described below), starting with the
4596                 removal of the conflicting package's files (any that
4597                 are also in the package being unpacked have already
4598                 been removed from the conflicting package's file list,
4599                 and so do not get removed now).
4600             </item>
4601           </enumlist>
4602         </p>
4603       </sect>
4604
4605       <sect id="configdetails"><heading>Details of configuration</heading>
4606
4607         <p>
4608           When we configure a package (this happens with <tt>dpkg
4609             --install</tt> and <tt>dpkg --configure</tt>), we first
4610           update any <tt>conffile</tt>s and then call:
4611           <example compact="compact">
4612 <var>postinst</var> configure <var>most-recently-configured-version</var>
4613           </example>
4614         </p>
4615
4616         <p>
4617           No attempt is made to unwind after errors during
4618           configuration. If the configuration fails, the package is in
4619           a "Half-Configured" state, and an error message is generated.
4620         </p>
4621
4622         <p>
4623           If there is no most recently configured version
4624           <prgn>dpkg</prgn> will pass a null argument.
4625           <footnote>
4626             <p>
4627               Historical note: Truly ancient (pre-1997) versions of
4628               <prgn>dpkg</prgn> passed <tt>&lt;unknown&gt;</tt>
4629               (including the angle brackets) in this case.  Even older
4630               ones did not pass a second argument at all, under any
4631               circumstance.  Note that upgrades using such an old dpkg
4632               version are unlikely to work for other reasons, even if
4633               this old argument behavior is handled by your postinst script.
4634             </p>
4635           </footnote>     
4636         </p>
4637       </sect>
4638
4639       <sect id="removedetails"><heading>Details of removal and/or
4640       configuration purging</heading>
4641
4642         <p>
4643           <enumlist>
4644             <item>
4645               <p>
4646                 <example compact="compact">
4647 <var>prerm</var> remove
4648                 </example>
4649               </p>
4650               <p>
4651                 If prerm fails during replacement due to conflict
4652                 <example>
4653 <var>conflictor's-postinst</var> abort-remove \
4654   in-favour <var>package</var> <var>new-version</var>
4655                 </example>
4656                 Or else we call:
4657                 <example>
4658 <var>postinst</var> abort-remove
4659                 </example>
4660               </p>
4661               <p>
4662                 If this fails, the package is in a "Half-Configured"
4663                 state, or else it remains "Installed".
4664               </p>
4665             </item>
4666             <item>
4667                 The package's files are removed (except <tt>conffile</tt>s).
4668             </item>
4669             <item>
4670                 <example compact="compact">
4671 <var>postrm</var> remove
4672                 </example>
4673
4674               <p>
4675                 If it fails, there's no error unwind, and the package is in
4676                 an "Half-Installed" state.
4677               </p>
4678             </item>
4679             <item>
4680               <p>
4681                 All the maintainer scripts except the <prgn>postrm</prgn>
4682                 are removed.
4683               </p>
4684
4685               <p>
4686                 If we aren't purging the package we stop here.  Note
4687                 that packages which have no <prgn>postrm</prgn> and no
4688                 <tt>conffile</tt>s are automatically purged when
4689                 removed, as there is no difference except for the
4690                 <prgn>dpkg</prgn> status.
4691               </p>
4692             </item>
4693             <item>
4694                 The <tt>conffile</tt>s and any backup files
4695                 (<tt>~</tt>-files, <tt>#*#</tt> files,
4696                 <tt>%</tt>-files, <tt>.dpkg-{old,new,tmp}</tt>, etc.)
4697                 are removed.
4698             </item>
4699             <item>
4700               <p>
4701                 <example compact="compact">
4702 <var>postrm</var> purge
4703                 </example>
4704               </p>
4705               <p>
4706                 If this fails, the package remains in a "Config-Files"
4707                 state.
4708               </p>
4709             </item>
4710             <item>
4711                 The package's file list is removed.
4712             </item>
4713           </enumlist>
4714
4715         </p>
4716       </sect>
4717     </chapt>
4718
4719
4720     <chapt id="relationships">
4721       <heading>Declaring relationships between packages</heading>
4722
4723       <sect id="depsyntax">
4724         <heading>Syntax of relationship fields</heading>
4725
4726         <p>
4727           These fields all have a uniform syntax.  They are a list of
4728           package names separated by commas.
4729         </p>
4730
4731         <p>
4732           In the <tt>Depends</tt>, <tt>Recommends</tt>,
4733           <tt>Suggests</tt>, <tt>Pre-Depends</tt>,
4734           <tt>Build-Depends</tt> and <tt>Build-Depends-Indep</tt>
4735           control fields of the package, which declare
4736           dependencies on other packages, the package names listed may
4737           also include lists of alternative package names, separated
4738           by vertical bar (pipe) symbols <tt>|</tt>.  In such a case,
4739           that part of the dependency can be satisfied by any one of
4740           the alternative packages.
4741         </p>
4742
4743         <p>
4744           All of the fields except for <tt>Provides</tt> may restrict
4745           their applicability to particular versions of each named
4746           package.  This is done in parentheses after each individual
4747           package name; the parentheses should contain a relation from
4748           the list below followed by a version number, in the format
4749           described in <ref id="f-Version">.
4750         </p>
4751
4752         <p>
4753           The relations allowed are <tt>&lt;&lt;</tt>, <tt>&lt;=</tt>,
4754           <tt>=</tt>, <tt>&gt;=</tt> and <tt>&gt;&gt;</tt> for strictly
4755           earlier, earlier or equal, exactly equal, later or equal and
4756           strictly later, respectively.  The deprecated
4757           forms <tt>&lt;</tt> and <tt>&gt;</tt> were confusingly used to
4758           mean earlier/later or equal, rather than strictly earlier/later,
4759           and must not appear in new packages (though <prgn>dpkg</prgn>
4760           still supports them with a warning).
4761         </p>
4762
4763         <p>
4764           Whitespace may appear at any point in the version
4765           specification subject to the rules in <ref
4766           id="controlsyntax">, and must appear where it's necessary to
4767           disambiguate; it is not otherwise significant.  All of the
4768           relationship fields can only be folded in source package control files.  For
4769           consistency and in case of future changes to
4770           <prgn>dpkg</prgn> it is recommended that a single space be
4771           used after a version relationship and before a version
4772           number; it is also conventional to put a single space after
4773           each comma, on either side of each vertical bar, and before
4774           each open parenthesis.  When opening a continuation line in a relationship field, it
4775           is conventional to do so after a comma and before the space
4776           following that comma.
4777         </p>
4778
4779         <p>
4780           For example, a list of dependencies might appear as:
4781           <example compact="compact">
4782 Package: mutt
4783 Version: 1.3.17-1
4784 Depends: libc6 (>= 2.2.1), exim | mail-transport-agent
4785           </example>
4786         </p>
4787
4788         <p>
4789           Relationships may be restricted to a certain set of
4790           architectures.  This is indicated in brackets after each
4791           individual package name and the optional version specification.
4792           The brackets enclose a non-empty list of Debian architecture names
4793           in the format described in <ref id="arch-spec">,
4794           separated by whitespace.  Exclamation marks may be prepended to
4795           each of the names.  (It is not permitted for some names to be
4796           prepended with exclamation marks while others aren't.)
4797         </p>
4798
4799         <p>
4800           For build relationship fields
4801           (<tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
4802           <tt>Build-Conflicts</tt> and <tt>Build-Conflicts-Indep</tt>), if
4803           the current Debian host architecture is not in this list and
4804           there are no exclamation marks in the list, or it is in the list
4805           with a prepended exclamation mark, the package name and the
4806           associated version specification are ignored completely for the
4807           purposes of defining the relationships.
4808         </p>
4809
4810         <p>
4811           For example:
4812           <example compact="compact">
4813 Source: glibc
4814 Build-Depends-Indep: texinfo
4815 Build-Depends: kernel-headers-2.2.10 [!hurd-i386],
4816   hurd-dev [hurd-i386], gnumach-dev [hurd-i386]
4817           </example>
4818           requires <tt>kernel-headers-2.2.10</tt> on all architectures
4819           other than hurd-i386 and requires <tt>hurd-dev</tt> and
4820           <tt>gnumach-dev</tt> only on hurd-i386.
4821         </p>
4822
4823         <p>
4824           For binary relationship fields and the <tt>Built-Using</tt>
4825           field, the architecture restriction
4826           syntax is only supported in the source package control
4827           file <file>debian/control</file>.  When the corresponding binary
4828           package control file is generated, the relationship will either
4829           be omitted or included without the architecture restriction
4830           based on the architecture of the binary package.  This means
4831           that architecture restrictions must not be used in binary
4832           relationship fields for architecture-independent packages
4833           (<tt>Architecture: all</tt>).
4834         </p>
4835
4836         <p>
4837           For example:
4838           <example compact="compact">
4839 Depends: foo [i386], bar [amd64]
4840           </example>
4841           becomes <tt>Depends: foo</tt> when the package is built on
4842           the <tt>i386</tt> architecture, <tt>Depends: bar</tt> when the
4843           package is built on the <tt>amd64</tt> architecture, and omitted
4844           entirely in binary packages built on all other architectures.
4845         </p>
4846
4847         <p>
4848           If the architecture-restricted dependency is part of a set of
4849           alternatives using <tt>|</tt>, that alternative is ignored
4850           completely on architectures that do not match the restriction.
4851           For example:
4852           <example compact="compact">
4853 Build-Depends: foo [!i386] | bar [!amd64]
4854           </example>
4855           is equivalent to <tt>bar</tt> on the i386 architecture, to
4856           <tt>foo</tt> on the amd64 architecture, and to <tt>foo |
4857           bar</tt> on all other architectures.
4858         </p>
4859
4860         <p>
4861           Relationships may also be restricted to a certain set of
4862           architectures using architecture wildcards in the format
4863           described in <ref id="arch-wildcard-spec">.  The syntax for
4864           declaring such restrictions is the same as declaring
4865           restrictions using a certain set of architectures without
4866           architecture wildcards.  For example:
4867           <example compact="compact">
4868 Build-Depends: foo [linux-any], bar [any-i386], baz [!linux-any]
4869           </example>
4870           is equivalent to <tt>foo</tt> on architectures using the Linux
4871           kernel and any cpu, <tt>bar</tt> on architectures using any
4872           kernel and an i386 cpu, and <tt>baz</tt> on any architecture
4873           using a kernel other than Linux.
4874         </p>
4875
4876         <p>
4877           Note that the binary package relationship fields such as
4878           <tt>Depends</tt> appear in one of the binary package
4879           sections of the control file, whereas the build-time
4880           relationships such as <tt>Build-Depends</tt> appear in the
4881           source package section of the control file (which is the
4882           first section).
4883         </p>
4884       </sect>
4885
4886       <sect id="binarydeps">
4887         <heading>Binary Dependencies - <tt>Depends</tt>,
4888           <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
4889           <tt>Pre-Depends</tt>
4890         </heading>
4891
4892         <p>
4893           Packages can declare in their control file that they have
4894           certain relationships to other packages - for example, that
4895           they may not be installed at the same time as certain other
4896           packages, and/or that they depend on the presence of others.
4897         </p>
4898
4899         <p>
4900           This is done using the <tt>Depends</tt>, <tt>Pre-Depends</tt>,
4901           <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
4902           <tt>Breaks</tt> and <tt>Conflicts</tt> control fields.
4903           <tt>Breaks</tt> is described in <ref id="breaks">, and
4904           <tt>Conflicts</tt> is described in <ref id="conflicts">.  The
4905           rest are described below.
4906         </p>
4907
4908         <p>
4909           These seven fields are used to declare a dependency
4910           relationship by one package on another.  Except for
4911           <tt>Enhances</tt> and <tt>Breaks</tt>, they appear in the
4912           depending (binary) package's control file.
4913           (<tt>Enhances</tt> appears in the recommending package's
4914           control file, and <tt>Breaks</tt> appears in the version of
4915           depended-on package which causes the named package to
4916           break).
4917         </p>
4918
4919         <p>
4920           A <tt>Depends</tt> field takes effect <em>only</em> when a
4921           package is to be configured.  It does not prevent a package
4922           being on the system in an unconfigured state while its
4923           dependencies are unsatisfied, and it is possible to replace
4924           a package whose dependencies are satisfied and which is
4925           properly installed with a different version whose
4926           dependencies are not and cannot be satisfied; when this is
4927           done the depending package will be left unconfigured (since
4928           attempts to configure it will give errors) and will not
4929           function properly.  If it is necessary, a
4930           <tt>Pre-Depends</tt> field can be used, which has a partial
4931           effect even when a package is being unpacked, as explained
4932           in detail below.  (The other three dependency fields,
4933           <tt>Recommends</tt>, <tt>Suggests</tt> and
4934           <tt>Enhances</tt>, are only used by the various front-ends
4935           to <prgn>dpkg</prgn> such as <prgn>apt-get</prgn>,
4936           <prgn>aptitude</prgn>, and <prgn>dselect</prgn>.)
4937         </p>
4938
4939         <p>
4940           Since <tt>Depends</tt> only places requirements on the order in
4941           which packages are configured, packages in an installation run
4942           are usually all unpacked first and all configured later.
4943           <footnote>
4944             This approach makes dependency resolution easier.  If two
4945             packages A and B are being upgraded, the installed package A
4946             depends on exactly the installed package B, and the new
4947             package A depends on exactly the new package B (a common
4948             situation when upgrading shared libraries and their
4949             corresponding development packages), satisfying the
4950             dependencies at every stage of the upgrade would be
4951             impossible.  This relaxed restriction means that both new
4952             packages can be unpacked together and then configured in their
4953             dependency order.
4954           </footnote>
4955         </p>
4956
4957         <p>
4958           If there is a circular dependency among packages being installed
4959           or removed, installation or removal order honoring the
4960           dependency order is impossible, requiring the dependency loop be
4961           broken at some point and the dependency requirements violated
4962           for at least one package.  Packages involved in circular
4963           dependencies may not be able to rely on their dependencies being
4964           configured before they themselves are configured, depending on
4965           which side of the break of the circular dependency loop they
4966           happen to be on.  If one of the packages in the loop has
4967           no <prgn>postinst</prgn> script, then the cycle will be broken
4968           at that package; this ensures that all <prgn>postinst</prgn>
4969           scripts are run with their dependencies properly configured if
4970           this is possible.  Otherwise the breaking point is arbitrary.
4971           Packages should therefore avoid circular dependencies where
4972           possible, particularly if they have <prgn>postinst</prgn>
4973           scripts.
4974         </p>
4975
4976         <p>
4977           The meaning of the five dependency fields is as follows:
4978           <taglist>
4979             <tag><tt>Depends</tt></tag>
4980             <item>
4981               <p>
4982                 This declares an absolute dependency.  A package will
4983                 not be configured unless all of the packages listed in
4984                 its <tt>Depends</tt> field have been correctly
4985                 configured (unless there is a circular dependency as
4986                 described above).
4987               </p>
4988
4989               <p>
4990                 The <tt>Depends</tt> field should be used if the
4991                 depended-on package is required for the depending
4992                 package to provide a significant amount of
4993                 functionality.
4994               </p>
4995
4996               <p>
4997                 The <tt>Depends</tt> field should also be used if the
4998                 <prgn>postinst</prgn> or <prgn>prerm</prgn> scripts
4999                 require the depended-on package to be unpacked or
5000                 configured in order to run.  In the case of <tt>postinst
5001                 configure</tt>, the depended-on packages will be unpacked
5002                 and configured first.  (If both packages are involved in a
5003                 dependency loop, this might not work as expected; see the
5004                 explanation a few paragraphs back.)  In the case
5005                 of <prgn>prerm</prgn> or other <prgn>postinst</prgn>
5006                 actions, the package dependencies will normally be at
5007                 least unpacked, but they may be only "Half-Installed" if a
5008                 previous upgrade of the dependency failed.
5009               </p>
5010
5011               <p>
5012                 Finally, the <tt>Depends</tt> field should be used if the
5013                 depended-on package is needed by the <prgn>postrm</prgn>
5014                 script to fully clean up after the package removal.  There
5015                 is no guarantee that package dependencies will be
5016                 available when <prgn>postrm</prgn> is run, but the
5017                 depended-on package is more likely to be available if the
5018                 package declares a dependency (particularly in the case
5019                 of <tt>postrm remove</tt>).  The <prgn>postrm</prgn>
5020                 script must gracefully skip actions that require a
5021                 dependency if that dependency isn't available.
5022               </p>
5023             </item>
5024
5025             <tag><tt>Recommends</tt></tag>
5026             <item>
5027               <p>
5028                 This declares a strong, but not absolute, dependency.
5029               </p>
5030
5031               <p>
5032                 The <tt>Recommends</tt> field should list packages
5033                 that would be found together with this one in all but
5034                 unusual installations.
5035               </p>
5036             </item>
5037
5038             <tag><tt>Suggests</tt></tag>
5039             <item>
5040                 This is used to declare that one package may be more
5041                 useful with one or more others.  Using this field
5042                 tells the packaging system and the user that the
5043                 listed packages are related to this one and can
5044                 perhaps enhance its usefulness, but that installing
5045                 this one without them is perfectly reasonable.
5046             </item>
5047
5048             <tag><tt>Enhances</tt></tag>
5049             <item>
5050                 This field is similar to Suggests but works in the
5051                 opposite direction. It is used to declare that a
5052                 package can enhance the functionality of another
5053                 package.
5054             </item>
5055
5056             <tag><tt>Pre-Depends</tt></tag>
5057             <item>
5058               <p>
5059                 This field is like <tt>Depends</tt>, except that it
5060                 also forces <prgn>dpkg</prgn> to complete installation
5061                 of the packages named before even starting the
5062                 installation of the package which declares the
5063                 pre-dependency, as follows:
5064               </p>
5065
5066               <p>
5067                 When a package declaring a pre-dependency is about to
5068                 be <em>unpacked</em> the pre-dependency can be
5069                 satisfied if the depended-on package is either fully
5070                 configured, <em>or even if</em> the depended-on
5071                 package(s) are only in the "Unpacked" or the "Half-Configured"
5072                 state, provided that they have been configured
5073                 correctly at some point in the past (and not removed
5074                 or partially removed since).  In this case, both the
5075                 previously-configured and currently "Unpacked" or
5076                 "Half-Configured" versions must satisfy any version
5077                 clause in the <tt>Pre-Depends</tt> field.
5078               </p>
5079
5080               <p>
5081                 When the package declaring a pre-dependency is about to
5082                 be <em>configured</em>, the pre-dependency will be treated
5083                 as a normal <tt>Depends</tt>.  It will be considered
5084                 satisfied only if the depended-on package has been
5085                 correctly configured.  However, unlike
5086                 with <tt>Depends</tt>, <tt>Pre-Depends</tt> does not
5087                 permit circular dependencies to be broken.  If a circular
5088                 dependency is encountered while attempting to honor
5089                 <tt>Pre-Depends</tt>, the installation will be aborted.
5090               </p>
5091
5092               <p>
5093                 <tt>Pre-Depends</tt> are also required if the
5094                 <prgn>preinst</prgn> script depends on the named package.
5095                 It is best to avoid this situation if possible.
5096               </p>
5097
5098               <p>
5099                 <tt>Pre-Depends</tt> should be used sparingly,
5100                 preferably only by packages whose premature upgrade or
5101                 installation would hamper the ability of the system to
5102                 continue with any upgrade that might be in progress.
5103               </p>
5104
5105               <p>
5106                 You should not specify a <tt>Pre-Depends</tt> entry for a
5107                 package before this has been discussed on the
5108                 <tt>debian-devel</tt> mailing list and a consensus about
5109                 doing that has been reached.  See <ref id="dependencies">.
5110               </p>
5111             </item>
5112           </taglist>
5113         </p>
5114
5115         <p>
5116           When selecting which level of dependency to use you should
5117           consider how important the depended-on package is to the
5118           functionality of the one declaring the dependency.  Some
5119           packages are composed of components of varying degrees of
5120           importance.  Such a package should list using
5121           <tt>Depends</tt> the package(s) which are required by the
5122           more important components.  The other components'
5123           requirements may be mentioned as Suggestions or
5124           Recommendations, as appropriate to the components' relative
5125           importance.
5126         </p>
5127       </sect>
5128
5129       <sect id="breaks">
5130         <heading>Packages which break other packages - <tt>Breaks</tt></heading>
5131
5132         <p>
5133           When one binary package declares that it breaks another,
5134           <prgn>dpkg</prgn> will refuse to allow the package which
5135           declares <tt>Breaks</tt> to be unpacked unless the broken
5136           package is deconfigured first, and it will refuse to
5137           allow the broken package to be reconfigured.
5138         </p>
5139
5140         <p>
5141           A package will not be regarded as causing breakage merely
5142           because its configuration files are still installed; it must
5143           be at least "Half-Installed".
5144         </p>
5145
5146         <p>
5147           A special exception is made for packages which declare that
5148           they break their own package name or a virtual package which
5149           they provide (see below): this does not count as a real
5150           breakage.
5151         </p>
5152
5153         <p>
5154           Normally a <tt>Breaks</tt> entry will have an "earlier than"
5155           version clause; such a <tt>Breaks</tt> is introduced in the
5156           version of an (implicit or explicit) dependency which violates
5157           an assumption or reveals a bug in earlier versions of the broken
5158           package, or which takes over a file from earlier versions of the
5159           package named in <tt>Breaks</tt>.  This use of <tt>Breaks</tt>
5160           will inform higher-level package management tools that the
5161           broken package must be upgraded before the new one.
5162         </p>
5163
5164         <p>
5165           If the breaking package also overwrites some files from the
5166           older package, it should use <tt>Replaces</tt> to ensure this
5167           goes smoothly.  See <ref id="replaces"> for a full discussion
5168           of taking over files from other packages, including how to
5169           use <tt>Breaks</tt> in those cases.
5170         </p>
5171
5172         <p>
5173           Many of the cases where <tt>Breaks</tt> should be used were
5174           previously handled with <tt>Conflicts</tt>
5175           because <tt>Breaks</tt> did not yet exist.
5176           Many <tt>Conflicts</tt> fields should now be <tt>Breaks</tt>.
5177           See <ref id="conflicts"> for more information about the
5178           differences.
5179         </p>
5180       </sect>
5181
5182       <sect id="conflicts">
5183         <heading>Conflicting binary packages - <tt>Conflicts</tt></heading>
5184
5185         <p>
5186           When one binary package declares a conflict with another using
5187           a <tt>Conflicts</tt> field, <prgn>dpkg</prgn> will refuse to
5188           allow them to be unpacked on the system at the same time.  This
5189           is a stronger restriction than <tt>Breaks</tt>, which prevents
5190           the broken package from being configured while the breaking
5191           package is in the "Unpacked" state but allows both packages to
5192           be unpacked at the same time.
5193         </p>
5194
5195         <p>
5196           If one package is to be unpacked, the other must be removed
5197           first.  If the package being unpacked is marked as replacing
5198           (see <ref id="replaces">, but note that <tt>Breaks</tt> should
5199           normally be used in this case) the one on the system, or the one
5200           on the system is marked as deselected, or both packages are
5201           marked <tt>Essential</tt>, then <prgn>dpkg</prgn> will
5202           automatically remove the package which is causing the conflict.
5203           Otherwise, it will halt the installation of the new package with
5204           an error.  This mechanism is specifically designed to produce an
5205           error when the installed package is <tt>Essential</tt>, but the
5206           new package is not.
5207         </p>
5208
5209         <p>
5210           A package will not cause a conflict merely because its
5211           configuration files are still installed; it must be at least
5212           "Half-Installed".
5213         </p>
5214
5215         <p>
5216           A special exception is made for packages which declare a
5217           conflict with their own package name, or with a virtual
5218           package which they provide (see below): this does not
5219           prevent their installation, and allows a package to conflict
5220           with others providing a replacement for it.  You use this
5221           feature when you want the package in question to be the only
5222           package providing some feature.
5223         </p>
5224
5225         <p>
5226           Normally, <tt>Breaks</tt> should be used instead
5227           of <tt>Conflicts</tt> since <tt>Conflicts</tt> imposes a
5228           stronger restriction on the ordering of package installation or
5229           upgrade and can make it more difficult for the package manager
5230           to find a correct solution to an upgrade or installation
5231           problem.  <tt>Breaks</tt> should be used
5232           <list>
5233             <item>when moving a file from one package to another (see
5234               <ref id="replaces">),</item>
5235             <item>when splitting a package (a special case of the previous
5236               one), or</item>
5237             <item>when the breaking package exposes a bug in or interacts
5238               badly with particular versions of the broken
5239               package.</item>
5240           </list>
5241           <tt>Conflicts</tt> should be used
5242           <list>
5243             <item>when two packages provide the same file and will
5244               continue to do so,</item>
5245             <item>in conjunction with <tt>Provides</tt> when only one
5246               package providing a given virtual facility may be unpacked
5247               at a time (see <ref id="virtual">),</item>
5248             <item>in other cases where one must prevent simultaneous
5249               installation of two packages for reasons that are ongoing
5250               (not fixed in a later version of one of the packages) or
5251               that must prevent both packages from being unpacked at the
5252               same time, not just configured.</item>
5253           </list>
5254           Be aware that adding <tt>Conflicts</tt> is normally not the best
5255           solution when two packages provide the same files.  Depending on
5256           the reason for that conflict, using alternatives or renaming the
5257           files is often a better approach.  See, for
5258           example, <ref id="binaries">.
5259         </p>
5260
5261         <p>
5262           Neither <tt>Breaks</tt> nor <tt>Conflicts</tt> should be used
5263           unless two packages cannot be installed at the same time or
5264           installing them both causes one of them to be broken or
5265           unusable.  Having similar functionality or performing the same
5266           tasks as another package is not sufficient reason to
5267           declare <tt>Breaks</tt> or <tt>Conflicts</tt> with that package.
5268         </p>
5269
5270         <p>
5271           A <tt>Conflicts</tt> entry may have an "earlier than" version
5272           clause if the reason for the conflict is corrected in a later
5273           version of one of the packages.  However, normally the presence
5274           of an "earlier than" version clause is a sign
5275           that <tt>Breaks</tt> should have been used instead.  An "earlier
5276           than" version clause in <tt>Conflicts</tt>
5277           prevents <prgn>dpkg</prgn> from upgrading or installing the
5278           package which declares such a conflict until the upgrade or
5279           removal of the conflicted-with package has been completed, which
5280           is a strong restriction.
5281         </p>
5282       </sect>
5283
5284       <sect id="virtual"><heading>Virtual packages - <tt>Provides</tt>
5285         </heading>
5286
5287         <p>
5288           As well as the names of actual ("concrete") packages, the
5289           package relationship fields <tt>Depends</tt>,
5290           <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
5291           <tt>Pre-Depends</tt>, <tt>Breaks</tt>, <tt>Conflicts</tt>,
5292           <tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
5293           <tt>Build-Conflicts</tt> and <tt>Build-Conflicts-Indep</tt>
5294           may mention "virtual packages".
5295         </p>
5296
5297         <p>
5298           A <em>virtual package</em> is one which appears in the
5299           <tt>Provides</tt> control field of another package.  The effect
5300           is as if the package(s) which provide a particular virtual
5301           package name had been listed by name everywhere the virtual
5302           package name appears. (See also <ref id="virtual_pkg">)
5303         </p>
5304
5305         <p>
5306           If there are both concrete and virtual packages of the same
5307           name, then the dependency may be satisfied (or the conflict
5308           caused) by either the concrete package with the name in
5309           question or any other concrete package which provides the
5310           virtual package with the name in question.  This is so that,
5311           for example, supposing we have
5312           <example compact="compact">
5313 Package: foo
5314 Depends: bar
5315           </example> and someone else releases an enhanced version of
5316           the <tt>bar</tt> package they can say:
5317           <example compact="compact">
5318 Package: bar-plus
5319 Provides: bar
5320           </example>
5321           and the <tt>bar-plus</tt> package will now also satisfy the
5322           dependency for the <tt>foo</tt> package.
5323         </p>
5324
5325         <p>
5326           If a relationship field has a version number attached, only real
5327           packages will be considered to see whether the relationship is
5328           satisfied (or the prohibition violated, for a conflict or
5329           breakage).  In other words, if a version number is specified,
5330           this is a request to ignore all <tt>Provides</tt> for that
5331           package name and consider only real packages.  The package
5332           manager will assume that a package providing that virtual
5333           package is not of the "right" version.  A <tt>Provides</tt>
5334           field may not contain version numbers, and the version number of
5335           the concrete package which provides a particular virtual package
5336           will not be considered when considering a dependency on or
5337           conflict with the virtual package name.<footnote>
5338             It is possible that a future release of <prgn>dpkg</prgn> may
5339             add the ability to specify a version number for each virtual
5340             package it provides.  This feature is not yet present,
5341             however, and is expected to be used only infrequently.
5342           </footnote>
5343         </p>
5344
5345         <p>
5346           To specify which of a set of real packages should be the default
5347           to satisfy a particular dependency on a virtual package, list
5348           the real package as an alternative before the virtual one.
5349         </p>
5350
5351         <p>
5352           If the virtual package represents a facility that can only be
5353           provided by one real package at a time, such as
5354           the <package>mail-transport-agent</package> virtual package that
5355           requires installation of a binary that would conflict with all
5356           other providers of that virtual package (see
5357           <ref id="mail-transport-agents">), all packages providing that
5358           virtual package should also declare a conflict with it
5359           using <tt>Conflicts</tt>.  This will ensure that at most one
5360           provider of that virtual package is unpacked or installed at a
5361           time.
5362         </p>
5363       </sect>
5364
5365       <sect id="replaces"><heading>Overwriting files and replacing
5366           packages - <tt>Replaces</tt></heading>
5367
5368         <p>
5369           Packages can declare in their control file that they should
5370           overwrite files in certain other packages, or completely replace
5371           other packages. The <tt>Replaces</tt> control field has these
5372           two distinct purposes.
5373         </p>
5374
5375         <sect1><heading>Overwriting files in other packages</heading>
5376
5377           <p>
5378             It is usually an error for a package to contain files which
5379             are on the system in another package.  However, if the
5380             overwriting package declares that it <tt>Replaces</tt> the one
5381             containing the file being overwritten, then <prgn>dpkg</prgn>
5382             will replace the file from the old package with that from the
5383             new.  The file will no longer be listed as "owned" by the old
5384             package and will be taken over by the new package.
5385             Normally, <tt>Breaks</tt> should be used in conjunction
5386             with <tt>Replaces</tt>.<footnote>
5387               To see why <tt>Breaks</tt> is normally needed in addition
5388               to <tt>Replaces</tt>, consider the case of a file in the
5389               package <package>foo</package> being taken over by the
5390               package <package>foo-data</package>.
5391               <tt>Replaces</tt> will allow <package>foo-data</package> to
5392               be installed and take over that file.  However,
5393               without <tt>Breaks</tt>, nothing
5394               requires <package>foo</package> to be upgraded to a newer
5395               version that knows it does not include that file and instead
5396               depends on <package>foo-data</package>.  Nothing would
5397               prevent the new <package>foo-data</package> package from
5398               being installed and then removed, removing the file that it
5399               took over from <package>foo</package>.  After that
5400               operation, the package manager would think the system was in
5401               a consistent state, but the <package>foo</package> package
5402               would be missing one of its files.
5403             </footnote>
5404           </p>
5405
5406           <p>
5407             For example, if a package <package>foo</package> is split
5408             into <package>foo</package> and <package>foo-data</package>
5409             starting at version 1.2-3, <package>foo-data</package> would
5410             have the fields
5411             <example compact="compact">
5412 Replaces: foo (&lt;&lt; 1.2-3)
5413 Breaks: foo (&lt;&lt; 1.2-3)
5414             </example>
5415             in its control file.  The new version of the
5416             package <package>foo</package> would normally have the field
5417             <example compact="compact">
5418 Depends: foo-data (&gt;= 1.2-3)
5419             </example>
5420             (or possibly <tt>Recommends</tt> or even <tt>Suggests</tt> if
5421             the files moved into <package>foo-data</package> are not
5422             required for normal operation).
5423           </p>
5424
5425           <p>
5426             If a package is completely replaced in this way, so that
5427             <prgn>dpkg</prgn> does not know of any files it still
5428             contains, it is considered to have "disappeared".  It will
5429             be marked as not wanted on the system (selected for
5430             removal) and "Not-Installed".  Any <tt>conffile</tt>s
5431             details noted for the package will be ignored, as they
5432             will have been taken over by the overwriting package.  The
5433             package's <prgn>postrm</prgn> script will be run with a
5434             special argument to allow the package to do any final
5435             cleanup required.  See <ref id="mscriptsinstact">.
5436             <footnote>
5437               Replaces is a one way relationship.  You have to install
5438               the replacing package after the replaced package.
5439             </footnote>
5440           </p>
5441
5442           <p>
5443             For this usage of <tt>Replaces</tt>, virtual packages (see
5444             <ref id="virtual">) are not considered when looking at a
5445             <tt>Replaces</tt> field.  The packages declared as being
5446             replaced must be mentioned by their real names.
5447           </p>
5448
5449           <p>
5450             This usage of <tt>Replaces</tt> only takes effect when both
5451             packages are at least partially on the system at once.  It is
5452             not relevant if the packages conflict unless the conflict has
5453             been overridden.
5454           </p>
5455         </sect1>
5456
5457         <sect1><heading>Replacing whole packages, forcing their
5458             removal</heading>
5459
5460           <p>
5461             Second, <tt>Replaces</tt> allows the packaging system to
5462             resolve which package should be removed when there is a
5463             conflict (see <ref id="conflicts">).  This usage only takes
5464             effect when the two packages <em>do</em> conflict, so that the
5465             two usages of this field do not interfere with each other.
5466           </p>
5467
5468           <p>
5469             In this situation, the package declared as being replaced
5470             can be a virtual package, so for example, all mail
5471             transport agents (MTAs) would have the following fields in
5472             their control files:
5473             <example compact="compact">
5474 Provides: mail-transport-agent
5475 Conflicts: mail-transport-agent
5476 Replaces: mail-transport-agent
5477             </example>
5478             ensuring that only one MTA can be unpacked at any one
5479             time.  See <ref id="virtual"> for more information about this
5480             example.
5481         </sect1>
5482       </sect>
5483
5484       <sect id="sourcebinarydeps">
5485         <heading>Relationships between source and binary packages -
5486           <tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
5487           <tt>Build-Conflicts</tt>, <tt>Build-Conflicts-Indep</tt>
5488         </heading>
5489
5490         <p>
5491           Source packages that require certain binary packages to be
5492           installed or absent at the time of building the package
5493           can declare relationships to those binary packages.
5494         </p>
5495
5496         <p>
5497           This is done using the <tt>Build-Depends</tt>,
5498           <tt>Build-Depends-Indep</tt>, <tt>Build-Conflicts</tt> and
5499           <tt>Build-Conflicts-Indep</tt> control fields.
5500         </p>
5501
5502         <p>
5503           Build-dependencies on "build-essential" binary packages can be
5504           omitted. Please see <ref id="pkg-relations"> for more information.
5505         </p>
5506
5507         <p>
5508           The dependencies and conflicts they define must be satisfied
5509           (as defined earlier for binary packages) in order to invoke
5510           the targets in <tt>debian/rules</tt>, as follows:<footnote>
5511             <p>
5512               There is no Build-Depends-Arch; this role is essentially
5513               met with Build-Depends.  Anyone building the
5514               <tt>build-indep</tt> and <tt>binary-indep</tt> targets is
5515               assumed to be building the whole package, and therefore
5516               installation of all build dependencies is required.
5517             </p>
5518             <p>
5519               The autobuilders use <tt>dpkg-buildpackage -B</tt>, which
5520               calls <tt>build</tt>, not <tt>build-arch</tt> since it does
5521               not yet know how to check for its existence, and
5522               <tt>binary-arch</tt>.  The purpose of the original split
5523               between <tt>Build-Depends</tt> and
5524               <tt>Build-Depends-Indep</tt> was so that the autobuilders
5525               wouldn't need to install extra packages needed only for the
5526               binary-indep targets.  But without a build-arch/build-indep
5527               split, this didn't work, since most of the work is done in
5528               the build target, not in the binary target.
5529             </p>
5530           </footnote>
5531           <taglist>
5532             <tag><tt>clean</tt>, <tt>build-arch</tt>, and
5533               <tt>binary-arch</tt></tag>
5534             <item>
5535               Only the <tt>Build-Depends</tt> and <tt>Build-Conflicts</tt>
5536               fields must be satisfied when these targets are invoked.
5537             </item>
5538             <tag><tt>build</tt>, <tt>build-indep</tt>, <tt>binary</tt>,
5539               and <tt>binary-indep</tt></tag>
5540             <item>
5541               The <tt>Build-Depends</tt>, <tt>Build-Conflicts</tt>,
5542               <tt>Build-Depends-Indep</tt>, and
5543               <tt>Build-Conflicts-Indep</tt> fields must be satisfied when
5544               these targets are invoked.
5545             </item>
5546           </taglist>
5547         </p>
5548       </sect>
5549
5550       <sect id="built-using">
5551         <heading>Additional source packages used to build the binary
5552           - <tt>Built-Using</tt>
5553         </heading>
5554
5555         <p>
5556           Some binary packages incorporate parts of other packages when built
5557           but do not have to depend on those packages.  Examples include
5558           linking with static libraries or incorporating source code from
5559           another package during the build.  In this case, the source packages
5560           of those other packages are a required part of the complete source
5561           (the binary package is not reproducible without them).
5562         </p>
5563
5564         <p>
5565           A <tt>Built-Using</tt> field must list the corresponding source
5566           package for any such binary package incorporated during the build
5567           <footnote>
5568             <tt>Build-Depends</tt> in the source package is not adequate since
5569             it (rightfully) does not document the exact version used in the
5570             build.
5571           </footnote>,
5572           including an "exactly equal" ("=") version relation on the version
5573           that was used to build that binary package<footnote>
5574             The archive software might reject packages that refer to
5575             non-existent sources.
5576           </footnote>.
5577         </p>
5578
5579         <p>
5580           A package using the source code from the gcc-4.6-source
5581           binary package built from the gcc-4.6 source package would
5582           have this field in its control file:
5583           <example compact="compact">
5584 Built-Using: gcc-4.6 (= 4.6.0-11)
5585           </example>
5586         </p>
5587
5588         <p>
5589           A package including binaries from grub2 and loadlin would
5590           have this field in its control file:
5591           <example compact="compact">
5592 Built-Using: grub2 (= 1.99-9), loadlin (= 1.6e-1)
5593           </example>
5594         </p>
5595       </sect>
5596     </chapt>
5597
5598
5599     <chapt id="sharedlibs"><heading>Shared libraries</heading>
5600
5601       <p>
5602         Packages containing shared libraries must be constructed with
5603         a little care to make sure that the shared library is always
5604         available.  This is especially important for packages whose
5605         shared libraries are vitally important, such as the C library
5606         (currently <tt>libc6</tt>).
5607       </p>
5608
5609       <p>
5610         This section deals only with public shared libraries: shared
5611         libraries that are placed in directories searched by the dynamic
5612         linker by default or which are intended to be linked against
5613         normally and possibly used by other, independent packages.  Shared
5614         libraries that are internal to a particular package or that are
5615         only loaded as dynamic modules are not covered by this section and
5616         are not subject to its requirements.
5617       </p>
5618
5619       <p>
5620         A shared library is identified by the <tt>SONAME</tt> attribute
5621         stored in its dynamic section.  When a binary is linked against a
5622         shared library, the <tt>SONAME</tt> of the shared library is
5623         recorded in the binary's <tt>NEEDED</tt> section so that the
5624         dynamic linker knows that library must be loaded at runtime.  The
5625         shared library file's full name (which usually contains additional
5626         version information not needed in the <tt>SONAME</tt>) is
5627         therefore normally not referenced directly.  Instead, the shared
5628         library is loaded by its <tt>SONAME</tt>, which exists on the file
5629         system as a symlink pointing to the full name of the shared
5630         library.  This symlink must be provided by the
5631         package.  <ref id="sharedlibs-runtime"> describes how to do this.
5632         <footnote>
5633           This is a convention of shared library versioning, but not a
5634           requirement.  Some libraries use the <tt>SONAME</tt> as the full
5635           library file name instead and therefore do not need a symlink.
5636           Most, however, encode additional information about
5637           backwards-compatible revisions as a minor version number in the
5638           file name.  The <tt>SONAME</tt> itself only changes when
5639           binaries linked with the earlier version of the shared library
5640           may no longer work, but the filename may change with each
5641           release of the library.  See <ref id="sharedlibs-runtime"> for
5642           more information.
5643         </footnote>
5644       </p>
5645
5646       <p>
5647         When linking a binary or another shared library against a shared
5648         library, the <tt>SONAME</tt> for that shared library is not yet
5649         known.  Instead, the shared library is found by looking for a file
5650         matching the library name with <tt>.so</tt> appended.  This file
5651         exists on the file system as a symlink pointing to the shared
5652         library.
5653       </p>
5654
5655       <p>
5656         Shared libraries are normally split into several binary packages.
5657         The <tt>SONAME</tt> symlink is installed by the runtime shared
5658         library package, and the bare <tt>.so</tt> symlink is installed in
5659         the development package since it's only used when linking binaries
5660         or shared libraries.  However, there are some exceptions for
5661         unusual shared libraries or for shared libraries that are also
5662         loaded as dynamic modules by other programs.
5663       </p>
5664
5665       <p>
5666         This section is primarily concerned with how the separation of
5667         shared libraries into multiple packages should be done and how
5668         dependencies on and between shared library binary packages are
5669         managed in Debian.  <ref id="libraries"> should be read in
5670         conjunction with this section and contains additional rules for
5671         the files contained in the shared library packages.
5672       </p>
5673
5674       <sect id="sharedlibs-runtime">
5675         <heading>Run-time shared libraries</heading>
5676
5677         <p>
5678           The run-time shared library must be placed in a package
5679           whose name changes whenever the <tt>SONAME</tt> of the shared
5680           library changes.  This allows several versions of the shared
5681           library to be installed at the same time, allowing installation
5682           of the new version of the shared library without immediately
5683           breaking binaries that depend on the old version.  Normally, the
5684           run-time shared library and its <tt>SONAME</tt> symlink should
5685           be placed in a package named
5686           <package><var>libraryname</var><var>soversion</var></package>,
5687           where <var>soversion</var> is the version number in
5688           the <tt>SONAME</tt> of the shared library.  Alternatively, if it
5689           would be confusing to directly append <var>soversion</var>
5690           to <var>libraryname</var> (if, for
5691           example, <var>libraryname</var> itself ends in a number), you
5692           should use
5693           <package><var>libraryname</var>-<var>soversion</var></package>
5694           instead.
5695         </p>
5696
5697         <p>
5698           To determine the <var>soversion</var>, look at
5699           the <tt>SONAME</tt> of the library, stored in the
5700           ELF <tt>SONAME</tt> attribute.  It is usually of the
5701           form <tt><var>name</var>.so.<var>major-version</var></tt> (for
5702           example, <tt>libz.so.1</tt>).  The version part is the part
5703           which comes after <tt>.so.</tt>, so in that example it
5704           is <tt>1</tt>.  The soname may instead be of the
5705           form <tt><var>name</var>-<var>major-version</var>.so</tt>, such
5706           as <tt>libdb-5.1.so</tt>, in which case the name would
5707           be <tt>libdb</tt> and the version would be <tt>5.1</tt>.
5708         </p>
5709
5710         <p>
5711           If you have several shared libraries built from the same source
5712           tree, you may lump them all together into a single shared
5713           library package provided that all of their <tt>SONAME</tt>s will
5714           always change together.  Be aware that this is not normally the
5715           case, and if the <tt>SONAME</tt>s do not change together,
5716           upgrading such a merged shared library package will be
5717           unnecessarily difficult because of file conflicts with the old
5718           version of the package.  When in doubt, always split shared
5719           library packages so that each binary package installs a single
5720           shared library.
5721         </p>
5722
5723         <p>
5724           Every time the shared library ABI changes in a way that may
5725           break binaries linked against older versions of the shared
5726           library, the <tt>SONAME</tt> of the library and the
5727           corresponding name for the binary package containing the runtime
5728           shared library should change.  Normally, this means
5729           the <tt>SONAME</tt> should change any time an interface is
5730           removed from the shared library or the signature of an interface
5731           (the number of parameters or the types of parameters that it
5732           takes, for example) is changed.  This practice is vital to
5733           allowing clean upgrades from older versions of the package and
5734           clean transitions between the old ABI and new ABI without having
5735           to upgrade every affected package simultaneously.
5736         </p>
5737
5738         <p>
5739           The <tt>SONAME</tt> and binary package name need not, and indeed
5740           normally should not, change if new interfaces are added but none
5741           are removed or changed, since this will not break binaries
5742           linked against the old shared library.  Correct versioning of
5743           dependencies on the newer shared library by binaries that use
5744           the new interfaces is handled via
5745           the <qref id="sharedlibs-depends"><tt>symbols</tt>
5746           or <tt>shlibs</tt> system</qref>.
5747         </p>
5748
5749       <p>
5750         The package should install the shared libraries under
5751         their normal names.  For example, the <package>libgdbm3</package>
5752         package should install <file>libgdbm.so.3.0.0</file> as
5753         <file>/usr/lib/libgdbm.so.3.0.0</file>.  The files should not be
5754         renamed or re-linked by any <prgn>prerm</prgn> or
5755         <prgn>postrm</prgn> scripts; <prgn>dpkg</prgn> will take care
5756         of renaming things safely without affecting running programs,
5757         and attempts to interfere with this are likely to lead to
5758         problems.
5759       </p>
5760
5761       <p>
5762         Shared libraries should not be installed executable, since
5763         the dynamic linker does not require this and trying to
5764         execute a shared library usually results in a core dump.
5765       </p>
5766
5767       <p>
5768         The run-time library package should include the symbolic link for
5769         the <tt>SONAME</tt> that <prgn>ldconfig</prgn> would create for
5770         the shared libraries.  For example,
5771         the <package>libgdbm3</package> package should include a symbolic
5772         link from <file>/usr/lib/libgdbm.so.3</file> to
5773         <file>libgdbm.so.3.0.0</file>.  This is needed so that the dynamic
5774         linker (for example <prgn>ld.so</prgn> or
5775         <prgn>ld-linux.so.*</prgn>) can find the library between the
5776         time that <prgn>dpkg</prgn> installs it and the time that
5777         <prgn>ldconfig</prgn> is run in the <prgn>postinst</prgn>
5778         script.<footnote>
5779             The package management system requires the library to be
5780             placed before the symbolic link pointing to it in the
5781             <file>.deb</file> file.  This is so that when
5782             <prgn>dpkg</prgn> comes to install the symlink
5783             (overwriting the previous symlink pointing at an older
5784             version of the library), the new shared library is already
5785             in place.  In the past, this was achieved by creating the
5786             library in the temporary packaging directory before
5787             creating the symlink.  Unfortunately, this was not always
5788             effective, since the building of the tar file in the
5789             <file>.deb</file> depended on the behavior of the underlying
5790             file system.  Some file systems (such as reiserfs) reorder
5791             the files so that the order of creation is forgotten.
5792             Since version 1.7.0, <prgn>dpkg</prgn>
5793             reorders the files itself as necessary when building a
5794             package.  Thus it is no longer important to concern
5795             oneself with the order of file creation.
5796         </footnote>
5797       </p>
5798
5799         <sect1 id="ldconfig">
5800           <heading><tt>ldconfig</tt></heading>
5801
5802         <p>
5803           Any package installing shared libraries in one of the default
5804           library directories of the dynamic linker (which are currently
5805           <file>/usr/lib</file> and <file>/lib</file>) or a directory that is
5806           listed in <file>/etc/ld.so.conf</file><footnote>
5807             These are currently <file>/usr/local/lib</file> plus
5808             directories under <file>/lib</file> and <file>/usr/lib</file>
5809             matching the multiarch triplet for the system architecture.
5810           </footnote>
5811           must use <prgn>ldconfig</prgn> to update the shared library
5812           system.
5813         </p>
5814
5815         <p>
5816             The package maintainer scripts must only call
5817             <prgn>ldconfig</prgn> under these circumstances:
5818             <list compact="compact">
5819               <item>When the <prgn>postinst</prgn> script is run with a
5820                   first argument of <tt>configure</tt>, the script must call
5821                   <prgn>ldconfig</prgn>, and may optionally invoke
5822                   <prgn>ldconfig</prgn> at other times.
5823               </item>
5824               <item>When the <prgn>postrm</prgn> script is run with a
5825                   first argument of <tt>remove</tt>, the script should call
5826                   <prgn>ldconfig</prgn>.
5827               </item>
5828             </list>
5829          <footnote>
5830             <p>
5831               During install or upgrade, the preinst is called before
5832               the new files are unpacked, so calling "ldconfig" is
5833               pointless.  The preinst of an existing package can also be
5834               called if an upgrade fails.  However, this happens during
5835               the critical time when a shared libs may exist on-disk
5836               under a temporary name.  Thus, it is dangerous and
5837               forbidden by current policy to call "ldconfig" at this
5838               time.
5839             </p>
5840
5841             <p>
5842               When a package is installed or upgraded, "postinst
5843               configure" runs after the new files are safely on-disk.
5844               Since it is perfectly safe to invoke ldconfig
5845               unconditionally in a postinst, it is OK for a package to
5846               simply put ldconfig in its postinst without checking the
5847               argument.  The postinst can also be called to recover from
5848               a failed upgrade.  This happens before any new files are
5849               unpacked, so there is no reason to call "ldconfig" at this
5850               point.
5851             </p>
5852
5853             <p>
5854               For a package that is being removed, prerm is
5855               called with all the files intact, so calling ldconfig is
5856               useless.  The other calls to "prerm" happen in the case of
5857               upgrade at a time when all the files of the old package
5858               are on-disk, so again calling "ldconfig" is pointless.
5859             </p>
5860
5861             <p>
5862               postrm, on the other hand, is called with the "remove"
5863               argument just after the files are removed, so this is
5864               the proper time to call "ldconfig" to notify the system
5865               of the fact that the shared libraries from the package
5866               are removed.  The postrm can be called at several other
5867               times.  At the time of "postrm purge", "postrm
5868               abort-install", or "postrm abort-upgrade", calling
5869               "ldconfig" is useless because the shared lib files are
5870               not on-disk.  However, when "postrm" is invoked with
5871               arguments "upgrade", "failed-upgrade", or "disappear", a
5872               shared lib may exist on-disk under a temporary filename.
5873             </p>
5874           </footnote>
5875         </p>
5876         </sect1>
5877
5878       </sect>
5879
5880       <sect id="sharedlibs-support-files">
5881         <heading>Shared library support files</heading>
5882
5883         <p>
5884           If your package contains files whose names do not change with
5885           each change in the library shared object version, you must not
5886           put them in the shared library package.  Otherwise, several
5887           versions of the shared library cannot be installed at the same
5888           time without filename clashes, making upgrades and transitions
5889           unnecessarily difficult.
5890         </p>
5891
5892         <p>
5893           It is recommended that supporting files and run-time support
5894           programs that do not need to be invoked manually by users, but
5895           are nevertheless required for the package to function, be placed
5896           (if they are binary) in a subdirectory of <file>/usr/lib</file>,
5897           preferably under <file>/usr/lib/</file><var>package-name</var>.
5898           If the program or file is architecture independent, the
5899           recommendation is for it to be placed in a subdirectory of
5900           <file>/usr/share</file> instead, preferably under
5901           <file>/usr/share/</file><var>package-name</var>.  Following the
5902           <var>package-name</var> naming convention ensures that the file
5903           names change when the shared object version changes.
5904         </p>
5905
5906         <p>
5907           Run-time support programs that use the shared library but are
5908           not required for the library to function or files used by the
5909           shared library that can be used by any version of the shared
5910           library package should instead be put in a separate package.
5911           This package might typically be named
5912           <package><var>libraryname</var>-tools</package>; note the
5913           absence of the <var>soversion</var> in the package name.
5914         </p>
5915
5916         <p>
5917           Files and support programs only useful when compiling software
5918           against the library should be included in the development
5919           package for the library.<footnote>
5920             For example, a <file><var>package-name</var>-config</file>
5921             script or <package>pkg-config</package> configuration files.
5922           </footnote>
5923         </p>
5924       </sect>
5925
5926       <sect id="sharedlibs-static">
5927         <heading>Static libraries</heading>
5928
5929       <p>
5930         The static library (<file><var>libraryname.a</var></file>)
5931         is usually provided in addition to the shared version.
5932         It is placed into the development package (see below).
5933       </p>
5934
5935       <p>
5936         In some cases, it is acceptable for a library to be
5937         available in static form only; these cases include:
5938         <list>
5939           <item>libraries for languages whose shared library support
5940                 is immature or unstable</item>
5941           <item>libraries whose interfaces are in flux or under
5942                 development (commonly the case when the library's
5943                 major version number is zero, or where the ABI breaks
5944                 across patchlevels)</item>
5945           <item>libraries which are explicitly intended to be
5946                 available only in static form by their upstream
5947                 author(s)</item>
5948         </list>
5949       </p>
5950
5951       <sect id="sharedlibs-dev">
5952         <heading>Development files</heading>
5953
5954       <p>
5955         If there are development files associated with a shared library,
5956         the source package needs to generate a binary development package
5957         named <package><var>libraryname</var><var>soversion</var>-dev</package>,
5958         or if you prefer only to support one development version at a
5959         time, <package><var>libraryname</var>-dev</package>.  Installing
5960         the development package must result in installation of all the
5961         development files necessary for compiling programs against that
5962         shared library.<footnote>
5963           This wording allows the development files to be split into
5964           several packages, such as a separate architecture-independent
5965           <package><var>libraryname</var>-headers</package>, provided that
5966           the development package depends on all the required additional
5967           packages.
5968         </footnote>
5969       </p>
5970
5971       <p>
5972         In case several development versions of a library exist, you may
5973         need to use <prgn>dpkg</prgn>'s Conflicts mechanism (see
5974         <ref id="conflicts">) to ensure that the user only installs one
5975         development version at a time (as different development versions are
5976         likely to have the same header files in them, which would cause a
5977         filename clash if both were unpacked).
5978       </p>
5979
5980       <p>
5981         The development package should contain a symlink for the associated
5982         shared library without a version number. For example, the
5983         <package>libgdbm-dev</package> package should include a symlink
5984         from <file>/usr/lib/libgdbm.so</file> to
5985         <file>libgdbm.so.3.0.0</file>.  This symlink is needed by the linker
5986         (<prgn>ld</prgn>) when compiling packages, as it will only look for
5987         <file>libgdbm.so</file> when compiling dynamically.
5988       </p>
5989
5990       <p>
5991         If the package provides Ada Library Information
5992         (<file>*.ali</file>) files for use with GNAT, these files must be
5993         installed read-only (mode 0444) so that GNAT will not attempt to
5994         recompile them.  This overrides the normal file mode requirements
5995         given in <ref id="permissions-owners">.
5996       </p>
5997       </sect>
5998
5999       <sect id="sharedlibs-intradeps">
6000         <heading>Dependencies between the packages of the same library</heading>
6001
6002         <p>
6003           Typically the development version should have an exact
6004           version dependency on the runtime library, to make sure that
6005           compilation and linking happens correctly.  The
6006           <tt>${binary:Version}</tt> substitution variable can be
6007           useful for this purpose.
6008           <footnote>
6009             Previously, <tt>${Source-Version}</tt> was used, but its name
6010             was confusing and it has been deprecated since dpkg 1.13.19.
6011           </footnote>
6012         </p>
6013       </sect>
6014
6015       <sect id="sharedlibs-depends">
6016         <heading>Dependencies between the library and other
6017           packages</heading>
6018
6019         <p>
6020           If a package contains a binary or library which links to a
6021           shared library, we must ensure that, when the package is
6022           installed on the system, all of the libraries needed are also
6023           installed.  These dependencies must be added to the binary
6024           package when it is built, since they may change based on which
6025           version of a shared library the binary or library was linked
6026           with even if there are no changes to the source of the binary
6027           (for example, symbol versions change, macros become functions or
6028           vice versa, or the binary package may determine at compile-time
6029           whether new library interfaces are available and can be called).
6030           To allow these dependencies to be constructed, shared libraries
6031           must provide either a <file>symbols</file> file or
6032           a <file>shlibs</file> file.  These provide information on the
6033           package dependencies required to ensure the presence of
6034           interfaces provided by this library.  Any package with binaries
6035           or libraries linking to a shared library must use these files to
6036           determine the required dependencies when it is built.  Other
6037           packages which use a shared library (for example using
6038           <tt>dlopen()</tt>) should compute appropriate dependencies
6039           using these files at build time as well.
6040         </p>
6041
6042         <p>
6043           The two mechanisms differ in the degree of detail that they
6044           provide.  A <file>symbols</file> file documents, for each symbol
6045           exported by a library, the minimal version of the package any
6046           binary using this symbol will need.  This is typically the
6047           version of the package in which the symbol was introduced.  This
6048           information permits detailed analysis of the symbols used by a
6049           particular package and construction of an accurate dependency,
6050           but it requires the package maintainer to track more information
6051           about the shared library.
6052         </p>
6053
6054         <p>
6055           A <file>shlibs</file> file, in contrast, only documents the last
6056           time the library ABI changed in any way.  It only provides
6057           information about the library as a whole, not individual
6058           symbols.  When a package is built using a shared library with
6059           only a <file>shlibs</file> file, the generated dependency will
6060           require a version of the shared library equal to or newer than
6061           the version of the last ABI change.  This generates
6062           unnecessarily restrictive dependencies compared
6063           to <file>symbols</file> files if none of the symbols used by the
6064           package have changed.  This, in turn, may make upgrades
6065           needlessly complex and unnecessarily restrict use of the package
6066           on systems with older versions of the shared libraries.
6067         </p>
6068
6069         <p>
6070           <file>shlibs</file> files also only support a limited range of
6071           library SONAMEs, making it difficult to use <file>shlibs</file>
6072           files in some unusual corner cases.<footnote>
6073             A <file>shlibs</file> file represents an SONAME as a library
6074             name and version number, such as <tt>libfoo VERSION</tt>,
6075             instead of recording the actual SONAME.  If the SONAME doesn't
6076             match one of the two expected formats
6077             (<tt>libfoo-VERSION.so</tt> or <tt>libfoo.so.VERSION</tt>), it
6078             cannot be represented.
6079           </footnote>
6080         </p>
6081
6082         <p>
6083           <file>symbols</file> files are therefore recommended for most
6084           shared library packages since they provide more accurate
6085           dependencies.  For most C libraries, the additional detail
6086           required by <file>symbols</file> files is not too difficult to
6087           maintain.  However, maintaining exhaustive symbols information
6088           for a C++ library can be quite onerous, so <file>shlibs</file>
6089           files may be more appropriate for most C++ libraries.  Libraries
6090           with a corresponding udeb must also provide
6091           a <file>shlibs</file> file, since the udeb infrastructure does
6092           not use <file>symbols</file> files.
6093         </p>
6094
6095         <sect1 id="dpkg-shlibdeps">
6096           <heading>Generating dependencies on shared libraries</heading>
6097
6098           <p>
6099             When a package that contains any shared libraries or compiled
6100             binaries is built, it must run <prgn>dpkg-shlibdeps</prgn> on
6101             each shared library and compiled binary to determine the
6102             libraries used and hence the dependencies needed by the
6103             package.<footnote>
6104               <prgn>dpkg-shlibdeps</prgn> will use a program
6105               like <prgn>objdump</prgn> or <prgn>readelf</prgn> to find
6106               the libraries and the symbols in those libraries directly
6107               needed by the binaries or shared libraries in the package.
6108             </footnote>
6109             To do this, put a call to <prgn>dpkg-shlibdeps</prgn> into
6110             your <file>debian/rules</file> file in the source package.
6111             List all of the compiled binaries, libraries, or loadable
6112             modules in your package.<footnote>
6113               The easiest way to call <prgn>dpkg-shlibdeps</prgn>
6114               correctly is to use a package helper framework such
6115               as <package>debhelper</package>.  If you are
6116               using <package>debhelper</package>,
6117               the <prgn>dh_shlibdeps</prgn> program will do this work for
6118               you.  It will also correctly handle multi-binary packages.
6119             </footnote>
6120             <prgn>dpkg-shlibdeps</prgn> will use the <file>symbols</file>
6121             or <file>shlibs</file> files installed by the shared libraries
6122             to generate dependency information.  The package must then
6123             provide a substitution variable into which the discovered
6124             dependency information can be placed.
6125           </p>
6126
6127           <p>
6128             If you are creating a udeb for use in the Debian Installer,
6129             you will need to specify that <prgn>dpkg-shlibdeps</prgn>
6130             should use the dependency line of type <tt>udeb</tt> by adding
6131             the <tt>-tudeb</tt> option<footnote>
6132               <prgn>dh_shlibdeps</prgn> from the <tt>debhelper</tt> suite
6133               will automatically add this option if it knows it is
6134               processing a udeb.
6135             </footnote>. If there is no dependency line of
6136             type <tt>udeb</tt> in the <file>shlibs</file>
6137             file, <prgn>dpkg-shlibdeps</prgn> will fall back to the
6138             regular dependency line.
6139           </p>
6140
6141           <p>
6142             <prgn>dpkg-shlibdeps</prgn> puts the dependency information
6143             into the <file>debian/substvars</file> file by default, which
6144             is then used by <prgn>dpkg-gencontrol</prgn>.  You will need
6145             to place a <tt>${shlibs:Depends}</tt> variable in
6146             the <tt>Depends</tt> field in the control file of every binary
6147             package built by this source package that contains compiled
6148             binaries, libraries, or loadable modules.  If you have
6149             multiple binary packages, you will need to
6150             call <prgn>dpkg-shlibdeps</prgn> on each one which contains
6151             compiled libraries or binaries.  For example, you could use
6152             the <tt>-T</tt> option to the <tt>dpkg</tt> utilities to
6153             specify a different <file>substvars</file> file for each
6154             binary package.<footnote>
6155               Again, <prgn>dh_shlibdeps</prgn>
6156               and <prgn>dh_gencontrol</prgn> will handle everything except
6157               the addition of the variable to the control file for you if
6158               you're using <package>debhelper</package>, including
6159               generating separate <file>substvars</file> files for each
6160               binary package and calling <prgn>dpkg-gencontrol</prgn> with
6161               the appropriate flags.
6162             </footnote>
6163           </p>
6164
6165           <p>
6166             For more details on <prgn>dpkg-shlibdeps</prgn>,
6167             see <manref name="dpkg-shlibdeps" section="1">.
6168           </p>
6169
6170           <p>
6171             We say that a binary <tt>foo</tt> <em>directly</em> uses a
6172             library <tt>libbar</tt> if it is explicitly linked with that
6173             library (that is, the library is listed in the
6174             ELF <tt>NEEDED</tt> attribute, caused by adding <tt>-lbar</tt>
6175             to the link line when the binary is created).  Other libraries
6176             that are needed by <tt>libbar</tt> are
6177             linked <em>indirectly</em> to <tt>foo</tt>, and the dynamic
6178             linker will load them automatically when it
6179             loads <tt>libbar</tt>.  A package should depend on the
6180             libraries it directly uses, but not the libraries it only uses
6181             indirectly.  The dependencies for the libraries used
6182             directly will automatically pull in the indirectly-used
6183             libraries.  <prgn>dpkg-shlibdeps</prgn> will handle this logic
6184             automatically, but package maintainers need to be aware of
6185             this distinction between directly and indirectly using a
6186             library if they have to override its results for some reason.
6187             <footnote>
6188               A good example of where this helps is the following.  We
6189               could update <tt>libimlib</tt> with a new version that
6190               supports a new revision of a graphics format called dgf (but
6191               retaining the same major version number) and depends on a
6192               new library package <package>libdgf4</package> instead of
6193               the older <package>libdgf3</package>.  If we
6194               used <prgn>ldd</prgn> to add dependencies for every library
6195               directly or indirectly linked with a binary, every package
6196               that uses <tt>libimlib</tt> would need to be recompiled so
6197               it would also depend on <package>libdgf4</package> in order
6198               to retire the older <package>libdgf3</package> package.
6199               Since dependencies are only added based on
6200               ELF <tt>NEEDED</tt> attribute, packages
6201               using <tt>libimlib</tt> can rely on <tt>libimlib</tt> itself
6202               having the dependency on an appropriate version
6203               of <tt>libdgf</tt> and do not need rebuilding.
6204             </footnote>
6205           </p>
6206         </sect1>
6207
6208         <sect1 id="sharedlibs-updates">
6209           <heading>Shared library ABI changes</heading>
6210
6211           <p>
6212             Maintaining a shared library package using
6213             either <file>symbols</file> or <file>shlibs</file> files
6214             requires being aware of the exposed ABI of the shared library
6215             and any changes to it.  Both <file>symbols</file>
6216             and <file>shlibs</file> files record every change to the ABI
6217             of the shared library; <file>symbols</file> files do so per
6218             public symbol, whereas <file>shlibs</file> files record only
6219             the last change for the entire library.
6220           </p>
6221
6222           <p>
6223             There are two types of ABI changes: ones that are
6224             backward-compatible and ones that are not.  An ABI change is
6225             backward-compatible if any reasonable program or library that
6226             was linked with the previous version of the shared library
6227             will still work correctly with the new version of the shared
6228             library.<footnote>
6229               An example of an "unreasonable" program is one that uses
6230               library interfaces that are documented as internal and
6231               unsupported.  If the only programs or libraries affected by
6232               a change are "unreasonable" ones, other techniques, such as
6233               declaring <tt>Breaks</tt> relationships with affected
6234               packages or treating their usage of the library as bugs in
6235               those packages, may be appropriate instead of changing the
6236               SONAME.  However, the default approach is to change the
6237               SONAME for any change to the ABI that could break a program.
6238             </footnote>
6239             Adding new symbols to the shared library is a
6240             backward-compatible change.  Removing symbols from the shared
6241             library is not.  Changing the behavior of a symbol may or may
6242             not be backward-compatible depending on the change; for
6243             example, changing a function to accept a new enum constant not
6244             previously used by the library is generally
6245             backward-compatible, but changing the members of a struct that
6246             is passed into library functions is generally not unless the
6247             library takes special precautions to accept old versions of
6248             the data structure.
6249           </p>
6250
6251           <p>
6252             ABI changes that are not backward-compatible normally require
6253             changing the <tt>SONAME</tt> of the library and therefore the
6254             shared library package name, which forces rebuilding all
6255             packages using that shared library to update their
6256             dependencies and allow them to use the new version of the
6257             shared library.  For more information,
6258             see <ref id="sharedlibs-runtime">.  The remainder of this
6259             section will deal with backward-compatible changes.
6260           </p>
6261
6262           <p>
6263             Backward-compatible changes require either updating or
6264             recording the <var>minimal-version</var> for that symbol
6265             in <file>symbols</file> files or updating the version in
6266             the <var>dependencies</var> in <file>shlibs</file> files.  For
6267             more information on how to do this in the two formats, see
6268             <ref id="symbols"> and <ref id="shlibs">.  Below are general
6269             rules that apply to both files.
6270           </p>
6271
6272           <p>
6273             The easy case is when a public symbol is added.  Simply add
6274             the version at which the symbol was introduced
6275             (for <file>symbols</file> files) or update the dependency
6276             version (for <file>shlibs</file>) files.  But special care
6277             should be taken to update dependency versions when the
6278             behavior of a public symbol changes.  This is easy to neglect,
6279             since there is no automated method of determining such
6280             changes, but failing to update versions in this case may
6281             result in binary packages with too-weak dependencies that will
6282             fail at runtime, possibly in ways that can cause security
6283             vulnerabilities.  If the package maintainer believes that a
6284             symbol behavior change may have occurred but isn't sure, it's
6285             safer to update the version rather than leave it unmodified.
6286             This may result in unnecessarily strict dependencies, but it
6287             ensures that packages whose dependencies are satisfied will
6288             work properly.
6289           </p>
6290
6291           <p>
6292             A common example of when a change to the dependency version
6293             is required is a function that takes an enum or struct
6294             argument that controls what the function does.  For example:
6295             <example>
6296               enum library_op { OP_FOO, OP_BAR };
6297               int library_do_operation(enum library_op);
6298             </example>
6299             If a new operation, <tt>OP_BAZ</tt>, is added,
6300             the <var>minimal-version</var>
6301             of <tt>library_do_operation</tt> (for <file>symbols</file>
6302             files) or the version in the dependency for the shared library
6303             (for <file>shlibs</file> files) must be increased to the
6304             version at which <tt>OP_BAZ</tt> was introduced.  Otherwise, a
6305             binary built against the new version of the library (having
6306             detected at compile-time that the library
6307             supports <tt>OP_BAZ</tt>) may be installed with a shared
6308             library that doesn't support <tt>OP_BAZ</tt> and will fail at
6309             runtime when it tries to pass <tt>OP_BAZ</tt> into this
6310             function.
6311           </p>
6312
6313           <p>
6314             Dependency versions in either <file>symbols</file>
6315             or <file>shlibs</file> files normally should not contain the
6316             Debian revision of the package, since the library behavior is
6317             normally fixed for a particular upstream version and any
6318             Debian packaging of that upstream version will have the same
6319             behavior.  In the rare case that the library behavior was
6320             changed in a particular Debian revision, appending <tt>~</tt>
6321             to the end of the version that includes the Debian revision is
6322             recommended, since this allows backports of the shared library
6323             package using the normal backport versioning convention to
6324             satisfy the dependency.
6325           </p>
6326         </sect1>
6327
6328         <sect1 id="sharedlibs-symbols">
6329           <heading>The <tt>symbols</tt> system</heading>
6330
6331           <p>
6332             In the following sections, we will first describe where the
6333             various <file>symbols</file> files are to be found, then
6334             the <file>symbols</file> file format, and finally how to
6335             create <file>symbols</file> files if your package contains a
6336             shared library.
6337           </p>
6338
6339           <sect2 id="symbols-paths">
6340             <heading>The <file>symbols</file> files present on the
6341               system</heading>
6342
6343             <p>
6344               <file>symbols</file> files for a shared library are normally
6345               provided by the shared library package as a control file,
6346               but there are several override paths that are checked first
6347               in case that information is wrong or missing.  The following
6348               list gives them in the order in which they are read
6349               by <prgn>dpkg-shlibdeps</prgn> The first one that contains
6350               the required information is used.
6351               <list>
6352                 <item>
6353                   <p><file>debian/*/DEBIAN/symbols</file></p>
6354
6355                   <p>
6356                     During the package build, if the package itself
6357                     contains shared libraries with <file>symbols</file>
6358                     files, they will be generated in these staging
6359                     directories by <prgn>dpkg-gensymbols</prgn>
6360                     (see <ref id="providing-symbols">).  <file>symbols</file>
6361                     files found in the build tree take precedence
6362                     over <file>symbols</file> files from other binary
6363                     packages.
6364                   </p>
6365
6366                   <p>
6367                     These files must exist
6368                     before <prgn>dpkg-shlibdeps</prgn> is run or the
6369                     dependencies of binaries and libraries from a source
6370                     package on other libraries from that same source
6371                     package will not be correct.  In practice, this means
6372                     that <prgn>dpkg-gensymbols</prgn> must be run
6373                     before <prgn>dpkg-shlibdeps</prgn> during the package
6374                     build.<footnote>
6375                       An example may clarify.  Suppose the source
6376                       package <tt>foo</tt> generates two binary
6377                       packages, <tt>libfoo2</tt> and <tt>foo-runtime</tt>.
6378                       When building the binary packages, the contents of
6379                       the packages are staged in the
6380                       directories <file>debian/libfoo2</file>
6381                       and <file>debian/foo-runtime</file> respectively.
6382                       (<file>debian/tmp</file> could be used instead of
6383                       one of these.)  Since <tt>libfoo2</tt> provides
6384                       the <tt>libfoo</tt> shared library, it will contain
6385                       a <tt>symbols</tt> file, which will be installed
6386                       in <file>debian/libfoo2/DEBIAN/symbols</file>,
6387                       eventually to be included as a control file in that
6388                       package.  When <prgn>dpkg-shlibdeps</prgn> is run on
6389                       the
6390                       executable <file>debian/foo-runtime/usr/bin/foo-prog</file>,
6391                       it will examine
6392                       the <file>debian/libfoo2/DEBIAN/symbols</file> file
6393                       to determine whether <tt>foo-prog</tt>'s library
6394                       dependencies are satisfied by any of the libraries
6395                       provided by <tt>libfoo2</tt>.  Since those binaries
6396                       were linked against the just-built shared library as
6397                       part of the build process, the <file>symbols</file>
6398                       file for the newly-built <tt>libfoo2</tt> must take
6399                       precedence over a <file>symbols</file> file for any
6400                       other <tt>libfoo2</tt> package already installed on
6401                       the system.
6402                     </footnote>
6403                   </p>
6404                 </item>
6405
6406                 <item>
6407                   <p>
6408                     <file>/etc/dpkg/symbols/<var>package</var>.symbols.<var>arch</var></file>
6409                     and <file>/etc/dpkg/symbols/<var>package</var>.symbols</file>
6410                   </p>
6411
6412                   <p>
6413                     Per-system overrides of shared library dependencies.
6414                     These files normally do not exist.  They are
6415                     maintained by the local system administrator and must
6416                     not be created by any Debian package.
6417                   </p>
6418                 </item>
6419
6420                 <item>
6421                   <p><file>symbols</file> control files for packages
6422                     installed on the system</p>
6423
6424                   <p>
6425                     The <file>symbols</file> control files for all the
6426                     packages currently installed on the system are
6427                     searched last.  This will be the most common source of
6428                     shared library dependency information.  These are
6429                     normally found
6430                     in <file>/var/lib/dpkg/info/*.symbols</file>, but
6431                     packages should not rely on this and instead should
6432                     use <tt>dpkg-query --control-path <var>package</var>
6433                     symbols</tt> if for some reason these files need to be
6434                     examined.
6435                   </p>
6436                 </item>
6437               </list>
6438             </p>
6439
6440             <p>
6441               Be aware that if a <file>debian/shlibs.local</file> exists
6442               in the source package, it will override
6443               any <file>symbols</file> files.  This is the only case where
6444               a <file>shlibs</file> is used despite <file>symbols</file>
6445               files being present.  See <ref id="shlibs-paths">
6446               and <ref id="sharedlibs-shlibdeps"> for more information.
6447             </p>
6448           </sect2>
6449
6450           <sect2 id="symbols">
6451             <heading>The <file>symbols</file> File Format</heading>
6452
6453             <p>
6454               The following documents the format of
6455               the <file>symbols</file> control file as included in binary
6456               packages.  These files are built from
6457               template <file>symbols</file> files in the source package
6458               by <prgn>dpkg-gensymbols</prgn>.  The template files support
6459               a richer syntax that allows <prgn>dpkg-gensymbols</prgn> to
6460               do some of the tedious work involved in
6461               maintaining <file>symbols</file> files, such as handling C++
6462               symbols or optional symbols that may not exist on particular
6463               architectures.  When writing <file>symbols</file> files for
6464               a shared library package, refer
6465               to <manref name="dpkg-gensymbols" section="1"> for the
6466               richer syntax.
6467             </p>
6468
6469             <p>
6470               A <file>symbols</file> may contain one or more entries, one
6471               for each shared library contained in the package
6472               corresponding to that <file>symbols</file>.  Each entry has
6473               the following format:
6474             </p>
6475
6476             <p>
6477               <example>
6478                 <var>library-soname</var> <var>main-dependency-template</var>
6479                 [| <var>alternative-dependency-template</var>]
6480                 [...]
6481                 [* <var>field-name</var>: <var>field-value</var>]
6482                 [...]
6483                 <var>symbol</var> <var>minimal-version</var>[ <var>id-of-dependency-template</var> ]
6484               </example>
6485             </p>
6486
6487             <p>
6488               To explain this format, we'll use the the <tt>zlib1g</tt>
6489               package as an example, which (at the time of writing)
6490               installs the shared
6491               library <file>/usr/lib/libz.so.1.2.3.4</file>.  Mandatory
6492               lines will be described first, followed by optional lines.
6493             </p>
6494
6495             <p>
6496               <var>library-soname</var> must contain exactly the value of
6497               the ELF <tt>SONAME</tt> attribute of the shared library.  In
6498               our example, this is <tt>libz.so.1</tt>.<footnote>
6499                 This can be determined by using the command
6500                 <example compact="compact">
6501                   readelf -d /usr/lib/libz.so.1.2.3.4 | grep SONAME
6502                 </example>
6503               </footnote>
6504             </p>
6505
6506             <p>
6507               <var>main-dependency-template</var> has the same syntax as a
6508               dependency field in a binary package control file, except
6509               that the string <tt>#MINVER#</tt> is replaced by a version
6510               restriction like <tt>(>= <var>version</var>)</tt> or by
6511               nothing if an unversioned dependency is deemed sufficient.
6512               The version restriction will be based on which symbols from
6513               the shared library are referenced and the version at which
6514               they were introduced (see below).  In nearly all
6515               cases, <var>main-dependency-template</var> will
6516               be <tt><var>package</var> #MINVER#</tt>,
6517               where <var>package</var> is the name of the binary package
6518               containing the shared library.  This adds a simple,
6519               possibly-versioned dependency on the shared library package.
6520               In some rare cases, such as when multiple packages provide
6521               the same shared library ABI, the dependency template may
6522               need to be more complex.
6523             </p>
6524
6525             <p>
6526               In our example, the first line of
6527               the <tt>zlib1g</tt> <file>symbols</file> file would be:
6528               <example compact="compact">
6529                 libz.so.1 zlib1g #MINVER#
6530               </example>
6531             </p>
6532
6533             <p>
6534               Each public symbol exported by the shared library must have
6535               a corresponding symbol line, indented by one
6536               space.  <var>symbol</var> is the exported symbol (which, for
6537               C++, means the mangled symbol) followed by <tt>@</tt> and
6538               the symbol version, or the string <tt>Base</tt> if there is
6539               no symbol version.  <var>minimal-version</var> is the most
6540               recent version of the shared library that changed the
6541               behavior of that symbol, whether by adding it, changing its
6542               function signature (the parameters, their types, or the
6543               return type), or changing its behavior in a way that is
6544               visible to a caller.
6545               <var>id-of-dependency-template</var> is an optional
6546               field that references
6547               an <var>alternative-dependency-template</var>; see below for
6548               a full description.
6549             </p>
6550
6551             <p>
6552               For example, <tt>libz.so.1</tt> contains the
6553               symbols <tt>compress</tt>
6554               and <tt>compressBound</tt>.  <tt>compress</tt> has no symbol
6555               version and last changed its behavior in upstream
6556               version <tt>1:1.1.4</tt>.  <tt>compressBound</tt> has the
6557               symbol version <tt>ZLIB_1.2.0</tt>, was introduced in
6558               upstream version <tt>1:1.2.0</tt>, and has not changed its
6559               behavior.  Its <file>symbols</file> file therefore contains
6560               the lines:
6561               <example compact="compact">
6562                 compress@Base 1:1.1.4
6563                 compressBound@ZLIB_1.2.0 1:1.2.0
6564               </example>
6565               Packages using only <tt>compress</tt> would then get a
6566               dependency on <tt>zlib1g (>= 1:1.1.4)</tt>, but packages
6567               using <tt>compressBound</tt> would get a dependency
6568               on <tt>zlib1g (>= 1:1.2.0)</tt>.
6569             </p>
6570
6571             <p>
6572               One or more <var>alternative-dependency-template</var> lines
6573               may be provided.  These are used in cases where some symbols
6574               in the shared library should use one dependency template
6575               while others should use a different template.  The
6576               alternative dependency templates are used only if a symbol
6577               line contains the <var>id-of-dependency-template</var>
6578               field.  The first alternative dependency template is
6579               numbered 1, the second 2, and so forth.<footnote>
6580                 An example of where this may be needed is with a library
6581                 that implements the libGL interface.  All GL
6582                 implementations provide the same set of base interfaces,
6583                 and then may provide some additional interfaces only used
6584                 by programs that require that specific GL implementation.
6585                 So, for example, libgl1-mesa-glx may use the
6586                 following <file>symbols</file> file:
6587                 <example>
6588                   libGL.so.1 libgl1
6589                   | libgl1-mesa-glx #MINVER#
6590                   publicGlSymbol@Base 6.3-1
6591                   [...]
6592                   implementationSpecificSymbol@Base 6.5.2-7 1
6593                   [...]
6594                 </example>
6595                 Binaries or shared libraries using
6596                 only <tt>publicGlSymbol</tt> would depend only
6597                 on <tt>libgl1</tt> (which may be provided by multiple
6598                 packages), but ones
6599                 using <tt>implementationSpecificSymbol</tt> would get a
6600                 dependency on <tt>libgl1-mesa-glx (>= 6.5.2-7)</tt>
6601               </footnote>
6602             </p>
6603
6604             <p>
6605               Finally, the entry for the library may contain one or more
6606               metadata fields.  Currently, the only
6607               supported <var>field-name</var>
6608               is <tt>Build-Depends-Package</tt>, whose value lists
6609               the <qref id="sharedlibs-dev">library development
6610               package</qref> on which packages using this shared library
6611               declare a build dependency.  If this field is
6612               present, <prgn>dpkg-shlibdeps</prgn> uses it to ensure that
6613               the resulting binary package dependency on the shared
6614               library is at least as strict as the source package
6615               dependency on the shared library development
6616               package.<footnote>
6617                 This field should normally not be necessary, since if the
6618                 behavior of any symbol has changed, the corresponding
6619                 symbol <var>minimal-version</var> should have been
6620                 increased.  But including it makes the <tt>symbols</tt>
6621                 system more robust by tightening the dependency in cases
6622                 where the package using the shared library specifically
6623                 requires at least a particular version of the shared
6624                 library development package for some reason.
6625               </footnote>
6626               For our example, the <tt>zlib1g</tt> <file>symbols</file>
6627               file would contain:
6628               <example compact="compact">
6629                 * Build-Depends-Package: zlib1g-dev
6630               </example>
6631             </p>
6632
6633             <p>
6634               Also see <manref name="deb-symbols" section="5">.
6635             </p>
6636           </sect2>
6637
6638           <sect2 id="providing-symbols">
6639             <heading>Providing a <file>symbols</file> file</heading>
6640
6641             <p>
6642               If your package provides a shared library, you should
6643               arrange to include a <file>symbols</file> control file
6644               following the format described above in that package.  You
6645               must include either a <file>symbols</file> control file or
6646               a <file>shlibs</file> control file.
6647             </p>
6648
6649             <p>
6650               Normally, this is done by creating a <file>symbols</file> in
6651               the source package
6652               named <file>debian/<var>package</var>.symbols</file>
6653               or <file>debian/symbols</file>, possibly
6654               with <file>.<var>arch</var></file> appended if the symbols
6655               information varies by architecture.  This file may use the
6656               extended syntax documented in <manref name="dpkg-gensymbols"
6657               section="1">.  Then, call <prgn>dpkg-gensymbols</prgn> as
6658               part of the package build process.  It will
6659               create <file>symbols</file> files in the package staging
6660               area based on the binaries and libraries in the package
6661               staging area and the <file>symbols</file> files in the
6662               source package.<footnote>
6663                 If you are
6664                 using <tt>debhelper</tt>, <prgn>dh_makeshlibs</prgn> will
6665                 take care of calling either <prgn>dpkg-gensymbols</prgn>
6666                 or generating a <file>shlibs</file> file as appropriate.
6667               </footnote>
6668             </p>
6669
6670             <p>
6671               Packages that provide <file>symbols</file> files must keep
6672               them up-to-date to ensure correct dependencies in packages
6673               that use the shared libraries.  This means updating
6674               the <file>symbols</file> file whenever a new public symbol
6675               is added, changing the <var>minimal-version</var> field
6676               whenever a symbol changes behavior or signature in a
6677               backward-compatible way (see <ref id="sharedlibs-updates">),
6678               and changing the <var>library-soname</var>
6679               and <var>main-dependency-template</var>, and probably all of
6680               the <var>minimal-version</var> fields, when the library
6681               changes <tt>SONAME</tt>.  Removing a public symbol from
6682               the <file>symbols</file> file because it's no longer
6683               provided by the library normally requires changing
6684               the <tt>SONAME</tt> of the library.
6685               See <ref id="sharedlibs-runtime"> for more information
6686               on <tt>SONAME</tt>s.
6687             </p>
6688           </sect2>
6689         </sect1>
6690
6691         <sect1 id="sharedlibs-shlibdeps">
6692           <heading>The <tt>shlibs</tt> system</heading>
6693
6694           <p>
6695             The <tt>shlibs</tt> system is a simpler alternative to
6696             the <tt>symbols</tt> system for declaring dependencies for
6697             shared libraries.  It may be more appropriate for C++
6698             libraries and other cases where tracking individual symbols is
6699             too difficult.  It predated the <tt>symbols</tt> system and is
6700             therefore frequently seen in older packages.  It is also
6701             required for udebs, which do not support <tt>symbols</tt>.
6702           </p>
6703
6704           <p>
6705             In the following sections, we will first describe where the
6706             various <file>shlibs</file> files are to be found, then how to
6707             use <prgn>dpkg-shlibdeps</prgn>, and finally
6708             the <file>shlibs</file> file format and how to create them.
6709           </p>
6710
6711           <sect2 id="shlibs-paths">
6712             <heading>The <file>shlibs</file> files present on the
6713               system</heading>
6714
6715             <p>
6716               There are several places where <tt>shlibs</tt> files are
6717               found.  The following list gives them in the order in which
6718               they are read by <prgn>dpkg-shlibdeps</prgn>.  (The first
6719               one which gives the required information is used.)
6720               <list>
6721                 <item>
6722                   <p><file>debian/shlibs.local</file></p>
6723
6724                   <p>
6725                     This lists overrides for this package.  This file
6726                     should normally not be used, but may be needed
6727                     temporarily in unusual situations to work around bugs
6728                     in other packages, or in unusual cases where the
6729                     normally declared dependency information in the
6730                     installed <file>shlibs</file> file for a library
6731                     cannot be used.  This file overrides information
6732                     obtained from any other source.
6733                   </p>
6734                 </item>
6735
6736                 <item>
6737                   <p><file>/etc/dpkg/shlibs.override</file></p>
6738
6739                   <p>
6740                     This lists global overrides.  This list is normally
6741                     empty.  It is maintained by the local system
6742                     administrator.
6743                   </p>
6744                 </item>
6745
6746                 <item>
6747                   <p><file>DEBIAN/shlibs</file> files in the "build
6748                     directory"</p>
6749
6750                   <p>
6751                     These files are generated as part of the package build
6752                     process and staged for inclusion as control files in
6753                     the binary packages being built.  They provide details
6754                     of any shared libraries included in the same package.
6755                   </p>
6756                 </item>
6757
6758                 <item>
6759                   <p><file>shlibs</file> control files for packages
6760                     installed on the system</p>
6761
6762                   <p>
6763                     The <file>shlibs</file> control files for all the
6764                     packages currently installed on the system.  These are
6765                     normally found
6766                     in <file>/var/lib/dpkg/info/*.shlibs</file>, but
6767                     packages should not rely on this and instead should
6768                     use <tt>dpkg-query --control-path <var>package</var>
6769                     shlibs</tt> if for some reason these files need to be
6770                     examined.
6771                   </p>
6772                 </item>
6773
6774                 <item>
6775                   <p><file>/etc/dpkg/shlibs.default</file></p>
6776
6777                   <p>
6778                     This file lists any shared libraries whose packages
6779                     have failed to provide correct <file>shlibs</file>
6780                     files.  It was used when the <file>shlibs</file> setup
6781                     was first introduced, but it is now normally empty.
6782                     It is maintained by the <tt>dpkg</tt> maintainer.
6783                   </p>
6784                 </item>
6785               </list>
6786             </p>
6787
6788             <p>
6789               If a <file>symbols</file> file for a shared library package
6790               is available, <prgn>dpkg-shlibdeps</prgn> will always use it
6791               in preference to a <file>shlibs</file>, with the exception
6792               of <file>debian/shlibs.local</file>.  The latter overrides
6793               any other <file>shlibs</file> or <file>symbols</file> files.
6794             </p>
6795           </sect2>
6796
6797           <sect2 id="shlibs">
6798             <heading>The <file>shlibs</file> File Format</heading>
6799
6800             <p>
6801               Each <file>shlibs</file> file has the same format.  Lines
6802               beginning with <tt>#</tt> are considered to be comments and
6803               are ignored.  Each line is of the form:
6804               <example compact="compact">
6805                 [<var>type</var>: ]<var>library-name</var> <var>soname-version</var> <var>dependencies ...</var>
6806               </example>
6807             </p>
6808
6809             <p>
6810               We will explain this by reference to the example of the
6811               <tt>zlib1g</tt> package, which (at the time of writing)
6812               installs the shared
6813               library <file>/usr/lib/libz.so.1.2.3.4</file>.
6814             </p>
6815
6816             <p>
6817               <var>type</var> is an optional element that indicates the
6818               type of package for which the line is valid. The only type
6819               currently in use is <tt>udeb</tt>.  The colon and space
6820               after the type are required.
6821             </p>
6822
6823             <p>
6824               <var>library-name</var> is the name of the shared library,
6825               in this case <tt>libz</tt>.  (This must match the name part
6826               of the soname, see below.)
6827             </p>
6828
6829             <p>
6830               <var>soname-version</var> is the version part of the
6831               ELF <tt>SONAME</tt> attribute of the library, determined the
6832               same way that the <var>soversion</var> component of the
6833               recommended shared library package name is determined.
6834               See <ref id="sharedlibs-runtime"> for the details.
6835             </p>
6836
6837             <p>
6838               <var>dependencies</var> has the same syntax as a dependency
6839               field in a binary package control file.  It should give
6840               details of which packages are required to satisfy a binary
6841               built against the version of the library contained in the
6842               package.  See <ref id="depsyntax"> for details on the
6843               syntax, and <ref id="sharedlibs-updates"> for details on how
6844               to maintain the dependency version constraint.
6845             </p>
6846
6847             <p>
6848               In our example, if the last change to the <tt>zlib1g</tt>
6849               package that could change behavior for a client of that
6850               library was in version <tt>1:1.2.3.3.dfsg-1</tt>, then
6851               the <tt>shlibs</tt> entry for this library could say:
6852               <example compact="compact">
6853                 libz 1 zlib1g (>= 1:1.2.3.3.dfsg)
6854               </example>
6855               This version restriction must be new enough that any binary
6856               built against the current version of the library will work
6857               with any version of the shared library that satisfies that
6858               dependency.
6859             </p>
6860
6861             <p>
6862               As zlib1g also provides a udeb containing the shared
6863               library, there would also be a second line:
6864               <example compact="compact">
6865                 udeb: libz 1 zlib1g-udeb (>= 1:1.2.3.3.dfsg)
6866               </example>
6867             </p>
6868           </sect2>
6869
6870           <sect2>
6871             <heading>Providing a <file>shlibs</file> file</heading>
6872
6873             <p>
6874               To provide a <file>shlibs</file> file for a shared library
6875               binary package, create a <file>shlibs</file> file following
6876               the format described above and place it in
6877               the <file>DEBIAN</file> directory for that package during
6878               the build.  It will then be included as a control file for
6879               that package<footnote>
6880                 This is what <prgn>dh_makeshlibs</prgn> in
6881                 the <package>debhelper</package> suite does. If your
6882                 package also has a udeb that provides a shared
6883                 library, <prgn>dh_makeshlibs</prgn> can automatically
6884                 generate the <tt>udeb:</tt> lines if you specify the name
6885                 of the udeb with the <tt>--add-udeb</tt> option.
6886               </footnote>.
6887             </p>
6888
6889             <p>
6890               Since <prgn>dpkg-shlibdeps</prgn> reads
6891               the <file>DEBIAN/shlibs</file> files in all of the binary
6892               packages being built from this source package, all of
6893               the <file>DEBIAN/shlibs</file> files should be installed
6894               before <prgn>dpkg-shlibdeps</prgn> is called on any of the
6895               binary packages.
6896             </p>
6897           </sect2>
6898         </sect1>
6899       </sect>
6900     </chapt>
6901
6902
6903     <chapt id="opersys"><heading>The Operating System</heading>
6904
6905       <sect>
6906         <heading>File system hierarchy</heading>
6907
6908
6909         <sect1 id="fhs">
6910           <heading>File System Structure</heading>
6911
6912           <p>
6913             The location of all files and directories must comply with the
6914             Filesystem Hierarchy Standard (FHS), version 2.3, with the
6915             exceptions noted below, and except where doing so would
6916             violate other terms of Debian Policy.  The following
6917             exceptions to the FHS apply:
6918
6919             <enumlist>
6920               <item>
6921                 <p>
6922                 The FHS requirement that architecture-independent
6923                 application-specific static files be located in
6924                 <file>/usr/share</file> is relaxed to a suggestion.
6925
6926                 In particular, a subdirectory of <file>/usr/lib</file> may
6927                 be used by a package (or a collection of packages) to hold a
6928                 mixture of architecture-independent and
6929                 architecture-dependent files. However, when a directory is
6930                 entirely composed of architecture-independent files, it
6931                 should be located in <file>/usr/share</file>.
6932                 </p>
6933               </item>
6934               <item>
6935                 <p>
6936                   The optional rules related to user specific
6937                   configuration files for applications are stored in
6938                   the user's home directory are relaxed.  It is
6939                   recommended that such files start with the
6940                   '<tt>.</tt>' character (a "dot file"), and if an
6941                   application needs to create more than one dot file
6942                   then the preferred placement is in a subdirectory
6943                   with a name starting with a '.' character, (a "dot
6944                   directory"). In this case it is recommended the
6945                   configuration files not start with the '.'
6946                   character.
6947                 </p>
6948               </item>
6949               <item>
6950                 <p>
6951                   The requirement for amd64 to use <file>/lib64</file>
6952                   for 64 bit binaries is removed.
6953                 </p>
6954               </item>
6955               <item>
6956                 <p>
6957                   The requirement for object files, internal binaries, and
6958                   libraries, including <file>libc.so.*</file>, to be located
6959                   directly under <file>/lib{,32}</file> and
6960                   <file>/usr/lib{,32}</file> is amended, permitting files
6961                   to instead be installed to
6962                   <file>/lib/<var>triplet</var></file> and
6963                   <file>/usr/lib/<var>triplet</var></file>, where
6964                   <tt><var>triplet</var></tt> is the value returned by
6965                   <tt>dpkg-architecture -qDEB_HOST_MULTIARCH</tt> for the
6966                   architecture of the package.  Packages may <em>not</em>
6967                   install files to any <var>triplet</var> path other
6968                   than the one matching the architecture of that package;
6969                   for instance, an <tt>Architecture: amd64</tt> package
6970                   containing 32-bit x86 libraries may not install these
6971                   libraries to <file>/usr/lib/i386-linux-gnu</file>.
6972                   <footnote>
6973                     This is necessary in order to reserve the directories for
6974                     use in cross-installation of library packages from other
6975                     architectures, as part of the planned deployment of
6976                     <tt>multiarch</tt>.
6977                   </footnote>
6978                 </p>
6979                 <p>
6980                   Applications may also use a single subdirectory under
6981                   <file>/usr/lib/<var>triplet</var></file>.
6982                 </p>
6983                 <p>
6984                   The execution time linker/loader, ld*, must still be made
6985                   available in the existing location under /lib or /lib64
6986                   since this is part of the ELF ABI for the architecture.
6987                 </p>
6988               </item>
6989               <item>
6990                 <p>
6991                   The requirement that
6992                   <file>/usr/local/share/man</file> be "synonymous"
6993                   with <file>/usr/local/man</file> is relaxed to a
6994                   recommendation</p>
6995               </item>
6996               <item>
6997                 <p>
6998                   The requirement that windowmanagers with a single
6999                   configuration file call it <file>system.*wmrc</file>
7000                   is removed, as is the restriction that the window
7001                   manager subdirectory be named identically to the
7002                   window manager name itself.
7003                 </p>
7004               </item>
7005               <item>
7006                 <p>
7007                   The requirement that boot manager configuration
7008                   files live in <file>/etc</file>, or at least are
7009                   symlinked there, is relaxed to a recommendation.
7010                 </p>
7011               </item>
7012               <item>
7013                 <p>
7014                   The additional directory <file>/run</file> in the root
7015                   file system is allowed.  <file>/run</file>
7016                   replaces <file>/var/run</file>, and the
7017                   subdirectory <file>/run/lock</file>
7018                   replaces <file>/var/lock</file>, with
7019                   the <file>/var</file> directories replaced by symlinks
7020                   for backwards compatibility.  <file>/run</file>
7021                   and <file>/run/lock</file> must follow all of the
7022                   requirements in the FHS for <file>/var/run</file>
7023                   and <file>/var/lock</file>, respectively, such as file
7024                   naming conventions, file format requirements, or the
7025                   requirement that files be cleared during the boot
7026                   process.  Files and directories residing
7027                   in <file>/run</file> should be stored on a temporary
7028                   file system.
7029                 </p>
7030                 <p>
7031                   Packages must not assume the <file>/run</file>
7032                   directory exists or is usable without a dependency
7033                   on <tt>initscripts (>= 2.88dsf-13.3)</tt> until the
7034                   stable release of Debian supports <file>/run</file>.
7035                 </p>
7036               </item>
7037               <item>
7038                 <p>
7039                   The <file>/sys</file> directory in the root filesystem is
7040                   additionally allowed. <footnote>This directory is used as
7041                     mount point to mount virtual filesystems to get access to
7042                     kernel information.</footnote>
7043                 </p>
7044               </item>
7045               <item>
7046                 <p>
7047                   On GNU/Hurd systems, the following additional
7048                   directories are allowed in the root
7049                   filesystem: <file>/hurd</file>
7050                   and <file>/servers</file>.<footnote>
7051                     These directories are used to store translators and as
7052                     a set of standard names for mount points,
7053                     respectively.
7054                   </footnote>
7055                 </p>
7056               </item>
7057             </enumlist>
7058           </p>
7059
7060           <p>
7061             The version of this document referred here can be
7062             found in the <tt>debian-policy</tt> package or on <url
7063             id="http://www.debian.org/doc/packaging-manuals/fhs/"
7064               name="FHS (Debian copy)"> alongside this manual (or, if
7065             you have the <package>debian-policy</package> installed,
7066             you can try <url
7067               id="file:///usr/share/doc/debian-policy/fhs/" name="FHS
7068               (local copy)">). The
7069             latest version, which may be a more recent version, may
7070             be found on
7071             <url id="http://www.pathname.com/fhs/" name="FHS (upstream)">.
7072             Specific questions about following the standard may be
7073             asked on the <tt>debian-devel</tt> mailing list, or
7074             referred to the FHS mailing list (see the
7075             <url id="http://www.pathname.com/fhs/" name="FHS web site"> for
7076             more information).
7077           </p>
7078         </sect1>
7079
7080         <sect1>
7081           <heading>Site-specific programs</heading>
7082
7083           <p>
7084             As mandated by the FHS, packages must not place any
7085             files in <file>/usr/local</file>, either by putting them in
7086             the file system archive to be unpacked by <prgn>dpkg</prgn>
7087             or by manipulating them in their maintainer scripts.
7088           </p>
7089
7090           <p>
7091             However, the package may create empty directories below
7092             <file>/usr/local</file> so that the system administrator knows
7093             where to place site-specific files.  These are not
7094             directories <em>in</em> <file>/usr/local</file>, but are
7095             children of directories in <file>/usr/local</file>.  These
7096             directories (<file>/usr/local/*/dir/</file>)
7097             should be removed on package removal if they are
7098             empty.
7099           </p>
7100
7101           <p>
7102             Note that this applies only to
7103             directories <em>below</em> <file>/usr/local</file>,
7104             not <em>in</em> <file>/usr/local</file>.  Packages must
7105             not create sub-directories in the
7106             directory <file>/usr/local</file> itself, except those
7107             listed in FHS, section 4.5.  However, you may create
7108             directories below them as you wish. You must not remove
7109             any of the directories listed in 4.5, even if you created
7110             them.
7111           </p>
7112
7113           <p>
7114             Since <file>/usr/local</file> can be mounted read-only from a
7115             remote server, these directories must be created and
7116             removed by the <prgn>postinst</prgn> and <prgn>prerm</prgn>
7117             maintainer scripts and not be included in the
7118             <file>.deb</file> archive.  These scripts must not fail if
7119             either of these operations fail.
7120           </p>
7121
7122           <p>
7123             For example, the <tt>emacsen-common</tt> package could
7124             contain something like
7125             <example compact="compact">
7126 if [ ! -e /usr/local/share/emacs ]; then
7127   if mkdir /usr/local/share/emacs 2>/dev/null; then
7128     if chown root:staff /usr/local/share/emacs; then
7129       chmod 2775 /usr/local/share/emacs || true
7130     fi
7131   fi
7132 fi
7133             </example>
7134             in its <prgn>postinst</prgn> script, and
7135             <example compact="compact">
7136 rmdir /usr/local/share/emacs/site-lisp 2>/dev/null || true
7137 rmdir /usr/local/share/emacs 2>/dev/null || true
7138             </example>
7139             in the <prgn>prerm</prgn> script.  (Note that this form is
7140             used to ensure that if the script is interrupted, the
7141             directory <file>/usr/local/share/emacs</file> will still be
7142             removed.)
7143           </p>
7144
7145           <p>
7146             If you do create a directory in <file>/usr/local</file> for
7147             local additions to a package, you should ensure that
7148             settings in <file>/usr/local</file> take precedence over the
7149             equivalents in <file>/usr</file>.
7150           </p>
7151
7152           <p>
7153             However, because <file>/usr/local</file> and its contents are
7154             for exclusive use of the local administrator, a package
7155             must not rely on the presence or absence of files or
7156             directories in <file>/usr/local</file> for normal operation.
7157           </p>
7158
7159           <p>
7160             The <file>/usr/local</file> directory itself and all the
7161             subdirectories created by the package should (by default) have
7162             permissions 2775 (group-writable and set-group-id) and be
7163             owned by <tt>root:staff</tt>.
7164           </p>
7165         </sect1>
7166
7167         <sect1>
7168           <heading>The system-wide mail directory</heading>
7169           <p>
7170             The system-wide mail directory
7171             is <file>/var/mail</file>. This directory is part of the
7172             base system and should not be owned by any particular mail
7173             agents.  The use of the old
7174             location <file>/var/spool/mail</file> is deprecated, even
7175             though the spool may still be physically located there.
7176           </p>
7177         </sect1>
7178
7179         <sect1 id="fhs-run">
7180           <heading><file>/run</file> and <file>/run/lock</file></heading>
7181
7182           <p>
7183             The directory <file>/run</file> is cleared at boot, normally
7184             by being a mount point for a temporary file system.  Packages
7185             therefore must not assume that any files or directories
7186             under <file>/run</file> other than <file>/run/lock</file>
7187             exist unless the package has arranged to create those files or
7188             directories since the last reboot.  Normally, this is done by
7189             the package via an init script.  See <ref id="writing-init">
7190             for more information.
7191           </p>
7192
7193           <p>
7194             Packages must not include files or directories
7195             under <file>/run</file>, or under the
7196             older <file>/var/run</file> and <file>/var/lock</file> paths.
7197             The latter paths will normally be symlinks or other
7198             redirections to <file>/run</file> for backwards compatibility.
7199           </p>
7200         </sect1>
7201       </sect>
7202
7203       <sect>
7204         <heading>Users and groups</heading>
7205
7206         <sect1>
7207           <heading>Introduction</heading>
7208           <p>
7209             The Debian system can be configured to use either plain or
7210             shadow passwords.
7211           </p>
7212
7213           <p>
7214             Some user ids (UIDs) and group ids (GIDs) are reserved
7215             globally for use by certain packages.  Because some
7216             packages need to include files which are owned by these
7217             users or groups, or need the ids compiled into binaries,
7218             these ids must be used on any Debian system only for the
7219             purpose for which they are allocated. This is a serious
7220             restriction, and we should avoid getting in the way of
7221             local administration policies. In particular, many sites
7222             allocate users and/or local system groups starting at 100.
7223           </p>
7224
7225           <p>
7226             Apart from this we should have dynamically allocated ids,
7227             which should by default be arranged in some sensible
7228             order, but the behavior should be configurable.
7229           </p>
7230
7231           <p>
7232             Packages other than <tt>base-passwd</tt> must not modify
7233             <file>/etc/passwd</file>, <file>/etc/shadow</file>,
7234             <file>/etc/group</file> or <file>/etc/gshadow</file>.
7235           </p>
7236         </sect1>
7237
7238         <sect1>
7239           <heading>UID and GID classes</heading>
7240           <p>
7241             The UID and GID numbers are divided into classes as
7242             follows:
7243             <taglist>
7244               <tag>0-99:</tag>
7245               <item>
7246                 <p>
7247                   Globally allocated by the Debian project, the same
7248                   on every Debian system.  These ids will appear in
7249                   the <file>passwd</file> and <file>group</file> files of all
7250                   Debian systems, new ids in this range being added
7251                   automatically as the <tt>base-passwd</tt> package is
7252                   updated.
7253                 </p>
7254
7255                 <p>
7256                   Packages which need a single statically allocated
7257                   uid or gid should use one of these; their
7258                   maintainers should ask the <tt>base-passwd</tt>
7259                   maintainer for ids.
7260                 </p>
7261               </item>
7262
7263               <tag>100-999:</tag>
7264               <item>
7265                 <p>
7266                   Dynamically allocated system users and groups.
7267                   Packages which need a user or group, but can have
7268                   this user or group allocated dynamically and
7269                   differently on each system, should use <tt>adduser
7270                   --system</tt> to create the group and/or user.
7271                   <prgn>adduser</prgn> will check for the existence of
7272                   the user or group, and if necessary choose an unused
7273                   id based on the ranges specified in
7274                   <file>adduser.conf</file>.
7275                 </p>
7276               </item>
7277
7278               <tag>1000-59999:</tag>
7279               <item>
7280                 <p>
7281                   Dynamically allocated user accounts.  By default
7282                   <prgn>adduser</prgn> will choose UIDs and GIDs for
7283                   user accounts in this range, though
7284                   <file>adduser.conf</file> may be used to modify this
7285                   behavior.
7286                 </p>
7287               </item>
7288
7289               <tag>60000-64999:</tag>
7290               <item>
7291                 <p>
7292                   Globally allocated by the Debian project, but only
7293                   created on demand. The ids are allocated centrally
7294                   and statically, but the actual accounts are only
7295                   created on users' systems on demand.
7296                 </p>
7297
7298                 <p>
7299                   These ids are for packages which are obscure or
7300                   which require many statically-allocated ids.  These
7301                   packages should check for and create the accounts in
7302                   <file>/etc/passwd</file> or <file>/etc/group</file> (using
7303                   <prgn>adduser</prgn> if it has this facility) if
7304                   necessary.  Packages which are likely to require
7305                   further allocations should have a "hole" left after
7306                   them in the allocation, to give them room to
7307                   grow.
7308                 </p>
7309               </item>
7310
7311               <tag>65000-65533:</tag>
7312               <item>
7313                 <p>Reserved.</p>
7314               </item>
7315
7316               <tag>65534:</tag>
7317               <item>
7318                 <p>
7319                   User <tt>nobody</tt>. The corresponding gid refers
7320                   to the group <tt>nogroup</tt>.
7321                 </p>
7322               </item>
7323
7324               <tag>65535:</tag>
7325               <item>
7326                 <p>
7327                   <tt>(uid_t)(-1) == (gid_t)(-1)</tt> <em>must
7328                   not</em> be used, because it is the error return
7329                   sentinel value.
7330                 </p>
7331               </item>
7332             </taglist>
7333           </p>
7334         </sect1>
7335       </sect>
7336
7337       <sect id="sysvinit">
7338         <heading>System run levels and <file>init.d</file> scripts</heading>
7339
7340         <sect1 id="/etc/init.d">
7341           <heading>Introduction</heading>
7342
7343           <p>
7344             The <file>/etc/init.d</file> directory contains the scripts
7345             executed by <prgn>init</prgn> at boot time and when the
7346             init state (or "runlevel") is changed (see <manref
7347             name="init" section="8">).
7348           </p>
7349
7350           <p>
7351             There are at least two different, yet functionally
7352             equivalent, ways of handling these scripts.  For the sake
7353             of simplicity, this document describes only the symbolic
7354             link method. However, it must not be assumed by maintainer
7355             scripts that this method is being used, and any automated
7356             manipulation of the various runlevel behaviors by
7357             maintainer scripts must be performed using
7358             <prgn>update-rc.d</prgn> as described below and not by
7359             manually installing or removing symlinks.  For information
7360             on the implementation details of the other method,
7361             implemented in the <tt>file-rc</tt> package, please refer
7362             to the documentation of that package.
7363           </p>
7364
7365           <p>
7366             These scripts are referenced by symbolic links in the
7367             <file>/etc/rc<var>n</var>.d</file> directories.  When changing
7368             runlevels, <prgn>init</prgn> looks in the directory
7369             <file>/etc/rc<var>n</var>.d</file> for the scripts it should
7370             execute, where <tt><var>n</var></tt> is the runlevel that
7371             is being changed to, or <tt>S</tt> for the boot-up
7372             scripts.
7373           </p>
7374
7375           <p>
7376             The names of the links all have the form
7377             <file>S<var>mm</var><var>script</var></file> or
7378             <file>K<var>mm</var><var>script</var></file> where
7379             <var>mm</var> is a two-digit number and <var>script</var>
7380             is the name of the script (this should be the same as the
7381             name of the actual script in <file>/etc/init.d</file>).
7382           </p>
7383
7384           <p>
7385             When <prgn>init</prgn> changes runlevel first the targets
7386             of the links whose names start with a <tt>K</tt> are
7387             executed, each with the single argument <tt>stop</tt>,
7388             followed by the scripts prefixed with an <tt>S</tt>, each
7389             with the single argument <tt>start</tt>.  (The links are
7390             those in the <file>/etc/rc<var>n</var>.d</file> directory
7391             corresponding to the new runlevel.)  The <tt>K</tt> links
7392             are responsible for killing services and the <tt>S</tt>
7393             link for starting services upon entering the runlevel.
7394           </p>
7395
7396           <p>
7397             For example, if we are changing from runlevel 2 to
7398             runlevel 3, init will first execute all of the <tt>K</tt>
7399             prefixed scripts it finds in <file>/etc/rc3.d</file>, and then
7400             all of the <tt>S</tt> prefixed scripts in that directory.
7401             The links starting with <tt>K</tt> will cause the
7402             referred-to file to be executed with an argument of
7403             <tt>stop</tt>, and the <tt>S</tt> links with an argument
7404             of <tt>start</tt>.
7405           </p>
7406
7407           <p>
7408             The two-digit number <var>mm</var> is used to determine
7409             the order in which to run the scripts: low-numbered links
7410             have their scripts run first.  For example, the
7411             <tt>K20</tt> scripts will be executed before the
7412             <tt>K30</tt> scripts.  This is used when a certain service
7413             must be started before another.  For example, the name
7414             server <prgn>bind</prgn> might need to be started before
7415             the news server <prgn>inn</prgn> so that <prgn>inn</prgn>
7416             can set up its access lists.  In this case, the script
7417             that starts <prgn>bind</prgn> would have a lower number
7418             than the script that starts <prgn>inn</prgn> so that it
7419             runs first:
7420             <example compact="compact">
7421 /etc/rc2.d/S17bind
7422 /etc/rc2.d/S70inn
7423             </example>
7424           </p>
7425
7426           <p>
7427             The two runlevels 0 (halt) and 6 (reboot) are slightly
7428             different.  In these runlevels, the links with an
7429             <tt>S</tt> prefix are still called after those with a
7430             <tt>K</tt> prefix, but they too are called with the single
7431             argument <tt>stop</tt>.
7432           </p>
7433         </sect1>
7434
7435         <sect1 id="writing-init">
7436           <heading>Writing the scripts</heading>
7437
7438           <p>
7439             Packages that include daemons for system services should
7440             place scripts in <file>/etc/init.d</file> to start or stop
7441             services at boot time or during a change of runlevel.
7442             These scripts should be named
7443             <file>/etc/init.d/<var>package</var></file>, and they should
7444             accept one argument, saying what to do:
7445
7446             <taglist>
7447               <tag><tt>start</tt></tag>
7448               <item>start the service,</item>
7449
7450               <tag><tt>stop</tt></tag>
7451               <item>stop the service,</item>
7452
7453               <tag><tt>restart</tt></tag>
7454               <item>stop and restart the service if it's already running,
7455                   otherwise start the service</item>
7456
7457               <tag><tt>reload</tt></tag>
7458               <item><p>cause the configuration of the service to be
7459                   reloaded without actually stopping and restarting
7460                   the service,</item>
7461
7462               <tag><tt>force-reload</tt></tag>
7463               <item>cause the configuration to be reloaded if the
7464                   service supports this, otherwise restart the
7465                   service.</item>
7466             </taglist>
7467
7468             The <tt>start</tt>, <tt>stop</tt>, <tt>restart</tt>, and
7469             <tt>force-reload</tt> options should be supported by all
7470             scripts in <file>/etc/init.d</file>, the <tt>reload</tt>
7471             option is optional.
7472           </p>
7473
7474           <p>
7475             The <file>init.d</file> scripts must ensure that they will
7476             behave sensibly (i.e., returning success and not starting
7477             multiple copies of a service) if invoked with <tt>start</tt>
7478             when the service is already running, or with <tt>stop</tt>
7479             when it isn't, and that they don't kill unfortunately-named
7480             user processes.  The best way to achieve this is usually to
7481             use <prgn>start-stop-daemon</prgn> with the <tt>--oknodo</tt>
7482             option.
7483           </p>
7484
7485           <p>
7486             Be careful of using <tt>set -e</tt> in <file>init.d</file>
7487             scripts.  Writing correct <file>init.d</file> scripts requires
7488             accepting various error exit statuses when daemons are already
7489             running or already stopped without aborting
7490             the <file>init.d</file> script, and common <file>init.d</file>
7491             function libraries are not safe to call with <tt>set -e</tt>
7492             in effect<footnote>
7493               <tt>/lib/lsb/init-functions</tt>, which assists in writing
7494               LSB-compliant init scripts, may fail if <tt>set -e</tt> is
7495               in effect and echoing status messages to the console fails,
7496               for example.
7497             </footnote>.  For <tt>init.d</tt> scripts, it's often easier
7498             to not use <tt>set -e</tt> and instead check the result of
7499             each command separately.
7500           </p>
7501
7502           <p>
7503             If a service reloads its configuration automatically (as
7504             in the case of <prgn>cron</prgn>, for example), the
7505             <tt>reload</tt> option of the <file>init.d</file> script
7506             should behave as if the configuration has been reloaded
7507             successfully.
7508           </p>
7509
7510           <p>
7511             The <file>/etc/init.d</file> scripts must be treated as
7512             configuration files, either (if they are present in the
7513             package, that is, in the .deb file) by marking them as
7514             <tt>conffile</tt>s, or, (if they do not exist in the .deb)
7515             by managing them correctly in the maintainer scripts (see
7516             <ref id="config-files">).  This is important since we want
7517             to give the local system administrator the chance to adapt
7518             the scripts to the local system, e.g., to disable a
7519             service without de-installing the package, or to specify
7520             some special command line options when starting a service,
7521             while making sure their changes aren't lost during the next
7522             package upgrade.
7523           </p>
7524
7525           <p>
7526             These scripts should not fail obscurely when the
7527             configuration files remain but the package has been
7528             removed, as configuration files remain on the system after
7529             the package has been removed.  Only when <prgn>dpkg</prgn>
7530             is executed with the <tt>--purge</tt> option will
7531             configuration files be removed.  In particular, as the
7532             <file>/etc/init.d/<var>package</var></file> script itself is
7533             usually a <tt>conffile</tt>, it will remain on the system
7534             if the package is removed but not purged.  Therefore, you
7535             should include a <tt>test</tt> statement at the top of the
7536             script, like this:
7537             <example compact="compact">
7538 test -f <var>program-executed-later-in-script</var> || exit 0
7539             </example>
7540           </p>
7541
7542           <p>
7543             Often there are some variables in the <file>init.d</file>
7544             scripts whose values control the behavior of the scripts,
7545             and which a system administrator is likely to want to
7546             change.  As the scripts themselves are frequently
7547             <tt>conffile</tt>s, modifying them requires that the
7548             administrator merge in their changes each time the package
7549             is upgraded and the <tt>conffile</tt> changes.  To ease
7550             the burden on the system administrator, such configurable
7551             values should not be placed directly in the script.
7552             Instead, they should be placed in a file in
7553             <file>/etc/default</file>, which typically will have the same
7554             base name as the <file>init.d</file> script.  This extra file
7555             should be sourced by the script when the script runs.  It
7556             must contain only variable settings and comments in SUSv3
7557             <prgn>sh</prgn> format.  It may either be a
7558             <tt>conffile</tt> or a configuration file maintained by
7559             the package maintainer scripts.  See <ref id="config-files">
7560             for more details.
7561           </p>
7562
7563           <p>
7564             To ensure that vital configurable values are always
7565             available, the <file>init.d</file> script should set default
7566             values for each of the shell variables it uses, either
7567             before sourcing the <file>/etc/default/</file> file or
7568             afterwards using something like the <tt>:
7569             ${VAR:=default}</tt> syntax.  Also, the <file>init.d</file>
7570             script must behave sensibly and not fail if the
7571             <file>/etc/default</file> file is deleted.
7572           </p>
7573
7574           <p>
7575             Files and directories under <file>/run</file>, including ones
7576             referred to via the compatibility paths <file>/var/run</file>
7577             and <file>/var/lock</file>, are normally stored on a temporary
7578             filesystem and are normally not persistent across a reboot.
7579             The <file>init.d</file> scripts must handle this correctly.
7580             This will typically mean creating any required subdirectories
7581             dynamically when the <file>init.d</file> script is run.
7582             See <ref id="fhs-run"> for more information.
7583           </p>
7584         </sect1>
7585
7586         <sect1>
7587           <heading>Interfacing with the initscript system</heading>
7588
7589           <p>
7590             Maintainers should use the abstraction layer provided by
7591             the <prgn>update-rc.d</prgn> and <prgn>invoke-rc.d</prgn>
7592             programs to deal with initscripts in their packages'
7593             scripts such as <prgn>postinst</prgn>, <prgn>prerm</prgn>
7594             and <prgn>postrm</prgn>.
7595           </p>
7596
7597           <p>
7598             Directly managing the /etc/rc?.d links and directly
7599             invoking the <file>/etc/init.d/</file> initscripts should
7600             be done only by packages providing the initscript
7601             subsystem (such as <prgn>sysv-rc</prgn> and
7602             <prgn>file-rc</prgn>).
7603           </p>
7604
7605           <sect2>
7606             <heading>Managing the links</heading>
7607
7608             <p>
7609               The program <prgn>update-rc.d</prgn> is provided for
7610               package maintainers to arrange for the proper creation and
7611               removal of <file>/etc/rc<var>n</var>.d</file> symbolic links,
7612               or their functional equivalent if another method is being
7613               used.  This may be used by maintainers in their packages'
7614               <prgn>postinst</prgn> and <prgn>postrm</prgn> scripts.
7615             </p>
7616
7617             <p>
7618               You must not include any <file>/etc/rc<var>n</var>.d</file>
7619               symbolic links in the actual archive or manually create or
7620               remove the symbolic links in maintainer scripts; you must
7621               use the <prgn>update-rc.d</prgn> program instead.  (The
7622               former will fail if an alternative method of maintaining
7623               runlevel information is being used.)  You must not include
7624               the <file>/etc/rc<var>n</var>.d</file> directories themselves
7625               in the archive either.  (Only the <tt>sysvinit</tt>
7626               package may do so.)
7627             </p>
7628
7629             <p>
7630               By default <prgn>update-rc.d</prgn> will start services in
7631               each of the multi-user state runlevels (2, 3, 4, and 5)
7632               and stop them in the halt runlevel (0), the single-user
7633               runlevel (1) and the reboot runlevel (6).  The system
7634               administrator will have the opportunity to customize
7635               runlevels by simply adding, moving, or removing the
7636               symbolic links in <file>/etc/rc<var>n</var>.d</file> if
7637               symbolic links are being used, or by modifying
7638               <file>/etc/runlevel.conf</file> if the <tt>file-rc</tt> method
7639               is being used.
7640             </p>
7641
7642             <p>
7643               To get the default behavior for your package, put in your
7644               <prgn>postinst</prgn> script
7645               <example compact="compact">
7646                 update-rc.d <var>package</var> defaults
7647               </example>
7648               and in your <prgn>postrm</prgn>
7649               <example compact="compact">
7650                 if [ "$1" = purge ]; then
7651                 update-rc.d <var>package</var> remove
7652                 fi
7653               </example>. Note that if your package changes runlevels
7654               or priority, you may have to remove and recreate the links,
7655               since otherwise the old links may persist. Refer to the
7656               documentation of <prgn>update-rc.d</prgn>.
7657             </p>
7658
7659             <p>
7660               This will use a default sequence number of 20.  If it does
7661               not matter when or in which order the <file>init.d</file>
7662               script is run, use this default.  If it does, then you
7663               should talk to the maintainer of the <prgn>sysvinit</prgn>
7664               package or post to <tt>debian-devel</tt>, and they will
7665               help you choose a number.
7666             </p>
7667
7668             <p>
7669               For more information about using <tt>update-rc.d</tt>,
7670               please consult its man page <manref name="update-rc.d"
7671                 section="8">.
7672             </p>
7673           </sect2>
7674
7675           <sect2>
7676             <heading>Running initscripts</heading>
7677             <p>
7678               The program <prgn>invoke-rc.d</prgn> is provided to make
7679               it easier for package maintainers to properly invoke an
7680               initscript, obeying runlevel and other locally-defined
7681               constraints that might limit a package's right to start,
7682               stop and otherwise manage services. This program may be
7683               used by maintainers in their packages' scripts.
7684             </p>
7685
7686             <p>
7687               The package maintainer scripts must use
7688               <prgn>invoke-rc.d</prgn> to invoke the
7689               <file>/etc/init.d/*</file> initscripts, instead of
7690               calling them directly.
7691             </p>
7692
7693             <p>
7694               By default, <prgn>invoke-rc.d</prgn> will pass any
7695               action requests (start, stop, reload, restart...) to the
7696               <file>/etc/init.d</file> script, filtering out requests
7697               to start or restart a service out of its intended
7698               runlevels.
7699             </p>
7700
7701             <p>
7702               Most packages will simply need to change:
7703               <example compact="compact">/etc/init.d/&lt;package&gt;
7704               &lt;action&gt;</example> in their <prgn>postinst</prgn>
7705               and <prgn>prerm</prgn> scripts to:
7706               <example compact="compact">
7707         if which invoke-rc.d >/dev/null 2>&1; then
7708                 invoke-rc.d <var>package</var> &lt;action&gt;
7709         else
7710                 /etc/init.d/<var>package</var> &lt;action&gt;
7711         fi
7712               </example>
7713             </p>
7714
7715             <p>
7716               A package should register its initscript services using
7717               <prgn>update-rc.d</prgn> before it tries to invoke them
7718               using <prgn>invoke-rc.d</prgn>. Invocation of
7719               unregistered services may fail.
7720             </p>
7721
7722             <p>
7723               For more information about using
7724               <prgn>invoke-rc.d</prgn>, please consult its man page
7725               <manref name="invoke-rc.d" section="8">.
7726             </p>
7727           </sect2>
7728         </sect1>
7729
7730         <sect1>
7731           <heading>Boot-time initialization</heading>
7732
7733           <p>
7734             There used to be another directory, <file>/etc/rc.boot</file>,
7735             which contained scripts which were run once per machine
7736             boot. This has been deprecated in favour of links from
7737             <file>/etc/rcS.d</file> to files in <file>/etc/init.d</file> as
7738             described in <ref id="/etc/init.d">.  Packages must not
7739             place files in <file>/etc/rc.boot</file>.
7740           </p>
7741         </sect1>
7742
7743         <sect1>
7744           <heading>Example</heading>
7745
7746           <p>
7747             An example on which you can base your
7748             <file>/etc/init.d</file> scripts is found in
7749             <file>/etc/init.d/skeleton</file>.
7750           </p>
7751
7752         </sect1>
7753       </sect>
7754
7755       <sect>
7756         <heading>Console messages from <file>init.d</file> scripts</heading>
7757
7758         <p>
7759           This section describes the formats to be used for messages
7760           written to standard output by the <file>/etc/init.d</file>
7761           scripts.  The intent is to improve the consistency of
7762           Debian's startup and shutdown look and feel.  For this
7763           reason, please look very carefully at the details.  We want
7764           the messages to have the same format in terms of wording,
7765           spaces, punctuation and case of letters.
7766         </p>
7767
7768         <p>
7769           Here is a list of overall rules that should be used for
7770           messages generated by <file>/etc/init.d</file> scripts.  
7771         </p>
7772
7773         <p>
7774           <list>
7775             <item>
7776                 The message should fit in one line (fewer than 80
7777                 characters), start with a capital letter and end with
7778                 a period (<tt>.</tt>) and line feed (<tt>"\n"</tt>).
7779             </item>
7780
7781             <item>
7782               If the script is performing some time consuming task in
7783               the background (not merely starting or stopping a
7784               program, for instance), an ellipsis (three dots:
7785               <tt>...</tt>) should be output to the screen, with no
7786               leading or tailing whitespace or line feeds.
7787             </item>
7788
7789             <item>
7790               The messages should appear as if the computer is telling
7791               the user what it is doing (politely :-), but should not
7792                 mention "it" directly.  For example, instead of:
7793                 <example compact="compact">
7794 I'm starting network daemons: nfsd mountd.
7795                 </example>
7796                 the message should say
7797                 <example compact="compact">
7798 Starting network daemons: nfsd mountd.
7799                 </example>
7800             </item>
7801           </list>
7802         </p>
7803
7804         <p>
7805           <tt>init.d</tt> script should use the following  standard
7806           message formats for the situations enumerated below.
7807         </p>
7808
7809         <p>
7810           <list>
7811             <item>
7812               <p>When daemons are started</p>
7813
7814               <p>
7815                 If the script starts one or more daemons, the output
7816                 should look like this (a single line, no leading
7817                 spaces):
7818                 <example compact="compact">
7819 Starting <var>description</var>: <var>daemon-1</var> ... <var>daemon-n</var>.
7820                 </example>
7821                 The <var>description</var> should describe the
7822                 subsystem the daemon or set of daemons are part of,
7823                 while <var>daemon-1</var> up to <var>daemon-n</var>
7824                 denote each daemon's name (typically the file name of
7825                 the program).
7826               </p>
7827
7828               <p>
7829                 For example, the output of <file>/etc/init.d/lpd</file>
7830                 would look like:
7831                 <example compact="compact">
7832 Starting printer spooler: lpd.
7833                 </example>
7834               </p>
7835
7836               <p>
7837                 This can be achieved by saying
7838                 <example compact="compact">
7839 echo -n "Starting printer spooler: lpd"
7840 start-stop-daemon --start --quiet --exec /usr/sbin/lpd
7841 echo "."
7842                 </example>
7843                 in the script. If there are more than one daemon to
7844                 start, the output should look like this:
7845                 <example compact="compact">
7846 echo -n "Starting remote file system services:"
7847 echo -n " nfsd"; start-stop-daemon --start --quiet nfsd
7848 echo -n " mountd"; start-stop-daemon --start --quiet mountd
7849 echo -n " ugidd"; start-stop-daemon --start --quiet ugidd
7850 echo "."
7851                 </example>
7852                 This makes it possible for the user to see what is
7853                 happening and when the final daemon has been started.
7854                 Care should be taken in the placement of white spaces:
7855                 in the example above the system administrators can
7856                 easily comment out a line if they don't want to start
7857                 a specific daemon, while the displayed message still
7858                 looks good.
7859               </p>
7860             </item>
7861
7862             <item>
7863               <p>When a system parameter is being set</p>
7864
7865               <p>
7866                 If you have to set up different system parameters
7867                 during the system boot, you should use this format:
7868                 <example compact="compact">
7869 Setting <var>parameter</var> to "<var>value</var>".
7870                 </example>
7871               </p>
7872
7873               <p>
7874                 You can use a statement such as the following to get
7875                 the quotes right:
7876                 <example compact="compact">
7877 echo "Setting DNS domainname to \"$domainname\"."
7878                 </example>
7879               </p>
7880
7881               <p>
7882                 Note that the same symbol (<tt>"</tt>) <!-- " --> is used
7883                 for the left and right quotation marks.  A grave accent
7884                 (<tt>`</tt>) is not a quote character; neither is an
7885                 apostrophe (<tt>'</tt>).
7886               </p>
7887             </item>
7888
7889             <item>
7890               <p>When a daemon is stopped or restarted</p>
7891
7892               <p>
7893                 When you stop or restart a daemon, you should issue a
7894                 message identical to the startup message, except that
7895                 <tt>Starting</tt> is replaced with <tt>Stopping</tt>
7896                 or <tt>Restarting</tt> respectively.
7897               </p>
7898
7899               <p>
7900                 For example, stopping the printer daemon will look like
7901                 this:
7902                 <example compact="compact">
7903 Stopping printer spooler: lpd.
7904                 </example>
7905               </p>
7906             </item>
7907
7908             <item>
7909               <p>When something is executed</p>
7910
7911               <p>
7912                 There are several examples where you have to run a
7913                 program at system startup or shutdown to perform a
7914                 specific task, for example, setting the system's clock
7915                 using <prgn>netdate</prgn> or killing all processes
7916                 when the system shuts down.  Your message should look
7917                 like this:
7918                 <example compact="compact">
7919 Doing something very useful...done.
7920                 </example>
7921                 You should print the <tt>done.</tt> immediately after
7922                 the job has been completed, so that the user is
7923                 informed why they have to wait.  You can get this
7924                 behavior by saying
7925                 <example compact="compact">
7926 echo -n "Doing something very useful..."
7927 do_something
7928 echo "done."
7929                 </example>
7930                 in your script.
7931               </p>
7932             </item>
7933
7934             <item>
7935               <p>When the configuration is reloaded</p>
7936
7937               <p>
7938                 When a daemon is forced to reload its configuration
7939                 files you should use the following format:
7940                 <example compact="compact">
7941 Reloading <var>description</var> configuration...done.
7942                 </example>
7943                 where <var>description</var> is the same as in the
7944                 daemon starting message.
7945               </p>
7946             </item>
7947           </list>
7948         </p>
7949       </sect>
7950
7951       <sect id="cron-jobs">
7952         <heading>Cron jobs</heading>
7953
7954         <p>
7955           Packages must not modify the configuration file
7956           <file>/etc/crontab</file>, and they must not modify the files in
7957           <file>/var/spool/cron/crontabs</file>.
7958         </p>
7959
7960         <p>
7961           If a package wants to install a job that has to be executed via
7962           cron, it should place a file named as specified
7963           in <ref id="cron-files"> into one or more of the following
7964           directories:
7965           <example compact="compact">
7966 /etc/cron.hourly
7967 /etc/cron.daily
7968 /etc/cron.weekly
7969 /etc/cron.monthly
7970           </example>
7971           As these directory names imply, the files within them are
7972           executed on an hourly, daily, weekly, or monthly basis,
7973           respectively. The exact times are listed in
7974           <file>/etc/crontab</file>.
7975         </p>
7976
7977         <p>
7978           All files installed in any of these directories must be
7979           scripts (e.g., shell scripts or Perl scripts) so that they
7980           can easily be modified by the local system administrator.
7981           In addition, they must be treated as configuration files.
7982         </p>
7983
7984         <p>
7985           If a certain job has to be executed at some other frequency or
7986           at a specific time, the package should install a file in
7987           <file>/etc/cron.d</file> with a name as specified
7988           in <ref id="cron-files">.  This file uses the same syntax
7989           as <file>/etc/crontab</file> and is processed
7990           by <prgn>cron</prgn> automatically. The file must also be
7991           treated as a configuration file. (Note that entries in the
7992           <file>/etc/cron.d</file> directory are not handled by
7993           <prgn>anacron</prgn>. Thus, you should only use this
7994           directory for jobs which may be skipped if the system is not
7995           running.)
7996         </p>
7997
7998         <p>
7999           Unlike <file>crontab</file> files described in the IEEE Std
8000           1003.1-2008 (POSIX.1) available from
8001           <url id="http://www.opengroup.org/onlinepubs/9699919799/"
8002                name="The Open Group">, the files in
8003           <file>/etc/cron.d</file> and the file
8004           <file>/etc/crontab</file> have seven fields; namely:
8005           <enumlist>
8006             <item>Minute [0,59]</item>
8007             <item>Hour [0,23]</item>
8008             <item>Day of the month [1,31]</item>
8009             <item>Month of the year [1,12]</item>
8010             <item>Day of the week ([0,6] with 0=Sunday)</item>
8011             <item>Username</item>
8012             <item>Command to be run</item>
8013           </enumlist>
8014           Ranges of numbers are allowed.  Ranges are two numbers
8015           separated with a hyphen.  The specified range is inclusive.
8016           Lists are allowed.  A list is a set of numbers (or ranges)
8017           separated by commas. Step values can be used in conjunction
8018           with ranges.
8019         </p>
8020
8021         <p>
8022           The scripts or <tt>crontab</tt> entries in these directories should
8023           check if all necessary programs are installed before they
8024           try to execute them. Otherwise, problems will arise when a
8025           package was removed but not purged since configuration files
8026           are kept on the system in this situation.
8027         </p>
8028
8029         <p>
8030           Any <tt>cron</tt> daemon must provide
8031           <file>/usr/bin/crontab</file> and support normal
8032           <tt>crontab</tt> entries as specified in POSIX. The daemon
8033           must also support names for days and months, ranges, and
8034           step values. It has to support <file>/etc/crontab</file>,
8035           and correctly execute the scripts in
8036           <file>/etc/cron.d</file>. The daemon must also correctly
8037           execute scripts in
8038           <file>/etc/cron.{hourly,daily,weekly,monthly}</file>.
8039         </p>
8040
8041         <sect1 id="cron-files">
8042           <heading>Cron job file names</heading>
8043
8044           <p>
8045             The file name of a cron job file should normally match the
8046             name of the package from which it comes.
8047           </p>
8048
8049           <p>
8050             If a package supplies multiple cron job files files in the
8051             same directory, the file names should all start with the name
8052             of the package (possibly modified as described below) followed
8053             by a hyphen (<tt>-</tt>) and a suitable suffix.
8054           </p>
8055
8056           <p>
8057             A cron job file name must not include any period or plus
8058             characters (<tt>.</tt> or <tt>+</tt>) characters as this will
8059             cause cron to ignore the file.  Underscores (<tt>_</tt>)
8060             should be used instead of <tt>.</tt> and <tt>+</tt>
8061             characters.
8062           </p>
8063         </sect1>
8064       </sect>
8065
8066       <sect id="menus">
8067         <heading>Menus</heading>
8068
8069         <p>
8070           The Debian <tt>menu</tt> package provides a standard
8071           interface between packages providing applications and
8072           <em>menu programs</em> (either X window managers or
8073           text-based menu programs such as <prgn>pdmenu</prgn>).
8074         </p>
8075
8076         <p>
8077           All packages that provide applications that need not be
8078           passed any special command line arguments for normal
8079           operation should register a menu entry for those
8080           applications, so that users of the <tt>menu</tt> package
8081           will automatically get menu entries in their window
8082           managers, as well in shells like <tt>pdmenu</tt>.
8083         </p>
8084
8085         <p>
8086           Menu entries should follow the current menu policy.
8087         </p>
8088
8089         <p>
8090           The menu policy can be found in the <tt>menu-policy</tt>
8091           files in the <tt>debian-policy</tt> package.
8092           It is also available from the Debian web mirrors at
8093           <tt><url name="/doc/packaging-manuals/menu-policy/"
8094                 id="http://www.debian.org/doc/packaging-manuals/menu-policy/"></tt>.
8095         </p>
8096
8097         <p>
8098           Please also refer to the <em>Debian Menu System</em>
8099           documentation that comes with the <package>menu</package>
8100           package for information about how to register your
8101           applications.
8102         </p>
8103       </sect>
8104
8105       <sect id="mime">
8106         <heading>Multimedia handlers</heading>
8107
8108         <p>
8109           MIME (Multipurpose Internet Mail Extensions, RFCs 2045-2049)
8110           is a mechanism for encoding files and data streams and
8111           providing meta-information about them, in particular their
8112           type (e.g. audio or video) and format (e.g. PNG, HTML,
8113           MP3).
8114         </p>
8115
8116         <p>
8117           Registration of MIME type handlers allows programs like mail
8118           user agents and web browsers to invoke these handlers to
8119           view, edit or display MIME types they don't support directly.
8120         </p>
8121
8122         <p>
8123           Packages which provide programs to view/show/play, compose, edit or
8124           print MIME types should register them as such by placing a file in
8125           <manref name="mailcap" section="5"> format (RFC 1524) in the directory
8126           <file>/usr/lib/mime/packages/</file>.  The file name should be the
8127           binary package's name.
8128         </p>
8129
8130         <p>
8131           The <package>mime-support</package> package provides the
8132           <prgn>update-mime</prgn> program, which integrates these
8133           registrations in the <file>/etc/mailcap</file> file, using dpkg
8134           triggers<footnote>
8135             Creating, modifying or removing a file in
8136             <file>/usr/lib/mime/packages/</file> using maintainer scripts will
8137             not activate the trigger.  In that case, it can be done by calling
8138             <tt>dpkg-trigger --no-await /usr/lib/mime/packages</tt> from
8139             the maintainer script after creating, modifying, or removing
8140             the file.
8141           </footnote>.
8142           Packages using this facility <em>should not</em> depend on,
8143           recommend, or suggest <prgn>mime-support</prgn>.
8144         </p>
8145       </sect>
8146
8147       <sect>
8148         <heading>Keyboard configuration</heading>
8149
8150         <p>
8151           To achieve a consistent keyboard configuration so that all
8152           applications interpret a keyboard event the same way, all
8153           programs in the Debian distribution must be configured to
8154           comply with the following guidelines.
8155         </p>
8156
8157         <p>
8158           The following keys must have the specified interpretations:
8159
8160           <taglist>
8161             <tag><tt>&lt;--</tt></tag>
8162             <item>delete the character to the left of the cursor</item>
8163
8164             <tag><tt>Delete</tt></tag>
8165             <item>delete the character to the right of the cursor</item>
8166
8167             <tag><tt>Control+H</tt></tag>
8168             <item>emacs: the help prefix</item>
8169           </taglist>
8170
8171           The interpretation of any keyboard events should be
8172           independent of the terminal that is used, be it a virtual
8173           console, an X terminal emulator, an rlogin/telnet session,
8174           etc.
8175         </p>
8176
8177         <p>
8178           The following list explains how the different programs
8179           should be set up to achieve this:
8180         </p>
8181
8182         <p>
8183           <list>
8184             <item>
8185                 <tt>&lt;--</tt> generates <tt>KB_BackSpace</tt> in X.
8186             </item>
8187
8188             <item>
8189                 <tt>Delete</tt> generates <tt>KB_Delete</tt> in X.
8190             </item>
8191
8192             <item>
8193                 X translations are set up to make
8194                 <tt>KB_Backspace</tt> generate ASCII DEL, and to make
8195                 <tt>KB_Delete</tt> generate <tt>ESC [ 3 ~</tt> (this
8196                 is the vt220 escape code for the "delete character"
8197                 key).  This must be done by loading the X resources
8198                 using <prgn>xrdb</prgn> on all local X displays, not
8199                 using the application defaults, so that the
8200                 translation resources used correspond to the
8201                 <prgn>xmodmap</prgn> settings.
8202             </item>
8203
8204             <item>
8205                 The Linux console is configured to make
8206                 <tt>&lt;--</tt> generate DEL, and <tt>Delete</tt>
8207                 generate <tt>ESC [ 3 ~</tt>.
8208             </item>
8209
8210             <item>
8211                 X applications are configured so that <tt>&lt;</tt>
8212                 deletes left, and <tt>Delete</tt> deletes right.  Motif
8213                 applications already work like this.
8214             </item>
8215
8216             <item>
8217                 Terminals should have <tt>stty erase ^?</tt> .
8218             </item>
8219
8220             <item>
8221                 The <tt>xterm</tt> terminfo entry should have <tt>ESC
8222                 [ 3 ~</tt> for <tt>kdch1</tt>, just as for
8223                 <tt>TERM=linux</tt> and <tt>TERM=vt220</tt>.
8224             </item>
8225
8226             <item>
8227                 Emacs is programmed to map <tt>KB_Backspace</tt> or
8228                 the <tt>stty erase</tt> character to
8229                 <tt>delete-backward-char</tt>, and <tt>KB_Delete</tt>
8230                 or <tt>kdch1</tt> to <tt>delete-forward-char</tt>, and
8231                 <tt>^H</tt> to <tt>help</tt> as always.
8232             </item>
8233
8234             <item>
8235                 Other applications use the <tt>stty erase</tt>
8236                 character and <tt>kdch1</tt> for the two delete keys,
8237                 with ASCII DEL being "delete previous character" and
8238                 <tt>kdch1</tt> being "delete character under
8239                 cursor".
8240             </item>
8241
8242           </list>
8243         </p>
8244
8245         <p>
8246           This will solve the problem except for the following
8247           cases:
8248         </p>
8249
8250         <p>
8251           <list>
8252             <item>
8253                 Some terminals have a <tt>&lt;--</tt> key that cannot
8254                 be made to produce anything except <tt>^H</tt>.  On
8255                 these terminals Emacs help will be unavailable on
8256                 <tt>^H</tt> (assuming that the <tt>stty erase</tt>
8257                 character takes precedence in Emacs, and has been set
8258                 correctly).  <tt>M-x help</tt> or <tt>F1</tt> (if
8259                 available) can be used instead.
8260             </item>
8261
8262             <item>
8263                 Some operating systems use <tt>^H</tt> for <tt>stty
8264                 erase</tt>.  However, modern telnet versions and all
8265                 rlogin versions propagate <tt>stty</tt> settings, and
8266                 almost all UNIX versions honour <tt>stty erase</tt>.
8267                 Where the <tt>stty</tt> settings are not propagated
8268                 correctly, things can be made to work by using
8269                 <tt>stty</tt> manually.
8270             </item>
8271
8272             <item>
8273                 Some systems (including previous Debian versions) use
8274                 <prgn>xmodmap</prgn> to arrange for both
8275                 <tt>&lt;--</tt> and <tt>Delete</tt> to generate
8276                 <tt>KB_Delete</tt>.  We can change the behavior of
8277                 their X clients using the same X resources that we use
8278                 to do it for our own clients, or configure our clients
8279                 using their resources when things are the other way
8280                 around.  On displays configured like this
8281                 <tt>Delete</tt> will not work, but <tt>&lt;--</tt>
8282                 will.
8283             </item>
8284
8285             <item>
8286                 Some operating systems have different <tt>kdch1</tt>
8287                 settings in their <tt>terminfo</tt> database for
8288                 <tt>xterm</tt> and others.  On these systems the
8289                 <tt>Delete</tt> key will not work correctly when you
8290                 log in from a system conforming to our policy, but
8291                 <tt>&lt;--</tt> will.
8292             </item>
8293           </list>
8294         </p>
8295       </sect>
8296
8297       <sect>
8298         <heading>Environment variables</heading>
8299
8300         <p>
8301           A program must not depend on environment variables to get
8302           reasonable defaults.  (That's because these environment
8303           variables would have to be set in a system-wide
8304           configuration file like <file>/etc/profile</file>, which is not
8305           supported by all shells.)
8306         </p>
8307
8308         <p>
8309           If a program usually depends on environment variables for its
8310           configuration, the program should be changed to fall back to
8311           a reasonable default configuration if these environment
8312           variables are not present. If this cannot be done easily
8313           (e.g., if the source code of a non-free program is not
8314           available), the program must be replaced by a small
8315           "wrapper" shell script which sets the environment variables
8316           if they are not already defined, and calls the original program.
8317         </p>
8318
8319         <p>
8320           Here is an example of a wrapper script for this purpose:
8321
8322           <example compact="compact">
8323 #!/bin/sh
8324 BAR=${BAR:-/var/lib/fubar}
8325 export BAR
8326 exec /usr/lib/foo/foo "$@"
8327           </example>
8328         </p>
8329
8330         <p>
8331           Furthermore, as <file>/etc/profile</file> is a configuration
8332           file of the <prgn>base-files</prgn> package, other packages must
8333           not put any environment variables or other commands into that
8334           file.
8335         </p>
8336       </sect>
8337
8338       <sect id="doc-base">
8339         <heading>Registering Documents using doc-base</heading>
8340
8341         <p>
8342           The <package>doc-base</package> package implements a
8343           flexible mechanism for handling and presenting
8344           documentation. The recommended practice is for every Debian
8345           package that provides online documentation (other than just
8346           manual pages) to register these documents with
8347           <package>doc-base</package> by installing a
8348           <package>doc-base</package> control file in
8349           <file>/usr/share/doc-base/</file>.
8350         </p> 
8351         <p>
8352           Please refer to the documentation that comes with the
8353           <package>doc-base</package>  package for information and
8354           details. 
8355         </p>
8356       </sect>
8357
8358       <sect id="alternateinit">
8359         <heading>Alternate init systems</heading>
8360         <p>
8361           A number of other init systems are available now in Debian that
8362           can be used in place of <package>sysvinit</package>.  Alternative
8363           init implementations must support running SysV init scripts as
8364           described at <ref id="sysvinit"> for compatibility.
8365         </p>
8366         <p>
8367           Packages may integrate with these replacement init systems by
8368           providing implementation-specific configuration information about
8369           how and when to start a service or in what order to run certain
8370           tasks at boot time.  However, any package integrating with other
8371           init systems must also be backwards-compatible with
8372           <package>sysvinit</package> by providing a SysV-style init script
8373           with the same name as and equivalent functionality to any
8374           init-specific job, as this is the only start-up configuration
8375           method guaranteed to be supported by all init implementations.  An
8376           exception to this rule is scripts or jobs provided by the init
8377           implementation itself; such jobs may be required for an
8378           implementation-specific equivalent of the <file>/etc/rcS.d/</file>
8379           scripts and may not have a one-to-one correspondence with the init
8380           scripts.
8381         </p>
8382         <sect1 id="upstart">
8383           <heading>Event-based boot with upstart</heading>
8384
8385           <p>
8386             Packages may integrate with the <prgn>upstart</prgn> event-based
8387             boot system by installing job files in the
8388             <file>/etc/init</file> directory.  SysV init scripts for which
8389             an equivalent upstart job is available must query the output of
8390             the command <prgn>initctl version</prgn> for the string
8391             <tt>upstart</tt> and avoid running in favor of the native
8392             upstart job, using a test such as this:
8393             <example compact="compact">
8394 if [ "$1" = start ] && which initctl >/dev/null && initctl version | grep -q upstart
8395 then
8396         exit 1
8397 fi
8398             </example>
8399           </p>
8400           <p>
8401             Because packages shipping upstart jobs may be installed on
8402             systems that are not using upstart, maintainer scripts must
8403             still use the common <prgn>update-rc.d</prgn> and
8404             <prgn>invoke-rc.d</prgn> interfaces for configuring runlevels
8405             and for starting and stopping services.  These maintainer
8406             scripts must not call the upstart <prgn>start</prgn>,
8407             <prgn>restart</prgn>, <prgn>reload</prgn>, or <prgn>stop</prgn>
8408             interfaces directly.  Instead, implementations of
8409             <prgn>invoke-rc.d</prgn> must detect when upstart is running and
8410             when an upstart job with the same name as an init script is
8411             present, and perform the requested action using the upstart job
8412             instead of the init script.
8413           </p>
8414           <p>
8415             Dependency-based boot managers for SysV init scripts, such as
8416             <prgn>startpar</prgn>, may avoid running a given init script
8417             entirely when an equivalent upstart job is present, to avoid
8418             unnecessary forking of no-op init scripts.  In this case, the
8419             boot manager should integrate with upstart to detect when the
8420             upstart job in question is started or stopped to know when the
8421             dependency has been satisfied.
8422           </p>
8423          </sect1>
8424       </sect>
8425
8426     </chapt>
8427
8428
8429     <chapt id="files">
8430       <heading>Files</heading>
8431
8432       <sect id="binaries">
8433         <heading>Binaries</heading>
8434
8435         <p>
8436           Two different packages must not install programs with
8437           different functionality but with the same filenames.  (The
8438           case of two programs having the same functionality but
8439           different implementations is handled via "alternatives" or
8440           the "Conflicts" mechanism.  See <ref id="maintscripts"> and
8441           <ref id="conflicts"> respectively.)  If this case happens,
8442           one of the programs must be renamed.  The maintainers should
8443           report this to the <tt>debian-devel</tt> mailing list and
8444           try to find a consensus about which program will have to be
8445           renamed.  If a consensus cannot be reached, <em>both</em>
8446           programs must be renamed.
8447         </p>
8448
8449         <p>
8450          By default, when a package is being built, any binaries
8451          created should include debugging information, as well as
8452          being compiled with optimization.  You should also turn on
8453          as many reasonable compilation warnings as possible; this
8454          makes life easier for porters, who can then look at build
8455          logs for possible problems.  For the C programming language,
8456          this means the following compilation parameters should be
8457          used:
8458           <example compact="compact">
8459 CC = gcc
8460 CFLAGS = -O2 -g -Wall # sane warning options vary between programs
8461 LDFLAGS = # none
8462 INSTALL = install -s # (or use strip on the files in debian/tmp)
8463           </example>
8464         </p>
8465
8466         <p>
8467           Note that by default all installed binaries should be stripped,
8468           either by using the <tt>-s</tt> flag to
8469           <prgn>install</prgn>, or by calling <prgn>strip</prgn> on
8470           the binaries after they have been copied into
8471           <file>debian/tmp</file> but before the tree is made into a
8472           package.
8473         </p>
8474
8475         <p>
8476           Although binaries in the build tree should be compiled with
8477           debugging information by default, it can often be difficult to
8478           debug programs if they are also subjected to compiler
8479           optimization.  For this reason, it is recommended to support the
8480           standardized environment variable <tt>DEB_BUILD_OPTIONS</tt>
8481           (see <ref id="debianrules-options">).  This variable can contain
8482           several flags to change how a package is compiled and built.
8483         </p>
8484
8485         <p>
8486           It is up to the package maintainer to decide what
8487           compilation options are best for the package.  Certain
8488           binaries (such as computationally-intensive programs) will
8489           function better with certain flags (<tt>-O3</tt>, for
8490           example); feel free to use them.  Please use good judgment
8491           here.  Don't use flags for the sake of it; only use them
8492           if there is good reason to do so.  Feel free to override
8493           the upstream author's ideas about which compilation
8494           options are best: they are often inappropriate for our
8495           environment.
8496         </p>
8497       </sect>
8498
8499
8500       <sect id="libraries">
8501         <heading>Libraries</heading>
8502
8503         <p>
8504           If the package is <strong>architecture: any</strong>, then
8505           the shared library compilation and linking flags must have
8506           <tt>-fPIC</tt>, or the package shall not build on some of
8507           the supported architectures<footnote>
8508             <p>
8509               If you are using GCC, <tt>-fPIC</tt> produces code with
8510               relocatable position independent code, which is required for
8511               most architectures to create a shared library, with i386 and
8512               perhaps some others where non position independent code is
8513               permitted in a shared library.
8514             </p>
8515             <p>
8516               Position independent code may have a performance penalty,
8517               especially on <tt>i386</tt>. However, in most cases the
8518               speed penalty must be measured against the memory wasted on
8519               the few architectures where non position independent code is
8520               even possible.
8521             </p>
8522           </footnote>. Any exception to this rule must be discussed on
8523           the mailing list <em>debian-devel@lists.debian.org</em>, and
8524           a rough consensus obtained.  The reasons for not compiling
8525           with <tt>-fPIC</tt> flag must be recorded in the file
8526           <tt>README.Debian</tt>, and care must be taken to either
8527           restrict the architecture or arrange for <tt>-fPIC</tt> to
8528           be used on architectures where it is required.<footnote>
8529             <p>
8530               Some of the reasons why this might be required is if the
8531               library contains hand crafted assembly code that is not
8532               relocatable, the speed penalty is excessive for compute
8533               intensive libs, and similar reasons.
8534             </p>
8535           </footnote>
8536         </p>
8537         <p>
8538           As to the static libraries, the common case is not to have
8539           relocatable code, since there is no benefit, unless in specific
8540           cases; therefore the static version must not be compiled
8541           with the <tt>-fPIC</tt> flag. Any exception to this rule
8542           should be discussed on the mailing list
8543           <em>debian-devel@lists.debian.org</em>,  and the reasons for
8544           compiling with the <tt>-fPIC</tt> flag must be recorded in
8545           the file <tt>README.Debian</tt>. <footnote>
8546             <p>
8547               Some of the reasons for linking static libraries with
8548               the <tt>-fPIC</tt> flag are if, for example, one needs a
8549               Perl API for a library that is under rapid development,
8550               and has an unstable API, so shared libraries are
8551               pointless at this phase of the library's development. In
8552               that case, since Perl needs a library with relocatable
8553               code, it may make sense to create a static library with
8554               relocatable code. Another reason cited is if you are
8555               distilling various libraries into a common shared
8556               library, like <tt>mklibs</tt> does in the Debian
8557               installer project.
8558             </p>
8559           </footnote>
8560         </p>
8561         <p>
8562           In other words, if both a shared and a static library is
8563           being built, each source unit (<tt>*.c</tt>, for example,
8564           for C files) will need to be compiled twice, for the normal
8565           case. 
8566         </p>
8567
8568         <p>
8569           Libraries should be built with threading support and to be
8570           thread-safe if the library supports this.
8571         </p>
8572
8573         <p>
8574           Although not enforced by the build tools, shared libraries
8575           must be linked against all libraries that they use symbols from
8576           in the same way that binaries are.  This ensures the correct
8577           functioning of the <qref id="sharedlibs-symbols">symbols</qref>
8578           and <qref id="sharedlibs-shlibdeps">shlibs</qref>
8579           systems and guarantees that all libraries can be safely opened
8580           with <tt>dlopen()</tt>.  Packagers may wish to use the gcc
8581           option <tt>-Wl,-z,defs</tt> when building a shared library.
8582           Since this option enforces symbol resolution at build time,
8583           a missing library reference will be caught early as a fatal
8584           build error.
8585         </p>
8586
8587         <p>
8588           All installed shared libraries should be stripped with
8589           <example compact="compact">
8590 strip --strip-unneeded <var>your-lib</var>
8591           </example>
8592           (The option <tt>--strip-unneeded</tt> makes
8593           <prgn>strip</prgn> remove only the symbols which aren't
8594           needed for relocation processing.)  Shared libraries can
8595           function perfectly well when stripped, since the symbols for
8596           dynamic linking are in a separate part of the ELF object
8597           file.<footnote>
8598               You might also want to use the options
8599               <tt>--remove-section=.comment</tt> and
8600               <tt>--remove-section=.note</tt> on both shared libraries
8601               and executables, and <tt>--strip-debug</tt> on static
8602               libraries.
8603           </footnote>
8604         </p>
8605
8606         <p>
8607           Note that under some circumstances it may be useful to
8608           install a shared library unstripped, for example when
8609           building a separate package to support debugging.
8610         </p>
8611
8612         <p>
8613           Shared object files (often <file>.so</file> files) that are not
8614           public libraries, that is, they are not meant to be linked
8615           to by third party executables (binaries of other packages),
8616           should be installed in subdirectories of the
8617           <file>/usr/lib</file> directory.  Such files are exempt from the
8618           rules that govern ordinary shared libraries, except that
8619           they must not be installed executable and should be
8620           stripped.<footnote>
8621               A common example are the so-called "plug-ins",
8622               internal shared objects that are dynamically loaded by
8623               programs using <manref name="dlopen" section="3">.
8624           </footnote>
8625         </p>
8626
8627         <p>
8628           Packages that use <prgn>libtool</prgn> to create and install
8629           their shared libraries install a file containing additional
8630           metadata (ending in <file>.la</file>) alongside the library.
8631           For public libraries intended for use by other packages, these
8632           files normally should not be included in the Debian package,
8633           since the information they include is not necessary to link with
8634           the shared library on Debian and can add unnecessary additional
8635           dependencies to other programs or libraries.<footnote>
8636             These files store, among other things, all libraries on which
8637             that shared library depends.  Unfortunately, if
8638             the <file>.la</file> file is present and contains that
8639             dependency information, using <prgn>libtool</prgn> when
8640             linking against that library will cause the resulting program
8641             or library to be linked against those dependencies as well,
8642             even if this is unnecessary.  This can create unneeded
8643             dependencies on shared library packages that would otherwise
8644             be hidden behind the library ABI, and can make library
8645             transitions to new SONAMEs unnecessarily complicated and
8646             difficult to manage.
8647           </footnote>
8648           If the <file>.la</file> file is required for that library (if,
8649           for instance, it's loaded via <tt>libltdl</tt> in a way that
8650           requires that meta-information), the <tt>dependency_libs</tt>
8651           setting in the <file>.la</file> file should normally be set to
8652           the empty string.  If the shared library development package has
8653           historically included the <file>.la</file>, it must be retained
8654           in the development package (with <tt>dependency_libs</tt>
8655           emptied) until all libraries that depend on it have removed or
8656           emptied <tt>dependency_libs</tt> in their <file>.la</file>
8657           files to prevent linking with those other libraries
8658           using <prgn>libtool</prgn> from failing.
8659         </p>
8660
8661         <p>
8662           If the <file>.la</file> must be included, it should be included
8663           in the development (<tt>-dev</tt>) package, unless the library
8664           will be loaded by <prgn>libtool</prgn>'s <tt>libltdl</tt>
8665           library.  If it is intended for use with <tt>libltdl</tt>,
8666           the <file>.la</file> files must go in the run-time library
8667           package.
8668         </p>
8669
8670         <p>
8671           These requirements for handling of <file>.la</file> files do not
8672           apply to loadable modules or libraries not installed in
8673           directories searched by default by the dynamic linker.  Packages
8674           installing loadable modules will frequently need to install
8675           the <file>.la</file> files alongside the modules so that they
8676           can be loaded by <tt>libltdl</tt>.  <tt>dependency_libs</tt>
8677           does not need to be modified for libraries or modules that are
8678           not installed in directories searched by the dynamic linker by
8679           default and not intended for use by other packages.
8680         </p>
8681
8682         <p>
8683           You must make sure that you use only released versions of
8684           shared libraries to build your packages; otherwise other
8685           users will not be able to run your binaries
8686           properly. Producing source packages that depend on
8687           unreleased compilers is also usually a bad
8688           idea.
8689         </p>
8690       </sect>
8691
8692
8693       <sect>
8694         <heading>Shared libraries</heading>
8695         <p>
8696           This section has moved to <ref id="sharedlibs">.
8697         </p>
8698       </sect>
8699
8700
8701       <sect id="scripts">
8702         <heading>Scripts</heading>
8703
8704         <p>
8705           All command scripts, including the package maintainer
8706           scripts inside the package and used by <prgn>dpkg</prgn>,
8707           should have a <tt>#!</tt> line naming the shell to be used
8708           to interpret them.
8709         </p>
8710
8711         <p>
8712           In the case of Perl scripts this should be
8713           <tt>#!/usr/bin/perl</tt>.
8714         </p>
8715
8716         <p>
8717           When scripts are installed into a directory in the system
8718           PATH, the script name should not include an extension such
8719           as <tt>.sh</tt> or <tt>.pl</tt> that denotes the scripting
8720           language currently used to implement it.
8721         </p>
8722         <p>
8723           Shell scripts (<prgn>sh</prgn> and <prgn>bash</prgn>) other than
8724           <file>init.d</file> scripts should almost certainly start
8725           with <tt>set -e</tt> so that errors are detected.
8726           <file>init.d</file> scripts are something of a special case, due
8727           to how frequently they need to call commands that are allowed to
8728           fail, and it may instead be easier to check the exit status of
8729           commands directly.  See <ref id="writing-init"> for more
8730           information about writing <file>init.d</file> scripts.
8731         </p>
8732         <p>
8733           Every script should use <tt>set -e</tt> or check the exit status
8734           of <em>every</em> command.
8735         </p>
8736         <p>
8737           Scripts may assume that <file>/bin/sh</file> implements the
8738           SUSv3 Shell Command Language<footnote>
8739             Single UNIX Specification, version 3, which is also IEEE
8740             1003.1-2004 (POSIX), and is available on the World Wide Web
8741             from <url id="http://www.unix.org/version3/online.html"
8742                       name="The Open Group"> after free
8743             registration.</footnote>
8744           plus the following additional features not mandated by
8745           SUSv3:<footnote>
8746             These features are in widespread use in the Linux community
8747             and are implemented in all of bash, dash, and ksh, the most
8748             common shells users may wish to use as <file>/bin/sh</file>.
8749           </footnote>
8750           <list>
8751             <item><tt>echo -n</tt>, if implemented as a shell built-in,
8752               must not generate a newline.</item>
8753             <item><tt>test</tt>, if implemented as a shell built-in, must
8754               support <tt>-a</tt> and <tt>-o</tt> as binary logical
8755               operators.</item>
8756             <item><tt>local</tt> to create a scoped variable must be
8757               supported, including listing multiple variables in a single
8758               local command and assigning a value to a variable at the
8759               same time as localizing it.  <tt>local</tt> may or
8760               may not preserve the variable value from an outer scope if
8761               no assignment is present.  Uses such as:
8762 <example compact>
8763 fname () {
8764     local a b c=delta d
8765     # ... use a, b, c, d ...
8766 }
8767 </example>
8768               must be supported and must set the value of <tt>c</tt> to
8769               <tt>delta</tt>.
8770             </item>
8771             <item>The XSI extension to <prgn>kill</prgn> allowing <tt>kill
8772               -<var>signal</var></tt>, where <var>signal</var> is either
8773               the name of a signal or one of the numeric signals listed in
8774               the XSI extension (0, 1, 2, 3, 6, 9, 14, and 15), must be
8775               supported if <prgn>kill</prgn> is implemented as a shell
8776               built-in.
8777             </item>
8778             <item>The XSI extension to <prgn>trap</prgn> allowing numeric
8779               signals must be supported.  In addition to the signal
8780               numbers listed in the extension, which are the same as for
8781               <prgn>kill</prgn> above, 13 (SIGPIPE) must be allowed.
8782             </item>
8783           </list>
8784           If a shell script requires non-SUSv3 features from the shell
8785           interpreter other than those listed above, the appropriate shell
8786           must be specified in the first line of the script (e.g.,
8787           <tt>#!/bin/bash</tt>) and the package must depend on the package
8788           providing the shell (unless the shell package is marked
8789           "Essential", as in the case of <prgn>bash</prgn>).
8790         </p>
8791
8792         <p>
8793           You may wish to restrict your script to SUSv3 features plus the
8794           above set when possible so that it may use <file>/bin/sh</file>
8795           as its interpreter.  Checking your script
8796           with <prgn>checkbashisms</prgn> from
8797           the <package>devscripts</package> package or running your script
8798           with an alternate shell such as <prgn>posh</prgn> may help
8799           uncover violations of the above requirements.  If in doubt
8800           whether a script complies with these requirements,
8801           use <file>/bin/bash</file>.
8802         </p>
8803
8804         <p>
8805           Perl scripts should check for errors when making any
8806           system calls, including <tt>open</tt>, <tt>print</tt>,
8807           <tt>close</tt>, <tt>rename</tt> and <tt>system</tt>.
8808         </p>
8809
8810         <p>
8811           <prgn>csh</prgn> and <prgn>tcsh</prgn> should be avoided as
8812           scripting languages.  See <em>Csh Programming Considered
8813           Harmful</em>, one of the <tt>comp.unix.*</tt> FAQs, which
8814           can be found at <url id="http://www.faqs.org/faqs/unix-faq/shell/csh-whynot/">.
8815           If an upstream package comes with <prgn>csh</prgn> scripts
8816           then you must make sure that they start with
8817           <tt>#!/bin/csh</tt> and make your package depend on the
8818           <prgn>c-shell</prgn> virtual package.
8819         </p>
8820
8821         <p>
8822           Any scripts which create files in world-writeable
8823           directories (e.g., in <file>/tmp</file>) must use a
8824           mechanism which will fail atomically if a file with the same
8825           name already exists.
8826         </p>
8827
8828         <p>
8829           The Debian base system provides the <prgn>tempfile</prgn>
8830           and <prgn>mktemp</prgn> utilities for use by scripts for
8831           this purpose.
8832         </p>
8833       </sect>
8834
8835
8836       <sect>
8837         <heading>Symbolic links</heading>
8838
8839         <p>
8840           In general, symbolic links within a top-level directory should
8841           be relative, and symbolic links pointing from one top-level
8842           directory to or into another should be absolute. (A top-level
8843           directory is a sub-directory of the root
8844           directory <file>/</file>.)  For example, a symbolic link
8845           from <file>/usr/lib/foo</file> to <file>/usr/share/bar</file>
8846           should be relative (<file>../share/bar</file>), but a symbolic
8847           link from <file>/var/run</file> to <file>/run</file> should be
8848           absolute.<footnote>
8849             This is necessary to allow top-level directories to be
8850             symlinks.  If linking <file>/var/run</file>
8851             to <file>/run</file> were done with the relative symbolic
8852             link <file>../run</file>, but <file>/var</file> were a
8853             symbolic link to <file>/srv/disk1</file>, the symbolic link
8854             would point to <file>/srv/run</file> rather than the intended
8855             target.
8856           </footnote>
8857         </p>
8858
8859         <p>
8860           In addition, symbolic links should be specified as short as
8861           possible, i.e., link targets like <file>foo/../bar</file> are
8862           deprecated.
8863         </p>
8864
8865         <p>
8866           Note that when creating a relative link using
8867           <prgn>ln</prgn> it is not necessary for the target of the
8868           link to exist relative to the working directory you're
8869           running <prgn>ln</prgn> from, nor is it necessary to change
8870           directory to the directory where the link is to be made.
8871           Simply include the string that should appear as the target
8872           of the link (this will be a pathname relative to the
8873           directory in which the link resides) as the first argument
8874           to <prgn>ln</prgn>.
8875         </p>
8876
8877         <p>
8878           For example, in your <prgn>Makefile</prgn> or
8879           <file>debian/rules</file>, you can do things like:
8880           <example compact="compact">
8881 ln -fs gcc $(prefix)/bin/cc
8882 ln -fs gcc debian/tmp/usr/bin/cc
8883 ln -fs ../sbin/sendmail $(prefix)/bin/runq
8884 ln -fs ../sbin/sendmail debian/tmp/usr/bin/runq
8885           </example>
8886         </p>
8887
8888         <p>
8889           A symbolic link pointing to a compressed file (in the sense
8890           that it is meant to be uncompressed with <prgn>unzip</prgn>
8891           or <prgn>zless</prgn> etc.) should always
8892           have the same file extension as the referenced file. (For
8893           example, if a file <file>foo.gz</file> is referenced by a
8894           symbolic link, the filename of the link has to end with
8895           "<file>.gz</file>" too, as in <file>bar.gz</file>.)
8896         </p>
8897       </sect>
8898
8899       <sect>
8900         <heading>Device files</heading>
8901
8902         <p>
8903           Packages must not include device files or named pipes in the
8904           package file tree.
8905         </p>
8906
8907         <p>
8908           If a package needs any special device files that are not
8909           included in the base system, it must call
8910           <prgn>MAKEDEV</prgn> in the <prgn>postinst</prgn> script,
8911           after notifying the user<footnote>
8912               This notification could be done via a (low-priority)
8913               debconf message, or an echo (printf) statement.
8914           </footnote>.
8915         </p>
8916
8917         <p>
8918           Packages must not remove any device files in the
8919           <prgn>postrm</prgn> or any other script. This is left to the
8920           system administrator.
8921         </p>
8922
8923         <p>
8924           Debian uses the serial devices
8925           <file>/dev/ttyS*</file>. Programs using the old
8926           <file>/dev/cu*</file> devices should be changed to use
8927           <file>/dev/ttyS*</file>.
8928         </p>
8929
8930         <p>
8931           Named pipes needed by the package must be created in
8932           the <prgn>postinst</prgn> script<footnote>
8933             It's better to use <prgn>mkfifo</prgn> rather
8934             than <prgn>mknod</prgn> to create named pipes so that
8935             automated checks for packages incorrectly creating device
8936             files with <prgn>mknod</prgn> won't have false positives.
8937           </footnote> and removed in
8938           the <prgn>prerm</prgn> or <prgn>postrm</prgn> script as
8939           appropriate.
8940         </p>
8941       </sect>
8942
8943       <sect id="config-files">
8944         <heading>Configuration files</heading>
8945
8946         <sect1>
8947           <heading>Definitions</heading>
8948
8949           <p>
8950             <taglist>
8951               <tag>configuration file</tag>
8952               <item>
8953                   A file that affects the operation of a program, or
8954                   provides site- or host-specific information, or
8955                   otherwise customizes the behavior of a program.
8956                   Typically, configuration files are intended to be
8957                   modified by the system administrator (if needed or
8958                   desired) to conform to local policy or to provide
8959                   more useful site-specific behavior.
8960               </item>
8961
8962               <tag><tt>conffile</tt></tag>
8963               <item>
8964                   A file listed in a package's <tt>conffiles</tt>
8965                   file, and is treated specially by <prgn>dpkg</prgn>
8966                   (see <ref id="configdetails">).
8967               </item>
8968             </taglist>
8969           </p>
8970
8971           <p>
8972             The distinction between these two is important; they are
8973             not interchangeable concepts. Almost all
8974             <tt>conffile</tt>s are configuration files, but many
8975             configuration files are not <tt>conffiles</tt>.
8976           </p>
8977
8978           <p>
8979             As noted elsewhere, <file>/etc/init.d</file> scripts,
8980             <file>/etc/default</file> files, scripts installed in
8981             <file>/etc/cron.{hourly,daily,weekly,monthly}</file>, and cron
8982             configuration installed in <file>/etc/cron.d</file> must be
8983             treated as configuration files.  In general, any script that
8984             embeds configuration information is de-facto a configuration
8985             file and should be treated as such.
8986           </p>
8987         </sect1>
8988
8989         <sect1>
8990           <heading>Location</heading>
8991
8992           <p>
8993             Any configuration files created or used by your package
8994             must reside in <file>/etc</file>. If there are several,
8995             consider creating a subdirectory of <file>/etc</file>
8996             named after your package.
8997           </p>
8998
8999           <p>
9000             If your package creates or uses configuration files
9001             outside of <file>/etc</file>, and it is not feasible to modify
9002             the package to use <file>/etc</file> directly, put the files
9003             in <file>/etc</file> and create symbolic links to those files
9004             from the location that the package requires.
9005           </p>
9006         </sect1>
9007
9008         <sect1>
9009           <heading>Behavior</heading>
9010
9011           <p>
9012             Configuration file handling must conform to the following
9013             behavior:
9014             <list compact="compact">
9015               <item>
9016                   local changes must be preserved during a package
9017                   upgrade, and
9018               </item>
9019               <item>
9020                   configuration files must be preserved when the
9021                   package is removed, and only deleted when the
9022                   package is purged.
9023               </item>
9024             </list>
9025             Obsolete configuration files without local changes should be
9026             removed by the package during upgrade.<footnote>
9027               The <prgn>dpkg-maintscript-helper</prgn> tool, available from the
9028               <package>dpkg</package> package, can help for this task.</footnote>
9029           </p>
9030
9031           <p>
9032             The easy way to achieve this behavior is to make the
9033             configuration file a <tt>conffile</tt>. This is
9034             appropriate only if it is possible to distribute a default
9035             version that will work for most installations, although
9036             some system administrators may choose to modify it. This
9037             implies that the default version will be part of the
9038             package distribution, and must not be modified by the
9039             maintainer scripts during installation (or at any other
9040             time).
9041           </p>
9042
9043           <p>
9044             In order to ensure that local changes are preserved
9045             correctly, no package may contain or make hard links to
9046             conffiles.<footnote>
9047                 Rationale: There are two problems with hard links.
9048                 The first is that some editors break the link while
9049                 editing one of the files, so that the two files may
9050                 unwittingly become unlinked and different.  The second
9051                 is that <prgn>dpkg</prgn> might break the hard link
9052                 while upgrading <tt>conffile</tt>s.
9053             </footnote>
9054           </p>
9055
9056           <p>
9057             The other way to do it is via the maintainer scripts.  In
9058             this case, the configuration file must not be listed as a
9059             <tt>conffile</tt> and must not be part of the package
9060             distribution. If the existence of a file is required for
9061             the package to be sensibly configured it is the
9062             responsibility of the package maintainer to provide
9063             maintainer scripts which correctly create, update and
9064             maintain the file and remove it on purge.  (See <ref
9065             id="maintainerscripts"> for more information.)  These
9066             scripts must be idempotent (i.e., must work correctly if
9067             <prgn>dpkg</prgn> needs to re-run them due to errors
9068             during installation or removal), must cope with all the
9069             variety of ways <prgn>dpkg</prgn> can call maintainer
9070             scripts, must not overwrite or otherwise mangle the user's
9071             configuration without asking, must not ask unnecessary
9072             questions (particularly during upgrades), and must
9073             otherwise be good citizens.
9074           </p>
9075
9076           <p>
9077             The scripts are not required to configure every possible
9078             option for the package, but only those necessary to get
9079             the package running on a given system. Ideally the
9080             sysadmin should not have to do any configuration other
9081             than that done (semi-)automatically by the
9082             <prgn>postinst</prgn> script.
9083           </p>
9084
9085           <p>
9086             A common practice is to create a script called
9087             <file><var>package</var>-configure</file> and have the
9088             package's <prgn>postinst</prgn> call it if and only if the
9089             configuration file does not already exist.  In certain
9090             cases it is useful for there to be an example or template
9091             file which the maintainer scripts use.  Such files should
9092             be in <file>/usr/share/<var>package</var></file> or
9093             <file>/usr/lib/<var>package</var></file> (depending on whether
9094             they are architecture-independent or not).  There should
9095             be symbolic links to them from
9096             <file>/usr/share/doc/<var>package</var>/examples</file> if
9097             they are examples, and should be perfectly ordinary
9098             <prgn>dpkg</prgn>-handled files (<em>not</em>
9099             configuration files).
9100           </p>
9101
9102           <p>
9103             These two styles of configuration file handling must
9104             not be mixed, for that way lies madness:
9105             <prgn>dpkg</prgn> will ask about overwriting the file
9106             every time the package is upgraded.
9107           </p>
9108         </sect1>
9109
9110         <sect1>
9111           <heading>Sharing configuration files</heading>
9112
9113           <p>
9114             If two or more packages use the same configuration file
9115             and it is reasonable for both to be installed at the same
9116             time, one of these packages must be defined as
9117             <em>owner</em> of the configuration file, i.e., it will be
9118             the package which handles that file as a configuration
9119             file.  Other packages that use the configuration file must
9120             depend on the owning package if they require the
9121             configuration file to operate. If the other package will
9122             use the configuration file if present, but is capable of
9123             operating without it, no dependency need be declared.
9124           </p>
9125
9126           <p>
9127             If it is desirable for two or more related packages to
9128             share a configuration file <em>and</em> for all of the
9129             related packages to be able to modify that configuration
9130             file, then the following should be done:
9131             <enumlist compact="compact">
9132               <item>
9133                   One of the related packages (the "owning" package)
9134                   will manage the configuration file with maintainer
9135                   scripts as described in the previous section.
9136               </item>
9137               <item>
9138                   The owning package should also provide a program
9139                   that the other packages may use to modify the
9140                   configuration file.
9141               </item>
9142               <item>
9143                   The related packages must use the provided program
9144                   to make any desired modifications to the
9145                   configuration file.  They should either depend on
9146                   the core package to guarantee that the configuration
9147                   modifier program is available or accept gracefully
9148                   that they cannot modify the configuration file if it
9149                   is not.  (This is in addition to the fact that the
9150                   configuration file may not even be present in the
9151                   latter scenario.)
9152               </item>
9153             </enumlist>
9154           </p>
9155
9156           <p>
9157             Sometimes it's appropriate to create a new package which
9158             provides the basic infrastructure for the other packages
9159             and which manages the shared configuration files.  (The
9160             <tt>sgml-base</tt> package is a good example.)
9161           </p>
9162
9163           <p>
9164             If the configuration file cannot be shared as described above,
9165             the packages must be marked as conflicting with each other.
9166             Two packages that specify the same file as
9167             a <tt>conffile</tt> must conflict.  This is an instance of the
9168             general rule about not sharing files.  Neither alternatives
9169             nor diversions are likely to be appropriate in this case; in
9170             particular, <prgn>dpkg</prgn> does not handle diverted
9171             <tt>conffile</tt>s well.
9172           </p>
9173
9174           <p>
9175             When two packages both declare the same <tt>conffile</tt>, they
9176             may see left-over configuration files from each other even
9177             though they conflict with each other.  If a user removes
9178             (without purging) one of the packages and installs the other,
9179             the new package will take over the <tt>conffile</tt> from the
9180             old package.  If the file was modified by the user, it will be
9181             treated the same as any other locally
9182             modified <tt>conffile</tt> during an upgrade.
9183           </p>
9184
9185           <p>
9186             The maintainer scripts must not alter a <tt>conffile</tt>
9187             of <em>any</em> package, including the one the scripts
9188             belong to.
9189           </p>
9190         </sect1>
9191
9192         <sect1>
9193           <heading>User configuration files ("dotfiles")</heading>
9194
9195           <p>
9196             The files in <file>/etc/skel</file> will automatically be
9197             copied into new user accounts by <prgn>adduser</prgn>.
9198             No other program should reference the files in
9199             <file>/etc/skel</file>.
9200           </p>
9201
9202           <p>
9203             Therefore, if a program needs a dotfile to exist in
9204             advance in <file>$HOME</file> to work sensibly, that dotfile
9205             should be installed in <file>/etc/skel</file> and treated as a
9206             configuration file.
9207           </p>
9208
9209           <p>
9210             However, programs that require dotfiles in order to
9211             operate sensibly are a bad thing, unless they do create
9212             the dotfiles themselves automatically.
9213           </p>
9214
9215           <p>
9216             Furthermore, programs should be configured by the Debian
9217             default installation to behave as closely to the upstream
9218             default behavior as possible.
9219           </p>
9220
9221           <p>
9222             Therefore, if a program in a Debian package needs to be
9223             configured in some way in order to operate sensibly, that
9224             should be done using a site-wide configuration file placed
9225             in <file>/etc</file>.  Only if the program doesn't support a
9226             site-wide default configuration and the package maintainer
9227             doesn't have time to add it may a default per-user file be
9228             placed in <file>/etc/skel</file>.
9229           </p>
9230
9231           <p>
9232             <file>/etc/skel</file> should be as empty as we can make it.
9233             This is particularly true because there is no easy (or
9234             necessarily desirable) mechanism for ensuring that the
9235             appropriate dotfiles are copied into the accounts of
9236             existing users when a package is installed.
9237           </p>
9238         </sect1>
9239       </sect>
9240
9241       <sect>
9242         <heading>Log files</heading>
9243         <p>
9244           Log files should usually be named
9245           <file>/var/log/<var>package</var>.log</file>.  If you have many
9246           log files, or need a separate directory for permission
9247           reasons (<file>/var/log</file> is writable only by
9248           <file>root</file>), you should usually create a directory named
9249           <file>/var/log/<var>package</var></file> and place your log
9250           files there.
9251         </p>
9252
9253         <p>
9254           Log files must be rotated occasionally so that they don't grow
9255           indefinitely.  The best way to do this is to install a log
9256           rotation configuration file in the
9257           directory <file>/etc/logrotate.d</file>, normally
9258           named <file>/etc/logrotate.d/<var>package</var></file>, and use
9259           the facilities provided by <prgn>logrotate</prgn>.
9260           <footnote>
9261             <p>
9262               The traditional approach to log files has been to set up
9263               <em>ad hoc</em> log rotation schemes using simple shell
9264               scripts and cron.  While this approach is highly
9265               customizable, it requires quite a lot of sysadmin work.
9266               Even though the original Debian system helped a little
9267               by automatically installing a system which can be used
9268               as a template, this was deemed not enough.
9269             </p>
9270
9271             <p>
9272               The use of <prgn>logrotate</prgn>, a program developed
9273               by Red Hat, is better, as it centralizes log management.
9274               It has both a configuration file
9275               (<file>/etc/logrotate.conf</file>) and a directory where
9276               packages can drop their individual log rotation
9277               configurations (<file>/etc/logrotate.d</file>).
9278             </p>
9279           </footnote>
9280           Here is a good example for a logrotate config
9281           file (for more information see <manref name="logrotate"
9282             section="8">):
9283           <example compact="compact">
9284 /var/log/foo/*.log {
9285     rotate 12
9286     weekly
9287     compress
9288     missingok
9289     postrotate
9290         start-stop-daemon -K -p /var/run/foo.pid -s HUP -x /usr/sbin/foo -q
9291     endscript
9292 }
9293           </example>
9294           This rotates all files under <file>/var/log/foo</file>, saves 12
9295           compressed generations, and tells the daemon to reopen its log
9296           files after the log rotation.  It skips this log rotation
9297           (via <tt>missingok</tt>) if no such log file is present, which
9298           avoids errors if the package is removed but not purged.
9299         </p>
9300
9301         <p>
9302           Log files should be removed when the package is
9303           purged (but not when it is only removed).  This should be
9304           done by the <prgn>postrm</prgn> script when it is called
9305           with the argument <tt>purge</tt> (see <ref
9306           id="removedetails">).
9307         </p>
9308       </sect>
9309
9310       <sect id="permissions-owners">
9311         <heading>Permissions and owners</heading>
9312
9313         <p>
9314           The rules in this section are guidelines for general use.
9315           If necessary you may deviate from the details below.
9316           However, if you do so you must make sure that what is done
9317           is secure and you should try to be as consistent as possible
9318           with the rest of the system.  You should probably also
9319           discuss it on <prgn>debian-devel</prgn> first.
9320         </p>
9321
9322         <p>
9323           Files should be owned by <tt>root:root</tt>, and made
9324           writable only by the owner and universally readable (and
9325           executable, if appropriate), that is mode 644 or 755.
9326         </p>
9327
9328         <p>
9329           Directories should be mode 755 or (for group-writability)
9330           mode 2775.  The ownership of the directory should be
9331           consistent with its mode: if a directory is mode 2775, it
9332           should be owned by the group that needs write access to
9333           it.<footnote>
9334             <p>
9335               When a package is upgraded, and the owner or permissions
9336               of a file included in the package has changed, dpkg
9337               arranges for the ownership and permissions to be
9338               correctly set upon installation. However, this does not
9339               extend to directories; the permissions and ownership of
9340               directories already on the system does not change on
9341               install or upgrade of packages.  This makes sense, since
9342               otherwise common directories like <tt>/usr</tt> would
9343               always be in flux.  To correctly change permissions of a
9344               directory the package owns, explicit action is required,
9345               usually in the <tt>postinst</tt> script. Care must be
9346               taken to handle downgrades as well, in that case.
9347             </p>
9348           </footnote>
9349         </p>
9350
9351         <p>
9352           Control information files should be owned by <tt>root:root</tt>
9353           and either mode 644 (for most files) or mode 755 (for
9354           executables such as <qref id="maintscripts">maintainer
9355           scripts</qref>).
9356         </p>
9357
9358         <p>
9359           Setuid and setgid executables should be mode 4755 or 2755
9360           respectively, and owned by the appropriate user or group.
9361           They should not be made unreadable (modes like 4711 or
9362           2711 or even 4111); doing so achieves no extra security,
9363           because anyone can find the binary in the freely available
9364           Debian package; it is merely inconvenient.  For the same
9365           reason you should not restrict read or execute permissions
9366           on non-set-id executables.
9367         </p>
9368
9369         <p>
9370           Some setuid programs need to be restricted to particular
9371           sets of users, using file permissions.  In this case they
9372           should be owned by the uid to which they are set-id, and by
9373           the group which should be allowed to execute them.  They
9374           should have mode 4754; again there is no point in making
9375           them unreadable to those users who must not be allowed to
9376           execute them.
9377         </p>
9378
9379         <p>
9380           It is possible to arrange that the system administrator can
9381           reconfigure the package to correspond to their local
9382           security policy by changing the permissions on a binary:
9383           they can do this by using <prgn>dpkg-statoverride</prgn>, as
9384           described below.<footnote>
9385             Ordinary files installed by <prgn>dpkg</prgn> (as
9386             opposed to <tt>conffile</tt>s and other similar objects)
9387             normally have their permissions reset to the distributed
9388             permissions when the package is reinstalled.  However,
9389             the use of <prgn>dpkg-statoverride</prgn> overrides this
9390             default behavior.
9391           </footnote>
9392           Another method you should consider is to create a group for
9393           people allowed to use the program(s) and make any setuid
9394           executables executable only by that group.
9395         </p>
9396
9397         <p>
9398           If you need to create a new user or group for your package
9399           there are two possibilities.  Firstly, you may need to
9400           make some files in the binary package be owned by this
9401           user or group, or you may need to compile the user or
9402           group id (rather than just the name) into the binary
9403           (though this latter should be avoided if possible, as in
9404           this case you need a statically allocated id).</p>
9405
9406         <p>
9407           If you need a statically allocated id, you must ask for a
9408           user or group id from the <tt>base-passwd</tt> maintainer,
9409           and must not release the package until you have been
9410           allocated one.  Once you have been allocated one you must
9411           either make the package depend on a version of the
9412           <tt>base-passwd</tt> package with the id present in
9413           <file>/etc/passwd</file> or <file>/etc/group</file>, or arrange for
9414           your package to create the user or group itself with the
9415           correct id (using <tt>adduser</tt>) in its
9416           <prgn>preinst</prgn> or <prgn>postinst</prgn>.  (Doing it in
9417           the <prgn>postinst</prgn> is to be preferred if it is
9418           possible, otherwise a pre-dependency will be needed on the
9419           <tt>adduser</tt> package.)
9420         </p>
9421
9422         <p>
9423           On the other hand, the program might be able to determine
9424           the uid or gid from the user or group name at runtime, so
9425           that a dynamically allocated id can be used.  In this case
9426           you should choose an appropriate user or group name,
9427           discussing this on <prgn>debian-devel</prgn> and checking
9428           with the <package/base-passwd/ maintainer that it is unique and that
9429           they do not wish you to use a statically allocated id
9430           instead.  When this has been checked you must arrange for
9431           your package to create the user or group if necessary using
9432           <prgn>adduser</prgn> in the <prgn>preinst</prgn> or
9433           <prgn>postinst</prgn> script (again, the latter is to be
9434           preferred if it is possible).
9435         </p>
9436
9437         <p>
9438           Note that changing the numeric value of an id associated
9439           with a name is very difficult, and involves searching the
9440           file system for all appropriate files.  You need to think
9441           carefully whether a static or dynamic id is required, since
9442           changing your mind later will cause problems.
9443         </p>
9444
9445         <sect1><heading>The use of <prgn>dpkg-statoverride</prgn></heading>
9446           <p>
9447             This section is not intended as policy, but as a
9448             description of the use of <prgn>dpkg-statoverride</prgn>.
9449           </p>
9450
9451           <p>
9452             If a system administrator wishes to have a file (or
9453             directory or other such thing) installed with owner and
9454             permissions different from those in the distributed Debian
9455             package, they can use the <prgn>dpkg-statoverride</prgn>
9456             program to instruct <prgn>dpkg</prgn> to use the different
9457             settings every time the file is installed.  Thus the
9458             package maintainer should distribute the files with their
9459             normal permissions, and leave it for the system
9460             administrator to make any desired changes.  For example, a
9461             daemon which is normally required to be setuid root, but
9462             in certain situations could be used without being setuid,
9463             should be installed setuid in the <tt>.deb</tt>.  Then the
9464             local system administrator can change this if they wish.
9465             If there are two standard ways of doing it, the package
9466             maintainer can use <tt>debconf</tt> to find out the
9467             preference, and call <prgn>dpkg-statoverride</prgn> in the
9468             maintainer script if necessary to accommodate the system
9469             administrator's choice. Care must be taken during
9470             upgrades to not override an existing setting.
9471           </p>
9472
9473           <p>
9474             Given the above, <prgn>dpkg-statoverride</prgn> is
9475             essentially a tool for system administrators and would not
9476             normally be needed in the maintainer scripts.  There is
9477             one type of situation, though, where calls to
9478             <prgn>dpkg-statoverride</prgn> would be needed in the
9479             maintainer scripts, and that involves packages which use
9480             dynamically allocated user or group ids.  In such a
9481             situation, something like the following idiom can be very
9482             helpful in the package's <prgn>postinst</prgn>, where
9483             <tt>sysuser</tt> is a dynamically allocated id:
9484             <example>
9485 for i in /usr/bin/foo /usr/sbin/bar
9486 do
9487   # only do something when no setting exists
9488   if ! dpkg-statoverride --list $i >/dev/null 2>&1
9489   then
9490     #include: debconf processing, question about foo and bar
9491     if [ "$RET" = "true" ] ; then
9492       dpkg-statoverride --update --add sysuser root 4755 $i
9493     fi
9494   fi
9495 done
9496             </example>
9497             The corresponding code to remove the override when the package
9498             is purged would be:
9499             <example>
9500 for i in /usr/bin/foo /usr/sbin/bar
9501 do
9502   if dpkg-statoverride --list $i >/dev/null 2>&1
9503   then
9504     dpkg-statoverride --remove $i
9505   fi
9506 done
9507             </example>
9508           </p>
9509         </sect1>
9510       </sect>
9511
9512       <sect id="filenames">
9513         <heading>File names</heading>
9514
9515         <p>
9516           The name of the files installed by binary packages in the system PATH
9517           (namely <tt>/bin</tt>, <tt>/sbin</tt>, <tt>/usr/bin</tt>,
9518           <tt>/usr/sbin</tt> and <tt>/usr/games</tt>) must be encoded in
9519           ASCII.
9520         </p>
9521
9522         <p>
9523           The name of the files and directories installed by binary packages
9524           outside the system PATH must be encoded in UTF-8 and should be
9525           restricted to ASCII when it is possible to do so.
9526         </p>
9527       </sect>
9528     </chapt>
9529
9530
9531     <chapt id="customized-programs">
9532       <heading>Customized programs</heading>
9533
9534       <sect id="arch-spec">
9535         <heading>Architecture specification strings</heading>
9536
9537         <p>
9538           If a program needs to specify an <em>architecture specification
9539           string</em> in some place, it should select one of the strings
9540           provided by <tt>dpkg-architecture -L</tt>. The strings are in
9541           the format <tt><var>os</var>-<var>arch</var></tt>, though the OS
9542           part is sometimes elided, as when the OS is Linux.
9543         </p>
9544
9545         <p>
9546           Note that we don't want to use
9547           <tt><var>arch</var>-debian-linux</tt> to apply to the rule
9548           <tt><var>architecture</var>-<var>vendor</var>-<var>os</var></tt>
9549           since this would make our programs incompatible with other
9550           Linux distributions.  We also don't use something like
9551           <tt><var>arch</var>-unknown-linux</tt>, since the
9552           <tt>unknown</tt> does not look very good.
9553         </p>
9554
9555         <sect1 id="arch-wildcard-spec">
9556           <heading>Architecture wildcards</heading>
9557
9558           <p>
9559             A package may specify an architecture wildcard. Architecture
9560             wildcards are in the format <tt>any</tt> (which matches every
9561             architecture), <tt><var>os</var></tt>-any, or
9562             any-<tt><var>cpu</var></tt>. <footnote>
9563               Internally, the package system normalizes the GNU triplets
9564               and the Debian arches into Debian arch triplets (which are
9565               kind of inverted GNU triplets), with the first component of
9566               the triplet representing the libc and ABI in use, and then
9567               does matching against those triplets.  However, such
9568               triplets are an internal implementation detail that should
9569               not be used by packages directly.  The libc and ABI portion
9570               is handled internally by the package system based on
9571               the <var>os</var> and <var>cpu</var>.
9572             </footnote>
9573           </p>
9574         </sect1>
9575       </sect>
9576
9577       <sect>
9578         <heading>Daemons</heading>
9579
9580         <p>
9581           The configuration files <file>/etc/services</file>,
9582           <file>/etc/protocols</file>, and <file>/etc/rpc</file> are managed
9583           by the <prgn>netbase</prgn> package and must not be modified
9584           by other packages.
9585         </p>
9586
9587         <p>
9588           If a package requires a new entry in one of these files, the
9589           maintainer should get in contact with the
9590           <prgn>netbase</prgn> maintainer, who will add the entries
9591           and release a new version of the <prgn>netbase</prgn>
9592           package.
9593         </p>
9594
9595         <p>
9596           The configuration file <file>/etc/inetd.conf</file> must not be
9597           modified by the package's scripts except via the
9598           <prgn>update-inetd</prgn> script or the
9599           <file>DebianNet.pm</file> Perl module.  See their documentation
9600           for details on how to add entries.
9601         </p>
9602
9603         <p>
9604           If a package wants to install an example entry into
9605           <file>/etc/inetd.conf</file>, the entry must be preceded with
9606           exactly one hash character (<tt>#</tt>). Such lines are
9607           treated as "commented out by user" by the
9608           <prgn>update-inetd</prgn> script and are not changed or
9609           activated during package updates.
9610         </p>
9611       </sect>
9612
9613       <sect>
9614         <heading>Using pseudo-ttys and modifying wtmp, utmp and
9615         lastlog</heading>
9616
9617         <p>
9618           Some programs need to create pseudo-ttys. This should be done
9619           using Unix98 ptys if the C library supports it. The resulting
9620           program must not be installed setuid root, unless that
9621           is required for other functionality.
9622         </p>
9623
9624         <p>
9625           The files <file>/var/run/utmp</file>, <file>/var/log/wtmp</file> and
9626           <file>/var/log/lastlog</file> must be installed writable by
9627           group <tt>utmp</tt>.  Programs which need to modify those
9628           files must be installed setgid <tt>utmp</tt>.
9629         </p>
9630       </sect>
9631
9632       <sect>
9633         <heading>Editors and pagers</heading>
9634
9635         <p>
9636           Some programs have the ability to launch an editor or pager
9637           program to edit or display a text document.  Since there are
9638           lots of different editors and pagers available in the Debian
9639           distribution, the system administrator and each user should
9640           have the possibility to choose their preferred editor and
9641           pager.
9642         </p>
9643
9644         <p>
9645           In addition, every program should choose a good default
9646           editor/pager if none is selected by the user or system
9647           administrator.
9648         </p>
9649
9650         <p>
9651           Thus, every program that launches an editor or pager must
9652           use the EDITOR or PAGER environment variable to determine
9653           the editor or pager the user wishes to use.  If these
9654           variables are not set, the programs <file>/usr/bin/editor</file>
9655           and <file>/usr/bin/pager</file> should be used, respectively.
9656         </p>
9657
9658         <p>
9659           These two files are managed through the <prgn>dpkg</prgn>
9660           "alternatives" mechanism.  Every package providing an editor or
9661           pager must call the <prgn>update-alternatives</prgn> script to
9662           register as an alternative for <file>/usr/bin/editor</file>
9663           or <file>/usr/bin/pager</file> as appropriate.  The alternative
9664           should have a slave alternative
9665           for <file>/usr/share/man/man1/editor.1.gz</file>
9666           or <file>/usr/share/man/man1/pager.1.gz</file> pointing to the
9667           corresponding manual page.
9668         </p>
9669
9670         <p>
9671           If it is very hard to adapt a program to make use of the
9672           EDITOR or PAGER variables, that program may be configured to
9673           use <file>/usr/bin/sensible-editor</file> and
9674           <file>/usr/bin/sensible-pager</file> as the editor or pager
9675           program respectively.  These are two scripts provided in the
9676           <package>sensible-utils</package> package that check the EDITOR
9677           and PAGER variables and launch the appropriate program, and fall
9678           back to <file>/usr/bin/editor</file>
9679           and <file>/usr/bin/pager</file> if the variable is not set.
9680         </p>
9681
9682         <p>
9683           A program may also use the VISUAL environment variable to
9684           determine the user's choice of editor.  If it exists, it
9685           should take precedence over EDITOR.  This is in fact what
9686           <file>/usr/bin/sensible-editor</file> does.
9687         </p>
9688
9689         <p>
9690           It is not required for a package to depend on
9691           <tt>editor</tt> and <tt>pager</tt>, nor is it required for a
9692           package to provide such virtual packages.<footnote>
9693               The Debian base system already provides an editor and a
9694               pager program.
9695           </footnote>
9696         </p>
9697       </sect>
9698
9699       <sect id="web-appl">
9700         <heading>Web servers and applications</heading>
9701
9702         <p>
9703           This section describes the locations and URLs that should
9704           be used by all web servers and web applications in the
9705           Debian system.
9706         </p>
9707
9708         <p>
9709           <enumlist>
9710             <item>
9711                 Cgi-bin executable files are installed in the
9712                 directory
9713                 <example compact="compact">
9714 /usr/lib/cgi-bin
9715                 </example>
9716                 or a subdirectory of that directory, and the script
9717                 <example compact="compact">
9718 /usr/lib/cgi-bin/.../<var>cgi-bin-name</var>
9719                 </example>
9720                 should be referred to as
9721                 <example compact="compact">
9722 http://localhost/cgi-bin/.../<var>cgi-bin-name</var>
9723                 </example>
9724             </item>
9725
9726             <item>
9727               <p>(Deleted)</p>
9728             </item>
9729
9730             <item>
9731               <p>Access to images</p>
9732               <p>
9733                 It is recommended that images for a package be stored
9734                 in <tt>/usr/share/images/<var>package</var></tt> and
9735                 may be referred to through an alias <tt>/images/</tt>
9736                 as
9737                 <example>
9738                   http://localhost/images/&lt;package&gt;/&lt;filename&gt;     
9739                 </example>
9740                 
9741               </p>
9742             </item>
9743
9744             <item>
9745               <p>Web Document Root</p>
9746
9747               <p>
9748                 Web Applications should try to avoid storing files in
9749                 the Web Document Root.  Instead they should use the
9750                 /usr/share/doc/<var>package</var> directory for
9751                 documents and register the Web Application via the
9752                 <package>doc-base</package> package.  If access to the
9753                 web document root is unavoidable then use
9754                 <example compact="compact">
9755 /var/www
9756                 </example>
9757                 as the Document Root.  This might be just a symbolic
9758                 link to the location where the system administrator
9759                 has put the real document root.
9760               </p>
9761             </item>
9762             <item><p>Providing httpd and/or httpd-cgi</p>
9763               <p>
9764                 All web servers should provide the virtual package
9765                 <tt>httpd</tt>. If a web server has CGI support it should
9766                 provide <tt>httpd-cgi</tt> additionally.
9767               </p>
9768               <p>
9769                 All web applications which do not contain CGI scripts should
9770                 depend on <tt>httpd</tt>, all those web applications which
9771                 <tt>do</tt> contain CGI scripts, should depend on
9772                 <tt>httpd-cgi</tt>.
9773               </p>
9774             </item>
9775           </enumlist>
9776         </p>
9777       </sect>
9778
9779       <sect id="mail-transport-agents">
9780         <heading>Mail transport, delivery and user agents</heading>
9781
9782         <p>
9783           Debian packages which process electronic mail, whether mail
9784           user agents (MUAs) or mail transport agents (MTAs), must
9785           ensure that they are compatible with the configuration
9786           decisions below.  Failure to do this may result in lost
9787           mail, broken <tt>From:</tt> lines, and other serious brain
9788           damage!
9789         </p>
9790
9791         <p>
9792           The mail spool is <file>/var/mail</file> and the interface to
9793           send a mail message is <file>/usr/sbin/sendmail</file> (as per
9794           the FHS).  On older systems, the mail spool may be
9795           physically located in <file>/var/spool/mail</file>, but all
9796           access to the mail spool should be via the
9797           <file>/var/mail</file> symlink.  The mail spool is part of the
9798           base system and not part of the MTA package.
9799         </p>
9800
9801         <p>
9802           All Debian MUAs, MTAs, MDAs and other mailbox accessing
9803           programs (such as IMAP daemons) must lock the mailbox in an
9804           NFS-safe way. This means that <tt>fcntl()</tt> locking must
9805           be combined with dot locking.  To avoid deadlocks, a program
9806           should use <tt>fcntl()</tt> first and dot locking after
9807           this, or alternatively implement the two locking methods in
9808           a non blocking way<footnote>
9809               If it is not possible to establish both locks, the
9810               system shouldn't wait for the second lock to be
9811               established, but remove the first lock, wait a (random)
9812               time, and start over locking again.
9813           </footnote>. Using the functions <tt>maillock</tt> and
9814           <tt>mailunlock</tt> provided by the
9815           <tt>liblockfile*</tt><footnote>
9816               You will need to depend on <tt>liblockfile1 (&gt;&gt;1.01)</tt>
9817               to use these functions.
9818           </footnote> packages is the recommended way to realize this.
9819         </p>
9820
9821         <p>
9822           Mailboxes are generally either mode 600 and owned by
9823           <var>user</var> or mode 660 and owned by
9824           <tt><var>user</var>:mail</tt><footnote>
9825             There are two traditional permission schemes for mail spools:
9826             mode 600 with all mail delivery done by processes running as
9827             the destination user, or mode 660 and owned by group mail with
9828             mail delivery done by a process running as a system user in
9829             group mail.  Historically, Debian required mode 660 mail
9830             spools to enable the latter model, but that model has become
9831             increasingly uncommon and the principle of least privilege
9832             indicates that mail systems that use the first model should
9833             use permissions of 600.  If delivery to programs is permitted,
9834             it's easier to keep the mail system secure if the delivery
9835             agent runs as the destination user.  Debian Policy therefore
9836             permits either scheme.
9837           </footnote>. The local system administrator may choose a
9838           different permission scheme; packages should not make
9839           assumptions about the permission and ownership of mailboxes
9840           unless required (such as when creating a new mailbox).  A MUA
9841           may remove a mailbox (unless it has nonstandard permissions) in
9842           which case the MTA or another MUA must recreate it if needed.
9843         </p>
9844
9845         <p>
9846           The mail spool is 2775 <tt>root:mail</tt>, and MUAs should
9847           be setgid mail to do the locking mentioned above (and
9848           must obviously avoid accessing other users' mailboxes
9849           using this privilege).</p>
9850
9851         <p>
9852           <file>/etc/aliases</file> is the source file for the system mail
9853           aliases (e.g., postmaster, usenet, etc.), it is the one
9854           which the sysadmin and <prgn>postinst</prgn> scripts may
9855           edit.  After <file>/etc/aliases</file> is edited the program or
9856           human editing it must call <prgn>newaliases</prgn>.  All MTA
9857           packages must come with a <prgn>newaliases</prgn> program,
9858           even if it does nothing, but older MTA packages did not do
9859           this so programs should not fail if <prgn>newaliases</prgn>
9860           cannot be found.  Note that because of this, all MTA
9861           packages must have <tt>Provides</tt>, <tt>Conflicts</tt> and
9862           <tt>Replaces: mail-transport-agent</tt> control fields.
9863         </p>
9864
9865         <p>
9866           The convention of writing <tt>forward to
9867             <var>address</var></tt> in the mailbox itself is not
9868           supported.  Use a <tt>.forward</tt> file instead.</p>
9869
9870         <p>
9871           The <prgn>rmail</prgn> program used by UUCP
9872           for incoming mail should be  <file>/usr/sbin/rmail</file>.
9873           Likewise, <prgn>rsmtp</prgn>, for receiving
9874           batch-SMTP-over-UUCP, should be <file>/usr/sbin/rsmtp</file> if it
9875           is supported.</p>
9876
9877         <p>
9878           If your package needs to know what hostname to use on (for
9879           example) outgoing news and mail messages which are generated
9880           locally, you should use the file <file>/etc/mailname</file>.  It
9881           will contain the portion after the username and <tt>@</tt>
9882           (at) sign for email addresses of users on the machine
9883           (followed by a newline).
9884         </p>
9885
9886         <p>
9887           Such a package should check for the existence of this file
9888           when it is being configured.  If it exists, it should be
9889           used without comment, although an MTA's configuration script
9890           may wish to prompt the user even if it finds that this file
9891           exists.  If the file does not exist, the package should
9892           prompt the user for the value (preferably using
9893           <prgn>debconf</prgn>) and store it in <file>/etc/mailname</file>
9894           as well as using it in the package's configuration.  The
9895           prompt should make it clear that the name will not just be
9896           used by that package.  For example, in this situation the
9897           <tt>inn</tt> package could say something like:
9898           <example compact="compact">
9899 Please enter the "mail name" of your system.  This is the
9900 hostname portion of the address to be shown on outgoing
9901 news and mail messages.  The default is
9902 <var>syshostname</var>, your system's host name.  Mail
9903 name ["<var>syshostname</var>"]:
9904           </example>
9905           where <var>syshostname</var> is the output of <tt>hostname
9906             --fqdn</tt>.
9907         </p>
9908       </sect>
9909
9910       <sect>
9911         <heading>News system configuration</heading>
9912
9913         <p>
9914           All the configuration files related to the NNTP (news)
9915           servers and clients should be located under
9916           <file>/etc/news</file>.</p>
9917
9918         <p>
9919           There are some configuration issues that apply to a number
9920           of news clients and server packages on the machine. These
9921           are:
9922
9923           <taglist>
9924             <tag><file>/etc/news/organization</file></tag>
9925             <item>
9926                 A string which should appear as the
9927                 organization header for all messages posted
9928                 by NNTP clients on the machine
9929             </item>
9930
9931             <tag><file>/etc/news/server</file></tag>
9932             <item>
9933                 Contains the FQDN of the upstream NNTP
9934                 server, or localhost if the local machine is
9935                 an NNTP server.
9936             </item>
9937           </taglist>
9938
9939           Other global files may be added as required for cross-package news
9940           configuration.
9941         </p>
9942       </sect>
9943
9944
9945       <sect>
9946         <heading>Programs for the X Window System</heading>
9947
9948         <sect1>
9949           <heading>Providing X support and package priorities</heading>
9950
9951           <p>
9952             Programs that can be configured with support for the X
9953             Window System must be configured to do so and must declare
9954             any package dependencies necessary to satisfy their
9955             runtime requirements when using the X Window System.  If
9956             such a package is of higher priority than the X packages
9957             on which it depends, it is required that either the
9958             X-specific components be split into a separate package, or
9959             that an alternative version of the package, which includes
9960             X support, be provided, or that the package's priority be
9961             lowered.
9962           </p>
9963         </sect1>
9964
9965         <sect1>
9966           <heading>Packages providing an X server</heading>
9967
9968           <p>
9969             Packages that provide an X server that, directly or
9970             indirectly, communicates with real input and display
9971             hardware should declare in their <tt>Provides</tt> control
9972             field that they provide the virtual
9973             package <tt>xserver</tt>.<footnote>
9974                 This implements current practice, and provides an
9975                 actual policy for usage of the <tt>xserver</tt>
9976                 virtual package which appears in the virtual packages
9977                 list.  In a nutshell, X servers that interface
9978                 directly with the display and input hardware or via
9979                 another subsystem (e.g., GGI) should provide
9980                 <tt>xserver</tt>.  Things like <tt>Xvfb</tt>,
9981                 <tt>Xnest</tt>, and <tt>Xprt</tt> should not.
9982             </footnote>
9983           </p>
9984         </sect1>
9985
9986         <sect1>
9987           <heading>Packages providing a terminal emulator</heading>
9988
9989           <p>
9990             Packages that provide a terminal emulator for the X Window
9991             System which meet the criteria listed below should declare in
9992             their <tt>Provides</tt> control field that they provide the
9993             virtual package <tt>x-terminal-emulator</tt>.  They should
9994             also register themselves as an alternative for
9995             <file>/usr/bin/x-terminal-emulator</file>, with a priority of
9996             20.  That alternative should have a slave alternative
9997             for <file>/usr/share/man/man1/x-terminal-emulator.1.gz</file>
9998             pointing to the corresponding manual page.
9999           </p>
10000
10001           <p>
10002             To be an <tt>x-terminal-emulator</tt>, a program must:
10003             <list compact="compact">
10004               <item>
10005                   Be able to emulate a DEC VT100 terminal, or a
10006                   compatible terminal.
10007               </item>
10008
10009               <item>
10010                   Support the command-line option <tt>-e
10011                     <var>command</var></tt>, which creates a new
10012                   terminal window<footnote>
10013                       "New terminal window" does not necessarily mean
10014                       a new top-level X window directly parented by
10015                       the window manager; it could, if the terminal
10016                       emulator application were so coded, be a new
10017                       "view" in a multiple-document interface (MDI).
10018                   </footnote>
10019                   and runs the specified <var>command</var>,
10020                   interpreting the entirety of the rest of the command
10021                   line as a command to pass straight to exec, in the
10022                   manner that <tt>xterm</tt> does.
10023               </item>
10024
10025               <item>
10026                   Support the command-line option <tt>-T
10027                     <var>title</var></tt>, which creates a new terminal
10028                   window with the window title <var>title</var>.
10029               </item>
10030             </list>
10031           </p>
10032         </sect1>
10033
10034         <sect1>
10035           <heading>Packages providing a window manager</heading>
10036
10037           <p>
10038             Packages that provide a window manager should declare in
10039             their <tt>Provides</tt> control field that they provide the
10040             virtual package <tt>x-window-manager</tt>.  They should also
10041             register themselves as an alternative for
10042             <file>/usr/bin/x-window-manager</file>, with a priority
10043             calculated as follows:
10044             <list compact="compact">
10045               <item>
10046                   Start with a priority of 20.
10047               </item>
10048
10049               <item>
10050                   If the window manager supports the Debian menu
10051                   system, add 20 points if this support is available
10052                   in the package's default configuration (i.e., no
10053                   configuration files belonging to the system or user
10054                   have to be edited to activate the feature); if
10055                   configuration files must be modified, add only 10
10056                   points.
10057                 </p>
10058               </item>
10059
10060               <item>
10061                   If the window manager complies with <url
10062                     id="http://www.freedesktop.org/wiki/Specifications/wm-spec"
10063                     name="The Window Manager Specification Project">,
10064                   written by the <url id="http://www.freedesktop.org/wiki/"
10065                     name="Free Desktop Group">, add 40 points.
10066               </item>
10067
10068               <item>
10069                   If the window manager permits the X session to be
10070                   restarted using a <em>different</em> window manager
10071                   (without killing the X server) in its default
10072                   configuration, add 10 points; otherwise add none.
10073               </item>
10074             </list>
10075             That alternative should have a slave alternative
10076             for <file>/usr/share/man/man1/x-window-manager.1.gz</file>
10077             pointing to the corresponding manual page.
10078           </p>
10079         </sect1>
10080
10081         <sect1>
10082           <heading>Packages providing fonts</heading>
10083
10084           <p>
10085             Packages that provide fonts for the X Window
10086             System<footnote>
10087                 For the purposes of Debian Policy, a "font for the X
10088                 Window System" is one which is accessed via X protocol
10089                 requests.  Fonts for the Linux console, for PostScript
10090                 renderer, or any other purpose, do not fit this
10091                 definition.  Any tool which makes such fonts available
10092                 to the X Window System, however, must abide by this
10093                 font policy.
10094             </footnote>
10095             must do a number of things to ensure that they are both
10096             available without modification of the X or font server
10097             configuration, and that they do not corrupt files used by
10098             other font packages to register information about
10099             themselves.
10100             <enumlist>
10101               <item>
10102                   Fonts of any type supported by the X Window System
10103                   must be in a separate binary package from any
10104                   executables, libraries, or documentation (except
10105                   that specific to the fonts shipped, such as their
10106                   license information).  If one or more of the fonts
10107                   so packaged are necessary for proper operation of
10108                   the package with which they are associated the font
10109                   package may be Recommended; if the fonts merely
10110                   provide an enhancement, a Suggests relationship may
10111                   be used.  Packages must not Depend on font
10112                   packages.<footnote>
10113                       This is because the X server may retrieve fonts
10114                       from the local file system or over the network
10115                       from an X font server; the Debian package system
10116                       is empowered to deal only with the local
10117                       file system.
10118                   </footnote>
10119               </item>
10120
10121               <item>
10122                   BDF fonts must be converted to PCF fonts with the
10123                   <prgn>bdftopcf</prgn> utility (available in the
10124                   <tt>xfonts-utils</tt> package, <prgn>gzip</prgn>ped, and
10125                   placed in a directory that corresponds to their
10126                   resolution:
10127                   <list compact="compact">
10128                     <item>
10129                         100 dpi fonts must be placed in
10130                         <file>/usr/share/fonts/X11/100dpi/</file>.
10131                     </item>
10132
10133                     <item>
10134                         75 dpi fonts must be placed in
10135                         <file>/usr/share/fonts/X11/75dpi/</file>.
10136                     </item>
10137
10138                     <item>
10139                         Character-cell fonts, cursor fonts, and other
10140                         low-resolution fonts must be placed in
10141                         <file>/usr/share/fonts/X11/misc/</file>.
10142                     </item>
10143                   </list>
10144               </item>
10145
10146               <item>
10147                   Type 1 fonts must be placed in
10148                   <file>/usr/share/fonts/X11/Type1/</file>.  If font
10149                   metric files are available, they must be placed here
10150                   as well.
10151               </item>
10152
10153               <item>
10154                   Subdirectories of <file>/usr/share/fonts/X11/</file>
10155                   other than those listed above must be neither
10156                   created nor used.  (The <file>PEX</file>, <file>CID</file>,
10157                   <file>Speedo</file>, and <file>cyrillic</file> directories
10158                   are excepted for historical reasons, but installation of
10159                   files into these directories remains discouraged.)
10160               </item>
10161
10162               <item>
10163                   Font packages may, instead of placing files directly
10164                   in the X font directories listed above, provide
10165                   symbolic links in that font directory pointing to
10166                   the files' actual location in the filesystem.  Such
10167                   a location must comply with the FHS.
10168               </item>
10169
10170               <item>
10171                   Font packages should not contain both 75dpi and
10172                   100dpi versions of a font.  If both are available,
10173                   they should be provided in separate binary packages
10174                   with <tt>-75dpi</tt> or <tt>-100dpi</tt> appended to
10175                   the names of the packages containing the
10176                   corresponding fonts.
10177               </item>
10178
10179               <item>
10180                   Fonts destined for the <file>misc</file> subdirectory
10181                   should not be included in the same package as 75dpi
10182                   or 100dpi fonts; instead, they should be provided in
10183                   a separate package with <tt>-misc</tt> appended to
10184                   its name.
10185               </item>
10186
10187               <item>
10188                   Font packages must not provide the files
10189                   <file>fonts.dir</file>, <file>fonts.alias</file>, or
10190                   <file>fonts.scale</file> in a font directory:
10191                   <list>
10192                     <item>
10193                         <file>fonts.dir</file> files must not be provided at all.
10194                     </item>
10195
10196                     <item>
10197                         <file>fonts.alias</file> and <file>fonts.scale</file>
10198                         files, if needed, should be provided in the
10199                         directory
10200                         <file>/etc/X11/fonts/<var>fontdir</var>/<var>package</var>.<var>extension</var></file>,
10201                         where <var>fontdir</var> is the name of the
10202                         subdirectory of
10203                         <file>/usr/share/fonts/X11/</file> where the
10204                         package's corresponding fonts are stored
10205                         (e.g., <tt>75dpi</tt> or <tt>misc</tt>),
10206                         <var>package</var> is the name of the package
10207                         that provides these fonts, and
10208                         <var>extension</var> is either <tt>scale</tt>
10209                         or <tt>alias</tt>, whichever corresponds to
10210                         the file contents.
10211                     </item>
10212                   </list>
10213               </item>
10214
10215               <item>
10216                   Font packages must declare a dependency on
10217                   <tt>xfonts-utils</tt> in their <tt>Depends</tt>
10218                   or <tt>Pre-Depends</tt> control field.
10219               </item>
10220
10221               <item>
10222                   Font packages that provide one or more
10223                   <file>fonts.scale</file> files as described above must
10224                   invoke <prgn>update-fonts-scale</prgn> on each
10225                   directory into which they installed fonts
10226                   <em>before</em> invoking
10227                   <prgn>update-fonts-dir</prgn> on that directory.
10228                   This invocation must occur in both the
10229                   <prgn>postinst</prgn> (for all arguments) and
10230                   <prgn>postrm</prgn> (for all arguments except
10231                   <tt>upgrade</tt>) scripts.
10232               </item>
10233
10234               <item>
10235                   Font packages that provide one or more
10236                   <file>fonts.alias</file> files as described above must
10237                   invoke <prgn>update-fonts-alias</prgn> on each
10238                   directory into which they installed fonts.  This
10239                   invocation must occur in both the
10240                   <prgn>postinst</prgn> (for all arguments) and
10241                   <prgn>postrm</prgn> (for all arguments except
10242                   <tt>upgrade</tt>) scripts.
10243               </item>
10244
10245               <item>
10246                   Font packages must invoke
10247                   <prgn>update-fonts-dir</prgn> on each directory into
10248                   which they installed fonts.  This invocation must
10249                   occur in both the <prgn>postinst</prgn> (for all
10250                   arguments) and <prgn>postrm</prgn> (for all
10251                   arguments except <tt>upgrade</tt>) scripts.
10252               </item>
10253
10254               <item>
10255                   Font packages must not provide alias names for the
10256                   fonts they include which collide with alias names
10257                   already in use by fonts already packaged.
10258               </item>
10259
10260               <item>
10261                   Font packages must not provide fonts with the same
10262                   XLFD registry name as another font already packaged.
10263               </item>
10264             </enumlist>
10265           </p>
10266         </sect1>
10267
10268         <sect1 id="appdefaults">
10269           <heading>Application defaults files</heading>
10270
10271           <p>
10272             Application defaults files must be installed in the
10273             directory <file>/etc/X11/app-defaults/</file> (use of a
10274             localized subdirectory of <file>/etc/X11/</file> as described
10275             in the <em>X Toolkit Intrinsics - C Language
10276             Interface</em> manual is also permitted).  They must be
10277             registered as <tt>conffile</tt>s or handled as
10278             configuration files.
10279           </p>
10280
10281           <p>
10282             Customization of programs' X resources may also be
10283             supported with the provision of a file with the same name
10284             as that of the package placed in
10285             the <file>/etc/X11/Xresources/</file> directory, which
10286             must be registered as a <tt>conffile</tt> or handled as a
10287             configuration file.<footnote>
10288                 Note that this mechanism is not the same as using
10289                 app-defaults; app-defaults are tied to the client
10290                 binary on the local file system, whereas X resources
10291                 are stored in the X server and affect all connecting
10292                 clients.
10293             </footnote>
10294           </p>
10295         </sect1>
10296
10297         <sect1>
10298           <heading>Installation directory issues</heading>
10299
10300           <p>
10301             Historically, packages using the X Window System used a
10302             separate set of installation directories from other packages.
10303             This practice has been discontinued and packages using the X
10304             Window System should now generally be installed in the same
10305             directories as any other package.  Specifically, packages must
10306             not install files under the <file>/usr/X11R6/</file> directory
10307             and the <file>/usr/X11R6/</file> directory hierarchy should be
10308             regarded as obsolete.
10309           </p>
10310
10311           <p>
10312             Include files previously installed under
10313             <file>/usr/X11R6/include/X11/</file> should be installed into
10314             <file>/usr/include/X11/</file>.  For files previously
10315             installed into subdirectories of
10316             <file>/usr/X11R6/lib/X11/</file>, package maintainers should
10317             determine if subdirectories of <file>/usr/lib/</file> and
10318             <file>/usr/share/</file> can be used.  If not, a subdirectory
10319             of <file>/usr/lib/X11/</file> should be used.
10320           </p>
10321
10322           <p>
10323             Configuration files for window, display, or session managers
10324             or other applications that are tightly integrated with the X
10325             Window System may be placed in a subdirectory
10326             of <file>/etc/X11/</file> corresponding to the package name.
10327             Other X Window System applications should use
10328             the <file>/etc/</file> directory unless otherwise mandated by
10329             policy (such as for <ref id="appdefaults">).
10330           </p>
10331         </sect1>
10332       </sect>
10333
10334       <sect id="perl">
10335         <heading>Perl programs and modules</heading>
10336
10337         <p>
10338           Perl programs and modules should follow the current Perl policy.
10339         </p>
10340
10341         <p>
10342           The Perl policy can be found in the <tt>perl-policy</tt>
10343           files in the <tt>debian-policy</tt> package.
10344           It is also available from the Debian web mirrors at
10345           <tt><url name="/doc/packaging-manuals/perl-policy/"
10346                 id="http://www.debian.org/doc/packaging-manuals/perl-policy/"></tt>.
10347         </p>
10348       </sect>
10349
10350       <sect id="emacs">
10351         <heading>Emacs lisp programs</heading>
10352
10353         <p>
10354           Please refer to the "Debian Emacs Policy" for details of how to
10355           package emacs lisp programs.
10356         </p>
10357
10358         <p>
10359           The Emacs policy is available in
10360           <file>debian-emacs-policy.gz</file> of the
10361           <package>emacsen-common</package> package.
10362           It is also available from the Debian web mirrors at
10363           <tt><url name="/doc/packaging-manuals/debian-emacs-policy"
10364                 id="http://www.debian.org/doc/packaging-manuals/debian-emacs-policy"></tt>.
10365         </p>
10366       </sect>
10367
10368       <sect>
10369         <heading>Games</heading>
10370
10371         <p>
10372           The permissions on <file>/var/games</file> are mode 755, owner
10373           <tt>root</tt> and group <tt>root</tt>.
10374         </p>
10375
10376         <p>
10377           Each game decides on its own security policy.</p>
10378
10379         <p>
10380           Games which require protected, privileged access to
10381           high-score files, saved games, etc., may be made
10382           set-<em>group</em>-id (mode 2755) and owned by
10383           <tt>root:games</tt>, and use files and directories with
10384           appropriate permissions (770 <tt>root:games</tt>, for
10385           example).  They must not be made
10386           set-<em>user</em>-id, as this causes security problems. (If
10387           an attacker can subvert any set-user-id game they can
10388           overwrite the executable of any other, causing other players
10389           of these games to run a Trojan horse program.  With a
10390           set-group-id game the attacker only gets access to less
10391           important game data, and if they can get at the other
10392           players' accounts at all it will take considerably more
10393           effort.)</p>
10394
10395         <p>
10396           Some packages, for example some fortune cookie programs, are
10397           configured by the upstream authors to install with their
10398           data files or other static information made unreadable so
10399           that they can only be accessed through set-id programs
10400           provided.  You should not do this in a Debian package: anyone can
10401           download the <file>.deb</file> file and read the data from it,
10402           so there is no point making the files unreadable.  Not
10403           making the files unreadable also means that you don't have
10404           to make so many programs set-id, which reduces the risk of a
10405           security hole.</p>
10406
10407         <p>
10408           As described in the FHS, binaries of games should be
10409           installed in the directory <file>/usr/games</file>. This also
10410           applies to games that use the X Window System. Manual pages
10411           for games (X and non-X games) should be installed in
10412           <file>/usr/share/man/man6</file>.</p>
10413       </sect>
10414     </chapt>
10415
10416
10417     <chapt id="docs">
10418       <heading>Documentation</heading>
10419
10420       <sect>
10421         <heading>Manual pages</heading>
10422
10423         <p>
10424           You should install manual pages in <prgn>nroff</prgn> source
10425           form, in appropriate places under <file>/usr/share/man</file>.
10426           You should only use sections 1 to 9 (see the FHS for more
10427           details).  You must not install a pre-formatted "cat page".
10428         </p>
10429
10430         <p>
10431           Each program, utility, and function should have an
10432           associated manual page included in the same package. It is
10433           suggested that all configuration files also have a manual
10434           page included as well. Manual pages for protocols and other
10435           auxiliary things are optional.
10436         </p>
10437
10438         <p>
10439           If no manual page is available, this is considered as a bug
10440           and should be reported to the Debian Bug Tracking System (the
10441           maintainer of the package is allowed to write this bug report
10442           themselves, if they so desire).  Do not close the bug report
10443           until a proper man page is available.<footnote>
10444               It is not very hard to write a man page. See the
10445               <url id="http://www.schweikhardt.net/man_page_howto.html"
10446                 name="Man-Page-HOWTO">,
10447               <manref name="man" section="7">, the examples created
10448               by <prgn>dh_make</prgn>, the helper
10449               program <prgn>help2man</prgn>, or the
10450               directory <file>/usr/share/doc/man-db/examples</file>.
10451           </footnote>
10452         </p>
10453
10454         <p>
10455           You may forward a complaint about a missing man page to the
10456           upstream authors, and mark the bug as forwarded in the
10457           Debian bug tracking system.  Even though the GNU Project do
10458           not in general consider the lack of a man page to be a bug,
10459           we do; if they tell you that they don't consider it a bug
10460           you should leave the bug in our bug tracking system open
10461           anyway.
10462         </p>
10463
10464         <p>
10465           Manual pages should be installed compressed using <tt>gzip -9</tt>.
10466         </p>
10467
10468         <p>
10469           If one man page needs to be accessible via several names it
10470           is better to use a symbolic link than the <file>.so</file>
10471           feature, but there is no need to fiddle with the relevant
10472           parts of the upstream source to change from <file>.so</file> to
10473           symlinks: don't do it unless it's easy.  You should not
10474           create hard links in the manual page directories, nor put
10475           absolute filenames in <file>.so</file> directives.  The filename
10476           in a <file>.so</file> in a man page should be relative to the
10477           base of the man page tree (usually
10478           <file>/usr/share/man</file>). If you do not create any links
10479           (whether symlinks, hard links, or <tt>.so</tt> directives)
10480           in the file system to the alternate names of the man page,
10481           then you should not rely on <prgn>man</prgn> finding your
10482           man page under those names based solely on the information in
10483           the man page's header.<footnote>
10484               Supporting this in <prgn>man</prgn> often requires
10485               unreasonable processing time to find a manual page or to
10486               report that none exists, and moves knowledge into man's
10487               database that would be better left in the file system.
10488               This support is therefore deprecated and will cease to
10489               be present in the future.
10490           </footnote>
10491         </p>
10492
10493         <p>
10494           Manual pages in locale-specific subdirectories of
10495           <file>/usr/share/man</file> should use either UTF-8 or the usual
10496           legacy encoding for that language (normally the one corresponding
10497           to the shortest relevant locale name in
10498           <file>/usr/share/i18n/SUPPORTED</file>). For example, pages under
10499           <file>/usr/share/man/fr</file> should use either UTF-8 or
10500           ISO-8859-1.<footnote>
10501             <prgn>man</prgn> will automatically detect whether UTF-8 is in
10502             use. In future, all manual pages will be required to use
10503             UTF-8.
10504           </footnote>
10505         </p>
10506
10507         <p>
10508           A country name (the <tt>DE</tt> in <tt>de_DE</tt>) should not be
10509           included in the subdirectory name unless it indicates a
10510           significant difference in the language, as this excludes
10511           speakers of the language in other countries.<footnote>
10512             At the time of writing, Chinese and Portuguese are the main
10513             languages with such differences, so <file>pt_BR</file>,
10514             <file>zh_CN</file>, and <file>zh_TW</file> are all allowed.
10515           </footnote>
10516         </p>
10517
10518         <p>
10519           If a localized version of a manual page is provided, it should
10520           either be up-to-date or it should be obvious to the reader that
10521           it is outdated and the original manual page should be used
10522           instead.  This can be done either by a note at the beginning of
10523           the manual page or by showing the missing or changed portions in
10524           the original language instead of the target language.
10525         </p>
10526       </sect>
10527
10528       <sect>
10529         <heading>Info documents</heading>
10530
10531         <p>
10532           Info documents should be installed in <file>/usr/share/info</file>.
10533           They should be compressed with <tt>gzip -9</tt>.
10534         </p>
10535
10536         <p>
10537           The <prgn>install-info</prgn> program maintains a directory of
10538           installed info documents in <file>/usr/share/info/dir</file> for the
10539           use of info readers.  This file must not be included in packages
10540           other than <package>install-info</package>.
10541         </p>
10542
10543         <p>
10544           <prgn>install-info</prgn> is automatically invoked when
10545           appropriate using dpkg triggers.  Packages other than
10546           <package>install-info</package> <em>should not</em> invoke
10547           <prgn>install-info</prgn> directly and <em>should not</em>
10548           depend on, recommend, or suggest <package>install-info</package>
10549           for this purpose.
10550         </p>
10551
10552         <p>
10553           Info readers requiring the <file>/usr/share/info/dir</file> file
10554           should depend on <package>install-info</package>.
10555         </p>
10556
10557         <p>
10558           Info documents should contain section and directory entry
10559           information in the document for the use
10560           of <prgn>install-info</prgn>.  The section should be specified
10561           via a line starting with <tt>INFO-DIR-SECTION</tt> followed by a
10562           space and the section of this info page.  The directory entry or
10563           entries should be included between
10564           a <tt>START-INFO-DIR-ENTRY</tt> line and
10565           an <tt>END-INFO-DIR-ENTRY</tt> line.  For example:
10566           <example>
10567 INFO-DIR-SECTION Individual utilities
10568 START-INFO-DIR-ENTRY
10569 * example: (example).               An example info directory entry.
10570 END-INFO-DIR-ENTRY
10571           </example>
10572           To determine which section to use, you should look
10573           at <file>/usr/share/info/dir</file> on your system and choose
10574           the most relevant (or create a new section if none of the
10575           current sections are relevant).<footnote>
10576             Normally, info documents are generated from Texinfo source.
10577             To include this information in the generated info document, if
10578             it is absent, add commands like:
10579             <example>
10580 @dircategory Individual utilities
10581 @direntry
10582 * example: (example).               An example info directory entry.
10583 @end direntry
10584             </example>
10585             to the Texinfo source of the document and ensure that the info
10586             documents are rebuilt from source during the package build.
10587           </footnote>
10588         </p>
10589       </sect>
10590
10591       <sect>
10592         <heading>Additional documentation</heading>
10593
10594         <p>
10595           Any additional documentation that comes with the package may
10596           be installed at the discretion of the package maintainer.
10597           Plain text documentation should be installed in the directory
10598           <file>/usr/share/doc/<var>package</var></file>, where
10599           <var>package</var> is the name of the package, and
10600           compressed with <tt>gzip -9</tt> unless it is small.
10601         </p>
10602
10603         <p>
10604           If a package comes with large amounts of documentation which
10605           many users of the package will not require you should create
10606           a separate binary package to contain it, so that it does not
10607           take up disk space on the machines of users who do not need
10608           or want it installed.</p>
10609
10610         <p>
10611           It is often a good idea to put text information files
10612           (<file>README</file>s, changelogs, and so forth) that come with
10613           the source package in <file>/usr/share/doc/<var>package</var></file>
10614           in the binary package.  However, you don't need to install
10615           the instructions for building and installing the package, of
10616           course!</p>
10617
10618         <p>
10619           Packages must not require the existence of any files in
10620           <file>/usr/share/doc/</file> in order to function
10621           <footnote>
10622               The system administrator should be able to
10623               delete files in <file>/usr/share/doc/</file> without causing
10624               any programs to break.
10625           </footnote>.
10626           Any files that are referenced by programs but are also
10627           useful as stand alone documentation should be installed under
10628           <file>/usr/share/<var>package</var>/</file> with symbolic links from
10629           <file>/usr/share/doc/<var>package</var></file>.
10630         </p>
10631
10632         <p>
10633           <file>/usr/share/doc/<var>package</var></file> may be a symbolic
10634           link to another directory in <file>/usr/share/doc</file> only if
10635           the two packages both come from the same source and the
10636           first package Depends on the second.<footnote>
10637             <p>
10638               Please note that this does not override the section on
10639               changelog files below, so the file 
10640               <file>/usr/share/doc/<var>package</var>/changelog.Debian.gz</file>
10641               must refer to the changelog for the current version of
10642               <var>package</var> in question. In practice, this means
10643               that the sources of the target and the destination of the
10644               symlink must be the same (same source package and
10645               version). 
10646             </p>
10647           </footnote>
10648         </p>
10649
10650         <p>
10651           Former Debian releases placed all additional documentation
10652           in <file>/usr/doc/<var>package</var></file>.  This has been
10653           changed to <file>/usr/share/doc/<var>package</var></file>,
10654           and packages must not put documentation in the directory
10655           <file>/usr/doc/<var>package</var></file>. <footnote>
10656             At this phase of the transition, we no longer require a
10657             symbolic link in <file>/usr/doc/</file>. At a later point,
10658             policy shall change to make the symbolic links a bug.
10659           </footnote>
10660         </p>
10661       </sect>
10662
10663       <sect>
10664         <heading>Preferred documentation formats</heading>
10665
10666         <p>
10667           The unification of Debian documentation is being carried out
10668           via HTML.</p>
10669
10670         <p>
10671           If your package comes with extensive documentation in a
10672           markup format that can be converted to various other formats
10673           you should if possible ship HTML versions in a binary
10674           package, in the directory
10675           <file>/usr/share/doc/<var>appropriate-package</var></file> or
10676           its subdirectories.<footnote>
10677               The rationale: The important thing here is that HTML
10678               docs should be available in <em>some</em> package, not
10679               necessarily in the main binary package.
10680           </footnote>
10681         </p>
10682
10683         <p>
10684           Other formats such as PostScript may be provided at the
10685           package maintainer's discretion.
10686         </p>
10687       </sect>
10688
10689       <sect id="copyrightfile">
10690         <heading>Copyright information</heading>
10691
10692         <p>
10693           Every package must be accompanied by a verbatim copy of its
10694           copyright information and distribution license in the file
10695           <file>/usr/share/doc/<var>package</var>/copyright</file>. This
10696           file must neither be compressed nor be a symbolic link.
10697         </p>
10698
10699         <p>
10700           In addition, the copyright file must say where the upstream
10701           sources (if any) were obtained, and should name the original
10702           authors.
10703         </p>
10704
10705         <p>
10706           Packages in the <em>contrib</em> or <em>non-free</em> archive
10707           areas should state in the copyright file that the package is not
10708           part of the Debian distribution and briefly explain why.
10709         </p>
10710
10711         <p>
10712           A copy of the file which will be installed in
10713           <file>/usr/share/doc/<var>package</var>/copyright</file> should
10714           be in <file>debian/copyright</file> in the source package.
10715         </p>
10716
10717         <p>
10718           <file>/usr/share/doc/<var>package</var></file> may be a symbolic
10719           link to another directory in <file>/usr/share/doc</file> only if
10720           the two packages both come from the same source and the
10721           first package Depends on the second.  These rules are important
10722           because <file>copyright</file> files must be extractable by
10723           mechanical means.
10724         </p>
10725
10726         <p>
10727           Packages distributed under the Apache license (version 2.0), the
10728           Artistic license, the GNU GPL (versions 1, 2, or 3), the GNU
10729           LGPL (versions 2, 2.1, or 3), and the GNU FDL (versions 1.2 or
10730           1.3) should refer to the corresponding files
10731           under <file>/usr/share/common-licenses</file>,<footnote>
10732             <p>
10733               In particular,
10734               <file>/usr/share/common-licenses/Apache-2.0</file>,
10735               <file>/usr/share/common-licenses/Artistic</file>,
10736               <file>/usr/share/common-licenses/GPL-1</file>,
10737               <file>/usr/share/common-licenses/GPL-2</file>,
10738               <file>/usr/share/common-licenses/GPL-3</file>,
10739               <file>/usr/share/common-licenses/LGPL-2</file>,
10740               <file>/usr/share/common-licenses/LGPL-2.1</file>,
10741               <file>/usr/share/common-licenses/LGPL-3</file>,
10742               <file>/usr/share/common-licenses/GFDL-1.2</file>, and
10743               <file>/usr/share/common-licenses/GFDL-1.3</file>
10744               respectively.  The University of California BSD license is
10745               also included in <package>base-files</package> as
10746               <file>/usr/share/common-licenses/BSD</file>, but given the
10747               brevity of this license, its specificity to code whose
10748               copyright is held by the Regents of the University of
10749               California, and the frequency of minor wording changes, its
10750               text should be included in the copyright file rather than
10751               referencing this file.
10752             </p>
10753           </footnote> rather than quoting them in the copyright
10754           file. 
10755         </p>
10756
10757         <p>
10758           You should not use the copyright file as a general <file>README</file>
10759           file.  If your package has such a file it should be
10760           installed in <file>/usr/share/doc/<var>package</var>/README</file> or
10761           <file>README.Debian</file> or some other appropriate place.
10762         </p>
10763
10764         <p>
10765           All copyright files must be encoded in UTF-8.
10766         </p>
10767
10768         <sect1 id="copyrightformat">
10769           <heading>Machine-readable copyright information</heading>
10770
10771           <p>
10772             A specification for a standard, machine-readable format
10773             for <file>debian/copyright</file> files is maintained as part
10774             of the <package>debian-policy</package> package.  This
10775             document may be found in the <file>copyright-format</file>
10776             files in the <package>debian-policy</package> package.  It is
10777             also available from the Debian web mirrors at
10778             <tt><url name="/doc/packaging-manuals/copyright-format/1.0/"
10779                      id="http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/"></tt>.
10780           </p>
10781
10782           <p>
10783             Use of this format is optional.
10784           </p>
10785         </sect1>
10786       </sect>
10787
10788       <sect>
10789         <heading>Examples</heading>
10790
10791         <p>
10792           Any examples (configurations, source files, whatever),
10793           should be installed in a directory
10794           <file>/usr/share/doc/<var>package</var>/examples</file>.  These
10795           files should not be referenced by any program: they're there
10796           for the benefit of the system administrator and users as
10797           documentation only.  Architecture-specific example files
10798           should be installed in a directory
10799           <file>/usr/lib/<var>package</var>/examples</file> with symbolic
10800           links to them from
10801           <file>/usr/share/doc/<var>package</var>/examples</file>, or the
10802           latter directory itself may be a symbolic link to the
10803           former.
10804         </p>
10805
10806         <p>
10807           If the purpose of a package is to provide examples, then the
10808           example files may be installed into
10809           <file>/usr/share/doc/<var>package</var></file>.
10810         </p>
10811       </sect>
10812
10813       <sect id="changelogs">
10814         <heading>Changelog files</heading>
10815
10816         <p>
10817           Packages that are not Debian-native must contain a
10818           compressed copy of the <file>debian/changelog</file> file from
10819           the Debian source tree in
10820           <file>/usr/share/doc/<var>package</var></file> with the name
10821           <file>changelog.Debian.gz</file>.
10822         </p>
10823
10824         <p>
10825           If an upstream changelog is available, it should be accessible as
10826           <file>/usr/share/doc/<var>package</var>/changelog.gz</file> in
10827           plain text.  If the upstream changelog is distributed in
10828           HTML, it should be made available in that form as
10829           <file>/usr/share/doc/<var>package</var>/changelog.html.gz</file>
10830           and a plain text <file>changelog.gz</file> should be generated
10831           from it using, for example, <tt>lynx -dump -nolist</tt>.  If
10832           the upstream changelog files do not already conform to this
10833           naming convention, then this may be achieved either by
10834           renaming the files, or by adding a symbolic link, at the
10835           maintainer's discretion.<footnote>
10836               Rationale: People should not have to look in places for
10837               upstream changelogs merely because they are given
10838               different names or are distributed in HTML format.
10839           </footnote>
10840         </p>
10841
10842         <p>
10843           All of these files should be installed compressed using
10844           <tt>gzip -9</tt>, as they will become large with time even
10845           if they start out small.
10846         </p>
10847
10848         <p>
10849           If the package has only one changelog which is used both as
10850           the Debian changelog and the upstream one because there is
10851           no separate upstream maintainer then that changelog should
10852           usually be installed as
10853           <file>/usr/share/doc/<var>package</var>/changelog.gz</file>; if
10854           there is a separate upstream maintainer, but no upstream
10855           changelog, then the Debian changelog should still be called
10856           <file>changelog.Debian.gz</file>.
10857         </p>
10858
10859         <p>
10860           For details about the format and contents of the Debian
10861           changelog file, please see <ref id="dpkgchangelog">.
10862         </p>
10863       </sect>
10864     </chapt>
10865
10866     <appendix id="pkg-scope">
10867       <heading>Introduction and scope of these appendices</heading>
10868
10869       <p>
10870         These appendices are taken essentially verbatim from the
10871         now-deprecated Packaging Manual, version 3.2.1.0.  They are
10872         the chapters which are likely to be of use to package
10873         maintainers and which have not already been included in the
10874         policy document itself. Most of these sections are very likely
10875         not relevant to policy; they should be treated as
10876         documentation for the packaging system. Please note that these
10877         appendices are included for convenience, and for historical
10878         reasons: they used to be part of policy package, and they have
10879         not yet been incorporated into dpkg documentation. However,
10880         they still have value, and hence they are presented here.
10881       </p>
10882
10883       <p>
10884         They have not yet been checked to ensure that they are
10885         compatible with the contents of policy, and if there are any
10886         contradictions, the version in the main policy document takes
10887         precedence.  The remaining chapters of the old Packaging
10888         Manual have also not been read in detail to ensure that there
10889         are not parts which have been left out.  Both of these will be
10890         done in due course.
10891       </p>
10892
10893       <p>
10894         Certain parts of the Packaging manual were integrated into the
10895         Policy Manual proper, and removed from the appendices. Links
10896         have been placed from the old locations to the new ones.
10897       </p>
10898
10899       <p>
10900         <prgn>dpkg</prgn> is a suite of programs for creating binary
10901         package files and installing and removing them on Unix
10902         systems.<footnote>
10903             <prgn>dpkg</prgn> is targeted primarily at Debian, but may
10904             work on or be ported to other systems.
10905         </footnote>
10906       </p>
10907
10908       <p>
10909         The binary packages are designed for the management of
10910         installed executable programs (usually compiled binaries) and
10911         their associated data, though source code examples and
10912         documentation are provided as part of some packages.</p>
10913
10914       <p>
10915         This manual describes the technical aspects of creating Debian
10916         binary packages (<file>.deb</file> files).  It documents the
10917         behavior of the package management programs
10918         <prgn>dpkg</prgn>, <prgn>dselect</prgn> et al. and the way
10919         they interact with packages.</p>
10920
10921       <p>
10922         This manual does not go into detail about the options and
10923         usage of the package building and installation tools.  It
10924         should therefore be read in conjunction with those programs'
10925         man pages.
10926       </p>
10927
10928       <p>
10929         The utility programs which are provided with <prgn>dpkg</prgn>
10930         not described in detail here, are documented in their man pages.
10931       </p>
10932
10933       <p>
10934         It is assumed that the reader is reasonably familiar with the
10935         <prgn>dpkg</prgn> System Administrators' manual.
10936         Unfortunately this manual does not yet exist.
10937       </p>
10938
10939       <p>
10940         The Debian version of the FSF's GNU hello program is provided as
10941         an example for people wishing to create Debian packages. However,
10942         while the examples are helpful, they do not replace the need to
10943         read and follow the Policy and Programmer's Manual.</p>
10944     </appendix>
10945
10946     <appendix id="pkg-binarypkg">
10947       <heading>Binary packages (from old Packaging Manual)</heading>
10948
10949       <p>
10950         See <manref name="deb" section="5"> and <ref id="pkg-controlarea">.
10951       </p>
10952
10953       <sect id="pkg-bincreating"><heading>Creating package files -
10954       <prgn>dpkg-deb</prgn>
10955         </heading>
10956
10957         <p>
10958           All manipulation of binary package files is done by
10959           <prgn>dpkg-deb</prgn>; it's the only program that has
10960           knowledge of the format.  (<prgn>dpkg-deb</prgn> may be
10961           invoked by calling <prgn>dpkg</prgn>, as <prgn>dpkg</prgn>
10962           will spot that the options requested are appropriate to
10963           <prgn>dpkg-deb</prgn> and invoke that instead with the same
10964           arguments.)
10965         </p>
10966
10967         <p>
10968           In order to create a binary package you must make a
10969           directory tree which contains all the files and directories
10970           you want to have in the file system data part of the package.
10971           In Debian-format source packages this directory is usually
10972           <file>debian/tmp</file>, relative to the top of the package's
10973           source tree.
10974         </p>
10975
10976         <p>
10977           They should have the locations (relative to the root of the
10978           directory tree you're constructing) ownerships and
10979           permissions which you want them to have on the system when
10980           they are installed.
10981         </p>
10982
10983         <p>
10984           With current versions of <prgn>dpkg</prgn> the uid/username
10985           and gid/groupname mappings for the users and groups being
10986           used should be the same on the system where the package is
10987           built and the one where it is installed.
10988         </p>
10989
10990         <p>
10991           You need to add one special directory to the root of the
10992           miniature file system tree you're creating:
10993           <prgn>DEBIAN</prgn>.  It should contain the control
10994           information files, notably the binary package control file
10995           (see <ref id="pkg-controlfile">).
10996         </p>
10997
10998         <p>
10999           The <prgn>DEBIAN</prgn> directory will not appear in the
11000           file system archive of the package, and so won't be installed
11001           by <prgn>dpkg</prgn> when the package is unpacked.
11002         </p>
11003
11004         <p>
11005           When you've prepared the package, you should invoke:
11006           <example>
11007   dpkg --build <var>directory</var>
11008           </example>
11009         </p>
11010
11011         <p>
11012           This will build the package in
11013           <file><var>directory</var>.deb</file>.  (<prgn>dpkg</prgn> knows
11014           that <tt>--build</tt> is a <prgn>dpkg-deb</prgn> option, so
11015           it invokes <prgn>dpkg-deb</prgn> with the same arguments to
11016           build the package.)
11017         </p>
11018
11019         <p>
11020           See the man page <manref name="dpkg-deb" section="8"> for details of how
11021           to examine the contents of this newly-created file.  You may find the
11022           output of following commands enlightening:
11023           <example>
11024   dpkg-deb --info <var>filename</var>.deb
11025   dpkg-deb --contents <var>filename</var>.deb
11026   dpkg --contents <var>filename</var>.deb
11027           </example>
11028           To view the copyright file for a package you could use this command:
11029           <example>
11030   dpkg --fsys-tarfile <var>filename</var>.deb | tar xOf - --wildcards \*/copyright | pager
11031           </example>
11032         </p>
11033       </sect>
11034
11035       <sect id="pkg-controlarea">
11036         <heading>Package control information files</heading>
11037
11038         <p>
11039           The control information portion of a binary package is a
11040           collection of files with names known to <prgn>dpkg</prgn>.
11041           It will treat the contents of these files specially - some
11042           of them contain information used by <prgn>dpkg</prgn> when
11043           installing or removing the package; others are scripts which
11044           the package maintainer wants <prgn>dpkg</prgn> to run.
11045         </p>
11046
11047         <p>
11048           It is possible to put other files in the package control
11049           information file area, but this is not generally a good idea
11050           (though they will largely be ignored).
11051         </p>
11052
11053         <p>
11054           Here is a brief list of the control information files supported
11055           by <prgn>dpkg</prgn> and a summary of what they're used for.
11056         </p>
11057
11058         <p>
11059           <taglist>
11060             <tag><tt>control</tt>
11061             <item>
11062               <p>
11063                 This is the key description file used by
11064                 <prgn>dpkg</prgn>.  It specifies the package's name
11065                 and version, gives its description for the user,
11066                 states its relationships with other packages, and so
11067                 forth.  See <ref id="sourcecontrolfiles"> and
11068                 <ref id="binarycontrolfiles">.
11069               </p>
11070
11071               <p>
11072                 It is usually generated automatically from information
11073                 in the source package by the
11074                 <prgn>dpkg-gencontrol</prgn> program, and with
11075                 assistance from <prgn>dpkg-shlibdeps</prgn>.
11076                 See <ref id="pkg-sourcetools">.
11077               </p>
11078             </item>
11079
11080             <tag><tt>postinst</tt>, <tt>preinst</tt>, <tt>postrm</tt>,
11081                  <tt>prerm</tt>
11082             </tag>
11083             <item>
11084               <p>
11085                 These are executable files (usually scripts) which
11086                 <prgn>dpkg</prgn> runs during installation, upgrade
11087                 and removal of packages.  They allow the package to
11088                 deal with matters which are particular to that package
11089                 or require more complicated processing than that
11090                 provided by <prgn>dpkg</prgn>.  Details of when and
11091                 how they are called are in <ref id="maintainerscripts">.
11092               </p>
11093
11094               <p>
11095                 It is very important to make these scripts idempotent.
11096                 See <ref id="idempotency">.
11097               </p>
11098
11099               <p>
11100                 The maintainer scripts are not guaranteed to run with a
11101                 controlling terminal and may not be able to interact with
11102                 the user.  See <ref id="controllingterminal">.
11103               </p>
11104             </item>
11105
11106             <tag><tt>conffiles</tt>
11107             </tag>
11108             <item>
11109                 This file contains a list of configuration files which
11110                 are to be handled automatically by <prgn>dpkg</prgn>
11111                 (see <ref id="pkg-conffiles">).  Note that not necessarily
11112                 every configuration file should be listed here.
11113             </item>
11114
11115             <tag><tt>shlibs</tt>
11116             </tag>
11117             <item>
11118                 This file contains a list of the shared libraries
11119                 supplied by the package, with dependency details for
11120                 each.  This is used by <prgn>dpkg-shlibdeps</prgn>
11121                 when it determines what dependencies are required in a
11122                 package control file. The <tt>shlibs</tt> file format
11123                 is described on <ref id="shlibs">.
11124             </item>
11125           </taglist>
11126         </p>
11127
11128       <sect id="pkg-controlfile">
11129         <heading>The main control information file: <tt>control</tt></heading>
11130
11131         <p>
11132           The most important control information file used by
11133           <prgn>dpkg</prgn> when it installs a package is
11134           <tt>control</tt>.  It contains all the package's "vital
11135           statistics".
11136         </p>
11137
11138         <p>
11139           The binary package control files of packages built from
11140           Debian sources are made by a special tool,
11141           <prgn>dpkg-gencontrol</prgn>, which reads
11142           <file>debian/control</file> and <file>debian/changelog</file> to
11143           find the information it needs.  See <ref id="pkg-sourcepkg"> for
11144           more details.
11145         </p>
11146
11147         <p>
11148           The fields in binary package control files are listed in
11149           <ref id="binarycontrolfiles">.
11150         </p>
11151
11152         <p>
11153           A description of the syntax of control files and the purpose
11154           of the fields is available in <ref id="controlfields">.
11155         </p>
11156       </sect>
11157
11158       <sect>
11159         <heading>Time Stamps</heading>
11160
11161         <p>
11162           See <ref id="timestamps">.
11163         </p>
11164       </sect>
11165     </appendix>
11166
11167     <appendix id="pkg-sourcepkg">
11168       <heading>Source packages (from old Packaging Manual) </heading>
11169
11170       <p>
11171         The Debian binary packages in the distribution are generated
11172         from Debian sources, which are in a special format to assist
11173         the easy and automatic building of binaries.
11174       </p>
11175
11176       <sect id="pkg-sourcetools">
11177         <heading>Tools for processing source packages</heading>
11178
11179         <p>
11180           Various tools are provided for manipulating source packages;
11181           they pack and unpack sources and help build of binary
11182           packages and help manage the distribution of new versions.
11183         </p>
11184
11185         <p>
11186           They are introduced and typical uses described here; see
11187           <manref name="dpkg-source" section="1"> for full
11188           documentation about their arguments and operation.
11189         </p>
11190
11191         <p>
11192           For examples of how to construct a Debian source package,
11193           and how to use those utilities that are used by Debian
11194           source packages, please see the <prgn>hello</prgn> example
11195           package.
11196         </p>
11197
11198         <sect1 id="pkg-dpkg-source">
11199           <heading>
11200             <prgn>dpkg-source</prgn> - packs and unpacks Debian source
11201             packages
11202           </heading>
11203
11204           <p>
11205             This program is frequently used by hand, and is also
11206             called from package-independent automated building scripts
11207             such as <prgn>dpkg-buildpackage</prgn>.
11208           </p>
11209
11210           <p>
11211             To unpack a package it is typically invoked with
11212             <example>
11213   dpkg-source -x <var>.../path/to/filename</var>.dsc
11214             </example>
11215           </p>
11216
11217            <p>
11218             with the <file><var>filename</var>.tar.gz</file> and
11219             <file><var>filename</var>.diff.gz</file> (if applicable) in
11220             the same directory.  It unpacks into
11221             <file><var>package</var>-<var>version</var></file>, and if
11222             applicable
11223             <file><var>package</var>-<var>version</var>.orig</file>, in
11224             the current directory.
11225           </p>
11226
11227           <p>
11228             To create a packed source archive it is typically invoked:
11229             <example>
11230   dpkg-source -b <var>package</var>-<var>version</var>
11231           </example>
11232           </p>
11233
11234           <p>
11235             This will create the <file>.dsc</file>, <file>.tar.gz</file> and
11236             <file>.diff.gz</file> (if appropriate) in the current
11237             directory.  <prgn>dpkg-source</prgn> does not clean the
11238             source tree first - this must be done separately if it is
11239             required.
11240           </p>
11241
11242           <p>
11243             See also <ref id="pkg-sourcearchives">.</p>
11244         </sect1>
11245
11246
11247         <sect1 id="pkg-dpkg-buildpackage">
11248           <heading>
11249             <prgn>dpkg-buildpackage</prgn> - overall package-building
11250             control script
11251           </heading>
11252
11253           <p>
11254             See <manref name="dpkg-buildpackage" section="1">.
11255           </p>
11256         </sect1>
11257
11258         <sect1 id="pkg-dpkg-gencontrol">
11259           <heading>
11260             <prgn>dpkg-gencontrol</prgn> - generates binary package
11261             control files
11262           </heading>
11263
11264           <p>
11265             This program is usually called from <file>debian/rules</file>
11266             (see <ref id="pkg-sourcetree">) in the top level of the source
11267             tree.
11268           </p>
11269
11270           <p>
11271             This is usually done just before the files and directories in the
11272             temporary directory tree where the package is being built have their
11273             permissions and ownerships set and the package is constructed using
11274             <prgn>dpkg-deb/</prgn>
11275               <footnote>
11276                 This is so that the control file which is produced has
11277                 the right permissions
11278             </footnote>.
11279           </p>
11280
11281           <p>
11282             <prgn>dpkg-gencontrol</prgn> must be called after all the
11283             files which are to go into the package have been placed in
11284             the temporary build directory, so that its calculation of
11285             the installed size of a package is correct.
11286           </p>
11287
11288           <p>
11289             It is also necessary for <prgn>dpkg-gencontrol</prgn> to
11290             be run after <prgn>dpkg-shlibdeps</prgn> so that the
11291             variable substitutions created by
11292             <prgn>dpkg-shlibdeps</prgn> in <file>debian/substvars</file>
11293             are available.
11294           </p>
11295
11296           <p>
11297             For a package which generates only one binary package, and
11298             which builds it in <file>debian/tmp</file> relative to the top
11299             of the source package, it is usually sufficient to call
11300             <prgn>dpkg-gencontrol</prgn>.
11301           </p>
11302
11303           <p>
11304             Sources which build several binaries will typically need
11305             something like:
11306             <example>
11307   dpkg-gencontrol -Pdebian/tmp-<var>pkg</var> -p<var>package</var>
11308             </example> The <tt>-P</tt> tells
11309             <prgn>dpkg-gencontrol</prgn> that the package is being
11310             built in a non-default directory, and the <tt>-p</tt>
11311             tells it which package's control file should be generated.
11312           </p>
11313
11314           <p>
11315             <prgn>dpkg-gencontrol</prgn> also adds information to the
11316             list of files in <file>debian/files</file>, for the benefit of
11317             (for example) a future invocation of
11318             <prgn>dpkg-genchanges</prgn>.</p>
11319         </sect1>
11320
11321         <sect1 id="pkg-dpkg-shlibdeps">
11322           <heading>
11323             <prgn>dpkg-shlibdeps</prgn> - calculates shared library
11324             dependencies
11325           </heading>
11326
11327           <p>
11328             See <manref name="dpkg-shlibdeps" section="1">.
11329           </p>
11330         </sect1>
11331
11332         <sect1 id="pkg-dpkg-distaddfile">
11333           <heading>
11334             <prgn>dpkg-distaddfile</prgn> - adds a file to
11335             <file>debian/files</file>
11336           </heading>
11337
11338           <p>
11339             Some packages' uploads need to include files other than
11340             the source and binary package files.
11341           </p>
11342
11343           <p>
11344             <prgn>dpkg-distaddfile</prgn> adds a file to the
11345             <file>debian/files</file> file so that it will be included in
11346             the <file>.changes</file> file when
11347             <prgn>dpkg-genchanges</prgn> is run.
11348           </p>
11349
11350           <p>
11351             It is usually invoked from the <tt>binary</tt> target of
11352             <file>debian/rules</file>:
11353             <example>
11354   dpkg-distaddfile <var>filename</var> <var>section</var> <var>priority</var>
11355             </example>
11356             The <var>filename</var> is relative to the directory where
11357             <prgn>dpkg-genchanges</prgn> will expect to find it - this
11358             is usually the directory above the top level of the source
11359             tree.  The <file>debian/rules</file> target should put the
11360             file there just before or just after calling
11361             <prgn>dpkg-distaddfile</prgn>.
11362           </p>
11363
11364           <p>
11365             The <var>section</var> and <var>priority</var> are passed
11366             unchanged into the resulting <file>.changes</file> file.
11367           </p>
11368         </sect1>
11369
11370
11371         <sect1 id="pkg-dpkg-genchanges">
11372           <heading>
11373             <prgn>dpkg-genchanges</prgn> - generates a <file>.changes</file>
11374             upload control file
11375           </heading>
11376
11377           <p>
11378             See <manref name="dpkg-genchanges" section="1">.
11379           </p>
11380         </sect1>
11381
11382         <sect1 id="pkg-dpkg-parsechangelog">
11383           <heading>
11384             <prgn>dpkg-parsechangelog</prgn> - produces parsed
11385             representation of a changelog
11386           </heading>
11387
11388           <p>
11389             See <manref name="dpkg-parsechangelog" section="1">.
11390           </p>
11391         </sect1>
11392
11393         <sect1 id="pkg-dpkg-architecture">
11394           <heading>
11395             <prgn>dpkg-architecture</prgn> - information about the build and
11396             host system
11397           </heading>
11398
11399           <p>
11400             See <manref name="dpkg-architecture" section="1">.
11401           </p>
11402         </sect1>
11403       </sect>
11404
11405       <sect id="pkg-sourcetree">
11406         <heading>The Debian package source tree</heading>
11407
11408         <p>
11409           The source archive scheme described later is intended to
11410           allow a Debian package source tree with some associated
11411           control information to be reproduced and transported easily.
11412           The Debian package source tree is a version of the original
11413           program with certain files added for the benefit of the
11414           packaging process, and with any other changes required
11415           made to the rest of the source code and installation
11416           scripts.
11417         </p>
11418
11419         <p>
11420           The extra files created for Debian are in the subdirectory
11421           <file>debian</file> of the top level of the Debian package
11422           source tree. They are described below.
11423         </p>
11424
11425         <sect1 id="pkg-debianrules">
11426           <heading><file>debian/rules</file> - the main building script</heading>
11427
11428           <p>
11429             See <ref id="debianrules">.
11430           </p>
11431         </sect1>
11432
11433         <sect1 id="pkg-srcsubstvars">
11434           <heading><file>debian/substvars</file> and variable substitutions</heading>
11435
11436           <p>
11437             See <ref id="substvars">.
11438           </p>
11439
11440         </sect1>
11441
11442         <sect1>
11443           <heading><file>debian/files</file></heading>
11444
11445           <p>
11446             See <ref id="debianfiles">.
11447           </p>
11448         </sect1>
11449
11450         <sect1><heading><file>debian/tmp</file>
11451           </heading>
11452
11453           <p>
11454             This is the canonical temporary location for the
11455             construction of binary packages by the <tt>binary</tt>
11456             target.  The directory <file>tmp</file> serves as the root of
11457             the file system tree as it is being constructed (for
11458             example, by using the package's upstream makefiles install
11459             targets and redirecting the output there), and it also
11460             contains the <tt>DEBIAN</tt> subdirectory.  See <ref
11461             id="pkg-bincreating">.
11462           </p>
11463
11464           <p>
11465             If several binary packages are generated from the same
11466             source tree it is usual to use several
11467             <file>debian/tmp<var>something</var></file> directories, for
11468             example <file>tmp-a</file> or <file>tmp-doc</file>.
11469           </p>
11470
11471           <p>
11472             Whatever <file>tmp</file> directories are created and used by
11473             <tt>binary</tt> must of course be removed by the
11474             <tt>clean</tt> target.</p></sect1>
11475       </sect>
11476
11477
11478       <sect id="pkg-sourcearchives"><heading>Source packages as archives
11479         </heading>
11480
11481         <p>
11482           As it exists on the FTP site, a Debian source package
11483           consists of three related files.  You must have the right
11484           versions of all three to be able to use them.
11485         </p>
11486
11487         <p>
11488           <taglist>
11489             <tag>Debian source control file - <tt>.dsc</tt></tag>
11490             <item>
11491                 This file is a control file used by <prgn>dpkg-source</prgn>
11492                 to extract a source package.
11493                 See <ref id="debiansourcecontrolfiles">.
11494             </item>
11495
11496             <tag>
11497               Original source archive -
11498               <file>
11499                 <var>package</var>_<var>upstream-version</var>.orig.tar.gz
11500               </file>
11501             </tag>
11502
11503             <item>
11504               <p>
11505                 This is a compressed (with <tt>gzip -9</tt>)
11506                 <prgn>tar</prgn> file containing the source code from
11507                 the upstream authors of the program.
11508               </p>
11509             </item>
11510
11511             <tag>
11512               Debian package diff -
11513               <file>
11514                 <var>package</var>_<var>upstream_version-revision</var>.diff.gz
11515               </file>
11516             </tag>
11517             <item>
11518
11519               <p>
11520                 This is a unified context diff (<tt>diff -u</tt>)
11521                 giving the changes which are required to turn the
11522                 original source into the Debian source.  These changes
11523                 may only include editing and creating plain files.
11524                 The permissions of files, the targets of symbolic
11525                 links and the characteristics of special files or
11526                 pipes may not be changed and no files may be removed
11527                 or renamed.
11528               </p>
11529
11530               <p>
11531                 All the directories in the diff must exist, except the
11532                 <file>debian</file> subdirectory of the top of the source
11533                 tree, which will be created by
11534                 <prgn>dpkg-source</prgn> if necessary when unpacking.
11535               </p>
11536
11537               <p>
11538                 The <prgn>dpkg-source</prgn> program will
11539                 automatically make the <file>debian/rules</file> file
11540                 executable (see below).</p></item>
11541           </taglist>
11542         </p>
11543
11544         <p>
11545           If there is no original source code - for example, if the
11546           package is specially prepared for Debian or the Debian
11547           maintainer is the same as the upstream maintainer - the
11548           format is slightly different: then there is no diff, and the
11549           tarfile is named
11550           <file><var>package</var>_<var>version</var>.tar.gz</file>,
11551           and preferably contains a directory named
11552           <file><var>package</var>-<var>version</var></file>.
11553         </p>
11554       </sect>
11555
11556       <sect>
11557         <heading>Unpacking a Debian source package without <prgn>dpkg-source</prgn></heading>
11558
11559         <p>
11560           <tt>dpkg-source -x</tt> is the recommended way to unpack a
11561           Debian source package.  However, if it is not available it
11562           is possible to unpack a Debian source archive as follows:
11563         <enumlist compact="compact">
11564           <item>
11565             <p>
11566               Untar the tarfile, which will create a <file>.orig</file>
11567               directory.</p>
11568           </item>
11569           <item>
11570             <p>Rename the <file>.orig</file> directory to
11571               <file><var>package</var>-<var>version</var></file>.</p>
11572           </item>
11573             <item>
11574             <p>
11575               Create the subdirectory <file>debian</file> at the top of
11576               the source tree.</p>
11577           </item>
11578           <item><p>Apply the diff using <tt>patch -p0</tt>.</p>
11579           </item>
11580           <item><p>Untar the tarfile again if you want a copy of the original
11581               source code alongside the Debian version.</p>
11582           </item>
11583         </enumlist>
11584
11585         <p>
11586           It is not possible to generate a valid Debian source archive
11587           without using <prgn>dpkg-source</prgn>.  In particular,
11588           attempting to use <prgn>diff</prgn> directly to generate the
11589           <file>.diff.gz</file> file will not work.
11590         </p>
11591
11592         <sect1>
11593           <heading>Restrictions on objects in source packages</heading>
11594
11595           <p>
11596             The source package may not contain any hard links
11597             <footnote>
11598                 This is not currently detected when building source
11599                 packages, but only when extracting
11600                 them.
11601             </footnote>
11602             <footnote>
11603                 Hard links may be permitted at some point in the
11604                 future, but would require a fair amount of
11605                 work.
11606             </footnote>, device special files, sockets or setuid or
11607             setgid files.
11608             <footnote>
11609                 Setgid directories are allowed.
11610             </footnote>
11611           </p>
11612
11613           <p>
11614             The source packaging tools manage the changes between the
11615             original and Debian source using <prgn>diff</prgn> and
11616             <prgn>patch</prgn>.  Turning the original source tree as
11617             included in the <file>.orig.tar.gz</file> into the Debian
11618             package source must not involve any changes which cannot be
11619             handled by these tools.  Problematic changes which cause
11620             <prgn>dpkg-source</prgn> to halt with an error when
11621             building the source package are:
11622             <list compact="compact">
11623               <item><p>Adding or removing symbolic links, sockets or pipes.</p>
11624               </item>
11625               <item><p>Changing the targets of symbolic links.</p>
11626               </item>
11627               <item><p>Creating directories, other than <file>debian</file>.</p>
11628               </item>
11629               <item><p>Changes to the contents of binary files.</p></item>
11630             </list> Changes which cause <prgn>dpkg-source</prgn> to
11631             print a warning but continue anyway are:
11632             <list compact="compact">
11633               <item>
11634                 <p>
11635                   Removing files, directories or symlinks.
11636                   <footnote>
11637                       Renaming a file is not treated specially - it is
11638                       seen as the removal of the old file (which
11639                       generates a warning, but is otherwise ignored),
11640                       and the creation of the new one.
11641                   </footnote>
11642                 </p>
11643               </item>
11644               <item>
11645                 <p>
11646                   Changed text files which are missing the usual final
11647                   newline (either in the original or the modified
11648                   source tree).
11649                 </p>
11650               </item>
11651             </list>
11652             Changes which are not represented, but which are not detected by
11653             <prgn>dpkg-source</prgn>, are:
11654             <list compact="compact">
11655               <item><p>Changing the permissions of files (other than
11656                   <file>debian/rules</file>) and directories.</p></item>
11657             </list>
11658           </p>
11659
11660           <p>
11661             The <file>debian</file> directory and <file>debian/rules</file>
11662             are handled specially by <prgn>dpkg-source</prgn> - before
11663             applying the changes it will create the <file>debian</file>
11664             directory, and afterwards it will make
11665             <file>debian/rules</file> world-executable.
11666           </p>
11667         </sect1>
11668       </sect>
11669     </appendix>
11670
11671     <appendix id="pkg-controlfields">
11672       <heading>Control files and their fields (from old Packaging Manual)</heading>
11673
11674       <p>
11675         Many of the tools in the <prgn>dpkg</prgn> suite manipulate
11676         data in a common format, known as control files.  Binary and
11677         source packages have control data as do the <file>.changes</file>
11678         files which control the installation of uploaded files, and
11679         <prgn>dpkg</prgn>'s internal databases are in a similar
11680         format.
11681       </p>
11682
11683       <sect>
11684         <heading>Syntax of control files</heading>
11685
11686         <p>
11687           See <ref id="controlsyntax">.
11688         </p>
11689
11690         <p>
11691           It is important to note that there are several fields which
11692           are optional as far as <prgn>dpkg</prgn> and the related
11693           tools are concerned, but which must appear in every Debian
11694           package, or whose omission may cause problems.
11695         </p>
11696       </sect>
11697
11698       <sect>
11699         <heading>List of fields</heading>
11700
11701         <p>
11702           See <ref id="controlfieldslist">.
11703         </p>
11704
11705         <p>
11706           This section now contains only the fields that didn't belong
11707           to the Policy manual.
11708         </p>
11709
11710         <sect1 id="pkg-f-Filename">
11711           <heading><tt>Filename</tt> and <tt>MSDOS-Filename</tt></heading>
11712
11713           <p>
11714             These fields in <tt>Packages</tt> files give the
11715             filename(s) of (the parts of) a package in the
11716             distribution directories, relative to the root of the
11717             Debian hierarchy.  If the package has been split into
11718             several parts the parts are all listed in order, separated
11719             by spaces.
11720           </p>
11721         </sect1>
11722
11723         <sect1 id="pkg-f-Size">
11724           <heading><tt>Size</tt> and <tt>MD5sum</tt></heading>
11725
11726           <p>
11727             These fields in <file>Packages</file> files give the size (in
11728             bytes, expressed in decimal) and MD5 checksum of the
11729             file(s) which make(s) up a binary package in the
11730             distribution.  If the package is split into several parts
11731             the values for the parts are listed in order, separated by
11732             spaces.
11733           </p>
11734         </sect1>
11735
11736         <sect1 id="pkg-f-Status">
11737           <heading><tt>Status</tt></heading>
11738
11739           <p>
11740             This field in <prgn>dpkg</prgn>'s status file records
11741             whether the user wants a package installed, removed or
11742             left alone, whether it is broken (requiring
11743             re-installation) or not and what its current state on the
11744             system is.  Each of these pieces of information is a
11745             single word.
11746           </p>
11747         </sect1>
11748
11749         <sect1 id="pkg-f-Config-Version">
11750           <heading><tt>Config-Version</tt></heading>
11751
11752           <p>
11753             If a package is not installed or not configured, this
11754             field in <prgn>dpkg</prgn>'s status file records the last
11755             version of the package which was successfully
11756             configured.
11757           </p>
11758         </sect1>
11759
11760         <sect1 id="pkg-f-Conffiles">
11761           <heading><tt>Conffiles</tt></heading>
11762
11763           <p>
11764             This field in <prgn>dpkg</prgn>'s status file contains
11765             information about the automatically-managed configuration
11766             files held by a package.  This field should <em>not</em>
11767             appear anywhere in a package!
11768           </p>
11769         </sect1>
11770
11771         <sect1>
11772           <heading>Obsolete fields</heading>
11773
11774           <p>
11775             These are still recognized by <prgn>dpkg</prgn> but should
11776             not appear anywhere any more.
11777
11778             <taglist compact="compact">
11779
11780               <tag><tt>Revision</tt></tag>
11781               <tag><tt>Package-Revision</tt></tag>
11782               <tag><tt>Package_Revision</tt></tag>
11783               <item>
11784                   The Debian revision part of the package version was
11785                   at one point in a separate control field.  This
11786                   field went through several names.
11787               </item>
11788
11789               <tag><tt>Recommended</tt></tag>
11790               <item>Old name for <tt>Recommends</tt>.</item>
11791
11792               <tag><tt>Optional</tt></tag>
11793               <item>Old name for <tt>Suggests</tt>.</item>
11794
11795               <tag><tt>Class</tt></tag>
11796               <item>Old name for <tt>Priority</tt>.</item>
11797
11798             </taglist>
11799           </p>
11800         </sect1>
11801       </sect>
11802
11803     </appendix>
11804
11805     <appendix id="pkg-conffiles">
11806       <heading>Configuration file handling (from old Packaging Manual)</heading>
11807
11808       <p>
11809         <prgn>dpkg</prgn> can do a certain amount of automatic
11810         handling of package configuration files.
11811       </p>
11812
11813       <p>
11814         Whether this mechanism is appropriate depends on a number of
11815         factors, but basically there are two approaches to any
11816         particular configuration file.
11817       </p>
11818
11819       <p>
11820         The easy method is to ship a best-effort configuration in the
11821         package, and use <prgn>dpkg</prgn>'s conffile mechanism to
11822         handle updates.  If the user is unlikely to want to edit the
11823         file, but you need them to be able to without losing their
11824         changes, and a new package with a changed version of the file
11825         is only released infrequently, this is a good approach.
11826       </p>
11827
11828       <p>
11829         The hard method is to build the configuration file from
11830         scratch in the <prgn>postinst</prgn> script, and to take the
11831         responsibility for fixing any mistakes made in earlier
11832         versions of the package automatically.  This will be
11833         appropriate if the file is likely to need to be different on
11834         each system.
11835       </p>
11836
11837       <sect><heading>Automatic handling of configuration files by
11838       <prgn>dpkg</prgn>
11839         </heading>
11840
11841         <p>
11842           A package may contain a control information file called
11843           <tt>conffiles</tt>.  This file should be a list of filenames
11844           of configuration files needing automatic handling, separated
11845           by newlines.  The filenames should be absolute pathnames,
11846           and the files referred to should actually exist in the
11847           package.
11848         </p>
11849
11850         <p>
11851           When a package is upgraded <prgn>dpkg</prgn> will process
11852           the configuration files during the configuration stage,
11853           shortly before it runs the package's <prgn>postinst</prgn>
11854           script,
11855         </p>
11856
11857         <p>
11858           For each file it checks to see whether the version of the
11859           file included in the package is the same as the one that was
11860           included in the last version of the package (the one that is
11861           being upgraded from); it also compares the version currently
11862           installed on the system with the one shipped with the last
11863           version.
11864         </p>
11865
11866         <p>
11867           If neither the user nor the package maintainer has changed
11868           the file, it is left alone.  If one or the other has changed
11869           their version, then the changed version is preferred - i.e.,
11870           if the user edits their file, but the package maintainer
11871           doesn't ship a different version, the user's changes will
11872           stay, silently, but if the maintainer ships a new version
11873           and the user hasn't edited it the new version will be
11874           installed (with an informative message).  If both have
11875           changed their version the user is prompted about the problem
11876           and must resolve the differences themselves.
11877         </p>
11878
11879         <p>
11880           The comparisons are done by calculating the MD5 message
11881           digests of the files, and storing the MD5 of the file as it
11882           was included in the most recent version of the package.
11883         </p>
11884
11885         <p>
11886           When a package is installed for the first time
11887           <prgn>dpkg</prgn> will install the file that comes with it,
11888           unless that would mean overwriting a file already on the
11889           file system.
11890         </p>
11891
11892         <p>
11893           However, note that <prgn>dpkg</prgn> will <em>not</em>
11894           replace a conffile that was removed by the user (or by a
11895           script).  This is necessary because with some programs a
11896           missing file produces an effect hard or impossible to
11897           achieve in another way, so that a missing file needs to be
11898           kept that way if the user did it.
11899         </p>
11900
11901         <p>
11902           Note that a package should <em>not</em> modify a
11903           <prgn>dpkg</prgn>-handled conffile in its maintainer
11904           scripts.  Doing this will lead to <prgn>dpkg</prgn> giving
11905           the user confusing and possibly dangerous options for
11906           conffile update when the package is upgraded.</p>
11907       </sect>
11908
11909       <sect><heading>Fully-featured maintainer script configuration
11910       handling
11911         </heading>
11912
11913         <p>
11914           For files which contain site-specific information such as
11915           the hostname and networking details and so forth, it is
11916           better to create the file in the package's
11917           <prgn>postinst</prgn> script.
11918         </p>
11919
11920         <p>
11921           This will typically involve examining the state of the rest
11922           of the system to determine values and other information, and
11923           may involve prompting the user for some information which
11924           can't be obtained some other way.
11925         </p>
11926
11927         <p>
11928           When using this method there are a couple of important
11929           issues which should be considered:
11930         </p>
11931
11932         <p>
11933           If you discover a bug in the program which generates the
11934           configuration file, or if the format of the file changes
11935           from one version to the next, you will have to arrange for
11936           the postinst script to do something sensible - usually this
11937           will mean editing the installed configuration file to remove
11938           the problem or change the syntax.  You will have to do this
11939           very carefully, since the user may have changed the file,
11940           perhaps to fix the very problem that your script is trying
11941           to deal with - you will have to detect these situations and
11942           deal with them correctly.
11943         </p>
11944
11945         <p>
11946           If you do go down this route it's probably a good idea to
11947           make the program that generates the configuration file(s) a
11948           separate program in <file>/usr/sbin</file>, by convention called
11949           <file><var>package</var>config</file> and then run that if
11950           appropriate from the post-installation script.  The
11951           <tt><var>package</var>config</tt> program should not
11952           unquestioningly overwrite an existing configuration - if its
11953           mode of operation is geared towards setting up a package for
11954           the first time (rather than any arbitrary reconfiguration
11955           later) you should have it check whether the configuration
11956           already exists, and require a <tt>--force</tt> flag to
11957           overwrite it.</p></sect>
11958     </appendix>
11959
11960     <appendix id="pkg-alternatives"><heading>Alternative versions of
11961         an interface - <prgn>update-alternatives</prgn> (from old
11962     Packaging Manual)
11963       </heading>
11964
11965       <p>
11966         When several packages all provide different versions of the
11967         same program or file it is useful to have the system select a
11968         default, but to allow the system administrator to change it
11969         and have their decisions respected.
11970       </p>
11971
11972       <p>
11973         For example, there are several versions of the <prgn>vi</prgn>
11974         editor, and there is no reason to prevent all of them from
11975         being installed at once, each under their own name
11976         (<prgn>nvi</prgn>, <prgn>vim</prgn> or whatever).
11977         Nevertheless it is desirable to have the name <tt>vi</tt>
11978         refer to something, at least by default.
11979       </p>
11980
11981       <p>
11982         If all the packages involved cooperate, this can be done with
11983         <prgn>update-alternatives</prgn>.
11984       </p>
11985
11986       <p>
11987         Each package provides its own version under its own name, and
11988         calls <prgn>update-alternatives</prgn> in its postinst to
11989         register its version (and again in its prerm to deregister
11990         it).
11991       </p>
11992
11993       <p>
11994         See the man page <manref name="update-alternatives"
11995         section="8"> for details.
11996       </p>
11997
11998       <p>
11999         If <prgn>update-alternatives</prgn> does not seem appropriate
12000         you may wish to consider using diversions instead.</p>
12001     </appendix>
12002
12003     <appendix id="pkg-diversions"><heading>Diversions - overriding a
12004     package's version of a file (from old Packaging Manual)
12005       </heading>
12006
12007       <p>
12008         It is possible to have <prgn>dpkg</prgn> not overwrite a file
12009         when it reinstalls the package it belongs to, and to have it
12010         put the file from the package somewhere else instead.
12011       </p>
12012
12013       <p>
12014         This can be used locally to override a package's version of a
12015         file, or by one package to override another's version (or
12016         provide a wrapper for it).
12017       </p>
12018
12019       <p>
12020         Before deciding to use a diversion, read <ref
12021         id="pkg-alternatives"> to see if you really want a diversion
12022         rather than several alternative versions of a program.
12023       </p>
12024
12025       <p>
12026         There is a diversion list, which is read by <prgn>dpkg</prgn>,
12027         and updated by a special program <prgn>dpkg-divert</prgn>.
12028         Please see <manref name="dpkg-divert" section="8"> for full
12029         details of its operation.
12030       </p>
12031
12032       <p>
12033         When a package wishes to divert a file from another, it should
12034         call <prgn>dpkg-divert</prgn> in its preinst to add the
12035         diversion and rename the existing file.  For example,
12036         supposing that a <prgn>smailwrapper</prgn> package wishes to
12037         install a wrapper around <file>/usr/sbin/smail</file>:
12038         <example>
12039    dpkg-divert --package smailwrapper --add --rename \
12040       --divert /usr/sbin/smail.real /usr/sbin/smail
12041         </example> The <tt>--package smailwrapper</tt> ensures that
12042         <prgn>smailwrapper</prgn>'s copy of <file>/usr/sbin/smail</file>
12043         can bypass the diversion and get installed as the true version.
12044         It's safe to add the diversion unconditionally on upgrades since
12045         it will be left unchanged if it already exists, but
12046         <prgn>dpkg-divert</prgn> will display a message.  To suppress that
12047         message, make the command conditional on the version from which
12048         the package is being upgraded:
12049         <example>
12050    if [ upgrade != "$1" ] || dpkg --compare-versions "$2" lt 1.0-2; then
12051       dpkg-divert --package smailwrapper --add --rename \
12052          --divert /usr/sbin/smail.real /usr/sbin/smail
12053    fi
12054         </example> where <tt>1.0-2</tt> is the version at which the
12055         diversion was first added to the package.  Running the command
12056         during abort-upgrade is pointless but harmless.
12057       </p>
12058
12059       <p>
12060         The postrm has to do the reverse:
12061         <example>
12062   if [ remove = "$1" -o abort-install = "$1" -o disappear = "$1" ]; then
12063      dpkg-divert --package smailwrapper --remove --rename \
12064         --divert /usr/sbin/smail.real /usr/sbin/smail
12065   fi
12066         </example> If the diversion was added at a particular version, the
12067         postrm should also handle the failure case of upgrading from an
12068         older version (unless the older version is so old that direct
12069         upgrades are no longer supported):
12070         <example>
12071   if [ abort-upgrade = "$1" ] && dpkg --compare-versions "$2" lt 1.0-2; then
12072      dpkg-divert --package smailwrapper --remove --rename \
12073         --divert /usr/sbin/smail.real /usr/sbin/smail
12074   fi
12075         </example> where <tt>1.0-2</tt> is the version at which the
12076         diversion was first added to the package.  The postrm should not
12077         remove the diversion on upgrades both because there's no reason to
12078         remove the diversion only to immediately re-add it and since the
12079         postrm of the old package is run after unpacking so the removal of
12080         the diversion will fail.
12081       </p>
12082
12083       <p>
12084         Do not attempt to divert a file which is vitally important for
12085         the system's operation - when using <prgn>dpkg-divert</prgn>
12086         there is a time, after it has been diverted but before
12087         <prgn>dpkg</prgn> has installed the new version, when the file
12088         does not exist.</p>
12089
12090       <p>
12091         Do not attempt to divert a conffile, as <prgn>dpkg</prgn> does not
12092         handle it well.
12093       </p>
12094     </appendix>
12095
12096   </book>
12097 </debiandoc>
12098 <!-- Local variables: -->
12099 <!-- indent-tabs-mode: t -->
12100 <!-- End: -->
12101 <!-- vim:set ai sts=2 sw=2 tw=76: -->