]> git.donarmstrong.com Git - debian/debian-policy.git/blob - policy.sgml
Merge branch 'master' into bug478295-rra
[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 ]>
6 <debiandoc>
7
8   <book>
9     <titlepag>
10       <title>Debian Policy Manual</title>
11       <author><qref id="authors">The Debian Policy Mailing List</qref></author>
12       <version>version &version;, &date;</version>
13
14       <abstract>
15         This manual describes the policy requirements for the Debian
16         GNU/Linux distribution.  This includes the structure and
17         contents of the Debian archive and several design issues of
18         the operating system, as well as technical requirements that
19         each package must satisfy to be included in the distribution.
20       </abstract>
21
22       <copyright>
23         <copyrightsummary>
24           Copyright &copy; 1996,1997,1998 Ian Jackson
25           and Christian Schwarz.
26         </copyrightsummary>
27         <p>
28           These are the copyright dates of the original Policy manual.
29           Since then, this manual has been updated by many others.  No
30           comprehensive collection of copyright notices for subsequent
31           work exists.
32         </p>
33
34         <p>
35           This manual is free software; you may redistribute it and/or
36           modify it under the terms of the GNU General Public License
37           as published by the Free Software Foundation; either version
38           2, or (at your option) any later version.
39         </p>
40
41         <p>
42           This is distributed in the hope that it will be useful, but
43           <em>without any warranty</em>; without even the implied
44           warranty of merchantability or fitness for a particular
45           purpose.  See the GNU General Public License for more
46           details.
47         </p>
48
49         <p>
50           A copy of the GNU General Public License is available as
51           <file>/usr/share/common-licenses/GPL</file> in the Debian GNU/Linux
52           distribution or on the World Wide Web at
53           <url id="http://www.gnu.org/copyleft/gpl.html"
54                name="the GNU General Public Licence">. You can also
55           obtain it by writing to the Free Software Foundation, Inc.,
56           51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
57         </p>
58       </copyright>
59     </titlepag>
60
61     <toc detail="sect1">
62
63     <chapt id="scope">
64       <heading>About this manual</heading>
65       <sect>
66         <heading>Scope</heading>
67         <p>
68           This manual describes the policy requirements for the Debian
69           GNU/Linux distribution. This includes the structure and
70           contents of the Debian archive and several design issues of the
71           operating system, as well as technical requirements that
72           each package must satisfy to be included in the
73           distribution.
74         </p>
75
76         <p>
77           This manual also describes Debian policy as it relates to
78           creating Debian packages. It is not a tutorial on how to build
79           packages, nor is it exhaustive where it comes to describing
80           the behavior of the packaging system. Instead, this manual
81           attempts to define the interface to the package management
82           system that the developers have to be conversant with.<footnote>
83               Informally, the criteria used for inclusion is that the
84               material meet one of the following requirements:
85               <taglist compact="compact">
86                 <tag>Standard interfaces</tag>
87                 <item>
88                     The material presented represents an interface to
89                     the packaging system that is mandated for use, and
90                     is used by, a significant number of packages, and
91                     therefore should not be changed without peer
92                     review. Package maintainers can then rely on this
93                     interface not changing, and the package management
94                     software authors need to ensure compatibility with
95                     this interface definition. (Control file and
96                     changelog file formats are examples.)
97                 </item>
98                 <tag>Chosen Convention</tag>
99                 <item>
100                     If there are a number of technically viable choices
101                     that can be made, but one needs to select one of
102                     these options for inter-operability. The version
103                     number format is one example.
104                 </item>
105               </taglist>
106               Please note that these are not mutually exclusive;
107               selected conventions often become parts of standard
108               interfaces.
109           </footnote>
110         </p>
111
112         <p>
113           The footnotes present in this manual are
114           merely informative, and are not part of Debian policy itself.
115         </p>
116
117         <p>
118           The appendices to this manual are not necessarily normative,
119           either. Please see <ref id="pkg-scope"> for more information.
120         </p>
121
122         <p>
123           In the normative part of this manual,
124           the words <em>must</em>, <em>should</em> and
125           <em>may</em>, and the adjectives <em>required</em>,
126           <em>recommended</em> and <em>optional</em>, are used to
127           distinguish the significance of the various guidelines in
128           this policy document. Packages that do not conform to the
129           guidelines denoted by <em>must</em> (or <em>required</em>)
130           will generally not be considered acceptable for the Debian
131           distribution. Non-conformance with guidelines denoted by
132           <em>should</em> (or <em>recommended</em>) will generally be
133           considered a bug, but will not necessarily render a package
134           unsuitable for distribution. Guidelines denoted by
135           <em>may</em> (or <em>optional</em>) are truly optional and
136           adherence is left to the maintainer's discretion.
137         </p>
138
139         <p>
140           These classifications are roughly equivalent to the bug
141           severities <em>serious</em> (for <em>must</em> or
142           <em>required</em> directive violations), <em>minor</em>,
143           <em>normal</em> or <em>important</em>
144           (for <em>should</em> or <em>recommended</em> directive
145           violations) and <em>wishlist</em> (for <em>optional</em>
146           items).
147           <footnote>
148                 Compare RFC 2119.  Note, however, that these words are
149                 used in a different way in this document.
150           </footnote>
151         </p>
152
153         <p>
154           Much of the information presented in this manual will be
155           useful even when building a package which is to be
156           distributed in some other way or is intended for local use
157           only.
158         </p>
159       </sect>
160
161       <sect>
162         <heading>New versions of this document</heading>
163
164         <p>
165           This manual is distributed via the Debian package
166           <package><url name="debian-policy"
167               id="http://packages.debian.org/debian-policy"></package> 
168           (<httpsite>packages.debian.org</httpsite> 
169           <httppath>/debian-policy</httppath>).
170         </p>
171
172         <p>
173           The current version of this document is also available from
174           the Debian web mirrors at
175           <tt><url name="/doc/debian-policy/"
176                 id="http://www.debian.org/doc/debian-policy/"></tt>.
177           (
178           <httpsite>www.debian.org</httpsite>
179           <httppath>/doc/debian-policy/</httppath>)
180           Also available from the same directory are several other
181           formats: <file>policy.html.tar.gz</file>
182           (<httppath>/doc/debian-policy/policy.html.tar.gz</httppath>),
183           <file>policy.pdf.gz</file> 
184           (<httppath>/doc/debian-policy/policy.pdf.gz</httppath>)
185           and <file>policy.ps.gz</file>
186           (<httppath>/doc/debian-policy/policy.ps.gz</httppath>).
187         </p>
188
189         <p>
190           The <package>debian-policy</package> package also includes the file
191           <file>upgrading-checklist.txt.gz</file> which indicates policy
192           changes between versions of this document.
193         </p>
194       </sect>
195
196       <sect id="authors">
197         <heading>Authors and Maintainers</heading>
198
199         <p>
200           Originally called "Debian GNU/Linux Policy Manual", this
201           manual was initially written in 1996 by Ian Jackson.
202           It was revised on November 27th, 1996 by David A. Morris.
203           Christian Schwarz added new sections on March 15th, 1997,
204           and reworked/restructured it in April-July 1997.
205           Christoph Lameter contributed the "Web Standard".
206           Julian Gilbey largely restructured it in 2001.
207         </p>
208
209         <p>
210           Since September 1998, the responsibility for the contents of
211           this document lies on the <url name="debian-policy mailing list"
212           id="mailto:debian-policy@lists.debian.org">. Proposals
213           are discussed there and inserted into policy after a certain
214           consensus is established.
215           <!-- insert shameless policy-process plug here eventually -->
216           The actual editing is done by a group of maintainers that have
217           no editorial powers. These are the current maintainers:
218
219           <enumlist>
220             <item>Julian Gilbey</item>
221             <item>Branden Robinson</item>
222             <item>Josip Rodin</item>
223             <item>Manoj Srivastava</item>
224           </enumlist>
225         </p>
226
227         <p>
228           While the authors of this document have tried hard to avoid
229           typos and other errors, these do still occur. If you discover
230           an error in this manual or if you want to give any
231           comments, suggestions, or criticisms please send an email to
232           the Debian Policy List,
233           <email>debian-policy@lists.debian.org</email>, or submit a
234           bug report against the <tt>debian-policy</tt> package.
235         </p>
236
237         <p>
238           Please do not try to reach the individual authors or maintainers
239           of the Policy Manual regarding changes to the Policy.
240         </p>
241       </sect>
242
243       <sect id="related">
244         <heading>Related documents</heading>
245
246         <p>
247           There are several other documents other than this Policy Manual
248           that are necessary to fully understand some Debian policies and
249           procedures.
250         </p>
251
252         <p>
253           The external "sub-policy" documents are referred to in:
254           <list compact="compact">
255             <item><ref id="fhs"></item>
256             <item><ref id="virtual_pkg"></item>
257             <item><ref id="menus"></item>
258             <item><ref id="mime"></item>
259             <item><ref id="perl"></item>
260             <item><ref id="maintscriptprompt"></item>
261             <item><ref id="emacs"></item>
262           </list>
263         </p>
264
265         <p>
266           In addition to those, which carry the weight of policy, there
267           is the Debian Developer's Reference. This document describes
268           procedures and resources for Debian developers, but it is
269           <em>not</em> normative; rather, it includes things that don't
270           belong in the Policy, such as best practices for developers.
271         </p>
272
273         <p>
274           The Developer's Reference is available in the
275           <package>developers-reference</package> package.
276           It's also available from the Debian web mirrors at
277           <tt><url name="/doc/developers-reference/"
278                 id="http://www.debian.org/doc/developers-reference/"></tt>.
279         </p>
280       </sect>
281
282       <sect id="definitions">
283         <heading>Definitions</heading>
284
285         <p>
286           The following terms are used in this Policy Manual:
287           <taglist>
288             <tag>ASCII</tag>
289             <item>
290               The character encoding specified by ANSI X3.4-1986 and its
291               predecessor standards, referred to in MIME as US-ASCII, and
292               corresponding to an encoding in eight bits per character of
293               the first 128 <url id="http://www.unicode.org/"
294               name="Unicode"> characters, with the eighth bit always zero.
295             </item>
296             <tag>UTF-8</tag>
297             <item>
298               The transformation format (sometimes called encoding) of
299               <url id="http://www.unicode.org/" name="Unicode"> defined by
300               <url id="http://www.rfc-editor.org/rfc/rfc3629.txt"
301               name="RFC 3629">.  UTF-8 has the useful property of having
302               ASCII as a subset, so any text encoded in ASCII is trivially
303               also valid UTF-8.
304             </item>
305           </taglist>
306         </p>
307       </sect>
308     </chapt>
309
310
311     <chapt id="archive">
312       <heading>The Debian Archive</heading>
313
314       <p>
315         The Debian GNU/Linux system is maintained and distributed as a
316         collection of <em>packages</em>. Since there are so many of
317         them (currently well over 15000), they are split into
318         <em>sections</em> and given <em>priorities</em> to simplify
319         the handling of them.
320       </p>
321
322       <p>
323         The effort of the Debian project is to build a free operating
324         system, but not every package we want to make accessible is
325         <em>free</em> in our sense (see the Debian Free Software
326         Guidelines, below), or may be imported/exported without
327         restrictions. Thus, the archive is split into areas<footnote>
328           The Debian archive software uses the term "component" internally
329           and in the Release file format to refer to the division of an
330           archive.  The Debian Social Contract simply refers to "areas."
331           This document uses terminology similar to the Social Contract.
332         </footnote> based on their licenses and other restrictions.
333       </p>
334
335       <p>
336         The aims of this are:
337
338         <list compact="compact">
339           <item>to allow us to make as much software available as we can</item>
340           <item>to allow us to encourage everyone to write free software,
341                 and</item>
342           <item>to allow us to make it easy for people to produce
343                 CD-ROMs of our system without violating any licenses,
344                 import/export restrictions, or any other laws.</item>
345         </list>
346       </p>
347
348       <p>
349         The <em>main</em> archive area forms the <em>Debian GNU/Linux
350         distribution</em>.
351       </p>
352
353       <p>
354         Packages in the other archive areas (<tt>contrib</tt>,
355         <tt>non-free</tt>) are not considered to be part of the Debian
356         distribution, although we support their use and provide
357         infrastructure for them (such as our bug-tracking system and
358         mailing lists). This Debian Policy Manual applies to these
359         packages as well.
360       </p>
361
362       <sect id="dfsg">
363         <heading>The Debian Free Software Guidelines</heading>
364         <p>
365           The Debian Free Software Guidelines (DFSG) form our
366           definition of "free software".  These are:
367             <taglist>
368               <tag>1. Free Redistribution
369               </tag>
370               <item>
371                   The license of a Debian component may not restrict any
372                   party from selling or giving away the software as a
373                   component of an aggregate software distribution
374                   containing programs from several different
375                   sources. The license may not require a royalty or
376                   other fee for such sale.
377               </item>
378               <tag>2. Source Code
379               </tag>
380               <item>
381                   The program must include source code, and must allow
382                   distribution in source code as well as compiled form.
383               </item>
384               <tag>3. Derived Works
385               </tag>
386               <item>
387                   The license must allow modifications and derived
388                   works, and must allow them to be distributed under the
389                   same terms as the license of the original software.
390               </item>
391               <tag>4. Integrity of The Author's Source Code
392               </tag>
393               <item>
394                   The license may restrict source-code from being
395                   distributed in modified form <em>only</em> if the
396                   license allows the distribution of "patch files"
397                   with the source code for the purpose of modifying the
398                   program at build time. The license must explicitly
399                   permit distribution of software built from modified
400                   source code. The license may require derived works to
401                   carry a different name or version number from the
402                   original software.  (This is a compromise. The Debian
403                   Project encourages all authors to not restrict any
404                   files, source or binary, from being modified.)
405               </item>
406               <tag>5. No Discrimination Against Persons or Groups
407               </tag>
408               <item>
409                   The license must not discriminate against any person
410                   or group of persons.
411               </item>
412               <tag>6. No Discrimination Against Fields of Endeavor
413               </tag>
414               <item>
415                   The license must not restrict anyone from making use
416                   of the program in a specific field of endeavor. For
417                   example, it may not restrict the program from being
418                   used in a business, or from being used for genetic
419                   research.
420               </item>
421               <tag>7. Distribution of License
422               </tag>
423               <item>
424                   The rights attached to the program must apply to all
425                   to whom the program is redistributed without the need
426                   for execution of an additional license by those
427                   parties.
428               </item>
429               <tag>8. License Must Not Be Specific to Debian
430               </tag>
431               <item>
432                   The rights attached to the program must not depend on
433                   the program's being part of a Debian system. If the
434                   program is extracted from Debian and used or
435                   distributed without Debian but otherwise within the
436                   terms of the program's license, all parties to whom
437                   the program is redistributed must have the same
438                   rights as those that are granted in conjunction with
439                   the Debian system.
440               </item>
441               <tag>9. License Must Not Contaminate Other Software
442               </tag>
443               <item>
444                   The license must not place restrictions on other
445                   software that is distributed along with the licensed
446                   software. For example, the license must not insist
447                   that all other programs distributed on the same medium
448                   must be free software.
449               </item>
450               <tag>10. Example Licenses
451               </tag>
452               <item>
453                   The "GPL," "BSD," and "Artistic" licenses are examples of
454                   licenses that we consider <em>free</em>.
455               </item>
456             </taglist>
457         </p>
458       </sect>
459
460       <sect id="sections">
461         <heading>Archive areas</heading>
462
463         <sect1 id="main">
464           <heading>The main archive area</heading>
465
466           <p>
467             Every package in <em>main</em> must comply with the DFSG
468             (Debian Free Software Guidelines).
469           </p>
470
471           <p>
472             In addition, the packages in <em>main</em>
473             <list compact="compact">
474               <item>
475                   must not require a package outside of <em>main</em>
476                   for compilation or execution (thus, the package must
477                   not declare a "Depends", "Recommends", or
478                   "Build-Depends" relationship on a non-<em>main</em>
479                   package),
480               </item>
481               <item>
482                   must not be so buggy that we refuse to support them,
483                   and
484               </item>
485               <item>
486                   must meet all policy requirements presented in this
487                   manual.
488               </item>
489             </list>
490           </p>
491
492         </sect1>
493
494         <sect1 id="contrib">
495           <heading>The contrib archive area</heading>
496
497           <p>
498             Every package in <em>contrib</em> must comply with the DFSG.
499           </p>
500
501           <p>
502             In addition, the packages in <em>contrib</em>
503             <list compact="compact">
504               <item>
505                   must not be so buggy that we refuse to support them,
506                   and
507               </item>
508               <item>
509                   must meet all policy requirements presented in this
510                   manual.
511               </item>
512             </list>
513           </p>
514
515
516           <p>
517             Examples of packages which would be included in
518             <em>contrib</em> are:
519             <list compact="compact">
520               <item>
521                   free packages which require <em>contrib</em>,
522                   <em>non-free</em> packages or packages which are not
523                   in our archive at all for compilation or execution,
524                   and
525               </item>
526               <item>
527                   wrapper packages or other sorts of free accessories for
528                   non-free programs.
529               </item>
530             </list>
531           </p>
532         </sect1>
533
534         <sect1 id="non-free">
535           <heading>The non-free archive area</heading>
536
537           <p>
538             Packages must be placed in <em>non-free</em> if they are
539             not compliant with the DFSG or are encumbered by patents
540             or other legal issues that make their distribution
541             problematic.
542           </p>
543
544           <p>
545             In addition, the packages in <em>non-free</em>
546             <list compact="compact">
547               <item>
548                   must not be so buggy that we refuse to support them,
549                   and
550               </item>
551               <item>
552                   must meet all policy requirements presented in this
553                   manual that it is possible for them to meet.
554                   <footnote>
555                       It is possible that there are policy
556                       requirements which the package is unable to
557                       meet, for example, if the source is
558                       unavailable.  These situations will need to be
559                       handled on a case-by-case basis.
560                   </footnote>
561               </item>
562             </list>
563           </p>
564         </sect1>
565
566       </sect>
567
568       <sect id="pkgcopyright">
569         <heading>Copyright considerations</heading>
570
571         <p>
572           Every package must be accompanied by a verbatim copy of its
573           copyright information and distribution license in the file
574           <file>/usr/share/doc/<var>package</var>/copyright</file>
575           (see <ref id="copyrightfile"> for further details).
576         </p>
577
578         <p>
579           We reserve the right to restrict files from being included
580           anywhere in our archives if
581           <list compact="compact">
582             <item>
583                   their use or distribution would break a law,
584             </item>
585             <item>
586                   there is an ethical conflict in their distribution or
587                   use,
588             </item>
589             <item>
590                   we would have to sign a license for them, or
591             </item>
592             <item>
593                   their distribution would conflict with other project
594                   policies.
595             </item>
596           </list>
597         </p>
598
599         <p>
600           Programs whose authors encourage the user to make
601           donations are fine for the main distribution, provided
602           that the authors do not claim that not donating is
603           immoral, unethical, illegal or something similar; in such
604           a case they must go in <em>non-free</em>.
605         </p>
606
607         <p>
608           Packages whose copyright permission notices (or patent
609           problems) do not even allow redistribution of binaries
610           only, and where no special permission has been obtained,
611           must not be placed on the Debian FTP site and its mirrors
612           at all.
613         </p>
614
615         <p>
616           Note that under international copyright law (this applies
617           in the United States, too), <em>no</em> distribution or
618           modification of a work is allowed without an explicit
619           notice saying so.  Therefore a program without a copyright
620           notice <em>is</em> copyrighted and you may not do anything
621           to it without risking being sued! Likewise if a program
622           has a copyright notice but no statement saying what is
623           permitted then nothing is permitted.
624         </p>
625
626         <p>
627           Many authors are unaware of the problems that restrictive
628           copyrights (or lack of copyright notices) can cause for
629           the users of their supposedly-free software.  It is often
630           worthwhile contacting such authors diplomatically to ask
631           them to modify their license terms. However, this can be a
632           politically difficult thing to do and you should ask for
633           advice on the <tt>debian-legal</tt> mailing list first, as
634           explained below.
635         </p>
636
637         <p>
638           When in doubt about a copyright, send mail to
639           <email>debian-legal@lists.debian.org</email>.  Be prepared
640           to provide us with the copyright statement.  Software
641           covered by the GPL, public domain software and BSD-like
642           copyrights are safe; be wary of the phrases "commercial
643           use prohibited" and "distribution restricted".
644         </p>
645       </sect>
646
647       <sect id="subsections">
648         <heading>Sections</heading>
649
650         <p>
651           The packages in the archive areas <em>main</em>,
652           <em>contrib</em> and <em>non-free</em> are grouped further into
653           <em>sections</em> to simplify handling.
654         </p>
655
656         <p>
657           The archive area and section for each package should be
658           specified in the package's <tt>Section</tt> control record (see
659           <ref id="f-Section">).  However, the maintainer of the Debian
660           archive may override this selection to ensure the consistency of
661           the Debian distribution.  The <tt>Section</tt> field should be
662           of the form:
663           <list compact="compact">
664             <item>
665                   <em>section</em> if the package is in the
666                   <em>main</em> archive area,
667             </item>
668             <item>
669                   <em>area/section</em> if the package is in
670                   the <em>contrib</em> or <em>non-free</em>
671                   archive areas.
672             </item>
673           </list>
674         </p>
675
676         <p>
677           The Debian archive maintainers provide the authoritative
678           list of sections.  At present, they are:
679           <em>admin</em>, <em>cli-mono</em>, <em>comm</em>, <em>database</em>,
680           <em>devel</em>, <em>debug</em>, <em>doc</em>, <em>editors</em>,
681           <em>electronics</em>, <em>embedded</em>, <em>fonts</em>,
682           <em>games</em>, <em>gnome</em>, <em>graphics</em>, <em>gnu-r</em>,
683           <em>gnustep</em>, <em>hamradio</em>, <em>haskell</em>,
684           <em>httpd</em>, <em>interpreters</em>, <em>java</em>, <em>kde</em>,
685           <em>kernel</em>, <em>libs</em>, <em>libdevel</em>, <em>lisp</em>,
686           <em>localization</em>, <em>mail</em>, <em>math</em>, <em>misc</em>,
687           <em>net</em>, <em>news</em>, <em>ocaml</em>, <em>oldlibs</em>,
688           <em>otherosfs</em>, <em>perl</em>, <em>php</em>, <em>python</em>,
689           <em>ruby</em>, <em>science</em>, <em>shells</em>, <em>sound</em>,
690           <em>tex</em>, <em>text</em>, <em>utils</em>, <em>vcs</em>,
691           <em>video</em>, <em>web</em>, <em>x11</em>, <em>xfce</em>,
692           <em>zope</em>.  The additional section <em>debian-installer</em>
693           contains special packages used by the installer and is not used
694           for normal Debian packages.
695         </p>
696
697         <p>
698           For more information about the sections and their definitions,
699           see the <url id="http://packages.debian.org/unstable/"
700                        name="list of sections in unstable">.
701         </p>
702       </sect>
703
704       <sect id="priorities">
705         <heading>Priorities</heading>
706
707         <p>
708           Each package should have a <em>priority</em> value, which is
709           included in the package's <em>control record</em>
710           (see <ref id="f-Priority">).
711           This information is used by the Debian package management tools to
712           separate high-priority packages from less-important packages.
713         </p>
714
715         <p>
716           The following <em>priority levels</em> are recognized by the
717           Debian package management tools.
718           <taglist>
719             <tag><tt>required</tt></tag>
720             <item>
721                 Packages which are necessary for the proper
722                 functioning of the system (usually, this means that
723                 dpkg functionality depends on these packages).
724                 Removing a <tt>required</tt> package may cause your
725                 system to become totally broken and you may not even
726                 be able to use <prgn>dpkg</prgn> to put things back,
727                 so only do so if you know what you are doing.  Systems
728                 with only the <tt>required</tt> packages are probably
729                 unusable, but they do have enough functionality to
730                 allow the sysadmin to boot and install more software.
731             </item>
732             <tag><tt>important</tt></tag>
733             <item>
734                 Important programs, including those which one would
735                 expect to find on any Unix-like system.  If the
736                 expectation is that an experienced Unix person who
737                 found it missing would say "What on earth is going on,
738                 where is <prgn>foo</prgn>?", it must be an
739                 <tt>important</tt> package.<footnote>
740                     This is an important criterion because we are
741                     trying to produce, amongst other things, a free
742                     Unix.
743                 </footnote>
744                 Other packages without which the system will not run
745                 well or be usable must also have priority
746                 <tt>important</tt>.  This does
747                 <em>not</em> include Emacs, the X Window System, TeX
748                 or any other large applications.  The
749                 <tt>important</tt> packages are just a bare minimum of
750                 commonly-expected and necessary tools.
751             </item>
752             <tag><tt>standard</tt></tag>
753             <item>
754                 These packages provide a reasonably small but not too
755                 limited character-mode system.  This is what will be
756                 installed by default if the user doesn't select anything
757                 else.  It doesn't include many large applications.
758             </item>
759             <tag><tt>optional</tt></tag>
760             <item>
761                 (In a sense everything that isn't required is
762                 optional, but that's not what is meant here.) This is
763                 all the software that you might reasonably want to
764                 install if you didn't know what it was and don't have
765                 specialized requirements. This is a much larger system
766                 and includes the X Window System, a full TeX
767                 distribution, and many applications. Note that
768                 optional packages should not conflict with each other.
769             </item>
770             <tag><tt>extra</tt></tag>
771             <item>
772                 This contains all packages that conflict with others
773                 with required, important, standard or optional
774                 priorities, or are only likely to be useful if you
775                 already know what they are or have specialized
776                 requirements (such as packages containing only detached
777                 debugging symbols).
778             </item>
779           </taglist>
780         </p>
781
782         <p>
783           Packages must not depend on packages with lower priority
784           values (excluding build-time dependencies).  In order to
785           ensure this, the priorities of one or more packages may need
786           to be adjusted.
787         </p>
788       </sect>
789
790     </chapt>
791
792
793     <chapt id="binary">
794       <heading>Binary packages</heading>
795
796       <p>
797         The Debian GNU/Linux distribution is based on the Debian
798         package management system, called <prgn>dpkg</prgn>. Thus,
799         all packages in the Debian distribution must be provided
800         in the <tt>.deb</tt> file format.
801       </p>
802
803       <sect>
804         <heading>The package name</heading>
805
806         <p>
807           Every package must have a name that's unique within the Debian
808           archive.
809         </p>
810
811         <p>
812           The package name is included in the control field
813           <tt>Package</tt>, the format of which is described
814           in <ref id="f-Package">.
815           The package name is also included as a part of the file name
816           of the <tt>.deb</tt> file.
817         </p>
818       </sect>
819
820       <sect id="versions">
821         <heading>The version of a package</heading>
822
823         <p>
824           Every package has a version number recorded in its
825           <tt>Version</tt> control file field, described in
826           <ref id="f-Version">.
827         </p>
828
829         <p>
830           The package management system imposes an ordering on version
831           numbers, so that it can tell whether packages are being up- or
832           downgraded and so that package system front end applications
833           can tell whether a package it finds available is newer than
834           the one installed on the system.  The version number format
835           has the most significant parts (as far as comparison is
836           concerned) at the beginning.
837         </p>
838
839         <p>
840           If an upstream package has problematic version numbers they
841           should be converted to a sane form for use in the
842           <tt>Version</tt> field.
843         </p>
844
845         <sect1>
846           <heading>Version numbers based on dates</heading>
847
848           <p>
849             In general, Debian packages should use the same version
850             numbers as the upstream sources.
851           </p>
852
853           <p>
854             However, in some cases where the upstream version number is
855             based on a date (e.g., a development "snapshot" release) the
856             package management system cannot handle these version
857             numbers without epochs. For example, dpkg will consider
858             "96May01" to be greater than "96Dec24".
859           </p>
860
861           <p>
862             To prevent having to use epochs for every new upstream
863             version, the date based portion of the version number
864             should be changed to the following format in such cases:
865             "19960501", "19961224". It is up to the maintainer whether
866             they want to bother the upstream maintainer to change
867             the version numbers upstream, too.
868           </p>
869
870           <p>
871             Note that other version formats based on dates which are
872             parsed correctly by the package management system should
873             <em>not</em> be changed.
874           </p>
875
876           <p>
877             Native Debian packages (i.e., packages which have been
878             written especially for Debian) whose version numbers include
879             dates should always use the "YYYYMMDD" format.
880           </p>
881         </sect1>
882
883       </sect>
884
885       <sect>
886         <heading>The maintainer of a package</heading>
887
888         <p>
889           Every package must have a Debian maintainer (the
890           maintainer may be one person or a group of people
891           reachable from a common email address, such as a mailing
892           list).  The maintainer is responsible for ensuring that
893           the package is placed in the appropriate distributions.
894         </p>
895
896         <p>
897           The maintainer must be specified in the
898           <tt>Maintainer</tt> control field with their correct name
899           and a working email address.  If one person maintains
900           several packages, they should try to avoid having
901           different forms of their name and email address in
902           the <tt>Maintainer</tt> fields of those packages.
903         </p>
904
905         <p>
906           The format of the <tt>Maintainer</tt> control field is
907           described in <ref id="f-Maintainer">.
908         </p>
909
910         <p>
911           If the maintainer of a package quits from the Debian
912           project, "Debian QA Group"
913           <email>packages@qa.debian.org</email> takes over the
914           maintainer-ship of the package until someone else
915           volunteers for that task. These packages are called
916           <em>orphaned packages</em>.<footnote>
917                 The detailed procedure for doing this gracefully can
918                 be found in the Debian Developer's Reference,
919                 see <ref id="related">.
920           </footnote>
921         </p>
922       </sect>
923
924       <sect id="descriptions">
925         <heading>The description of a package</heading>
926
927         <p>
928           Every Debian package must have an extended description
929           stored in the appropriate field of the control record.
930           The technical information about the format of the
931           <tt>Description</tt> field is in <ref id="f-Description">.
932         </p>
933
934         <p>
935           The description should describe the package (the program) to a
936           user (system administrator) who has never met it before so that
937           they have enough information to decide whether they want to
938           install it. This description should not just be copied verbatim
939           from the program's documentation.
940         </p>
941
942         <p>
943           Put important information first, both in the synopsis and
944           extended description.  Sometimes only the first part of the
945           synopsis or of the description will be displayed.  You can
946           assume that there will usually be a way to see the whole
947           extended description.
948         </p>
949
950         <p>
951           The description should also give information about the
952           significant dependencies and conflicts between this package
953           and others, so that the user knows why these dependencies and
954           conflicts have been declared.
955         </p>
956
957         <p>
958           Instructions for configuring or using the package should
959           not be included (that is what installation scripts,
960           manual pages, info files, etc., are for).  Copyright
961           statements and other administrivia should not be included
962           either (that is what the copyright file is for).
963         </p>
964
965         <sect1 id="synopsis"><heading>The single line synopsis</heading>
966
967           <p>
968             The single line synopsis should be kept brief - certainly
969             under 80 characters.
970           </p>
971
972           <p>
973             Do not include the package name in the synopsis line.  The
974             display software knows how to display this already, and you
975             do not need to state it.  Remember that in many situations
976             the user may only see the synopsis line - make it as
977             informative as you can.
978           </p>
979
980         </sect1>
981
982         <sect1 id="extendeddesc"><heading>The extended description</heading>
983
984           <p>
985             Do not try to continue the single line synopsis into the
986             extended description.  This will not work correctly when
987             the full description is displayed, and makes no sense
988             where only the summary (the single line synopsis) is
989             available.
990           </p>
991
992           <p>
993             The extended description should describe what the package
994             does and how it relates to the rest of the system (in terms
995             of, for example, which subsystem it is which part of).
996           </p>
997
998           <p>
999             The description field needs to make sense to anyone, even
1000             people who have no idea about any of the things the
1001             package deals with.<footnote>
1002                 The blurb that comes with a program in its
1003                 announcements and/or <prgn>README</prgn> files is
1004                 rarely suitable for use in a description.  It is
1005                 usually aimed at people who are already in the
1006                 community where the package is used.
1007             </footnote>
1008           </p>
1009
1010         </sect1>
1011
1012       </sect>
1013
1014       <sect>
1015         <heading>Dependencies</heading>
1016
1017         <p>
1018           Every package must specify the dependency information
1019           about other packages that are required for the first to
1020           work correctly.
1021         </p>
1022
1023         <p>
1024           For example, a dependency entry must be provided for any
1025           shared libraries required by a dynamically-linked executable
1026           binary in a package.
1027         </p>
1028
1029         <p>
1030           Packages are not required to declare any dependencies they
1031           have on other packages which are marked <tt>Essential</tt>
1032           (see below), and should not do so unless they depend on a
1033           particular version of that package.<footnote>
1034             <p>
1035               Essential is needed in part to avoid unresolvable dependency
1036               loops on upgrade.  If packages add unnecessary dependencies
1037               on packages in this set, the chances that there
1038               <strong>will</strong> be an unresolvable dependency loop
1039               caused by forcing these Essential packages to be configured
1040               first before they need to be is greatly increased.  It also
1041               increases the chances that frontends will be unable to
1042               <strong>calculate</strong> an upgrade path, even if one
1043               exists.
1044             </p>
1045             <p>
1046               Also, functionality is rarely ever removed from the
1047               Essential set, but <em>packages</em> have been removed from
1048               the Essential set when the functionality moved to a
1049               different package. So depending on these packages <em>just
1050               in case</em> they stop being essential does way more harm
1051               than good.
1052             </p>
1053           </footnote>
1054         </p>
1055
1056         <p>
1057           Sometimes, a package requires another package to be installed
1058           <em>and</em> configured before it can be installed. In this
1059           case, you must specify a <tt>Pre-Depends</tt> entry for
1060           the package.
1061         </p>
1062
1063         <p>
1064           You should not specify a <tt>Pre-Depends</tt> entry for a
1065           package before this has been discussed on the
1066           <tt>debian-devel</tt> mailing list and a consensus about
1067           doing that has been reached.
1068         </p>
1069
1070         <p>
1071           The format of the package interrelationship control fields is
1072           described in <ref id="relationships">.
1073         </p>
1074       </sect>
1075
1076       <sect id="virtual_pkg">
1077         <heading>Virtual packages</heading>
1078
1079         <p>
1080           Sometimes, there are several packages which offer
1081           more-or-less the same functionality. In this case, it's
1082           useful to define a <em>virtual package</em> whose name
1083           describes that common functionality.  (The virtual
1084           packages only exist logically, not physically; that's why
1085           they are called <em>virtual</em>.) The packages with this
1086           particular function will then <em>provide</em> the virtual
1087           package. Thus, any other package requiring that function
1088           can simply depend on the virtual package without having to
1089           specify all possible packages individually.
1090         </p>
1091
1092         <p>
1093           All packages should use virtual package names where
1094           appropriate, and arrange to create new ones if necessary.
1095           They should not use virtual package names (except privately,
1096           amongst a cooperating group of packages) unless they have
1097           been agreed upon and appear in the list of virtual package
1098           names. (See also <ref id="virtual">)
1099         </p>
1100
1101         <p>
1102           The latest version of the authoritative list of virtual
1103           package names can be found in the <tt>debian-policy</tt> package.
1104           It is also available from the Debian web mirrors at
1105           <tt><url name="/doc/packaging-manuals/virtual-package-names-list.txt"
1106                 id="http://www.debian.org/doc/packaging-manuals/virtual-package-names-list.txt"></tt>.
1107         </p>
1108
1109         <p>
1110           The procedure for updating the list is described in the preface
1111           to the list.
1112         </p>
1113
1114       </sect>
1115
1116       <sect>
1117         <heading>Base system</heading>
1118
1119         <p>
1120           The <tt>base system</tt> is a minimum subset of the Debian
1121           GNU/Linux system that is installed before everything else
1122           on a new system. Only very few packages are allowed to form
1123           part of the base system, in order to keep the required disk
1124           usage very small.
1125         </p>
1126
1127         <p>
1128           The base system consists of all those packages with priority
1129           <tt>required</tt> or <tt>important</tt>. Many of them will
1130           be tagged <tt>essential</tt> (see below).
1131         </p>
1132       </sect>
1133
1134       <sect>
1135         <heading>Essential packages</heading>
1136
1137         <p>
1138           Essential is defined as the minimal set of functionality that
1139           must be available and usable on the system at all times, even
1140           when packages are in an unconfigured (but unpacked) state.
1141           Packages are tagged <tt>essential</tt> for a system using the
1142           <tt>Essential</tt> control file field.  The format of the
1143           <tt>Essential</tt> control field is described in <ref
1144           id="f-Essential">.
1145         </p>
1146
1147         <p>
1148           Since these packages cannot be easily removed (one has to
1149           specify an extra <em>force option</em> to
1150           <prgn>dpkg</prgn> to do so), this flag must not be used
1151           unless absolutely necessary.  A shared library package
1152           must not be tagged <tt>essential</tt>; dependencies will
1153           prevent its premature removal, and we need to be able to
1154           remove it when it has been superseded.
1155         </p>
1156
1157         <p>
1158           Since dpkg will not prevent upgrading of other packages
1159           while an <tt>essential</tt> package is in an unconfigured
1160             state, all <tt>essential</tt> packages must supply all of
1161             their core functionality even when unconfigured. If the
1162             package cannot satisfy this requirement it must not be
1163             tagged as essential, and any packages depending on this
1164             package must instead have explicit dependency fields as
1165             appropriate.
1166         </p>
1167
1168         <p>
1169           Maintainers should take great care in adding any programs,
1170           interfaces, or functionality to <tt>essential</tt> packages.
1171           Packages may assume that functionality provided by
1172           <tt>essential</tt> packages is always available without
1173           declaring explicit dependencies, which means that removing
1174           functionality from the Essential set is very difficult and is
1175           almost never done.  Any capability added to an
1176           <tt>essential</tt> package therefore creates an obligation to
1177           support that capability as part of the Essential set in
1178           perpetuity.
1179         </p>
1180
1181         <p>
1182           You must not tag any packages <tt>essential</tt> before
1183           this has been discussed on the <tt>debian-devel</tt>
1184           mailing list and a consensus about doing that has been
1185           reached.
1186         </p>
1187       </sect>
1188
1189       <sect id="maintscripts">
1190         <heading>Maintainer Scripts</heading>
1191
1192         <p>
1193           The package installation scripts should avoid producing
1194           output which is unnecessary for the user to see and
1195           should rely on <prgn>dpkg</prgn> to stave off boredom on
1196           the part of a user installing many packages.  This means,
1197           amongst other things, using the <tt>--quiet</tt> option on
1198           <prgn>install-info</prgn>.
1199         </p>
1200
1201         <p>
1202           Errors which occur during the execution of an installation
1203           script must be checked and the installation must not
1204           continue after an error.
1205         </p>
1206
1207         <p>
1208           Note that in general <ref id="scripts"> applies to package
1209           maintainer scripts, too.
1210         </p>
1211
1212         <p>
1213           You should not use <prgn>dpkg-divert</prgn> on a file
1214           belonging to another package without consulting the
1215           maintainer of that package first.
1216         </p>
1217
1218         <p>
1219           All packages which supply an instance of a common command
1220           name (or, in general, filename) should generally use
1221           <prgn>update-alternatives</prgn>, so that they may be
1222           installed together.  If <prgn>update-alternatives</prgn>
1223           is not used, then each package must use
1224           <tt>Conflicts</tt> to ensure that other packages are
1225           de-installed.  (In this case, it may be appropriate to
1226           specify a conflict against earlier versions of something
1227           that previously did not use
1228           <prgn>update-alternatives</prgn>; this is an exception to
1229           the usual rule that versioned conflicts should be
1230           avoided.)
1231         </p>
1232
1233         <sect1 id="maintscriptprompt">
1234           <heading>Prompting in maintainer scripts</heading>
1235           <p>
1236             Package maintainer scripts may prompt the user if
1237             necessary. Prompting must be done by communicating
1238             through a program, such as <prgn>debconf</prgn>, which
1239             conforms to the Debian Configuration Management
1240             Specification, version 2 or higher.
1241           </p>
1242
1243           <p>
1244             Packages which are essential, or which are dependencies of
1245             essential packages, may fall back on another prompting method
1246             if no such interface is available when they are executed.
1247           </p>
1248
1249           <p>
1250             The Debian Configuration Management Specification is included
1251             in the <file>debconf_specification</file> files in the
1252             <package>debian-policy</package> package.
1253             It is also available from the Debian web mirrors at
1254             <tt><url name="/doc/packaging-manuals/debconf_specification.html"
1255                 id="http://www.debian.org/doc/packaging-manuals/debconf_specification.html"></tt>.
1256           </p>
1257
1258           <p>
1259             Packages which use the Debian Configuration Management
1260             Specification may contain an additional
1261             <prgn>config</prgn> script and a <tt>templates</tt>
1262             file in their control archive<footnote>
1263                 The control.tar.gz inside the .deb.
1264                 See <manref name="deb" section="5">.
1265             </footnote>.
1266             The <prgn>config</prgn> script might be run before the
1267             <prgn>preinst</prgn> script, and before the package is unpacked
1268             or any of its dependencies or pre-dependencies are satisfied.
1269             Therefore it must work using only the tools present in
1270             <em>essential</em> packages.<footnote>
1271                   <package>Debconf</package> or another tool that
1272                   implements the Debian Configuration Management
1273                   Specification will also be installed, and any
1274                   versioned dependencies on it will be satisfied
1275                   before preconfiguration begins.
1276             </footnote>
1277           </p>
1278
1279           <p>
1280             Packages which use the Debian Configuration Management
1281             Specification must allow for translation of their user-visible
1282             messages by using a gettext-based system such as the one
1283             provided by the <package>po-debconf</package> package.
1284           </p>
1285
1286           <p>
1287             Packages should try to minimize the amount of prompting
1288             they need to do, and they should ensure that the user
1289             will only ever be asked each question once.  This means
1290             that packages should try to use appropriate shared
1291             configuration files (such as <file>/etc/papersize</file> and
1292             <file>/etc/news/server</file>), and shared
1293             <package>debconf</package> variables rather than each
1294             prompting for their own list of required pieces of
1295             information.
1296           </p>
1297
1298           <p>
1299             It also means that an upgrade should not ask the same
1300             questions again, unless the user has used
1301             <tt>dpkg --purge</tt> to remove the package's configuration.
1302             The answers to configuration questions should be stored in an
1303             appropriate place in <file>/etc</file> so that the user can
1304             modify them, and how this has been done should be
1305             documented.
1306           </p>
1307
1308           <p>
1309             If a package has a vitally important piece of
1310             information to pass to the user (such as "don't run me
1311             as I am, you must edit the following configuration files
1312             first or you risk your system emitting badly-formatted
1313             messages"), it should display this in the
1314             <prgn>config</prgn> or <prgn>postinst</prgn> script and
1315             prompt the user to hit return to acknowledge the
1316             message.  Copyright messages do not count as vitally
1317             important (they belong in
1318             <file>/usr/share/doc/<var>package</var>/copyright</file>);
1319             neither do instructions on how to use a program (these
1320             should be in on-line documentation, where all the users
1321             can see them).
1322           </p>
1323
1324           <p>
1325             Any necessary prompting should almost always be confined
1326             to the <prgn>config</prgn> or <prgn>postinst</prgn>
1327             script. If it is done in the <prgn>postinst</prgn>, it
1328             should be protected with a conditional so that
1329             unnecessary prompting doesn't happen if a package's
1330             installation fails and the <prgn>postinst</prgn> is
1331             called with <tt>abort-upgrade</tt>,
1332             <tt>abort-remove</tt> or <tt>abort-deconfigure</tt>.
1333           </p>
1334         </sect1>
1335
1336       </sect>
1337
1338     </chapt>
1339
1340
1341     <chapt id="source">
1342       <heading>Source packages</heading>
1343
1344       <sect id="standardsversion">
1345         <heading>Standards conformance</heading>
1346
1347         <p>
1348           Source packages should specify the most recent version number
1349           of this policy document with which your package complied
1350           when it was last updated.
1351         </p>
1352
1353         <p>
1354           This information may be used to file bug reports
1355           automatically if your package becomes too much out of date.
1356         </p>
1357
1358         <p>
1359           The version is specified in the <tt>Standards-Version</tt>
1360           control field.
1361           The format of the <tt>Standards-Version</tt> field is
1362           described in <ref id="f-Standards-Version">.
1363         </p>
1364
1365         <p>
1366           You should regularly, and especially if your package has
1367           become out of date, check for the newest Policy Manual
1368           available and update your package, if necessary. When your
1369           package complies with the new standards you should update the
1370           <tt>Standards-Version</tt> source package field and
1371           release it.<footnote>
1372                 See the file <file>upgrading-checklist</file> for
1373                 information about policy which has changed between
1374                 different versions of this document.
1375           </footnote>
1376         </p>
1377
1378       </sect>
1379
1380       <sect id="pkg-relations">
1381         <heading>Package relationships</heading>
1382
1383         <p>
1384           Source packages should specify which binary packages they
1385           require to be installed or not to be installed in order to
1386           build correctly.  For example, if building a package
1387           requires a certain compiler, then the compiler should be
1388           specified as a build-time dependency.
1389         </p>
1390
1391         <p>
1392           It is not necessary to explicitly specify build-time
1393           relationships on a minimal set of packages that are always
1394           needed to compile, link and put in a Debian package a
1395           standard "Hello World!" program written in C or C++.  The
1396           required packages are called <em>build-essential</em>, and
1397           an informational list can be found in
1398           <file>/usr/share/doc/build-essential/list</file> (which is
1399           contained in the <tt>build-essential</tt>
1400           package).<footnote>
1401             Rationale:
1402                 <list compact="compact">
1403                   <item>
1404                       This allows maintaining the list separately
1405                       from the policy documents (the list does not
1406                       need the kind of control that the policy
1407                       documents do).
1408                   </item>
1409                   <item>
1410                       Having a separate package allows one to install
1411                       the build-essential packages on a machine, as
1412                       well as allowing other packages such as tasks to
1413                       require installation of the build-essential
1414                       packages using the depends relation.
1415                   </item>
1416                   <item>
1417                       The separate package allows bug reports against
1418                       the list to be categorized separately from
1419                       the policy management process in the BTS.
1420                   </item>
1421                 </list>
1422           </footnote>
1423         </p>
1424
1425         <p>
1426           When specifying the set of build-time dependencies, one
1427           should list only those packages explicitly required by the
1428           build.  It is not necessary to list packages which are
1429           required merely because some other package in the list of
1430           build-time dependencies depends on them.<footnote>
1431                 The reason for this is that dependencies change, and
1432                 you should list all those packages, and <em>only</em>
1433                 those packages that <em>you</em> need directly.  What
1434                 others need is their business.  For example, if you
1435                 only link against <file>libimlib</file>, you will need to
1436                 build-depend on <package>libimlib2-dev</package> but
1437                 not against any <tt>libjpeg*</tt> packages, even
1438                 though <tt>libimlib2-dev</tt> currently depends on
1439                 them: installation of <package>libimlib2-dev</package>
1440                 will automatically ensure that all of its run-time
1441                 dependencies are satisfied.
1442           </footnote>
1443         </p>
1444
1445         <p>
1446           If build-time dependencies are specified, it must be
1447           possible to build the package and produce working binaries
1448           on a system with only essential and build-essential
1449           packages installed and also those required to satisfy the
1450           build-time relationships (including any implied
1451           relationships).  In particular, this means that version
1452           clauses should be used rigorously in build-time
1453           relationships so that one cannot produce bad or
1454           inconsistently configured packages when the relationships
1455           are properly satisfied.
1456         </p>
1457
1458         <p>
1459           <ref id="relationships"> explains the technical details.
1460         </p>
1461       </sect>
1462
1463       <sect>
1464         <heading>Changes to the upstream sources</heading>
1465
1466         <p>
1467           If changes to the source code are made that are not
1468           specific to the needs of the Debian system, they should be
1469           sent to the upstream authors in whatever form they prefer
1470           so as to be included in the upstream version of the
1471           package.
1472         </p>
1473
1474         <p>
1475           If you need to configure the package differently for
1476           Debian or for Linux, and the upstream source doesn't
1477           provide a way to do so, you should add such configuration
1478           facilities (for example, a new <prgn>autoconf</prgn> test
1479           or <tt>#define</tt>) and send the patch to the upstream
1480           authors, with the default set to the way they originally
1481           had it.  You can then easily override the default in your
1482           <file>debian/rules</file> or wherever is appropriate.
1483         </p>
1484
1485         <p>
1486           You should make sure that the <prgn>configure</prgn> utility
1487           detects the correct architecture specification string
1488           (refer to <ref id="arch-spec"> for details).
1489         </p>
1490
1491         <p>
1492           If you need to edit a <prgn>Makefile</prgn> where GNU-style
1493           <prgn>configure</prgn> scripts are used, you should edit the
1494           <file>.in</file> files rather than editing the
1495           <prgn>Makefile</prgn> directly.  This allows the user to
1496           reconfigure the package if necessary.  You should
1497           <em>not</em> configure the package and edit the generated
1498           <prgn>Makefile</prgn>!  This makes it impossible for someone
1499           else to later reconfigure the package without losing the
1500           changes you made.
1501         </p>
1502
1503       </sect>
1504
1505       <sect id="dpkgchangelog">
1506         <heading>Debian changelog: <file>debian/changelog</file></heading>
1507
1508         <p>
1509           Changes in the Debian version of the package should be
1510           briefly explained in the Debian changelog file
1511           <file>debian/changelog</file>.<footnote>
1512             <p>
1513               Mistakes in changelogs are usually best rectified by
1514               making a new changelog entry rather than "rewriting
1515               history" by editing old changelog entries.
1516             </p>
1517           </footnote>
1518           This includes modifications
1519           made in the Debian package compared to the upstream one
1520           as well as other changes and updates to the package.
1521           <footnote>
1522               Although there is nothing stopping an author who is also
1523               the Debian maintainer from using this changelog for all
1524               their changes, it will have to be renamed if the Debian
1525               and upstream maintainers become different people. In such
1526               a case, however, it might be better to maintain the package
1527               as a non-native package.
1528           </footnote>
1529         </p>
1530
1531         <p>
1532           The format of the <file>debian/changelog</file> allows the
1533           package building tools to discover which version of the package
1534           is being built and find out other release-specific information.
1535         </p>
1536
1537         <p>
1538           That format is a series of entries like this:
1539
1540 <example compact="compact">
1541 <var>package</var> (<var>version</var>) <var>distribution(s)</var>; urgency=<var>urgency</var>
1542             <var>
1543               [optional blank line(s), stripped]
1544             </var>
1545   * <var>change details</var>
1546     <var>more change details</var>
1547             <var>
1548               [blank line(s), included in output of dpkg-parsechangelog]
1549             </var>
1550   * <var>even more change details</var>
1551             <var>
1552               [optional blank line(s), stripped]
1553             </var>
1554  -- <var>maintainer name</var> &lt;<var>email address</var>&gt;<var>[two spaces]</var>  <var>date</var>
1555 </example>
1556         </p>
1557
1558         <p>
1559           <var>package</var> and <var>version</var> are the source
1560           package name and version number.
1561         </p>
1562
1563         <p>
1564           <var>distribution(s)</var> lists the distributions where
1565           this version should be installed when it is uploaded - it
1566           is copied to the <tt>Distribution</tt> field in the
1567           <file>.changes</file> file.  See <ref id="f-Distribution">.
1568         </p>
1569
1570         <p>
1571           <var>urgency</var> is the value for the <tt>Urgency</tt>
1572           field in the <file>.changes</file> file for the upload
1573           (see <ref id="f-Urgency">). It is not possible to specify
1574           an urgency containing commas; commas are used to separate
1575           <tt><var>keyword</var>=<var>value</var></tt> settings in the
1576           <prgn>dpkg</prgn> changelog format (though there is
1577           currently only one useful <var>keyword</var>,
1578           <tt>urgency</tt>).
1579         </p>
1580
1581         <p>
1582           The change details may in fact be any series of lines
1583           starting with at least two spaces, but conventionally each
1584           change starts with an asterisk and a separating space and
1585           continuation lines are indented so as to bring them in
1586           line with the start of the text above.  Blank lines may be
1587           used here to separate groups of changes, if desired.
1588         </p>
1589
1590         <p>
1591           If this upload resolves bugs recorded in the Bug Tracking
1592           System (BTS), they may be automatically closed on the
1593           inclusion of this package into the Debian archive by
1594           including the string: <tt>closes: Bug#<var>nnnnn</var></tt>
1595           in the change details.<footnote>
1596               To be precise, the string should match the following
1597               Perl regular expression:
1598               <example>
1599 /closes:\s*(?:bug)?\#?\s?\d+(?:,\s*(?:bug)?\#?\s?\d+)*/i
1600               </example>
1601               Then all of the bug numbers listed will be closed by the
1602               archive maintenance script (<prgn>katie</prgn>) using the
1603               <var>version</var> of the changelog entry.
1604           </footnote>
1605           This information is conveyed via the <tt>Closes</tt> field
1606           in the <tt>.changes</tt> file (see <ref id="f-Closes">).
1607         </p>
1608
1609         <p>
1610           The maintainer name and email address used in the changelog
1611           should be the details of the person uploading <em>this</em>
1612           version.  They are <em>not</em> necessarily those of the
1613           usual package maintainer.  The information here will be
1614           copied to the <tt>Changed-By</tt> field in the
1615           <tt>.changes</tt> file (see <ref id="f-Changed-By">),
1616           and then later used to send an acknowledgement when the
1617           upload has been installed.
1618         </p>
1619
1620         <p>
1621           The <var>date</var> has the following format<footnote>
1622               This is the same as the format generated by <tt>date
1623               -R</tt>.
1624           </footnote> (compatible and with the same semantics of
1625           RFC 2822 and RFC 5322):
1626           <example>day-of-week, dd month yyyy hh:mm:ss +zzzz</example>
1627           where:
1628           <list compact="compact">
1629             <item>
1630               day-of week is one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun
1631             </item>
1632             <item>
1633               dd is a one- or two-digit day of the month (01-31)
1634             </item>
1635             <item>
1636               month is one of: Jan, Feb, Mar, Apr, May, Jun, Jul, Aug,
1637               Sep, Oct, Nov, Dec
1638             </item>
1639             <item>yyyy is the four-digit year (e.g. 2010)</item>
1640             <item>hh is the two-digit hour (00-23)</item>
1641             <item>mm is the two-digit minutes (00-59)</item>
1642             <item>ss is the two-digit seconds (00-60)</item>
1643             <item>
1644               +zzzz or -zzzz is the the time zone offset from Coordinated
1645               Universal Time (UTC).  "+" indicates that the time is ahead
1646               of (i.e., east of) UTC and "-" indicates that the time is
1647               behind (i.e., west of) UTC.  The first two digits indicate
1648               the hour difference from UTC and the last two digits
1649               indicate the number of additional minutes difference from
1650               UTC.  The last two digits must be in the range 00-59.
1651             </item>
1652           </list>
1653         </p>
1654
1655         <p>
1656           The first "title" line with the package name must start
1657           at the left hand margin.  The "trailer" line with the
1658           maintainer and date details must be preceded by exactly
1659           one space.  The maintainer details and the date must be
1660           separated by exactly two spaces.
1661         </p>
1662
1663         <p>
1664           The entire changelog must be encoded in UTF-8.
1665         </p>
1666
1667         <p>
1668           For more information on placement of the changelog files
1669           within binary packages, please see <ref id="changelogs">.
1670         </p>
1671       </sect>
1672
1673       <sect id="dpkgcopyright">
1674         <heading>Copyright: <file>debian/copyright</file></heading>
1675         <p>
1676           Every package must be accompanied by a verbatim copy of its
1677           copyright information and distribution license in the file
1678           <file>/usr/share/doc/<var>package</var>/copyright</file>
1679           (see <ref id="copyrightfile"> for further details). Also see
1680           <ref id="pkgcopyright"> for further considerations related
1681           to copyrights for packages.
1682         </p>
1683       </sect>
1684       <sect>
1685         <heading>Error trapping in makefiles</heading>
1686
1687         <p>
1688           When <prgn>make</prgn> invokes a command in a makefile
1689           (including your package's upstream makefiles and
1690           <file>debian/rules</file>), it does so using <prgn>sh</prgn>.  This
1691           means that <prgn>sh</prgn>'s usual bad error handling
1692           properties apply: if you include a miniature script as one
1693           of the commands in your makefile you'll find that if you
1694           don't do anything about it then errors are not detected
1695           and <prgn>make</prgn> will blithely continue after
1696           problems.
1697         </p>
1698
1699         <p>
1700           Every time you put more than one shell command (this
1701           includes using a loop) in a makefile command you
1702           must make sure that errors are trapped.  For
1703           simple compound commands, such as changing directory and
1704           then running a program, using <tt>&amp;&amp;</tt> rather
1705           than semicolon as a command separator is sufficient.  For
1706           more complex commands including most loops and
1707           conditionals you should include a separate <tt>set -e</tt>
1708           command at the start of every makefile command that's
1709           actually one of these miniature shell scripts.
1710         </p>
1711       </sect>
1712
1713       <sect id="timestamps">
1714         <heading>Time Stamps</heading>
1715         <p>
1716           Maintainers should preserve the modification times of the
1717           upstream source files in a package, as far as is reasonably
1718           possible.<footnote>
1719               The rationale is that there is some information conveyed
1720               by knowing the age of the file, for example, you could
1721               recognize that some documentation is very old by looking
1722               at the modification time, so it would be nice if the
1723               modification time of the upstream source would be
1724               preserved.
1725           </footnote>
1726         </p>
1727       </sect>
1728
1729       <sect id="restrictions">
1730         <heading>Restrictions on objects in source packages</heading>
1731
1732         <p>
1733           The source package may not contain any hard links<footnote>
1734             <p>
1735               This is not currently detected when building source
1736               packages, but only when extracting
1737               them.
1738             </p>
1739             <p>
1740               Hard links may be permitted at some point in the
1741               future, but would require a fair amount of
1742               work.
1743             </p>
1744           </footnote>, device special files, sockets or setuid or
1745           setgid files.<footnote>
1746               Setgid directories are allowed.
1747           </footnote>
1748         </p>
1749       </sect>
1750
1751       <sect id="debianrules">
1752         <heading>Main building script: <file>debian/rules</file></heading>
1753
1754         <p>
1755           This file must be an executable makefile, and contains the
1756           package-specific recipes for compiling the package and
1757           building binary package(s) from the source.
1758         </p>
1759
1760         <p>
1761           It must start with the line <tt>#!/usr/bin/make -f</tt>,
1762           so that it can be invoked by saying its name rather than
1763           invoking <prgn>make</prgn> explicitly. That is, invoking
1764           either of <tt>make -f debian/rules <em>args...</em></tt>
1765           or <tt>./debian/rules <em>args...</em></tt> must result in
1766           identical behavior.
1767         </p>
1768
1769         <p>
1770           Since an interactive <file>debian/rules</file> script makes it
1771           impossible to auto-compile that package and also makes it
1772           hard for other people to reproduce the same binary
1773           package, all <em>required targets</em> must be
1774           non-interactive. At a minimum, required targets are the
1775           ones called by <prgn>dpkg-buildpackage</prgn>, namely,
1776           <em>clean</em>, <em>binary</em>, <em>binary-arch</em>,
1777           <em>binary-indep</em>, and <em>build</em>. It also follows
1778           that any target that these targets depend on must also be
1779           non-interactive.
1780         </p>
1781
1782         <p>
1783           The targets are as follows (required unless stated otherwise):
1784           <taglist>
1785             <tag><tt>build</tt></tag>
1786             <item>
1787               <p>
1788                 The <tt>build</tt> target should perform all the
1789                 configuration and compilation of the package.
1790                 If a package has an interactive pre-build
1791                 configuration routine, the Debianized source package
1792                 must either be built after this has taken place (so
1793                 that the binary package can be built without rerunning
1794                 the configuration) or the configuration routine
1795                 modified to become non-interactive.  (The latter is
1796                 preferable if there are architecture-specific features
1797                 detected by the configuration routine.)
1798               </p>
1799
1800               <p>
1801                 For some packages, notably ones where the same
1802                 source tree is compiled in different ways to produce
1803                 two binary packages, the <tt>build</tt> target
1804                 does not make much sense.  For these packages it is
1805                 good enough to provide two (or more) targets
1806                 (<tt>build-a</tt> and <tt>build-b</tt> or whatever)
1807                 for each of the ways of building the package, and a
1808                 <tt>build</tt> target that does nothing.  The
1809                 <tt>binary</tt> target will have to build the
1810                 package in each of the possible ways and make the
1811                 binary package out of each.
1812               </p>
1813
1814               <p>
1815                 The <tt>build</tt> target must not do anything
1816                 that might require root privilege.
1817               </p>
1818
1819               <p>
1820                 The <tt>build</tt> target may need to run the
1821                 <tt>clean</tt> target first - see below.
1822               </p>
1823
1824               <p>
1825                 When a package has a configuration and build routine
1826                 which takes a long time, or when the makefiles are
1827                 poorly designed, or when <tt>build</tt> needs to
1828                 run <tt>clean</tt> first, it is a good idea to
1829                 <tt>touch build</tt> when the build process is
1830                 complete.  This will ensure that if <tt>debian/rules
1831                 build</tt> is run again it will not rebuild the whole
1832                 program.<footnote>
1833                     Another common way to do this is for <tt>build</tt>
1834                     to depend on <prgn>build-stamp</prgn> and to do
1835                     nothing else, and for the <prgn>build-stamp</prgn>
1836                     target to do the building and to <tt>touch
1837                     build-stamp</tt> on completion.  This is
1838                     especially useful if the build routine creates a
1839                     file or directory called <tt>build</tt>; in such a
1840                     case, <tt>build</tt> will need to be listed as
1841                     a phony target (i.e., as a dependency of the
1842                     <tt>.PHONY</tt> target).  See the documentation of
1843                     <prgn>make</prgn> for more information on phony
1844                     targets.
1845                 </footnote>
1846               </p>
1847             </item>
1848
1849             <tag><tt>build-arch</tt> (optional),
1850                  <tt>build-indep</tt> (optional)
1851             </tag>
1852             <item>
1853               <p>
1854                 A package may also provide both of the targets
1855                 <tt>build-arch</tt> and <tt>build-indep</tt>.
1856                 The <tt>build-arch</tt> target, if provided, should
1857                 perform all the configuration and compilation required for
1858                 producing all architecture-dependant binary packages
1859                 (those packages for which the body of the
1860                 <tt>Architecture</tt> field in <tt>debian/control</tt> is
1861                 not <tt>all</tt>).  Similarly, the <tt>build-indep</tt>
1862                 target, if provided, should perform all the configuration
1863                 and compilation required for producing all
1864                 architecture-independent binary packages (those packages
1865                 for which the body of the <tt>Architecture</tt> field
1866                 in <tt>debian/control</tt> is <tt>all</tt>).
1867                 The <tt>build</tt> target should depend on those of the
1868                 targets <tt>build-arch</tt> and <tt>build-indep</tt> that
1869                 are provided in the rules file.<footnote>
1870                   The intent of this split is so that binary-only builds
1871                   need not install the dependencies required for
1872                   the <tt>build-indep</tt> target.  However, this is not
1873                   yet used in practice since <tt>dpkg-buildpackage
1874                   -B</tt>, and therefore the autobuilders,
1875                   invoke <tt>build</tt> rather than <tt>build-arch</tt>
1876                   due to the difficulties in determining whether the
1877                   optional <tt>build-arch</tt> target exists.
1878                 </footnote>
1879               </p>
1880
1881               <p>
1882                 If one or both of the targets <tt>build-arch</tt> and
1883                 <tt>build-indep</tt> are not provided, then invoking
1884                 <file>debian/rules</file> with one of the not-provided
1885                 targets as arguments should produce a exit status code
1886                 of 2.  Usually this is provided automatically by make
1887                 if the target is missing.
1888               </p>
1889
1890               <p>
1891                 The <tt>build-arch</tt> and <tt>build-indep</tt> targets
1892                 must not do anything that might require root privilege.
1893               </p>
1894             </item>
1895
1896             <tag><tt>binary</tt>, <tt>binary-arch</tt>,
1897               <tt>binary-indep</tt>
1898             </tag>
1899             <item>
1900               <p>
1901                 The <tt>binary</tt> target must be all that is
1902                 necessary for the user to build the binary package(s)
1903                 produced from this source package.  It is
1904                 split into two parts: <prgn>binary-arch</prgn> builds
1905                 the binary packages which are specific to a particular
1906                 architecture, and <tt>binary-indep</tt> builds
1907                 those which are not.
1908               </p>
1909               <p>
1910                 <tt>binary</tt> may be (and commonly is) a target with
1911                 no commands which simply depends on
1912                 <tt>binary-arch</tt> and <tt>binary-indep</tt>.
1913               </p>
1914               <p>
1915                 Both <tt>binary-*</tt> targets should depend on the
1916                 <tt>build</tt> target, or on the appropriate
1917                 <tt>build-arch</tt> or <tt>build-indep</tt> target, if
1918                 provided, so that the package is built if it has not
1919                 been already.  It should then create the relevant
1920                 binary package(s), using <prgn>dpkg-gencontrol</prgn> to
1921                 make their control files and <prgn>dpkg-deb</prgn> to
1922                 build them and place them in the parent of the top
1923                 level directory.
1924               </p>
1925
1926               <p>
1927                 Both the <tt>binary-arch</tt> and
1928                 <tt>binary-indep</tt> targets <em>must</em> exist.
1929                 If one of them has nothing to do (which will always be
1930                 the case if the source generates only a single binary
1931                 package, whether architecture-dependent or not), it
1932                 must still exist and must always succeed.
1933               </p>
1934
1935               <p>
1936                 The <tt>binary</tt> targets must be invoked as
1937                 root.<footnote>
1938                     The <prgn>fakeroot</prgn> package often allows one
1939                     to build a package correctly even without being
1940                     root.
1941                 </footnote>
1942               </p>
1943             </item>
1944
1945             <tag><tt>clean</tt></tag>
1946             <item>
1947               <p>
1948                 This must undo any effects that the <tt>build</tt>
1949                 and <tt>binary</tt> targets may have had, except
1950                 that it should leave alone any output files created in
1951                 the parent directory by a run of a <tt>binary</tt>
1952                 target.
1953               </p>
1954
1955               <p>
1956                 If a <tt>build</tt> file is touched at the end of
1957                 the <tt>build</tt> target, as suggested above, it
1958                 should be removed as the first action that
1959                 <tt>clean</tt> performs, so that running
1960                 <tt>build</tt> again after an interrupted
1961                 <tt>clean</tt> doesn't think that everything is
1962                 already done.
1963               </p>
1964
1965               <p>
1966                 The <tt>clean</tt> target may need to be
1967                 invoked as root if <tt>binary</tt> has been
1968                 invoked since the last <tt>clean</tt>, or if
1969                 <tt>build</tt> has been invoked as root (since
1970                 <tt>build</tt> may create directories, for
1971                 example).
1972               </p>
1973             </item>
1974
1975             <tag><tt>get-orig-source</tt> (optional)</tag>
1976             <item>
1977               <p>
1978                 This target fetches the most recent version of the
1979                 original source package from a canonical archive site
1980                 (via FTP or WWW, for example), does any necessary
1981                 rearrangement to turn it into the original source
1982                 tar file format described below, and leaves it in the
1983                 current directory.
1984               </p>
1985
1986               <p>
1987                 This target may be invoked in any directory, and
1988                 should take care to clean up any temporary files it
1989                 may have left.
1990               </p>
1991
1992               <p>
1993                 This target is optional, but providing it if
1994                 possible is a good idea.
1995               </p>
1996             </item>
1997
1998             <tag><tt>patch</tt> (optional)</tag>
1999             <item>
2000               <p>
2001                 This target performs whatever additional actions are
2002                 required to make the source ready for editing (unpacking
2003                 additional upstream archives, applying patches, etc.).
2004                 It is recommended to be implemented for any package where
2005                 <tt>dpkg-source -x</tt> does not result in source ready
2006                 for additional modification.  See
2007                 <ref id="readmesource">.
2008               </p>
2009             </item>
2010           </taglist>
2011
2012         <p>
2013           The <tt>build</tt>, <tt>binary</tt> and
2014           <tt>clean</tt> targets must be invoked with the current
2015           directory being the package's top-level directory.
2016         </p>
2017
2018
2019         <p>
2020           Additional targets may exist in <file>debian/rules</file>,
2021           either as published or undocumented interfaces or for the
2022           package's internal use.
2023         </p>
2024
2025         <p>
2026           The architectures we build on and build for are determined
2027           by <prgn>make</prgn> variables using the utility
2028           <qref id="pkg-dpkg-architecture"><prgn>dpkg-architecture</prgn></qref>.
2029           You can determine the
2030           Debian architecture and the GNU style architecture
2031           specification string for the build machine (the machine type
2032           we are building on) as well as for the host machine (the
2033           machine type we are building for).  Here is a list of
2034           supported <prgn>make</prgn> variables:
2035           <list compact="compact">
2036             <item>
2037                 <tt>DEB_*_ARCH</tt> (the Debian architecture)
2038             </item>
2039             <item>
2040                 <tt>DEB_*_ARCH_CPU</tt> (the Debian CPU name)
2041             </item>
2042             <item>
2043                 <tt>DEB_*_ARCH_OS</tt> (the Debian System name)
2044             </item>
2045             <item>
2046                 <tt>DEB_*_GNU_TYPE</tt> (the GNU style architecture
2047                 specification string)
2048             </item>
2049             <item>
2050                 <tt>DEB_*_GNU_CPU</tt> (the CPU part of
2051                 <tt>DEB_*_GNU_TYPE</tt>)
2052             </item>
2053             <item>
2054                 <tt>DEB_*_GNU_SYSTEM</tt> (the System part of
2055                 <tt>DEB_*_GNU_TYPE</tt>)
2056           </list>
2057           where <tt>*</tt> is either <tt>BUILD</tt> for specification of
2058           the build machine or <tt>HOST</tt> for specification of the
2059           host machine.
2060         </p>
2061
2062         <p>
2063           Backward compatibility can be provided in the rules file
2064           by setting the needed variables to suitable default
2065           values; please refer to the documentation of
2066           <prgn>dpkg-architecture</prgn> for details.
2067         </p>
2068
2069         <p>
2070           It is important to understand that the <tt>DEB_*_ARCH</tt>
2071           string only determines which Debian architecture we are
2072           building on or for. It should not be used to get the CPU
2073           or system information; the <tt>DEB_*_ARCH_CPU</tt> and
2074           <tt>DEB_*_ARCH_OS</tt> variables should be used for that.
2075           GNU style variables should generally only be used with upstream
2076           build systems.
2077         </p>
2078
2079         <sect1 id="debianrules-options">
2080           <heading><file>debian/rules</file> and
2081             <tt>DEB_BUILD_OPTIONS</tt></heading>
2082
2083           <p>
2084             Supporting the standardized environment variable
2085             <tt>DEB_BUILD_OPTIONS</tt> is recommended.  This variable can
2086             contain several flags to change how a package is compiled and
2087             built.  Each flag must be in the form <var>flag</var> or
2088             <var>flag</var>=<var>options</var>.  If multiple flags are
2089             given, they must be separated by whitespace.<footnote>
2090               Some packages support any delimiter, but whitespace is the
2091               easiest to parse inside a makefile and avoids ambiguity with
2092               flag values that contain commas.
2093             </footnote>
2094             <var>flag</var> must start with a lowercase letter
2095             (<tt>a-z</tt>) and consist only of lowercase letters,
2096             numbers (<tt>0-9</tt>), and the characters
2097             <tt>-</tt> and <tt>_</tt> (hyphen and underscore).
2098             <var>options</var> must not contain whitespace.  The same
2099             tag should not be given multiple times with conflicting
2100             values.  Package maintainers may assume that
2101             <tt>DEB_BUILD_OPTIONS</tt> will not contain conflicting tags.
2102           </p>
2103
2104           <p>
2105             The meaning of the following tags has been standardized:
2106             <taglist>
2107               <tag>nocheck</tag>
2108               <item>
2109                   This tag says to not run any build-time test suite
2110                   provided by the package.
2111               </item>
2112               <tag>noopt</tag>
2113               <item>
2114                   The presence of this tag means that the package should
2115                   be compiled with a minimum of optimization.  For C
2116                   programs, it is best to add <tt>-O0</tt> to
2117                   <tt>CFLAGS</tt> (although this is usually the default).
2118                   Some programs might fail to build or run at this level
2119                   of optimization; it may be necessary to use
2120                   <tt>-O1</tt>, for example.
2121               </item>
2122               <tag>nostrip</tag>
2123               <item>
2124                   This tag means that the debugging symbols should not be
2125                   stripped from the binary during installation, so that
2126                   debugging information may be included in the package.
2127               </item>
2128               <tag>parallel=n</tag>
2129               <item>
2130                   This tag means that the package should be built using up
2131                   to <tt>n</tt> parallel processes if the package build
2132                   system supports this.<footnote>
2133                       Packages built with <tt>make</tt> can often implement
2134                       this by passing the <tt>-j</tt><var>n</var> option to
2135                       <tt>make</tt>.
2136                   </footnote>
2137                   If the package build system does not support parallel
2138                   builds, this string must be ignored.  If the package
2139                   build system only supports a lower level of concurrency
2140                   than <var>n</var>, the package should be built using as
2141                   many parallel processes as the package build system
2142                   supports.  It is up to the package maintainer to decide
2143                   whether the package build times are long enough and the
2144                   package build system is robust enough to make supporting
2145                   parallel builds worthwhile.
2146                </item>
2147             </taglist>
2148           </p>
2149
2150           <p>
2151             Unknown flags must be ignored by <file>debian/rules</file>.
2152           </p>
2153
2154           <p>
2155             The following makefile snippet is an example of how one may
2156             implement the build options; you will probably have to
2157             massage this example in order to make it work for your
2158             package.
2159             <example compact="compact">
2160 CFLAGS = -Wall -g
2161 INSTALL = install
2162 INSTALL_FILE    = $(INSTALL) -p    -o root -g root  -m  644
2163 INSTALL_PROGRAM = $(INSTALL) -p    -o root -g root  -m  755
2164 INSTALL_SCRIPT  = $(INSTALL) -p    -o root -g root  -m  755
2165 INSTALL_DIR     = $(INSTALL) -p -d -o root -g root  -m  755
2166
2167 ifneq (,$(filter noopt,$(DEB_BUILD_OPTIONS)))
2168     CFLAGS += -O0
2169 else
2170     CFLAGS += -O2
2171 endif
2172 ifeq (,$(filter nostrip,$(DEB_BUILD_OPTIONS)))
2173     INSTALL_PROGRAM += -s
2174 endif
2175 ifneq (,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
2176     NUMJOBS = $(patsubst parallel=%,%,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
2177     MAKEFLAGS += -j$(NUMJOBS)
2178 endif
2179
2180 build:
2181         # ...
2182 ifeq (,$(filter nocheck,$(DEB_BUILD_OPTIONS)))
2183         # Code to run the package test suite.
2184 endif
2185             </example>
2186           </p>
2187         </sect1>
2188       </sect>
2189
2190 <!-- FIXME: section pkg-srcsubstvars is the same as substvars -->
2191       <sect id="substvars">
2192         <heading>Variable substitutions: <file>debian/substvars</file></heading>
2193
2194         <p>
2195           When <prgn>dpkg-gencontrol</prgn>,
2196           <prgn>dpkg-genchanges</prgn> and <prgn>dpkg-source</prgn>
2197           generate control files they perform variable substitutions
2198           on their output just before writing it.  Variable
2199           substitutions have the form <tt>${<var>variable</var>}</tt>.
2200           The optional file <file>debian/substvars</file> contains
2201           variable substitutions to be used; variables can also be set
2202           directly from <file>debian/rules</file> using the <tt>-V</tt>
2203           option to the source packaging commands, and certain
2204           predefined variables are also available.
2205         </p>
2206
2207         <p>
2208           The <file>debian/substvars</file> file is usually generated and
2209           modified dynamically by <file>debian/rules</file> targets, in
2210           which case it must be removed by the <tt>clean</tt> target.
2211         </p>
2212
2213         <p>
2214           See <manref name="deb-substvars" section="5"> for full
2215           details about source variable substitutions, including the
2216           format of <file>debian/substvars</file>.</p>
2217       </sect>
2218
2219       <sect id="debianwatch">
2220         <heading>Optional upstream source location: <file>debian/watch</file></heading>
2221
2222         <p>
2223           This is an optional, recommended control file for the
2224           <tt>uscan</tt> utility which defines how to automatically
2225           scan ftp or http sites for newly available updates of the
2226           package. This is used by <url id="
2227           http://dehs.alioth.debian.org/"> and other Debian QA tools
2228           to help with quality control and maintenance of the
2229           distribution as a whole.
2230         </p>
2231
2232       </sect>
2233
2234       <sect id="debianfiles">
2235         <heading>Generated files list: <file>debian/files</file></heading>
2236
2237         <p>
2238           This file is not a permanent part of the source tree; it
2239           is used while building packages to record which files are
2240           being generated.  <prgn>dpkg-genchanges</prgn> uses it
2241           when it generates a <file>.changes</file> file.
2242         </p>
2243
2244         <p>
2245           It should not exist in a shipped source package, and so it
2246           (and any backup files or temporary files such as
2247           <file>files.new</file><footnote>
2248               <file>files.new</file> is used as a temporary file by
2249               <prgn>dpkg-gencontrol</prgn> and
2250               <prgn>dpkg-distaddfile</prgn> - they write a new
2251               version of <tt>files</tt> here before renaming it,
2252               to avoid leaving a corrupted copy if an error
2253               occurs.
2254           </footnote>) should be removed by the
2255           <tt>clean</tt> target.  It may also be wise to
2256           ensure a fresh start by emptying or removing it at the
2257           start of the <tt>binary</tt> target.
2258         </p>
2259
2260         <p>
2261           When <prgn>dpkg-gencontrol</prgn> is run for a binary
2262           package, it adds an entry to <file>debian/files</file> for the
2263           <file>.deb</file> file that will be created when <tt>dpkg-deb
2264           --build</tt> is run for that binary package.  So for most
2265           packages all that needs to be done with this file is to
2266           delete it in the <tt>clean</tt> target.
2267         </p>
2268
2269         <p>
2270           If a package upload includes files besides the source
2271           package and any binary packages whose control files were
2272           made with <prgn>dpkg-gencontrol</prgn> then they should be
2273           placed in the parent of the package's top-level directory
2274           and <prgn>dpkg-distaddfile</prgn> should be called to add
2275           the file to the list in <file>debian/files</file>.</p>
2276       </sect>
2277
2278       <sect id="embeddedfiles">
2279         <heading>Convenience copies of code</heading>
2280
2281         <p>
2282           Some software packages include in their distribution convenience
2283           copies of code from other software packages, generally so that
2284           users compiling from source don't have to download multiple
2285           packages.  Debian packages should not make use of these
2286           convenience copies unless the included package is explicitly
2287           intended to be used in this way.<footnote>
2288             For example, parts of the GNU build system work like this.
2289           </footnote>
2290           If the included code is already in the Debian archive in the
2291           form of a library, the Debian packaging should ensure that
2292           binary packages reference the libraries already in Debian and
2293           the convenience copy is not used.  If the included code is not
2294           already in Debian, it should be packaged separately as a
2295           prerequisite if possible.
2296           <footnote>
2297             Having multiple copies of the same code in Debian is
2298             inefficient, often creates either static linking or shared
2299             library conflicts, and, most importantly, increases the
2300             difficulty of handling security vulnerabilities in the
2301             duplicated code.
2302           </footnote>
2303         </p>
2304       </sect>
2305
2306       <sect id="readmesource">
2307         <heading>Source package handling:
2308           <file>debian/README.source</file></heading>
2309
2310         <p>
2311           If running <prgn>dpkg-source -x</prgn> on a source package
2312           doesn't produce the source of the package, ready for editing,
2313           and allow one to make changes and run
2314           <prgn>dpkg-buildpackage</prgn> to produce a modified package
2315           without taking any additional steps, creating a
2316           <file>debian/README.source</file> documentation file is
2317           recommended.  This file should explain how to do all of the
2318           following:
2319             <enumlist>
2320               <item>Generate the fully patched source, in a form ready for
2321               editing, that would be built to create Debian
2322               packages.  Doing this with a <tt>patch</tt> target in
2323               <file>debian/rules</file> is recommended; see
2324               <ref id="debianrules">.</item>
2325               <item>Modify the source and save those modifications so that
2326               they will be applied when building the package.</item>
2327               <item>Remove source modifications that are currently being
2328               applied when building the package.</item>
2329               <item>Optionally, document what steps are necessary to
2330               upgrade the Debian source package to a new upstream version,
2331               if applicable.</item>
2332             </enumlist>
2333           This explanation should include specific commands and mention
2334           any additional required Debian packages.  It should not assume
2335           familiarity with any specific Debian packaging system or patch
2336           management tools.
2337         </p>
2338
2339         <p>
2340           This explanation may refer to a documentation file installed by
2341           one of the package's build dependencies provided that the
2342           referenced documentation clearly explains these tasks and is not
2343           a general reference manual.
2344         </p>
2345
2346         <p>
2347           <file>debian/README.source</file> may also include any other
2348           information that would be helpful to someone modifying the
2349           source package.  Even if the package doesn't fit the above
2350           description, maintainers are encouraged to document in a
2351           <file>debian/README.source</file> file any source package with a
2352           particularly complex or unintuitive source layout or build
2353           system (for example, a package that builds the same source
2354           multiple times to generate different binary packages).
2355         </p>
2356       </sect>
2357     </chapt>
2358
2359
2360     <chapt id="controlfields">
2361       <heading>Control files and their fields</heading>
2362
2363       <p>
2364         The package management system manipulates data represented in
2365         a common format, known as <em>control data</em>, stored in
2366         <em>control files</em>.
2367         Control files are used for source packages, binary packages and
2368         the <file>.changes</file> files which control the installation
2369         of uploaded files<footnote>
2370             <prgn>dpkg</prgn>'s internal databases are in a similar
2371             format.
2372         </footnote>.
2373       </p>
2374
2375       <sect id="controlsyntax">
2376         <heading>Syntax of control files</heading>
2377
2378         <p>
2379           A control file consists of one or more paragraphs of
2380           fields<footnote>
2381                 The paragraphs are also sometimes referred to as stanzas.
2382           </footnote>.
2383           The paragraphs are separated by blank lines.  Some control
2384           files allow only one paragraph; others allow several, in
2385           which case each paragraph usually refers to a different
2386           package.  (For example, in source packages, the first
2387           paragraph refers to the source package, and later paragraphs
2388           refer to binary packages generated from the source.)
2389         </p>
2390
2391         <p>
2392           Each paragraph consists of a series of data fields; each
2393           field consists of the field name, followed by a colon and
2394           then the data/value associated with that field.  It ends at
2395           the end of the (logical) line.  Horizontal whitespace
2396           (spaces and tabs) may occur immediately before or after the
2397           value and is ignored there; it is conventional to put a
2398           single space after the colon.  For example, a field might
2399           be:
2400           <example compact="compact">
2401 Package: libc6
2402           </example>
2403           the field name is <tt>Package</tt> and the field value
2404           <tt>libc6</tt>.
2405         </p>
2406
2407         <p>
2408           Many fields' values may span several lines; in this case
2409           each continuation line must start with a space or a tab.
2410           Any trailing spaces or tabs at the end of individual
2411           lines of a field value are ignored. 
2412         </p>
2413
2414         <p>
2415           In fields where it is specified that lines may not wrap,
2416           only a single line of data is allowed and whitespace is not
2417           significant in a field body. Whitespace must not appear
2418           inside names (of packages, architectures, files or anything
2419           else) or version numbers, or between the characters of
2420           multi-character version relationships.
2421         </p>
2422
2423         <p>
2424           Field names are not case-sensitive, but it is usual to
2425           capitalize the field names using mixed case as shown below.
2426           Field values are case-sensitive unless the description of the
2427           field says otherwise.
2428         </p>
2429
2430         <p>
2431           Blank lines, or lines consisting only of spaces and tabs,
2432           are not allowed within field values or between fields - that
2433           would mean a new paragraph.
2434         </p>
2435
2436         <p>
2437           All control files must be encoded in UTF-8.
2438         </p>
2439       </sect>
2440
2441       <sect id="sourcecontrolfiles">
2442         <heading>Source package control files -- <file>debian/control</file></heading>
2443
2444         <p>
2445           The <file>debian/control</file> file contains the most vital
2446           (and version-independent) information about the source package
2447           and about the binary packages it creates.
2448         </p>
2449
2450         <p>
2451           The first paragraph of the control file contains information about
2452           the source package in general. The subsequent sets each describe a
2453           binary package that the source tree builds.
2454         </p>
2455
2456         <p>
2457           The fields in the general paragraph (the first one, for the source
2458           package) are:
2459
2460           <list compact="compact">
2461             <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2462             <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2463             <item><qref id="f-Uploaders"><tt>Uploaders</tt></qref></item>
2464             <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2465             <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2466             <item><qref id="sourcebinarydeps"><tt>Build-Depends</tt> et al</qref></item>
2467             <item><qref id="f-Standards-Version"><tt>Standards-Version</tt></qref> (recommended)</item>
2468             <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2469           </list>
2470         </p>
2471
2472         <p>
2473           The fields in the binary package paragraphs are:
2474
2475           <list compact="compact">
2476             <item><qref id="f-Package"><tt>Package</tt></qref> (mandatory)</item>
2477             <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2478             <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2479             <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2480             <item><qref id="f-Essential"><tt>Essential</tt></qref></item>
2481             <item><qref id="binarydeps"><tt>Depends</tt> et al</qref></item>
2482             <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2483             <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2484           </list>
2485         </p>
2486
2487         <p>
2488           The syntax and semantics of the fields are described below.
2489         </p>
2490
2491         <p>
2492           These fields are used by <prgn>dpkg-gencontrol</prgn> to
2493           generate control files for binary packages (see below), by
2494           <prgn>dpkg-genchanges</prgn> to generate the
2495           <tt>.changes</tt> file to accompany the upload, and by
2496           <prgn>dpkg-source</prgn> when it creates the
2497           <file>.dsc</file> source control file as part of a source
2498           archive. Many fields are permitted to span multiple lines in
2499           <file>debian/control</file> but not in any other control
2500           file. These tools are responsible for removing the line
2501           breaks from such fields when using fields from
2502           <file>debian/control</file> to generate other control files.
2503         </p>
2504
2505         <p>
2506           The fields here may contain variable references - their
2507           values will be substituted by <prgn>dpkg-gencontrol</prgn>,
2508           <prgn>dpkg-genchanges</prgn> or <prgn>dpkg-source</prgn>
2509           when they generate output control files.
2510           See <ref id="substvars"> for details.
2511         </p>
2512
2513         <p>
2514           In addition to the control file syntax described <qref
2515           id="controlsyntax">above</qref>, this file may also contain
2516           comment lines starting with <tt>#</tt> without any preceding
2517           whitespace.  All such lines are ignored, even in the middle of
2518           continuation lines for a multiline field, and do not end a
2519           multiline field.
2520         </p>
2521
2522       </sect>
2523
2524       <sect id="binarycontrolfiles">
2525         <heading>Binary package control files -- <file>DEBIAN/control</file></heading>
2526
2527         <p>
2528           The <file>DEBIAN/control</file> file contains the most vital
2529           (and version-dependent) information about a binary package.
2530         </p>
2531
2532         <p>
2533           The fields in this file are:
2534
2535           <list compact="compact">
2536             <item><qref id="f-Package"><tt>Package</tt></qref> (mandatory)</item>
2537             <item><qref id="f-Source"><tt>Source</tt></qref></item>
2538             <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2539             <item><qref id="f-Section"><tt>Section</tt></qref> (recommended)</item>
2540             <item><qref id="f-Priority"><tt>Priority</tt></qref> (recommended)</item>
2541             <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2542             <item><qref id="f-Essential"><tt>Essential</tt></qref></item>
2543             <item><qref id="binarydeps"><tt>Depends</tt> et al</qref></item>
2544             <item><qref id="f-Installed-Size"><tt>Installed-Size</tt></qref></item>
2545             <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2546             <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2547             <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2548           </list>
2549         </p>
2550       </sect>
2551
2552       <sect id="debiansourcecontrolfiles">
2553         <heading>Debian source control files -- <tt>.dsc</tt></heading>
2554
2555         <p>
2556           This file contains a series of fields, identified and
2557           separated just like the fields in the control file of
2558           a binary package.  The fields are listed below; their
2559           syntax is described above, in <ref id="pkg-controlfields">.
2560
2561         <list compact="compact">
2562           <item><qref id="f-Format"><tt>Format</tt></qref> (mandatory)</item>
2563           <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2564           <item><qref id="f-Binary"><tt>Binary</tt></qref></item>
2565           <item><qref id="f-Architecture"><tt>Architecture</tt></qref></item>
2566           <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2567           <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2568           <item><qref id="f-Uploaders"><tt>Uploaders</tt></qref></item>
2569           <item><qref id="f-Homepage"><tt>Homepage</tt></qref></item>
2570           <item><qref id="f-Standards-Version"><tt>Standards-Version</tt></qref> (recommended)</item>
2571           <item><qref id="sourcebinarydeps"><tt>Build-Depends</tt> et al</qref></item>
2572           <item><qref id="f-Checksums"><tt>Checksums-Sha1</tt>
2573               and <tt>Checksums-Sha256</tt> (recommended)</item>
2574           <item><qref id="f-Files"><tt>Files</tt></qref> (mandatory)</item>
2575         </list>
2576         </p>
2577
2578         <p>
2579           The source package control file is generated by
2580           <prgn>dpkg-source</prgn> when it builds the source
2581           archive, from other files in the source package,
2582           described above.  When unpacking, it is checked against
2583           the files and directories in the other parts of the
2584           source package.
2585         </p>
2586
2587       </sect>
2588
2589       <sect id="debianchangesfiles">
2590         <heading>Debian changes files -- <file>.changes</file></heading>
2591
2592         <p>
2593           The .changes files are used by the Debian archive maintenance
2594           software to process updates to packages. They contain one
2595           paragraph which contains information from the
2596           <tt>debian/control</tt> file and other data about the
2597           source package gathered via <tt>debian/changelog</tt>
2598           and <tt>debian/rules</tt>.
2599         </p>
2600
2601         <p>
2602           The fields in this file are:
2603
2604           <list compact="compact">
2605             <item><qref id="f-Format"><tt>Format</tt></qref> (mandatory)</item>
2606             <item><qref id="f-Date"><tt>Date</tt></qref> (mandatory)</item>
2607             <item><qref id="f-Source"><tt>Source</tt></qref> (mandatory)</item>
2608             <item><qref id="f-Binary"><tt>Binary</tt></qref> (mandatory)</item>
2609             <item><qref id="f-Architecture"><tt>Architecture</tt></qref> (mandatory)</item>
2610             <item><qref id="f-Version"><tt>Version</tt></qref> (mandatory)</item>
2611             <item><qref id="f-Distribution"><tt>Distribution</tt></qref> (mandatory)</item>
2612             <item><qref id="f-Urgency"><tt>Urgency</tt></qref> (recommended)</item>
2613             <item><qref id="f-Maintainer"><tt>Maintainer</tt></qref> (mandatory)</item>
2614             <item><qref id="f-Changed-By"><tt>Changed-By</tt></qref></item>
2615             <item><qref id="f-Description"><tt>Description</tt></qref> (mandatory)</item>
2616             <item><qref id="f-Closes"><tt>Closes</tt></qref></item>
2617             <item><qref id="f-Changes"><tt>Changes</tt></qref> (mandatory)</item>
2618             <item><qref id="f-Checksums"><tt>Checksums-Sha1</tt>
2619                 and <tt>Checksums-Sha256</tt> (recommended)</item>
2620             <item><qref id="f-Files"><tt>Files</tt></qref> (mandatory)</item>
2621           </list>
2622         </p>
2623       </sect>
2624
2625       <sect id="controlfieldslist">
2626         <heading>List of fields</heading>
2627
2628         <sect1 id="f-Source">
2629           <heading><tt>Source</tt></heading>
2630
2631           <p>
2632             This field identifies the source package name.
2633           </p>
2634
2635           <p>
2636             In <file>debian/control</file> or a <file>.dsc</file> file,
2637             this field must contain only the name of the source package.
2638           </p>
2639
2640           <p>
2641             In a binary package control file or a <file>.changes</file>
2642             file, the source package name may be followed by a version
2643             number in parentheses<footnote>
2644                 It is customary to leave a space after the package name
2645                 if a version number is specified.
2646             </footnote>.
2647             This version number may be omitted (and is, by
2648             <prgn>dpkg-gencontrol</prgn>) if it has the same value as
2649             the <tt>Version</tt> field of the binary package in
2650             question.  The field itself may be omitted from a binary
2651             package control file when the source package has the same
2652             name and version as the binary package.
2653           </p>
2654
2655           <p>
2656             Package names (both source and binary,
2657             see <ref id="f-Package">) must consist only of lower case
2658             letters (<tt>a-z</tt>), digits (<tt>0-9</tt>), plus
2659             (<tt>+</tt>) and minus (<tt>-</tt>) signs, and periods
2660             (<tt>.</tt>).  They must be at least two characters long and
2661             must start with an alphanumeric character.
2662           </p>
2663         </sect1>
2664
2665         <sect1 id="f-Maintainer">
2666           <heading><tt>Maintainer</tt></heading>
2667
2668           <p>
2669             The package maintainer's name and email address.  The name
2670             should come first, then the email address inside angle
2671             brackets <tt>&lt;&gt</tt> (in RFC822 format).
2672           </p>
2673
2674           <p>
2675             If the maintainer's name contains a full stop then the
2676             whole field will not work directly as an email address due
2677             to a misfeature in the syntax specified in RFC822; a
2678             program using this field as an address must check for this
2679             and correct the problem if necessary (for example by
2680             putting the name in round brackets and moving it to the
2681             end, and bringing the email address forward).
2682           </p>
2683         </sect1>
2684
2685         <sect1 id="f-Uploaders">
2686           <heading><tt>Uploaders</tt></heading>
2687
2688           <p>
2689             List of the names and email addresses of co-maintainers of
2690             the package, if any. If the package has other maintainers
2691             beside the one named in the 
2692             <qref id="f-Maintainer">Maintainer field</qref>, their
2693             names and email addresses should be listed here. The
2694             format is the same as that of the Maintainer tag, and
2695             multiple entries should be comma separated. Currently,
2696             this field is restricted to a single line of data.  This
2697             is an optional field.
2698           </p>
2699           <p>
2700             Any parser that interprets the Uploaders field in
2701             <file>debian/control</file> must permit it to span multiple
2702             lines.  Line breaks in an Uploaders field that spans multiple
2703             lines are not significant and the semantics of the field are
2704             the same as if the line breaks had not been present.
2705           </p>
2706         </sect1>
2707
2708         <sect1 id="f-Changed-By">
2709           <heading><tt>Changed-By</tt></heading>
2710
2711           <p>
2712             The name and email address of the person who changed the
2713             said package. Usually the name of the maintainer.
2714             All the rules for the Maintainer field apply here, too.
2715           </p>
2716         </sect1>
2717
2718         <sect1 id="f-Section">
2719           <heading><tt>Section</tt></heading>
2720
2721           <p>
2722             This field specifies an application area into which the package
2723             has been classified. See <ref id="subsections">.
2724           </p>
2725
2726           <p>
2727             When it appears in the <file>debian/control</file> file,
2728             it gives the value for the subfield of the same name in
2729             the <tt>Files</tt> field of the <file>.changes</file> file.
2730             It also gives the default for the same field in the binary
2731             packages.
2732           </p>
2733         </sect1>
2734
2735         <sect1 id="f-Priority">
2736           <heading><tt>Priority</tt></heading>
2737
2738           <p>
2739             This field represents how important it is that the user
2740             have the package installed. See <ref id="priorities">.
2741           </p>
2742
2743           <p>
2744             When it appears in the <file>debian/control</file> file,
2745             it gives the value for the subfield of the same name in
2746             the <tt>Files</tt> field of the <file>.changes</file> file.
2747             It also gives the default for the same field in the binary
2748             packages.
2749           </p>
2750         </sect1>
2751
2752         <sect1 id="f-Package">
2753           <heading><tt>Package</tt></heading>
2754
2755           <p>
2756             The name of the binary package.
2757           </p>
2758
2759           <p>
2760             Binary package names must follow the same syntax and
2761             restrictions as source package names.  See <ref id="f-Source">
2762             for the details.
2763           </p>
2764         </sect1>
2765
2766         <sect1 id="f-Architecture">
2767           <heading><tt>Architecture</tt></heading>
2768
2769           <p>
2770             Depending on context and the control file used, the
2771             <tt>Architecture</tt> field can include the following sets of
2772             values:
2773             <list>
2774                 <item>
2775                   A unique single word identifying a Debian machine
2776                   architecture as described in <ref id="arch-spec">.
2777                 </item>
2778                 <item>
2779                   An architecture wildcard identifying a set of Debian
2780                   machine architectures, see <ref id="arch-wildcard-spec">.
2781                   <tt>any</tt> matches all Debian machine architectures
2782                   and is the most frequently used.
2783                 </item>
2784                 <item>
2785                   <tt>all</tt>, which indicates an
2786                   architecture-independent package.
2787                 </item>
2788                 <item>
2789                   <tt>source</tt>, which indicates a source package.
2790                 </item>
2791             </list>
2792           </p>
2793
2794           <p>
2795             In the main <file>debian/control</file> file in the source
2796             package, this field may contain the special
2797             value <tt>all</tt>, the special architecture
2798             wildcard <tt>any</tt>, or a list of specific and wildcard
2799             architectures separated by spaces.  If <tt>all</tt>
2800             or <tt>any</tt> appears, that value must be the entire
2801             contents of the field.  Most packages will use
2802             either <tt>all</tt> or <tt>any</tt>.
2803           </p>
2804
2805           <p>
2806             Specifying a specific list of architectures indicates that the
2807             source will build an architecture-dependent package only on
2808             architectures included in the list.  Specifying a list of
2809             architecture wildcards indicates that the source will build an
2810             architecture-dependent package on only those architectures
2811             that match any of the specified architecture wildcards.
2812             Specifying a list of architectures or architecture wildcards
2813             other than <tt>any</tt> is for the minority of cases where a
2814             program is not portable or is not useful on some
2815             architectures.  Where possible, the program should be made
2816             portable instead.
2817           </p>
2818
2819           <p>
2820             In the source package control file <file>.dsc</file>, this
2821             field may contain either the architecture
2822             wildcard <tt>any</tt> or a list of architectures and
2823             architecture wildcards separated by spaces. If a list is
2824             given, it may include (or consist solely of) the special
2825             value <tt>all</tt>.  In other words, in <file>.dsc</file>
2826             files unlike the <file>debian/control</file>, <tt>all</tt> may
2827             occur in combination with specific architectures.
2828             The <tt>Architecture</tt> field in the source package control
2829             file <file>.dsc</file> is generally constructed from
2830             the <tt>Architecture</tt> fields in
2831             the <file>debian/control</file> in the source package.
2832           </p>
2833
2834           <p>
2835             Specifying <tt>any</tt> indicates that the source package
2836             isn't dependent on any particular architecture and should
2837             compile fine on any one. The produced binary package(s)
2838             will either be specific to whatever the current build
2839             architecture is or will be architecture-independent.
2840           </p>
2841
2842           <p>
2843             Specifying only <tt>all</tt> indicates that the source package
2844             will only build architecture-independent packages.  If this is
2845             the case, <tt>all</tt> must be used rather than <tt>any</tt>;
2846             <tt>any</tt> implies that the source package will build at
2847             least one architecture-dependent package.
2848           </p>
2849
2850           <p>
2851             Specifying a list of architectures or architecture wildcards
2852             indicates that the source will build an architecture-dependent
2853             package, and will only work correctly on the listed or
2854             matching architectures.  If the source package also builds at
2855             least one architecture-independent package, <tt>all</tt> will
2856             also be included in the list.
2857           </p>
2858
2859           <p>
2860             In a <file>.changes</file> file, the <tt>Architecture</tt>
2861             field lists the architecture(s) of the package(s) currently
2862             being uploaded.  This will be a list; if the source for the
2863             package is also being uploaded, the special
2864             entry <tt>source</tt> is also present.  <tt>all</tt> will be
2865             present if any architecture-independent packages are being
2866             uploaded.  Architecture wildcards such as <tt>any</tt> must
2867             never occur in the <tt>Architecture</tt> field in
2868             the <file>.changes</file> file.
2869           </p>
2870
2871           <p>
2872             See <ref id="debianrules"> for information on how to get
2873             the architecture for the build process.
2874           </p>
2875         </sect1>
2876
2877         <sect1 id="f-Essential">
2878           <heading><tt>Essential</tt></heading>
2879
2880           <p>
2881             This is a boolean field which may occur only in the
2882             control file of a binary package or in a per-package fields
2883             paragraph of a main source control data file.
2884           </p>
2885
2886           <p>
2887             If set to <tt>yes</tt> then the package management system
2888             will refuse to remove the package (upgrading and replacing
2889             it is still possible). The other possible value is <tt>no</tt>,
2890             which is the same as not having the field at all.
2891           </p>
2892         </sect1>
2893
2894         <sect1>
2895           <heading>Package interrelationship fields:
2896             <tt>Depends</tt>, <tt>Pre-Depends</tt>,
2897             <tt>Recommends</tt>, <tt>Suggests</tt>,
2898             <tt>Breaks</tt>, <tt>Conflicts</tt>,
2899             <tt>Provides</tt>, <tt>Replaces</tt>, <tt>Enhances</tt>
2900           </heading>
2901
2902           <p>
2903             These fields describe the package's relationships with
2904             other packages.  Their syntax and semantics are described
2905             in <ref id="relationships">.</p>
2906         </sect1>
2907
2908         <sect1 id="f-Standards-Version">
2909           <heading><tt>Standards-Version</tt></heading>
2910
2911           <p>
2912             The most recent version of the standards (the policy
2913             manual and associated texts) with which the package
2914             complies.
2915           </p>
2916
2917           <p>
2918             The version number has four components: major and minor
2919             version number and major and minor patch level.  When the
2920             standards change in a way that requires every package to
2921             change the major number will be changed.  Significant
2922             changes that will require work in many packages will be
2923             signaled by a change to the minor number.  The major patch
2924             level will be changed for any change to the meaning of the
2925             standards, however small; the minor patch level will be
2926             changed when only cosmetic, typographical or other edits
2927             are made which neither change the meaning of the document
2928             nor affect the contents of packages.
2929           </p>
2930
2931           <p>
2932             Thus only the first three components of the policy version
2933             are significant in the <em>Standards-Version</em> control
2934             field, and so either these three components or all four
2935             components may be specified.<footnote>
2936                 In the past, people specified the full version number
2937                 in the Standards-Version field, for example "2.3.0.0".
2938                 Since minor patch-level changes don't introduce new
2939                 policy, it was thought it would be better to relax
2940                 policy and only require the first 3 components to be
2941                 specified, in this example "2.3.0".  All four
2942                 components may still be used if someone wishes to do so.
2943             </footnote>
2944           </p>
2945
2946         </sect1>
2947
2948         <sect1 id="f-Version">
2949           <heading><tt>Version</tt></heading>
2950
2951           <p>
2952             The version number of a package. The format is:
2953             [<var>epoch</var><tt>:</tt>]<var>upstream_version</var>[<tt>-</tt><var>debian_revision</var>]
2954           </p>
2955
2956           <p>
2957             The three components here are:
2958             <taglist>
2959               <tag><var>epoch</var></tag>
2960               <item>
2961                 <p>
2962                   This is a single (generally small) unsigned integer.  It
2963                   may be omitted, in which case zero is assumed.  If it is
2964                   omitted then the <var>upstream_version</var> may not
2965                   contain any colons.
2966                 </p>
2967
2968                 <p>
2969                   It is provided to allow mistakes in the version numbers
2970                   of older versions of a package, and also a package's
2971                   previous version numbering schemes, to be left behind.
2972                 </p>
2973               </item>
2974
2975               <tag><var>upstream_version</var></tag>
2976               <item>
2977                 <p>
2978                   This is the main part of the version number.  It is
2979                   usually the version number of the original ("upstream")
2980                   package from which the <file>.deb</file> file has been made,
2981                   if this is applicable.  Usually this will be in the same
2982                   format as that specified by the upstream author(s);
2983                   however, it may need to be reformatted to fit into the
2984                   package management system's format and comparison
2985                   scheme.
2986                 </p>
2987
2988                 <p>
2989                   The comparison behavior of the package management system
2990                   with respect to the <var>upstream_version</var> is
2991                   described below.  The <var>upstream_version</var>
2992                   portion of the version number is mandatory.
2993                 </p>
2994
2995                 <p>
2996                   The <var>upstream_version</var> may contain only
2997                   alphanumerics<footnote>
2998                         Alphanumerics are <tt>A-Za-z0-9</tt> only.
2999                   </footnote>
3000                   and the characters <tt>.</tt> <tt>+</tt> <tt>-</tt>
3001                   <tt>:</tt> <tt>~</tt> (full stop, plus, hyphen, colon,
3002                   tilde) and should start with a digit.  If there is no
3003                   <var>debian_revision</var> then hyphens are not allowed;
3004                   if there is no <var>epoch</var> then colons are not
3005                   allowed.
3006                 </p>
3007               </item>
3008
3009               <tag><var>debian_revision</var></tag>
3010               <item>
3011                 <p>
3012                   This part of the version number specifies the version of
3013                   the Debian package based on the upstream version.  It
3014                   may contain only alphanumerics and the characters
3015                   <tt>+</tt> <tt>.</tt> <tt>~</tt> (plus, full stop,
3016                   tilde) and is compared in the same way as the
3017                   <var>upstream_version</var> is.
3018                 </p>
3019
3020                 <p>
3021                   It is optional; if it isn't present then the
3022                   <var>upstream_version</var> may not contain a hyphen.
3023                   This format represents the case where a piece of
3024                   software was written specifically to be turned into a
3025                   Debian package, and so there is only one "debianisation"
3026                   of it and therefore no revision indication is required.
3027                 </p>
3028
3029                 <p>
3030                   It is conventional to restart the
3031                   <var>debian_revision</var> at <tt>1</tt> each time the
3032                   <var>upstream_version</var> is increased.
3033                 </p>
3034
3035                 <p>
3036                   The package management system will break the version
3037                   number apart at the last hyphen in the string (if there
3038                   is one) to determine the <var>upstream_version</var> and
3039                   <var>debian_revision</var>.  The absence of a
3040                   <var>debian_revision</var> is equivalent to a
3041                   <var>debian_revision</var> of <tt>0</tt>.
3042                 </p>
3043               </item>
3044             </taglist>
3045           </p>
3046
3047           <p>
3048             When comparing two version numbers, first the <var>epoch</var>
3049             of each are compared, then the <var>upstream_version</var> if
3050             <var>epoch</var> is equal, and then <var>debian_revision</var>
3051             if <var>upstream_version</var> is also equal.
3052             <var>epoch</var> is compared numerically.  The
3053             <var>upstream_version</var> and <var>debian_revision</var>
3054             parts are compared by the package management system using the
3055             following algorithm:
3056           </p>
3057
3058           <p>
3059             The strings are compared from left to right.
3060           </p>
3061
3062           <p>
3063             First the initial part of each string consisting entirely of
3064             non-digit characters is determined.  These two parts (one of
3065             which may be empty) are compared lexically.  If a difference
3066             is found it is returned.  The lexical comparison is a
3067             comparison of ASCII values modified so that all the letters
3068             sort earlier than all the non-letters and so that a tilde
3069             sorts before anything, even the end of a part.  For example,
3070             the following parts are in sorted order from earliest to
3071             latest: <tt>~~</tt>, <tt>~~a</tt>, <tt>~</tt>, the empty part,
3072             <tt>a</tt>.<footnote>
3073               One common use of <tt>~</tt> is for upstream pre-releases.
3074               For example, <tt>1.0~beta1~svn1245</tt> sorts earlier than
3075               <tt>1.0~beta1</tt>, which sorts earlier than <tt>1.0</tt>.
3076             </footnote>
3077           </p>
3078
3079           <p>
3080             Then the initial part of the remainder of each string which
3081             consists entirely of digit characters is determined.  The
3082             numerical values of these two parts are compared, and any
3083             difference found is returned as the result of the comparison.
3084             For these purposes an empty string (which can only occur at
3085             the end of one or both version strings being compared) counts
3086             as zero.
3087           </p>
3088
3089           <p>
3090             These two steps (comparing and removing initial non-digit
3091             strings and initial digit strings) are repeated until a
3092             difference is found or both strings are exhausted.
3093           </p>
3094
3095           <p>
3096             Note that the purpose of epochs is to allow us to leave behind
3097             mistakes in version numbering, and to cope with situations
3098             where the version numbering scheme changes.  It is
3099             <em>not</em> intended to cope with version numbers containing
3100             strings of letters which the package management system cannot
3101             interpret (such as <tt>ALPHA</tt> or <tt>pre-</tt>), or with
3102             silly orderings.<footnote>
3103               The author of this manual has heard of a package whose
3104               versions went <tt>1.1</tt>, <tt>1.2</tt>, <tt>1.3</tt>,
3105               <tt>1</tt>, <tt>2.1</tt>, <tt>2.2</tt>, <tt>2</tt> and so
3106               forth.
3107             </footnote>
3108           </p>
3109         </sect1>
3110
3111         <sect1 id="f-Description">
3112           <heading><tt>Description</tt></heading>
3113
3114           <p>
3115             In a source or binary control file, the <tt>Description</tt>
3116             field contains a description of the binary package, consisting
3117             of two parts, the synopsis or the short description, and the
3118             long description. The field's format is as follows:
3119           </p>
3120
3121           <p>
3122 <example>
3123         Description: &lt;single line synopsis&gt;
3124          &lt;extended description over several lines&gt;
3125 </example>
3126           </p>
3127
3128           <p>
3129             The lines in the extended description can have these formats:
3130           </p>
3131
3132           <p><list>
3133
3134             <item>
3135               Those starting with a single space are part of a paragraph.
3136               Successive lines of this form will be word-wrapped when
3137               displayed. The leading space will usually be stripped off.
3138             </item>
3139
3140             <item>
3141               Those starting with two or more spaces. These will be
3142               displayed verbatim. If the display cannot be panned
3143               horizontally, the displaying program will line wrap them "hard"
3144               (i.e., without taking account of word breaks). If it can they
3145               will be allowed to trail off to the right. None, one or two
3146               initial spaces may be deleted, but the number of spaces
3147               deleted from each line will be the same (so that you can have
3148               indenting work correctly, for example).
3149             </item>
3150
3151             <item>
3152               Those containing a single space followed by a single full stop
3153               character. These are rendered as blank lines. This is the
3154               <em>only</em> way to get a blank line<footnote>
3155                 Completely empty lines will not be rendered as blank lines.
3156                 Instead, they will cause the parser to think you're starting
3157                 a whole new record in the control file, and will therefore
3158                 likely abort with an error.
3159               </footnote>.
3160             </item>
3161
3162             <item>
3163               Those containing a space, a full stop and some more characters.
3164               These are for future expansion. Do not use them.
3165             </item>
3166
3167           </list></p>
3168
3169           <p>
3170             Do not use tab characters.  Their effect is not predictable.
3171           </p>
3172
3173           <p>
3174             See <ref id="descriptions"> for further information on this.
3175           </p>
3176
3177           <p>
3178             In a <file>.changes</file> file, the <tt>Description</tt>
3179             field contains a summary of the descriptions for the packages
3180             being uploaded.  For this case, the first line of the field
3181             value (the part on the same line as <tt>Description:</tt>) is
3182             always empty.  The content of the field is expressed as
3183             continuation lines, one line per package.  Each line is
3184             indented by one space and contains the name of a binary
3185             package, a space, a hyphen (<tt>-</tt>), a space, and the
3186             short description line from that package.
3187           </p>
3188         </sect1>
3189
3190         <sect1 id="f-Distribution">
3191           <heading><tt>Distribution</tt></heading>
3192
3193           <p>
3194             In a <file>.changes</file> file or parsed changelog output
3195             this contains the (space-separated) name(s) of the
3196             distribution(s) where this version of the package should
3197             be installed.  Valid distributions are determined by the
3198             archive maintainers.<footnote>
3199               Example distribution names in the Debian archive used in
3200               <file>.changes</file> files are:
3201                 <taglist compact="compact">
3202                   <tag><em>unstable</em></tag>
3203                   <item>
3204                     This distribution value refers to the
3205                     <em>developmental</em> part of the Debian distribution
3206                     tree.  Most new packages, new upstream versions of
3207                     packages and bug fixes go into the <em>unstable</em>
3208                     directory tree.
3209                   </item>
3210
3211                   <tag><em>experimental</em></tag>
3212                   <item>
3213                     The packages with this distribution value are deemed
3214                     by their maintainers to be high risk.  Oftentimes they
3215                     represent early beta or developmental packages from
3216                     various sources that the maintainers want people to
3217                     try, but are not ready to be a part of the other parts
3218                     of the Debian distribution tree.
3219                   </item>
3220                 </taglist>
3221
3222                 <p>
3223                   Others are used for updating stable releases or for
3224                   security uploads.  More information is available in the
3225                   Debian Developer's Reference, section "The Debian
3226                   archive".
3227                 </p>
3228             </footnote>
3229             The Debian archive software only supports listing a single
3230             distribution.  Migration of packages to other distributions is
3231             handled outside of the upload process.
3232           </p>
3233         </sect1>
3234
3235         <sect1 id="f-Date">
3236           <heading><tt>Date</tt></heading>
3237
3238           <p>
3239             This field includes the date the package was built or last
3240             edited.  It must be in the same format as the <var>date</var>
3241             in a <file>debian/changelog</file> entry.
3242           </p>
3243
3244           <p>
3245             The value of this field is usually extracted from the
3246             <file>debian/changelog</file> file - see
3247             <ref id="dpkgchangelog">).
3248           </p>
3249         </sect1>
3250
3251         <sect1 id="f-Format">
3252           <heading><tt>Format</tt></heading>
3253
3254           <p>
3255             This field specifies a format revision for the file.
3256             The most current format described in the Policy Manual
3257             is version <strong>1.5</strong>.  The syntax of the
3258             format value is the same as that of a package version
3259             number except that no epoch or Debian revision is allowed
3260             - see <ref id="f-Version">.
3261           </p>
3262         </sect1>
3263
3264         <sect1 id="f-Urgency">
3265           <heading><tt>Urgency</tt></heading>
3266
3267           <p>
3268             This is a description of how important it is to upgrade to
3269             this version from previous ones.  It consists of a single
3270             keyword taking one of the values <tt>low</tt>,
3271             <tt>medium</tt>, <tt>high</tt>, <tt>emergency</tt>, or
3272             <tt>critical</tt><footnote>
3273               Other urgency values are supported with configuration
3274               changes in the archive software but are not used in Debian.
3275               The urgency affects how quickly a package will be considered
3276               for inclusion into the <tt>testing</tt> distribution and
3277               gives an indication of the importance of any fixes included
3278               in the upload.  <tt>Emergency</tt> and <tt>critical</tt> are
3279               treated as synonymous.
3280             </footnote> (not case-sensitive) followed by an optional
3281             commentary (separated by a space) which is usually in
3282             parentheses.  For example:
3283
3284             <example>
3285   Urgency: low (HIGH for users of diversions)
3286             </example>
3287
3288           </p>
3289
3290           <p>
3291             The value of this field is usually extracted from the
3292             <file>debian/changelog</file> file - see
3293             <ref id="dpkgchangelog">.
3294           </p>
3295         </sect1>
3296
3297         <sect1 id="f-Changes">
3298           <heading><tt>Changes</tt></heading>
3299
3300           <p>
3301             This field contains the human-readable changes data, describing
3302             the differences between the last version and the current one.
3303           </p>
3304
3305           <p>
3306             The first line of the field value (the part on the same line
3307             as <tt>Changes:</tt>) is always empty.  The content of the
3308             field is expressed as continuation lines, with each line
3309             indented by at least one space.  Blank lines must be
3310             represented by a line consisting only of a space and a full
3311             stop (<tt>.</tt>).
3312           </p>
3313
3314           <p>
3315             The value of this field is usually extracted from the
3316             <file>debian/changelog</file> file - see
3317             <ref id="dpkgchangelog">).
3318           </p>
3319
3320           <p>
3321             Each version's change information should be preceded by a
3322             "title" line giving at least the version, distribution(s)
3323             and urgency, in a human-readable way.
3324           </p>
3325
3326           <p>
3327             If data from several versions is being returned the entry
3328             for the most recent version should be returned first, and
3329             entries should be separated by the representation of a
3330             blank line (the "title" line may also be followed by the
3331             representation of a blank line).
3332           </p>
3333         </sect1>
3334
3335         <sect1 id="f-Binary">
3336           <heading><tt>Binary</tt></heading>
3337
3338           <p>
3339             This field is a list of binary packages.  Its syntax and
3340             meaning varies depending on the control file in which it
3341             appears.
3342           </p>
3343
3344           <p>
3345             When it appears in the <file>.dsc</file> file, it lists binary
3346             packages which a source package can produce, separated by
3347             commas<footnote>
3348                 A space after each comma is conventional.
3349             </footnote>.  It may span multiple lines.  The source package
3350             does not necessarily produce all of these binary packages for
3351             every architecture.  The source control file doesn't contain
3352             details of which architectures are appropriate for which of
3353             the binary packages.
3354           </p>
3355
3356           <p>
3357             When it appears in a <file>.changes</file> file, it lists the
3358             names of the binary packages being uploaded, separated by
3359             whitespace (not commas).  It may span multiple lines.
3360           </p>
3361         </sect1>
3362
3363         <sect1 id="f-Installed-Size">
3364           <heading><tt>Installed-Size</tt></heading>
3365
3366           <p>
3367             This field appears in the control files of binary packages,
3368             and in the <file>Packages</file> files.  It gives an estimate
3369             of the total amount of disk space required to install the
3370             named package.  Actual installed size may vary based on block
3371             size, file system properties, or actions taken by package
3372             maintainer scripts.
3373           </p>
3374
3375           <p>
3376             The disk space is given as the integer value of the estimated
3377             installed size in bytes, divided by 1024 and rounded up.
3378           </p>
3379         </sect1>
3380
3381         <sect1 id="f-Files">
3382           <heading><tt>Files</tt></heading>
3383
3384           <p>
3385             This field contains a list of files with information about
3386             each one.  The exact information and syntax varies with
3387             the context.
3388           </p>
3389
3390           <p>
3391             In all cases, Files is a multiline field.  The first line of
3392             the field value (the part on the same line as <tt>Files:</tt>)
3393             is always empty.  The content of the field is expressed as
3394             continuation lines, one line per file.  Each line must be
3395             indented by one space and contain a number of sub-fields,
3396             separated by spaces, as described below.
3397           </p>
3398
3399           <p>
3400             In the <file>.dsc</file> file, each line contains the MD5
3401             checksum, size and filename of the tar file and (if
3402             applicable) diff file which make up the remainder of the
3403             source package<footnote>
3404               That is, the parts which are not the <tt>.dsc</tt>.
3405             </footnote>.  For example:
3406             <example>
3407 Files:
3408  c6f698f19f2a2aa07dbb9bbda90a2754 571925 example_1.2.orig.tar.gz
3409  938512f08422f3509ff36f125f5873ba 6220 example_1.2-1.diff.gz
3410             </example>
3411             The exact forms of the filenames are described
3412             in <ref id="pkg-sourcearchives">.
3413           </p>
3414
3415           <p>
3416             In the <file>.changes</file> file this contains one line per
3417             file being uploaded.  Each line contains the MD5 checksum,
3418             size, section and priority and the filename.  For example:
3419             <example>
3420 Files:
3421  4c31ab7bfc40d3cf49d7811987390357 1428 text extra example_1.2-1.dsc
3422  c6f698f19f2a2aa07dbb9bbda90a2754 571925 text extra example_1.2.orig.tar.gz
3423  938512f08422f3509ff36f125f5873ba 6220 text extra example_1.2-1.diff.gz
3424  7c98fe853b3bbb47a00e5cd129b6cb56 703542 text extra example_1.2-1_i386.deb
3425             </example>
3426             The <qref id="f-Section">section</qref>
3427             and <qref id="f-Priority">priority</qref> are the values of
3428             the corresponding fields in the main source control file.  If
3429             no section or priority is specified then <tt>-</tt> should be
3430             used, though section and priority values must be specified for
3431             new packages to be installed properly.
3432           </p>
3433
3434           <p>
3435             The special value <tt>byhand</tt> for the section in a
3436             <tt>.changes</tt> file indicates that the file in question
3437             is not an ordinary package file and must by installed by
3438             hand by the distribution maintainers.  If the section is
3439             <tt>byhand</tt> the priority should be <tt>-</tt>.
3440           </p>
3441
3442           <p>
3443             If a new Debian revision of a package is being shipped and
3444             no new original source archive is being distributed the
3445             <tt>.dsc</tt> must still contain the <tt>Files</tt> field
3446             entry for the original source archive
3447             <file><var>package</var>_<var>upstream-version</var>.orig.tar.gz</file>,
3448             but the <file>.changes</file> file should leave it out.  In
3449             this case the original source archive on the distribution
3450             site must match exactly, byte-for-byte, the original
3451             source archive which was used to generate the
3452             <file>.dsc</file> file and diff which are being uploaded.</p>
3453         </sect1>
3454
3455         <sect1 id="f-Closes">
3456           <heading><tt>Closes</tt></heading>
3457
3458           <p>
3459             A space-separated list of bug report numbers that the upload
3460             governed by the .changes file closes.
3461           </p>
3462         </sect1>
3463
3464         <sect1 id="f-Homepage">
3465           <heading><tt>Homepage</tt></heading>
3466
3467           <p>
3468             The URL of the web site for this package, preferably (when
3469             applicable) the site from which the original source can be
3470             obtained and any additional upstream documentation or
3471             information may be found.  The content of this field is a
3472             simple URL without any surrounding characters such as
3473             <tt>&lt;&gt;</tt>.
3474           </p>
3475         </sect1>
3476
3477         <sect1 id="f-Checksums">
3478           <heading><tt>Checksums-Sha1</tt>
3479             and <tt>Checksums-Sha256</tt></heading>
3480
3481           <p>
3482             These fields contain a list of files with a checksum and size
3483             for each one.  Both <tt>Checksums-Sha1</tt>
3484             and <tt>Checksums-Sha256</tt> have the same syntax and differ
3485             only in the checksum algorithm used: SHA-1
3486             for <tt>Checksums-Sha1</tt> and SHA-256
3487             for <tt>Checksums-Sha256</tt>.
3488           </p>
3489
3490           <p>
3491             <tt>Checksums-Sha1</tt> and <tt>Checksums-Sha256</tt> are
3492             multiline fields.  The first line of the field value (the part
3493             on the same line as <tt>Checksums-Sha1:</tt>
3494             or <tt>Checksums-Sha256:</tt>) is always empty.  The content
3495             of the field is expressed as continuation lines, one line per
3496             file.  Each line consists of the checksum, a space, the file
3497             size, a space, and the file name.  For example (from
3498             a <file>.changes</file> file):
3499             <example>
3500 Checksums-Sha1:
3501  1f418afaa01464e63cc1ee8a66a05f0848bd155c 1276 example_1.0-1.dsc
3502  a0ed1456fad61116f868b1855530dbe948e20f06 171602 example_1.0.orig.tar.gz
3503  5e86ecf0671e113b63388dac81dd8d00e00ef298 6137 example_1.0-1.debian.tar.gz
3504  71a0ff7da0faaf608481195f9cf30974b142c183 548402 example_1.0-1_i386.deb
3505 Checksums-Sha256:
3506  ac9d57254f7e835bed299926fd51bf6f534597cc3fcc52db01c4bffedae81272 1276 example_1.0-1.dsc
3507  0d123be7f51e61c4bf15e5c492b484054be7e90f3081608a5517007bfb1fd128 171602 example_1.0.orig.tar.gz
3508  f54ae966a5f580571ae7d9ef5e1df0bd42d63e27cb505b27957351a495bc6288 6137 example_1.0-1.debian.tar.gz
3509  3bec05c03974fdecd11d020fc2e8250de8404867a8a2ce865160c250eb723664 548402 example_1.0-1_i386.deb
3510             </example>
3511           </p>
3512
3513           <p>
3514             In the <file>.dsc</file> file, these fields should list all
3515             files that make up the source package.  In
3516             the <file>.changes</file> file, these fields should list all
3517             files being uploaded.  The list of files in these fields
3518             must match the list of files in the <tt>Files</tt> field.
3519           </p>
3520         </sect1>
3521
3522       </sect>
3523
3524       <sect>
3525         <heading>User-defined fields</heading>
3526
3527         <p>
3528           Additional user-defined fields may be added to the
3529           source package control file.  Such fields will be
3530           ignored, and not copied to (for example) binary or
3531           source package control files or upload control files.
3532         </p>
3533
3534         <p>
3535           If you wish to add additional unsupported fields to
3536           these output files you should use the mechanism
3537           described here.
3538         </p>
3539
3540         <p>
3541           Fields in the main source control information file with
3542           names starting <tt>X</tt>, followed by one or more of
3543           the letters <tt>BCS</tt> and a hyphen <tt>-</tt>, will
3544           be copied to the output files.  Only the part of the
3545           field name after the hyphen will be used in the output
3546           file.  Where the letter <tt>B</tt> is used the field
3547           will appear in binary package control files, where the
3548           letter <tt>S</tt> is used in source package control
3549           files and where <tt>C</tt> is used in upload control
3550           (<tt>.changes</tt>) files.
3551         </p>
3552
3553         <p>
3554           For example, if the main source information control file
3555           contains the field
3556           <example>
3557   XBS-Comment: I stand between the candle and the star.
3558           </example>
3559           then the binary and source package control files will contain the
3560           field
3561           <example>
3562   Comment: I stand between the candle and the star.
3563           </example>
3564         </p>
3565
3566       </sect>
3567
3568     </chapt>
3569
3570
3571     <chapt id="maintainerscripts">
3572       <heading>Package maintainer scripts and installation procedure</heading>
3573
3574       <sect>
3575         <heading>Introduction to package maintainer scripts</heading>
3576
3577         <p>
3578           It is possible to supply scripts as part of a package which
3579           the package management system will run for you when your
3580           package is installed, upgraded or removed.
3581         </p>
3582
3583         <p>
3584           These scripts are the files <prgn>preinst</prgn>,
3585           <prgn>postinst</prgn>, <prgn>prerm</prgn> and
3586           <prgn>postrm</prgn> in the control area of the package.
3587           They must be proper executable files; if they are scripts
3588           (which is recommended), they must start with the usual
3589           <tt>#!</tt> convention.  They should be readable and
3590           executable by anyone, and must not be world-writable.
3591         </p>
3592
3593         <p>
3594           The package management system looks at the exit status from
3595           these scripts.  It is important that they exit with a
3596           non-zero status if there is an error, so that the package
3597           management system can stop its processing.  For shell
3598           scripts this means that you <em>almost always</em> need to
3599           use <tt>set -e</tt> (this is usually true when writing shell
3600           scripts, in fact).  It is also important, of course, that
3601           they exit with a zero status if everything went well.
3602         </p>
3603
3604         <p>
3605           Additionally, packages interacting with users using
3606           <tt>debconf</tt> in the <prgn>postinst</prgn> script should
3607           install a <prgn>config</prgn> script  in the control area,
3608           see <ref id="maintscriptprompt"> for details.
3609         </p>
3610
3611         <p>
3612           When a package is upgraded a combination of the scripts from
3613           the old and new packages is called during the upgrade
3614           procedure.  If your scripts are going to be at all
3615           complicated you need to be aware of this, and may need to
3616           check the arguments to your scripts.
3617         </p>
3618
3619         <p>
3620           Broadly speaking the <prgn>preinst</prgn> is called before
3621           (a particular version of) a package is installed, and the
3622           <prgn>postinst</prgn> afterwards; the <prgn>prerm</prgn>
3623           before (a version of) a package is removed and the
3624           <prgn>postrm</prgn> afterwards.
3625         </p>
3626
3627         <p>
3628           Programs called from maintainer scripts should not normally
3629           have a path prepended to them. Before installation is
3630           started, the package management system checks to see if the
3631           programs <prgn>ldconfig</prgn>,
3632           <prgn>start-stop-daemon</prgn>, <prgn>install-info</prgn>,
3633           and <prgn>update-rc.d</prgn> can be found via the
3634           <tt>PATH</tt> environment variable. Those programs, and any
3635           other program that one would expect to be in the
3636           <tt>PATH</tt>, should thus be invoked without an absolute
3637           pathname. Maintainer scripts should also not reset the
3638           <tt>PATH</tt>, though they might choose to modify it by
3639           prepending or appending package-specific directories. These
3640           considerations really apply to all shell scripts.</p>
3641       </sect>
3642
3643       <sect id="idempotency">
3644         <heading>Maintainer scripts idempotency</heading>
3645
3646         <p>
3647           It is necessary for the error recovery procedures that the
3648           scripts be idempotent.  This means that if it is run
3649           successfully, and then it is called again, it doesn't bomb
3650           out or cause any harm, but just ensures that everything is
3651           the way it ought to be.  If the first call failed, or
3652           aborted half way through for some reason, the second call
3653           should merely do the things that were left undone the first
3654           time, if any, and exit with a success status if everything
3655           is OK.<footnote>
3656               This is so that if an error occurs, the user interrupts
3657               <prgn>dpkg</prgn> or some other unforeseen circumstance
3658               happens you don't leave the user with a badly-broken
3659               package when <prgn>dpkg</prgn> attempts to repeat the
3660               action.
3661           </footnote>
3662         </p>
3663       </sect>
3664
3665       <sect id="controllingterminal">
3666         <heading>Controlling terminal for maintainer scripts</heading>
3667
3668         <p>
3669           Maintainer scripts are not guaranteed to run with a controlling
3670           terminal and may not be able to interact with the user.  They
3671           must be able to fall back to noninteractive behavior if no
3672           controlling terminal is available.  Maintainer scripts that
3673           prompt via a program conforming to the Debian Configuration
3674           Management Specification (see <ref id="maintscriptprompt">) may
3675           assume that program will handle falling back to noninteractive
3676           behavior.
3677         </p>
3678
3679         <p>
3680           For high-priority prompts without a reasonable default answer,
3681           maintainer scripts may abort if there is no controlling
3682           terminal.  However, this situation should be avoided if at all
3683           possible, since it prevents automated or unattended installs.
3684           In most cases, users will consider this to be a bug in the
3685           package.
3686         </p>
3687       </sect>
3688
3689       <sect id="exitstatus">
3690         <heading>Exit status</heading>
3691
3692         <p>
3693           Each script must return a zero exit status for
3694           success, or a nonzero one for failure, since the package
3695           management system looks for the exit status of these scripts
3696           and determines what action to take next based on that datum.
3697         </p>
3698       </sect>
3699
3700       <sect id="mscriptsinstact"><heading>Summary of ways maintainer
3701           scripts are called
3702         </heading>
3703
3704         <p>
3705           <list compact="compact">
3706             <item>
3707               <var>new-preinst</var> <tt>install</tt>
3708             </item>
3709             <item>
3710               <var>new-preinst</var> <tt>install</tt> <var>old-version</var>
3711             </item>
3712             <item>
3713                 <var>new-preinst</var> <tt>upgrade</tt> <var>old-version</var>
3714             </item>
3715             <item>
3716                 <var>old-preinst</var> <tt>abort-upgrade</tt>
3717                 <var>new-version</var>
3718             </item>
3719           </list>
3720
3721         <p>
3722           <list compact="compact">
3723             <item>
3724                 <var>postinst</var> <tt>configure</tt>
3725                 <var>most-recently-configured-version</var>
3726             </item>
3727             <item>
3728                 <var>old-postinst</var> <tt>abort-upgrade</tt>
3729                 <var>new-version</var>
3730             </item>
3731             <item>
3732                 <var>conflictor's-postinst</var> <tt>abort-remove</tt>
3733                 <tt>in-favour</tt> <var>package</var>
3734                 <var>new-version</var>
3735             </item>
3736             <item>
3737                 <var>postinst</var> <tt>abort-remove</tt>
3738             </item>
3739             <item>
3740                 <var>deconfigured's-postinst</var>
3741                 <tt>abort-deconfigure</tt> <tt>in-favour</tt>
3742                 <var>failed-install-package</var> <var>version</var>
3743                 [<tt>removing</tt> <var>conflicting-package</var>
3744                 <var>version</var>]
3745             </item>
3746           </list>
3747
3748         <p>
3749           <list compact="compact">
3750             <item>
3751                 <var>prerm</var> <tt>remove</tt>
3752             </item>
3753             <item>
3754                 <var>old-prerm</var> <tt>upgrade</tt>
3755                 <var>new-version</var>
3756             </item>
3757             <item>
3758                 <var>new-prerm</var> <tt>failed-upgrade</tt>
3759                 <var>old-version</var>
3760             </item>
3761             <item>
3762                 <var>conflictor's-prerm</var> <tt>remove</tt>
3763                 <tt>in-favour</tt> <var>package</var>
3764                 <var>new-version</var>
3765             </item>
3766             <item>
3767                 <var>deconfigured's-prerm</var> <tt>deconfigure</tt>
3768                 <tt>in-favour</tt> <var>package-being-installed</var>
3769                 <var>version</var> [<tt>removing</tt>
3770                 <var>conflicting-package</var>
3771                 <var>version</var>]
3772             </item>
3773           </list>
3774
3775         <p>
3776           <list compact="compact">
3777             <item>
3778                 <var>postrm</var> <tt>remove</tt>
3779             </item>
3780             <item>
3781                 <var>postrm</var> <tt>purge</tt>
3782             </item>
3783             <item>
3784                 <var>old-postrm</var> <tt>upgrade</tt>
3785                 <var>new-version</var>
3786             </item>
3787             <item>
3788                 <var>new-postrm</var> <tt>failed-upgrade</tt>
3789                 <var>old-version</var>
3790             </item>
3791             <item>
3792                 <var>new-postrm</var> <tt>abort-install</tt>
3793             </item>
3794             <item>
3795                 <var>new-postrm</var> <tt>abort-install</tt>
3796                 <var>old-version</var>
3797             </item>
3798             <item>
3799                 <var>new-postrm</var> <tt>abort-upgrade</tt>
3800                 <var>old-version</var>
3801             </item>
3802             <item>
3803                 <var>disappearer's-postrm</var> <tt>disappear</tt>
3804                 <var>overwriter</var>
3805                 <var>overwriter-version</var>
3806             </item>
3807           </list>
3808         </p>
3809
3810
3811       <sect id="unpackphase">
3812         <heading>Details of unpack phase of installation or upgrade</heading>
3813
3814         <p>
3815           The procedure on installation/upgrade/overwrite/disappear
3816           (i.e., when running <tt>dpkg --unpack</tt>, or the unpack
3817           stage of <tt>dpkg --install</tt>) is as follows.  In each
3818           case, if a major error occurs (unless listed below) the
3819           actions are, in general, run backwards - this means that the
3820           maintainer scripts are run with different arguments in
3821           reverse order.  These are the "error unwind" calls listed
3822           below.
3823
3824           <enumlist>
3825             <item>
3826                 <enumlist>
3827                   <item>
3828                       If a version of the package is already installed, call
3829                       <example compact="compact">
3830 <var>old-prerm</var> upgrade <var>new-version</var>
3831                       </example>
3832                   </item>
3833                   <item>
3834                       If the script runs but exits with a non-zero
3835                       exit status, <prgn>dpkg</prgn> will attempt:
3836                       <example compact="compact">
3837 <var>new-prerm</var> failed-upgrade <var>old-version</var>
3838                       </example>
3839                       If this works, the upgrade continues. If this
3840                       does not work, the error unwind:
3841                       <example compact="compact">
3842 <var>old-postinst</var> abort-upgrade <var>new-version</var>
3843                       </example>
3844                       If this works, then the old-version is
3845                       "Installed", if not, the old version is in a
3846                       "Half-Configured" state.
3847                   </item>
3848                 </enumlist>
3849             </item>
3850
3851             <item>
3852                 If a "conflicting" package is being removed at the same time,
3853                 or if any package will be broken (due to <tt>Breaks</tt>):
3854                 <enumlist>
3855                   <item>
3856                       If <tt>--auto-deconfigure</tt> is
3857                       specified, call, for each package to be deconfigured
3858                       due to <tt>Breaks</tt>:
3859                       <example compact="compact">
3860 <var>deconfigured's-prerm</var> deconfigure \
3861   in-favour <var>package-being-installed</var> <var>version</var>
3862                       </example>
3863                       Error unwind:
3864                       <example compact="compact">
3865 <var>deconfigured's-postinst</var> abort-deconfigure \
3866   in-favour <var>package-being-installed-but-failed</var> <var>version</var>
3867                       </example>
3868                       The deconfigured packages are marked as
3869                       requiring configuration, so that if
3870                       <tt>--install</tt> is used they will be
3871                       configured again if possible.
3872                   </item>
3873                   <item>
3874                       If any packages depended on a conflicting
3875                       package being removed and <tt>--auto-deconfigure</tt> is
3876                       specified, call, for each such package:
3877                       <example compact="compact">
3878 <var>deconfigured's-prerm</var> deconfigure \
3879   in-favour <var>package-being-installed</var> <var>version</var> \
3880     removing <var>conflicting-package</var> <var>version</var>
3881                       </example>
3882                       Error unwind:
3883                       <example compact="compact">
3884 <var>deconfigured's-postinst</var> abort-deconfigure \
3885   in-favour <var>package-being-installed-but-failed</var> <var>version</var> \
3886     removing <var>conflicting-package</var> <var>version</var>
3887                       </example>
3888                       The deconfigured packages are marked as
3889                       requiring configuration, so that if
3890                       <tt>--install</tt> is used they will be
3891                       configured again if possible.
3892                   </item>
3893                   <item>
3894                       To prepare for removal of each conflicting package, call:
3895                       <example compact="compact">
3896 <var>conflictor's-prerm</var> remove \
3897   in-favour <var>package</var> <var>new-version</var>
3898                       </example>
3899                       Error unwind:
3900                       <example compact="compact">
3901 <var>conflictor's-postinst</var> abort-remove \
3902   in-favour <var>package</var> <var>new-version</var>
3903                       </example>
3904                   </item>
3905                 </enumlist>
3906             </item>
3907
3908             <item>
3909                 <enumlist>
3910                   <item>
3911                       If the package is being upgraded, call:
3912                       <example compact="compact">
3913 <var>new-preinst</var> upgrade <var>old-version</var>
3914                       </example>
3915                       If this fails, we call:
3916                       <example>
3917 <var>new-postrm</var> abort-upgrade <var>old-version</var>
3918                       </example>
3919                       <enumlist>
3920                         <item>
3921                           <p>
3922                             If that works, then
3923                             <example>
3924 <var>old-postinst</var> abort-upgrade <var>new-version</var>
3925                             </example>
3926                             is called. If this works, then the old version
3927                             is in an "Installed" state, or else it is left
3928                             in an "Unpacked" state.
3929                           </p>
3930                         </item>
3931                         <item>
3932                           <p>
3933                             If it fails, then the old version is left
3934                             in an "Half-Installed" state.
3935                           </p>
3936                         </item>
3937                       </enumlist>
3938                       
3939                   </item>
3940                   <item>
3941                       Otherwise, if the package had some configuration
3942                       files from a previous version installed (i.e., it
3943                       is in the "configuration files only" state):
3944                       <example compact="compact">
3945 <var>new-preinst</var> install <var>old-version</var>
3946                       </example>
3947                       Error unwind:
3948                       <example>
3949 <var>new-postrm</var> abort-install <var>old-version</var>
3950                       </example>
3951                       If this fails, the package is left in a
3952                       "Half-Installed" state, which requires a
3953                       reinstall. If it works, the packages is left in
3954                       a "Config-Files" state.
3955                   </item>
3956                   <item>
3957                       Otherwise (i.e., the package was completely purged):
3958                       <example compact="compact">
3959 <var>new-preinst</var> install
3960                       </example>
3961                       Error unwind:
3962                       <example compact="compact">
3963 <var>new-postrm</var> abort-install
3964                       </example>
3965                       If the error-unwind fails, the package is in a
3966                       "Half-Installed" phase, and requires a
3967                       reinstall. If the error unwind works, the
3968                       package is in a not installed state.
3969                   </item>
3970                 </enumlist>
3971             </item>
3972
3973             <item>
3974               <p>
3975                 The new package's files are unpacked, overwriting any
3976                 that may be on the system already, for example any
3977                 from the old version of the same package or from
3978                 another package.  Backups of the old files are kept
3979                 temporarily, and if anything goes wrong the package
3980                 management system will attempt to put them back as
3981                 part of the error unwind.
3982               </p>
3983
3984               <p>
3985                 It is an error for a package to contain files which
3986                 are on the system in another package, unless
3987                 <tt>Replaces</tt> is used (see <ref id="replaces">).
3988                 <!--
3989                 The following paragraph is not currently the case:
3990                 Currently the <tt>- - force-overwrite</tt> flag is
3991                 enabled, downgrading it to a warning, but this may not
3992                 always be the case.
3993                 -->
3994               </p>
3995
3996               <p>
3997                 It is a more serious error for a package to contain a
3998                 plain file or other kind of non-directory where another
3999                 package has a directory (again, unless
4000                 <tt>Replaces</tt> is used).  This error can be
4001                 overridden if desired using
4002                 <tt>--force-overwrite-dir</tt>, but this is not
4003                 advisable.
4004               </p>
4005
4006               <p>
4007                 Packages which overwrite each other's files produce
4008                 behavior which, though deterministic, is hard for the
4009                 system administrator to understand.  It can easily
4010                 lead to "missing" programs if, for example, a package
4011                 is installed which overwrites a file from another
4012                 package, and is then removed again.<footnote>
4013                     Part of the problem is due to what is arguably a
4014                     bug in <prgn>dpkg</prgn>.
4015                 </footnote>
4016               </p>
4017
4018               <p>
4019                 A directory will never be replaced by a symbolic link
4020                 to a directory or vice versa; instead, the existing
4021                 state (symlink or not) will be left alone and
4022                 <prgn>dpkg</prgn> will follow the symlink if there is
4023                 one.
4024               </p>
4025             </item>
4026
4027             <item>
4028               <p>
4029                 <enumlist>
4030                   <item>
4031                       If the package is being upgraded, call
4032                       <example compact="compact">
4033 <var>old-postrm</var> upgrade <var>new-version</var>
4034                       </example>
4035                   </item>
4036                   <item>
4037                       If this fails, <prgn>dpkg</prgn> will attempt:
4038                       <example compact="compact">
4039 <var>new-postrm</var> failed-upgrade <var>old-version</var>
4040                       </example>
4041                       If this works, installation continues. If not, 
4042                       Error unwind:
4043                       <example compact="compact">
4044 <var>old-preinst</var> abort-upgrade <var>new-version</var>
4045                       </example>
4046                       If this fails, the old version is left in a
4047                       "Half-Installed" state. If it works, dpkg now
4048                       calls:
4049                       <example compact="compact">
4050 <var>new-postrm</var> abort-upgrade <var>old-version</var>
4051                       </example>
4052                       If this fails, the old version is left in a
4053                       "Half-Installed" state. If it works, dpkg now
4054                       calls:
4055                       <example compact="compact">
4056 <var>old-postinst</var> abort-upgrade <var>new-version</var>
4057                       </example>
4058                       If this fails, the old version is in an
4059                       "Unpacked" state.
4060                   </item>
4061                 </enumlist>
4062               </p>
4063
4064               <p>
4065                 This is the point of no return - if
4066                 <prgn>dpkg</prgn> gets this far, it won't back off
4067                 past this point if an error occurs.  This will
4068                 leave the package in a fairly bad state, which
4069                 will require a successful re-installation to clear
4070                 up, but it's when <prgn>dpkg</prgn> starts doing
4071                 things that are irreversible.
4072               </p>
4073             </item>
4074
4075             <item>
4076                 Any files which were in the old version of the package
4077                 but not in the new are removed.
4078             </item>
4079
4080             <item>
4081                 The new file list replaces the old.
4082             </item>
4083
4084             <item>
4085                 The new maintainer scripts replace the old.
4086             </item>
4087
4088             <item>
4089                 Any packages all of whose files have been overwritten
4090                 during the installation, and which aren't required for
4091                 dependencies, are considered to have been removed.
4092                 For each such package
4093                 <enumlist>
4094                   <item>
4095                       <prgn>dpkg</prgn> calls:
4096                       <example compact="compact">
4097 <var>disappearer's-postrm</var> disappear \
4098   <var>overwriter</var> <var>overwriter-version</var>
4099                       </example>
4100                   </item>
4101                   <item>
4102                       The package's maintainer scripts are removed.
4103                   </item>
4104                   <item>
4105                       It is noted in the status database as being in a
4106                       sane state, namely not installed (any conffiles
4107                       it may have are ignored, rather than being
4108                       removed by <prgn>dpkg</prgn>).  Note that
4109                       disappearing packages do not have their prerm
4110                       called, because <prgn>dpkg</prgn> doesn't know
4111                       in advance that the package is going to
4112                       vanish.
4113                   </item>
4114                 </enumlist>
4115             </item>
4116
4117             <item>
4118                 Any files in the package we're unpacking that are also
4119                 listed in the file lists of other packages are removed
4120                 from those lists.  (This will lobotomize the file list
4121                 of the "conflicting" package if there is one.)
4122             </item>
4123
4124             <item>
4125                 The backup files made during installation, above, are
4126                 deleted.
4127             </item>
4128
4129             <item>
4130               <p>
4131                 The new package's status is now sane, and recorded as
4132                 "unpacked".
4133               </p>
4134
4135               <p>
4136                 Here is another point of no return - if the
4137                 conflicting package's removal fails we do not unwind
4138                 the rest of the installation; the conflicting package
4139                 is left in a half-removed limbo.
4140               </p>
4141             </item>
4142
4143             <item>
4144                 If there was a conflicting package we go and do the
4145                 removal actions (described below), starting with the
4146                 removal of the conflicting package's files (any that
4147                 are also in the package being installed have already
4148                 been removed from the conflicting package's file list,
4149                 and so do not get removed now).
4150             </item>
4151           </enumlist>
4152         </p>
4153       </sect>
4154
4155       <sect id="configdetails"><heading>Details of configuration</heading>
4156
4157         <p>
4158           When we configure a package (this happens with <tt>dpkg
4159             --install</tt> and <tt>dpkg --configure</tt>), we first
4160           update any <tt>conffile</tt>s and then call:
4161           <example compact="compact">
4162 <var>postinst</var> configure <var>most-recently-configured-version</var>
4163           </example>
4164         </p>
4165
4166         <p>
4167           No attempt is made to unwind after errors during
4168           configuration. If the configuration fails, the package is in
4169           a "Failed Config" state, and an error message is generated.
4170         </p>
4171
4172         <p>
4173           If there is no most recently configured version
4174           <prgn>dpkg</prgn> will pass a null argument.
4175           <footnote>
4176             <p>
4177               Historical note: Truly ancient (pre-1997) versions of
4178               <prgn>dpkg</prgn> passed <tt>&lt;unknown&gt;</tt>
4179               (including the angle brackets) in this case.  Even older
4180               ones did not pass a second argument at all, under any
4181               circumstance.  Note that upgrades using such an old dpkg
4182               version are unlikely to work for other reasons, even if
4183               this old argument behavior is handled by your postinst script.
4184             </p>
4185           </footnote>     
4186         </p>
4187       </sect>
4188
4189       <sect id="removedetails"><heading>Details of removal and/or
4190       configuration purging</heading>
4191
4192         <p>
4193           <enumlist>
4194             <item>
4195               <p>
4196                 <example compact="compact">
4197 <var>prerm</var> remove
4198                 </example>
4199               </p>
4200               <p>
4201                 If prerm fails during replacement due to conflict
4202                 <example>
4203 <var>conflictor's-postinst</var> abort-remove \
4204   in-favour <var>package</var> <var>new-version</var>
4205                 </example>
4206                 Or else we call:
4207                 <example>
4208 <var>postinst</var> abort-remove
4209                 </example>
4210               </p>
4211               <p>
4212                 If this fails, the package is in a "Half-Configured"
4213                 state, or else it remains "Installed".
4214               </p>
4215             </item>
4216             <item>
4217                 The package's files are removed (except <tt>conffile</tt>s).
4218             </item>
4219             <item>
4220                 <example compact="compact">
4221 <var>postrm</var> remove
4222                 </example>
4223
4224               <p>
4225                 If it fails, there's no error unwind, and the package is in
4226                 an "Half-Installed" state.
4227               </p>
4228             </item>
4229             <item>
4230               <p>
4231                 All the maintainer scripts except the <prgn>postrm</prgn>
4232                 are removed.
4233               </p>
4234
4235               <p>
4236                 If we aren't purging the package we stop here.  Note
4237                 that packages which have no <prgn>postrm</prgn> and no
4238                 <tt>conffile</tt>s are automatically purged when
4239                 removed, as there is no difference except for the
4240                 <prgn>dpkg</prgn> status.
4241               </p>
4242             </item>
4243             <item>
4244                 The <tt>conffile</tt>s and any backup files
4245                 (<tt>~</tt>-files, <tt>#*#</tt> files,
4246                 <tt>%</tt>-files, <tt>.dpkg-{old,new,tmp}</tt>, etc.)
4247                 are removed.
4248             </item>
4249             <item>
4250               <p>
4251                 <example compact="compact">
4252 <var>postrm</var> purge
4253                 </example>
4254               </p>
4255               <p>
4256                 If this fails, the package remains in a "Config-Files"
4257                 state.
4258               </p>
4259             </item>
4260             <item>
4261                 The package's file list is removed.
4262             </item>
4263           </enumlist>
4264
4265         </p>
4266       </sect>
4267     </chapt>
4268
4269
4270     <chapt id="relationships">
4271       <heading>Declaring relationships between packages</heading>
4272
4273       <sect id="depsyntax">
4274         <heading>Syntax of relationship fields</heading>
4275
4276         <p>
4277           These fields all have a uniform syntax.  They are a list of
4278           package names separated by commas.
4279         </p>
4280
4281         <p>
4282           In the <tt>Depends</tt>, <tt>Recommends</tt>,
4283           <tt>Suggests</tt>, <tt>Pre-Depends</tt>,
4284           <tt>Build-Depends</tt> and <tt>Build-Depends-Indep</tt>
4285           control file fields of the package, which declare
4286           dependencies on other packages, the package names listed may
4287           also include lists of alternative package names, separated
4288           by vertical bar (pipe) symbols <tt>|</tt>.  In such a case,
4289           if any one of the alternative packages is installed, that
4290           part of the dependency is considered to be satisfied.
4291         </p>
4292
4293         <p>
4294           All of the fields except for <tt>Provides</tt> may restrict
4295           their applicability to particular versions of each named
4296           package.  This is done in parentheses after each individual
4297           package name; the parentheses should contain a relation from
4298           the list below followed by a version number, in the format
4299           described in <ref id="f-Version">.
4300         </p>
4301
4302         <p>
4303           The relations allowed are <tt>&lt;&lt;</tt>, <tt>&lt;=</tt>,
4304           <tt>=</tt>, <tt>&gt;=</tt> and <tt>&gt;&gt;</tt> for
4305           strictly earlier, earlier or equal, exactly equal, later or
4306           equal and strictly later, respectively.  The deprecated
4307           forms <tt>&lt;</tt> and <tt>&gt;</tt> were used to mean
4308           earlier/later or equal, rather than strictly earlier/later,
4309           so they should not appear in new packages (though
4310           <prgn>dpkg</prgn> still supports them).
4311         </p>
4312
4313         <p>
4314           Whitespace may appear at any point in the version
4315           specification subject to the rules in <ref
4316           id="controlsyntax">, and must appear where it's necessary to
4317           disambiguate; it is not otherwise significant.  All of the
4318           relationship fields may span multiple lines.  For
4319           consistency and in case of future changes to
4320           <prgn>dpkg</prgn> it is recommended that a single space be
4321           used after a version relationship and before a version
4322           number; it is also conventional to put a single space after
4323           each comma, on either side of each vertical bar, and before
4324           each open parenthesis.  When wrapping a relationship field, it
4325           is conventional to do so after a comma and before the space
4326           following that comma.
4327         </p>
4328
4329         <p>
4330           For example, a list of dependencies might appear as:
4331           <example compact="compact">
4332 Package: mutt
4333 Version: 1.3.17-1
4334 Depends: libc6 (>= 2.2.1), exim | mail-transport-agent
4335           </example>
4336         </p>
4337
4338         <p>
4339           All fields that specify build-time relationships
4340           (<tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
4341           <tt>Build-Conflicts</tt> and <tt>Build-Conflicts-Indep</tt>)
4342           may be restricted to a certain set of architectures.  This
4343           is indicated in brackets after each individual package name and
4344           the optional version specification.  The brackets enclose a
4345           list of Debian architecture names separated by whitespace.
4346           Exclamation marks may be prepended to each of the names.
4347           (It is not permitted for some names to be prepended with
4348           exclamation marks while others aren't.) If the current Debian
4349           host architecture is not in this list and there are no
4350           exclamation marks in the list, or it is in the list with a
4351           prepended exclamation mark, the package name and the
4352           associated version specification are ignored completely for
4353           the purposes of defining the relationships.
4354         </p>
4355
4356         <p>
4357           For example:
4358           <example compact="compact">
4359 Source: glibc
4360 Build-Depends-Indep: texinfo
4361 Build-Depends: kernel-headers-2.2.10 [!hurd-i386],
4362   hurd-dev [hurd-i386], gnumach-dev [hurd-i386]
4363           </example>
4364           requires <tt>kernel-headers-2.2.10</tt> on all architectures
4365           other than hurd-i386 and requires <tt>hurd-dev</tt> and
4366           <tt>gnumach-dev</tt> only on hurd-i386.
4367         </p>
4368
4369         <p>
4370           If the architecture-restricted dependency is part of a set of
4371           alternatives using <tt>|</tt>, that alternative is ignored
4372           completely on architectures that do not match the restriction.
4373           For example:
4374           <example compact="compact">
4375 Build-Depends: foo [!i386] | bar [!amd64]
4376           </example>
4377           is equivalent to <tt>bar</tt> on the i386 architecture, to
4378           <tt>foo</tt> on the amd64 architecture, and to <tt>foo |
4379           bar</tt> on all other architectures.
4380         </p>
4381
4382         <p>
4383           All fields that specify build-time relationships may also be
4384           restricted to a certain set of architectures using architecture
4385           wildcards.  The syntax for declaring such restrictions is the
4386           same as declaring restrictions using a certain set of
4387           architectures without architecture wildcards.  For example:
4388           <example compact="compact">
4389 Build-Depends: foo [linux-any], bar [any-i386], baz [!linux-any]
4390           </example>
4391           is equivalent to <tt>foo</tt> on architectures using the Linux
4392           kernel and any cpu, <tt>bar</tt> on architectures using any
4393           kernel and an i386 cpu, and <tt>baz</tt> on any architecture
4394           using a kernel other than Linux.
4395         </p>
4396
4397         <p>
4398           Note that the binary package relationship fields such as
4399           <tt>Depends</tt> appear in one of the binary package
4400           sections of the control file, whereas the build-time
4401           relationships such as <tt>Build-Depends</tt> appear in the
4402           source package section of the control file (which is the
4403           first section).
4404         </p>
4405       </sect>
4406
4407       <sect id="binarydeps">
4408         <heading>Binary Dependencies - <tt>Depends</tt>,
4409           <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
4410           <tt>Pre-Depends</tt>
4411         </heading>
4412
4413         <p>
4414           Packages can declare in their control file that they have
4415           certain relationships to other packages - for example, that
4416           they may not be installed at the same time as certain other
4417           packages, and/or that they depend on the presence of others.
4418         </p>
4419
4420         <p>
4421           This is done using the <tt>Depends</tt>, <tt>Pre-Depends</tt>,
4422           <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
4423           <tt>Breaks</tt> and <tt>Conflicts</tt> control file fields.
4424           <tt>Breaks</tt> is described in <ref id="breaks">, and
4425           <tt>Conflicts</tt> is described in <ref id="conflicts">.  The
4426           rest are described below.
4427         </p>
4428
4429         <p>
4430           These seven fields are used to declare a dependency
4431           relationship by one package on another.  Except for
4432           <tt>Enhances</tt> and <tt>Breaks</tt>, they appear in the
4433           depending (binary) package's control file.
4434           (<tt>Enhances</tt> appears in the recommending package's
4435           control file, and <tt>Breaks</tt> appears in the version of
4436           depended-on package which causes the named package to
4437           break).
4438         </p>
4439
4440         <p>
4441           A <tt>Depends</tt> field takes effect <em>only</em> when a
4442           package is to be configured.  It does not prevent a package
4443           being on the system in an unconfigured state while its
4444           dependencies are unsatisfied, and it is possible to replace
4445           a package whose dependencies are satisfied and which is
4446           properly installed with a different version whose
4447           dependencies are not and cannot be satisfied; when this is
4448           done the depending package will be left unconfigured (since
4449           attempts to configure it will give errors) and will not
4450           function properly.  If it is necessary, a
4451           <tt>Pre-Depends</tt> field can be used, which has a partial
4452           effect even when a package is being unpacked, as explained
4453           in detail below.  (The other three dependency fields,
4454           <tt>Recommends</tt>, <tt>Suggests</tt> and
4455           <tt>Enhances</tt>, are only used by the various front-ends
4456           to <prgn>dpkg</prgn> such as <prgn>apt-get</prgn>,
4457           <prgn>aptitude</prgn>, and <prgn>dselect</prgn>.)
4458         </p>
4459
4460         <p>
4461           For this reason packages in an installation run are usually
4462           all unpacked first and all configured later; this gives
4463           later versions of packages with dependencies on later
4464           versions of other packages the opportunity to have their
4465           dependencies satisfied.
4466         </p>
4467
4468         <p>
4469           In case of circular dependencies, since installation or
4470           removal order honoring the dependency order can't be
4471           established, dependency loops are broken at some point
4472           (based on rules below), and some packages may not be able to
4473           rely on their dependencies being present when being
4474           installed or removed, depending on which side of the break
4475           of the circular dependency loop they happen to be on.  If one
4476           of the packages in the loop has no postinst script, then the
4477           cycle will be broken at that package, so as to ensure that
4478           all postinst scripts run with the dependencies properly
4479           configured if this is possible. Otherwise the breaking point
4480           is arbitrary.
4481         </p>
4482
4483         <p>
4484           The <tt>Depends</tt> field thus allows package maintainers
4485           to impose an order in which packages should be configured.
4486         </p>
4487
4488         <p>
4489           The meaning of the five dependency fields is as follows:
4490           <taglist>
4491             <tag><tt>Depends</tt></tag>
4492             <item>
4493               <p>
4494                 This declares an absolute dependency.  A package will
4495                 not be configured unless all of the packages listed in
4496                 its <tt>Depends</tt> field have been correctly
4497                 configured.
4498               </p>
4499
4500               <p>
4501                 The <tt>Depends</tt> field should be used if the
4502                 depended-on package is required for the depending
4503                 package to provide a significant amount of
4504                 functionality.
4505               </p>
4506
4507               <p>
4508                 The <tt>Depends</tt> field should also be used if the
4509                 <prgn>postinst</prgn>, <prgn>prerm</prgn> or
4510                 <prgn>postrm</prgn> scripts require the package to be
4511                 present in order to run.  Note, however, that the
4512                 <prgn>postrm</prgn> cannot rely on any non-essential
4513                 packages to be present during the <tt>purge</tt>
4514                 phase.
4515             </item>
4516
4517             <tag><tt>Recommends</tt></tag>
4518             <item>
4519               <p>
4520                 This declares a strong, but not absolute, dependency.
4521               </p>
4522
4523               <p>
4524                 The <tt>Recommends</tt> field should list packages
4525                 that would be found together with this one in all but
4526                 unusual installations.
4527               </p>
4528             </item>
4529
4530             <tag><tt>Suggests</tt></tag>
4531             <item>
4532                 This is used to declare that one package may be more
4533                 useful with one or more others.  Using this field
4534                 tells the packaging system and the user that the
4535                 listed packages are related to this one and can
4536                 perhaps enhance its usefulness, but that installing
4537                 this one without them is perfectly reasonable.
4538             </item>
4539
4540             <tag><tt>Enhances</tt></tag>
4541             <item>
4542                 This field is similar to Suggests but works in the
4543                 opposite direction. It is used to declare that a
4544                 package can enhance the functionality of another
4545                 package.
4546             </item>
4547
4548             <tag><tt>Pre-Depends</tt></tag>
4549             <item>
4550               <p>
4551                 This field is like <tt>Depends</tt>, except that it
4552                 also forces <prgn>dpkg</prgn> to complete installation
4553                 of the packages named before even starting the
4554                 installation of the package which declares the
4555                 pre-dependency, as follows:
4556               </p>
4557
4558               <p>
4559                 When a package declaring a pre-dependency is about to
4560                 be <em>unpacked</em> the pre-dependency can be
4561                 satisfied if the depended-on package is either fully
4562                 configured, <em>or even if</em> the depended-on
4563                 package(s) are only unpacked or in the "Half-Configured"
4564                 state, provided that they have been configured
4565                 correctly at some point in the past (and not removed
4566                 or partially removed since).  In this case, both the
4567                 previously-configured and currently unpacked or
4568                 "Half-Configured" versions must satisfy any version
4569                 clause in the <tt>Pre-Depends</tt> field.
4570               </p>
4571
4572               <p>
4573                 When the package declaring a pre-dependency is about
4574                 to be <em>configured</em>, the pre-dependency will be
4575                 treated as a normal <tt>Depends</tt>, that is, it will
4576                 be considered satisfied only if the depended-on
4577                 package has been correctly configured.
4578               </p>
4579
4580               <p>
4581                 <tt>Pre-Depends</tt> should be used sparingly,
4582                 preferably only by packages whose premature upgrade or
4583                 installation would hamper the ability of the system to
4584                 continue with any upgrade that might be in progress.
4585               </p>
4586
4587               <p>
4588                 <tt>Pre-Depends</tt> are also required if the
4589                 <prgn>preinst</prgn> script depends on the named
4590                 package.  It is best to avoid this situation if
4591                 possible.
4592               </p>
4593             </item>
4594           </taglist>
4595         </p>
4596
4597         <p>
4598           When selecting which level of dependency to use you should
4599           consider how important the depended-on package is to the
4600           functionality of the one declaring the dependency.  Some
4601           packages are composed of components of varying degrees of
4602           importance.  Such a package should list using
4603           <tt>Depends</tt> the package(s) which are required by the
4604           more important components.  The other components'
4605           requirements may be mentioned as Suggestions or
4606           Recommendations, as appropriate to the components' relative
4607           importance.
4608         </p>
4609       </sect>
4610
4611       <sect id="breaks">
4612         <heading>Packages which break other packages - <tt>Breaks</tt></heading>
4613
4614         <p>
4615           When one binary package declares that it breaks another,
4616           <prgn>dpkg</prgn> will refuse to allow the package which
4617           declares <tt>Breaks</tt> be installed unless the broken
4618           package is deconfigured first, and it will refuse to
4619           allow the broken package to be reconfigured.
4620         </p>
4621
4622         <p>
4623           A package will not be regarded as causing breakage merely
4624           because its configuration files are still installed; it must
4625           be at least "Half-Installed".
4626         </p>
4627
4628         <p>
4629           A special exception is made for packages which declare that
4630           they break their own package name or a virtual package which
4631           they provide (see below): this does not count as a real
4632           breakage.
4633         </p>
4634
4635         <p>
4636           Normally a <tt>Breaks</tt> entry will have an "earlier than"
4637           version clause; such a <tt>Breaks</tt> is introduced in the
4638           version of an (implicit or explicit) dependency which
4639           violates an assumption or reveals a bug in earlier versions
4640           of the broken package.  This use of <tt>Breaks</tt> will
4641           inform higher-level package management tools that broken
4642           package must be upgraded before the new one.
4643         </p>
4644
4645         <p>
4646           If the breaking package also overwrites some files from the
4647           older package, it should use <tt>Replaces</tt> (not
4648           <tt>Conflicts</tt>) to ensure this goes smoothly.
4649         </p>
4650       </sect>
4651
4652       <sect id="conflicts">
4653         <heading>Conflicting binary packages - <tt>Conflicts</tt></heading>
4654
4655         <p>
4656           When one binary package declares a conflict with another
4657           using a <tt>Conflicts</tt> field, <prgn>dpkg</prgn> will
4658           refuse to allow them to be installed on the system at the
4659           same time.
4660         </p>
4661
4662         <p>
4663           If one package is to be installed, the other must be removed
4664           first - if the package being installed is marked as
4665           replacing (see <ref id="replaces">) the one on the system,
4666           or the one on the system is marked as deselected, or both
4667           packages are marked <tt>Essential</tt>, then
4668           <prgn>dpkg</prgn> will automatically remove the package
4669           which is causing the conflict, otherwise it will halt the
4670           installation of the new package with an error.  This
4671           mechanism is specifically designed to produce an error when
4672           the installed package is <tt>Essential</tt>, but the new
4673           package is not.
4674         </p>
4675
4676         <p>
4677           A package will not cause a conflict merely because its
4678           configuration files are still installed; it must be at least
4679           "Half-Installed".
4680         </p>
4681
4682         <p>
4683           A special exception is made for packages which declare a
4684           conflict with their own package name, or with a virtual
4685           package which they provide (see below): this does not
4686           prevent their installation, and allows a package to conflict
4687           with others providing a replacement for it.  You use this
4688           feature when you want the package in question to be the only
4689           package providing some feature.
4690         </p>
4691
4692         <p>
4693           A <tt>Conflicts</tt> entry should almost never have an
4694           "earlier than" version clause.  This would prevent
4695           <prgn>dpkg</prgn> from upgrading or installing the package
4696           which declared such a conflict until the upgrade or removal
4697           of the conflicted-with package had been completed.  Instead,
4698           <tt>Breaks</tt> may be used.
4699         </p>
4700       </sect>
4701
4702       <sect id="virtual"><heading>Virtual packages - <tt>Provides</tt>
4703         </heading>
4704
4705         <p>
4706           As well as the names of actual ("concrete") packages, the
4707           package relationship fields <tt>Depends</tt>,
4708           <tt>Recommends</tt>, <tt>Suggests</tt>, <tt>Enhances</tt>,
4709           <tt>Pre-Depends</tt>, <tt>Breaks</tt>, <tt>Conflicts</tt>,
4710           <tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
4711           <tt>Build-Conflicts</tt> and <tt>Build-Conflicts-Indep</tt>
4712           may mention "virtual packages".
4713         </p>
4714
4715         <p>
4716           A <em>virtual package</em> is one which appears in the
4717           <tt>Provides</tt> control file field of another package.
4718           The effect is as if the package(s) which provide a
4719           particular virtual package name had been listed by name
4720           everywhere the virtual package name appears. (See also <ref
4721             id="virtual_pkg">)
4722         </p>
4723
4724         <p>
4725           If there are both concrete and virtual packages of the same
4726           name, then the dependency may be satisfied (or the conflict
4727           caused) by either the concrete package with the name in
4728           question or any other concrete package which provides the
4729           virtual package with the name in question.  This is so that,
4730           for example, supposing we have
4731           <example compact="compact">
4732 Package: foo
4733 Depends: bar
4734           </example> and someone else releases an enhanced version of
4735           the <tt>bar</tt> package they can say:
4736           <example compact="compact">
4737 Package: bar-plus
4738 Provides: bar
4739           </example>
4740           and the <tt>bar-plus</tt> package will now also satisfy the
4741           dependency for the <tt>foo</tt> package.
4742         </p>
4743
4744         <p>
4745           If a relationship field has a version number attached
4746           then only real packages will be considered to see whether
4747           the relationship is satisfied (or the prohibition violated,
4748           for a conflict or breakage) - it is assumed that a real
4749           package which provides the virtual package is not of the
4750           "right" version.  So, a <tt>Provides</tt> field may not
4751           contain version numbers, and the version number of the
4752           concrete package which provides a particular virtual package
4753           will not be looked at when considering a dependency on or
4754           conflict with the virtual package name.
4755         </p>
4756
4757         <p>
4758           It is likely that the ability will be added in a future
4759           release of <prgn>dpkg</prgn> to specify a version number for
4760           each virtual package it provides.  This feature is not yet
4761           present, however, and is expected to be used only
4762           infrequently.
4763         </p>
4764
4765         <p>
4766           If you want to specify which of a set of real packages
4767           should be the default to satisfy a particular dependency on
4768           a virtual package, you should list the real package as an
4769           alternative before the virtual one.
4770         </p>
4771       </sect>
4772
4773
4774       <sect id="replaces"><heading>Overwriting files and replacing
4775           packages - <tt>Replaces</tt></heading>
4776
4777         <p>
4778           Packages can declare in their control file that they should
4779           overwrite files in certain other packages, or completely
4780           replace other packages. The <tt>Replaces</tt> control file
4781           field has these two distinct purposes.
4782         </p>
4783
4784         <sect1><heading>Overwriting files in other packages</heading>
4785
4786           <p>
4787             Firstly, as mentioned before, it is usually an error for a
4788             package to contain files which are on the system in
4789             another package.
4790           </p>
4791
4792           <p>
4793             However, if the overwriting package declares that it
4794             <tt>Replaces</tt> the one containing the file being
4795             overwritten, then <prgn>dpkg</prgn> will replace the file
4796             from the old package with that from the new.  The file
4797             will no longer be listed as "owned" by the old package.
4798           </p>
4799
4800           <p>
4801             For example, if a package <package>foo</package> is split
4802             into <package>foo</package> and <package>foo-data</package>
4803             starting at version 1.2-3, <package>foo-data</package> should
4804             have the field
4805             <example compact="compact">
4806 Replaces: foo (&lt;&lt; 1.2-3)
4807             </example>
4808             in its control file.  The package <package>foo</package>
4809             doesn't need any special control fields in this example,
4810             although would generally depend on or
4811             recommend <package>foo-data</package>.
4812           </p>
4813
4814           <p>
4815             If a package is completely replaced in this way, so that
4816             <prgn>dpkg</prgn> does not know of any files it still
4817             contains, it is considered to have "disappeared".  It will
4818             be marked as not wanted on the system (selected for
4819             removal) and not installed.  Any <tt>conffile</tt>s
4820             details noted for the package will be ignored, as they
4821             will have been taken over by the overwriting package.  The
4822             package's <prgn>postrm</prgn> script will be run with a
4823             special argument to allow the package to do any final
4824             cleanup required.  See <ref id="mscriptsinstact">.
4825             <footnote>
4826               <p>
4827                 Replaces is a one way relationship -- you have to              
4828                 install the replacing package after the replaced
4829                 package.
4830               </p>
4831             </footnote>
4832           </p>
4833
4834           <p>
4835             For this usage of <tt>Replaces</tt>, virtual packages (see
4836             <ref id="virtual">) are not considered when looking at a
4837             <tt>Replaces</tt> field - the packages declared as being
4838             replaced must be mentioned by their real names.
4839           </p>
4840
4841           <p>
4842             Furthermore, this usage of <tt>Replaces</tt> only takes
4843             effect when both packages are at least partially on the
4844             system at once, so that it can only happen if they do not
4845             conflict or if the conflict has been overridden.
4846           </p>
4847
4848         </sect1>
4849
4850         <sect1><heading>Replacing whole packages, forcing their
4851             removal</heading>
4852
4853           <p>
4854             Secondly, <tt>Replaces</tt> allows the packaging system to
4855             resolve which package should be removed when there is a
4856             conflict - see <ref id="conflicts">.  This usage only
4857             takes effect when the two packages <em>do</em> conflict,
4858             so that the two usages of this field do not interfere with
4859             each other.
4860           </p>
4861
4862           <p>
4863             In this situation, the package declared as being replaced
4864             can be a virtual package, so for example, all mail
4865             transport agents (MTAs) would have the following fields in
4866             their control files:
4867             <example compact="compact">
4868 Provides: mail-transport-agent
4869 Conflicts: mail-transport-agent
4870 Replaces: mail-transport-agent
4871             </example>
4872             ensuring that only one MTA can be installed at any one
4873             time.
4874         </sect1>
4875       </sect>
4876
4877       <sect id="sourcebinarydeps">
4878         <heading>Relationships between source and binary packages -
4879           <tt>Build-Depends</tt>, <tt>Build-Depends-Indep</tt>,
4880           <tt>Build-Conflicts</tt>, <tt>Build-Conflicts-Indep</tt>
4881         </heading>
4882
4883         <p>
4884           Source packages that require certain binary packages to be
4885           installed or absent at the time of building the package
4886           can declare relationships to those binary packages.
4887         </p>
4888
4889         <p>
4890           This is done using the <tt>Build-Depends</tt>,
4891           <tt>Build-Depends-Indep</tt>, <tt>Build-Conflicts</tt> and
4892           <tt>Build-Conflicts-Indep</tt> control file fields.
4893         </p>
4894
4895         <p>
4896           Build-dependencies on "build-essential" binary packages can be
4897           omitted. Please see <ref id="pkg-relations"> for more information.
4898         </p>
4899
4900         <p>
4901           The dependencies and conflicts they define must be satisfied
4902           (as defined earlier for binary packages) in order to invoke
4903           the targets in <tt>debian/rules</tt>, as follows:<footnote>
4904             <p>
4905               There is no Build-Depends-Arch; this role is essentially
4906               met with Build-Depends.  Anyone building the
4907               <tt>build-indep</tt> and binary-indep<tt></tt> targets is
4908               assumed to be building the whole package, and therefore
4909               installation of all build dependencies is required.
4910             </p>
4911             <p>
4912               The autobuilders use <tt>dpkg-buildpackage -B</tt>, which
4913               calls <tt>build</tt>, not <tt>build-arch</tt> since it does
4914               not yet know how to check for its existence, and
4915               <tt>binary-arch</tt>.  The purpose of the original split
4916               between <tt>Build-Depends</tt> and
4917               <tt>Build-Depends-Indep</tt> was so that the autobuilders
4918               wouldn't need to install extra packages needed only for the
4919               binary-indep targets.  But without a build-arch/build-indep
4920               split, this didn't work, since most of the work is done in
4921               the build target, not in the binary target.
4922             </p>
4923           </footnote>
4924           <taglist>
4925             <tag><tt>clean</tt>, <tt>build-arch</tt>, and
4926               <tt>binary-arch</tt></tag>
4927             <item>
4928               Only the <tt>Build-Depends</tt> and <tt>Build-Conflicts</tt>
4929               fields must be satisfied when these targets are invoked.
4930             </item>
4931             <tag><tt>build</tt>, <tt>build-indep</tt>, <tt>binary</tt>,
4932               and <tt>binary-indep</tt></tag>
4933             <item>
4934               The <tt>Build-Depends</tt>, <tt>Build-Conflicts</tt>,
4935               <tt>Build-Depends-Indep</tt>, and
4936               <tt>Build-Conflicts-Indep</tt> fields must be satisfied when
4937               these targets are invoked.
4938             </item>
4939           </taglist>
4940         </p>
4941       </sect>
4942     </chapt>
4943
4944
4945     <chapt id="sharedlibs"><heading>Shared libraries</heading>
4946
4947       <p>
4948         Packages containing shared libraries must be constructed with
4949         a little care to make sure that the shared library is always
4950         available.  This is especially important for packages whose
4951         shared libraries are vitally important, such as the C library
4952         (currently <tt>libc6</tt>).
4953       </p>
4954
4955       <p>
4956         Packages involving shared libraries should be split up into
4957         several binary packages. This section mostly deals with how
4958         this separation is to be accomplished; rules for files within
4959         the shared library packages are in <ref id="libraries"> instead.
4960       </p>
4961
4962       <sect id="sharedlibs-runtime">
4963         <heading>Run-time shared libraries</heading>
4964
4965       <p>
4966         The run-time shared library needs to be placed in a package
4967         whose name changes whenever the shared object version
4968         changes.<footnote>
4969             <p>
4970               Since it is common place to install several versions of a
4971               package that just provides shared libraries, it is a
4972               good idea that the library package should not
4973               contain any extraneous non-versioned files, unless they
4974               happen to be in versioned directories.</p>
4975           </footnote>
4976           The most common mechanism is to place it in a package
4977         called
4978         <package><var>libraryname</var><var>soversion</var></package>,
4979         where <file><var>soversion</var></file> is the version number
4980         in the soname of the shared library<footnote>
4981               The soname is the shared object name: it's the thing
4982               that has to match exactly between building an executable
4983               and running it for the dynamic linker to be able run the
4984               program.  For example, if the soname of the library is
4985               <file>libfoo.so.6</file>, the library package would be
4986               called <file>libfoo6</file>.
4987           </footnote>.
4988         Alternatively, if it would be confusing to directly append
4989         <var>soversion</var> to <var>libraryname</var> (e.g. because
4990         <var>libraryname</var> itself ends in a number), you may use
4991         <package><var>libraryname</var>-<var>soversion</var></package> and
4992         <package><var>libraryname</var>-<var>soversion</var>-dev</package>
4993         instead.
4994       </p>
4995
4996       <p>
4997         If you have several shared libraries built from the same
4998         source tree you may lump them all together into a single
4999         shared library package, provided that you change all of
5000         their sonames at once (so that you don't get filename
5001         clashes if you try to install different versions of the
5002         combined shared libraries package).
5003       </p>
5004
5005       <p>
5006         The package should install the shared libraries under
5007         their normal names.  For example, the <package>libgdbm3</package>
5008         package should install <file>libgdbm.so.3.0.0</file> as
5009         <file>/usr/lib/libgdbm.so.3.0.0</file>.  The files should not be
5010         renamed or re-linked by any <prgn>prerm</prgn> or
5011         <prgn>postrm</prgn> scripts; <prgn>dpkg</prgn> will take care
5012         of renaming things safely without affecting running programs,
5013         and attempts to interfere with this are likely to lead to
5014         problems.
5015       </p>
5016
5017       <p>
5018         Shared libraries should not be installed executable, since
5019         the dynamic linker does not require this and trying to
5020         execute a shared library usually results in a core dump.
5021       </p>
5022
5023       <p>
5024         The run-time library package should include the symbolic link that
5025         <prgn>ldconfig</prgn> would create for the shared libraries.
5026         For example, the <package>libgdbm3</package> package should include
5027         a symbolic link from <file>/usr/lib/libgdbm.so.3</file> to
5028         <file>libgdbm.so.3.0.0</file>.  This is needed so that the dynamic
5029         linker (for example <prgn>ld.so</prgn> or
5030         <prgn>ld-linux.so.*</prgn>) can find the library between the
5031         time that <prgn>dpkg</prgn> installs it and the time that
5032         <prgn>ldconfig</prgn> is run in the <prgn>postinst</prgn>
5033         script.<footnote>
5034             The package management system requires the library to be
5035             placed before the symbolic link pointing to it in the
5036             <file>.deb</file> file.  This is so that when
5037             <prgn>dpkg</prgn> comes to install the symlink
5038             (overwriting the previous symlink pointing at an older
5039             version of the library), the new shared library is already
5040             in place.  In the past, this was achieved by creating the
5041             library in the temporary packaging directory before
5042             creating the symlink.  Unfortunately, this was not always
5043             effective, since the building of the tar file in the
5044             <file>.deb</file> depended on the behavior of the underlying
5045             file system.  Some file systems (such as reiserfs) reorder
5046             the files so that the order of creation is forgotten.
5047             Since version 1.7.0, <prgn>dpkg</prgn>
5048             reorders the files itself as necessary when building a
5049             package.  Thus it is no longer important to concern
5050             oneself with the order of file creation.
5051         </footnote>
5052       </p>
5053
5054         <sect1 id="ldconfig">
5055           <heading><tt>ldconfig</tt></heading>
5056
5057         <p>
5058           Any package installing shared libraries in one of the default
5059           library directories of the dynamic linker (which are currently
5060           <file>/usr/lib</file> and <file>/lib</file>) or a directory that is
5061           listed in <file>/etc/ld.so.conf</file><footnote>
5062             These are currently
5063             <list compact="compact">
5064               <item>/usr/local/lib</item>
5065               <item>/usr/lib/libc5-compat</item>
5066               <item>/lib/libc5-compat</item>
5067             </list>
5068           </footnote>
5069           must use <prgn>ldconfig</prgn> to update the shared library
5070           system.
5071         </p>
5072
5073         <p>
5074             The package maintainer scripts must only call
5075             <prgn>ldconfig</prgn> under these circumstances:
5076             <list compact="compact">
5077               <item>When the <prgn>postinst</prgn> script is run with a
5078                   first argument of <tt>configure</tt>, the script must call
5079                   <prgn>ldconfig</prgn>, and may optionally invoke
5080                   <prgn>ldconfig</prgn> at other times.
5081               </item>
5082               <item>When the <prgn>postrm</prgn> script is run with a
5083                   first argument of <tt>remove</tt>, the script should call
5084                   <prgn>ldconfig</prgn>.
5085               </item>
5086             </list>
5087          <footnote>
5088             <p>
5089               During install or upgrade, the preinst is called before
5090               the new files are installed, so calling "ldconfig" is
5091               pointless.  The preinst of an existing package can also be
5092               called if an upgrade fails.  However, this happens during
5093               the critical time when a shared libs may exist on-disk
5094               under a temporary name.  Thus, it is dangerous and
5095               forbidden by current policy to call "ldconfig" at this
5096               time.
5097             </p>
5098
5099             <p>
5100               When a package is installed or upgraded, "postinst
5101               configure" runs after the new files are safely on-disk.
5102               Since it is perfectly safe to invoke ldconfig
5103               unconditionally in a postinst, it is OK for a package to
5104               simply put ldconfig in its postinst without checking the
5105               argument.  The postinst can also be called to recover from
5106               a failed upgrade.  This happens before any new files are
5107               unpacked, so there is no reason to call "ldconfig" at this
5108               point.
5109             </p>
5110
5111             <p>
5112               For a package that is being removed, prerm is
5113               called with all the files intact, so calling ldconfig is
5114               useless.  The other calls to "prerm" happen in the case of
5115               upgrade at a time when all the files of the old package
5116               are on-disk, so again calling "ldconfig" is pointless.
5117             </p>
5118
5119             <p>
5120               postrm, on the other hand, is called with the "remove"
5121               argument just after the files are removed, so this is
5122               the proper time to call "ldconfig" to notify the system
5123               of the fact that the shared libraries from the package
5124               are removed.  The postrm can be called at several other
5125               times.  At the time of "postrm purge", "postrm
5126               abort-install", or "postrm abort-upgrade", calling
5127               "ldconfig" is useless because the shared lib files are
5128               not on-disk.  However, when "postrm" is invoked with
5129               arguments "upgrade", "failed-upgrade", or "disappear", a
5130               shared lib may exist on-disk under a temporary filename.
5131             </p>
5132           </footnote>
5133         </p>
5134         </sect1>
5135
5136       </sect>
5137
5138       <sect id="sharedlibs-support-files">
5139         <heading>Shared library support files</heading>
5140
5141         <p>
5142           If your package contains files whose names do not change with
5143           each change in the library shared object version, you must not
5144           put them in the shared library package.  Otherwise, several
5145           versions of the shared library cannot be installed at the same
5146           time without filename clashes, making upgrades and transitions
5147           unnecessarily difficult.
5148         </p>
5149
5150         <p>
5151           It is recommended that supporting files and run-time support
5152           programs that do not need to be invoked manually by users, but
5153           are nevertheless required for the package to function, be placed
5154           (if they are binary) in a subdirectory of <file>/usr/lib</file>,
5155           preferably under <file>/usr/lib/</file><var>package-name</var>.
5156           If the program or file is architecture independent, the
5157           recommendation is for it to be placed in a subdirectory of
5158           <file>/usr/share</file> instead, preferably under
5159           <file>/usr/share/</file><var>package-name</var>.  Following the
5160           <var>package-name</var> naming convention ensures that the file
5161           names change when the shared object version changes.
5162         </p>
5163
5164         <p>
5165           Run-time support programs that use the shared library but are
5166           not required for the library to function or files used by the
5167           shared library that can be used by any version of the shared
5168           library package should instead be put in a separate package.
5169           This package might typically be named
5170           <package><var>libraryname</var>-tools</package>; note the
5171           absence of the <var>soversion</var> in the package name.
5172         </p>
5173
5174         <p>
5175           Files and support programs only useful when compiling software
5176           against the library should be included in the development
5177           package for the library.<footnote>
5178             For example, a <file><var>package-name</var>-config</file>
5179             script or <package>pkg-config</package> configuration files.
5180           </footnote>
5181         </p>
5182       </sect>
5183
5184       <sect id="sharedlibs-static">
5185         <heading>Static libraries</heading>
5186
5187       <p>
5188         The static library (<file><var>libraryname.a</var></file>)
5189         is usually provided in addition to the shared version.
5190         It is placed into the development package (see below).
5191       </p>
5192
5193       <p>
5194         In some cases, it is acceptable for a library to be
5195         available in static form only; these cases include:
5196         <list>
5197           <item>libraries for languages whose shared library support
5198                 is immature or unstable</item>
5199           <item>libraries whose interfaces are in flux or under
5200                 development (commonly the case when the library's
5201                 major version number is zero, or where the ABI breaks
5202                 across patchlevels)</item>
5203           <item>libraries which are explicitly intended to be
5204                 available only in static form by their upstream
5205                 author(s)</item>
5206         </list>
5207       </p>
5208
5209       <sect id="sharedlibs-dev">
5210         <heading>Development files</heading>
5211
5212       <p>
5213         The development files associated to a shared library need to be
5214         placed in a package called
5215         <package><var>libraryname</var><var>soversion</var>-dev</package>,
5216         or if you prefer only to support one development version at a
5217         time, <package><var>libraryname</var>-dev</package>.
5218       </p>
5219
5220       <p>
5221         In case several development versions of a library exist, you may
5222         need to use <prgn>dpkg</prgn>'s Conflicts mechanism (see
5223         <ref id="conflicts">) to ensure that the user only installs one
5224         development version at a time (as different development versions are
5225         likely to have the same header files in them, which would cause a
5226         filename clash if both were installed).
5227       </p>
5228
5229       <p>
5230         The development package should contain a symlink for the associated
5231         shared library without a version number. For example, the
5232         <package>libgdbm-dev</package> package should include a symlink
5233         from <file>/usr/lib/libgdbm.so</file> to
5234         <file>libgdbm.so.3.0.0</file>.  This symlink is needed by the linker
5235         (<prgn>ld</prgn>) when compiling packages, as it will only look for
5236         <file>libgdbm.so</file> when compiling dynamically.
5237       </p>
5238       </sect>
5239
5240       <sect id="sharedlibs-intradeps">
5241         <heading>Dependencies between the packages of the same library</heading>
5242
5243         <p>
5244           Typically the development version should have an exact
5245           version dependency on the runtime library, to make sure that
5246           compilation and linking happens correctly.  The
5247           <tt>${binary:Version}</tt> substitution variable can be
5248           useful for this purpose.
5249           <footnote>
5250             Previously, <tt>${Source-Version}</tt> was used, but its name
5251             was confusing and it has been deprecated since dpkg 1.13.19.
5252           </footnote>
5253         </p>
5254       </sect>
5255
5256       <sect id="sharedlibs-shlibdeps">
5257         <heading>Dependencies between the library and other packages -
5258         the <tt>shlibs</tt> system</heading>
5259
5260         <p>
5261           If a package contains a binary or library which links to a
5262           shared library, we must ensure that when the package is
5263           installed on the system, all of the libraries needed are
5264           also installed.  This requirement led to the creation of the
5265           <tt>shlibs</tt> system, which is very simple in its design:
5266           any package which <em>provides</em> a shared library also
5267           provides information on the package dependencies required to
5268           ensure the presence of this library, and any package which
5269           <em>uses</em> a shared library uses this information to
5270           determine the dependencies it requires.  The files which
5271           contain the mapping from shared libraries to the necessary
5272           dependency information are called <file>shlibs</file> files.
5273         </p>
5274
5275         <p>
5276           Thus, when a package is built which contains any shared
5277           libraries, it must provide a <file>shlibs</file> file for other
5278           packages to use, and when a package is built which contains
5279           any shared libraries or compiled binaries, it must run
5280           <qref id="pkg-dpkg-shlibdeps"><prgn>dpkg-shlibdeps</prgn></qref>
5281           on these to determine the libraries used and hence the
5282           dependencies needed by this package.<footnote>
5283             <p>
5284               In the past, the shared libraries linked to were
5285               determined by calling <prgn>ldd</prgn>, but now
5286               <prgn>objdump</prgn> is used to do this.  The only
5287               change this makes to package building is that
5288               <prgn>dpkg-shlibdeps</prgn> must also be run on shared
5289               libraries, whereas in the past this was unnecessary.
5290               The rest of this footnote explains the advantage that
5291               this method gives.
5292             </p>
5293
5294             <p>
5295               We say that a binary <tt>foo</tt> <em>directly</em> uses
5296               a library <tt>libbar</tt> if it is explicitly linked
5297               with that library (that is, it uses the flag
5298               <tt>-lbar</tt> during the linking stage).  Other
5299               libraries that are needed by <tt>libbar</tt> are linked
5300               <em>indirectly</em> to <tt>foo</tt>, and the dynamic
5301               linker will load them automatically when it loads
5302               <tt>libbar</tt>.  A package should depend on
5303               the libraries it directly uses, and the dependencies for
5304               those libraries should automatically pull in the other
5305               libraries.
5306             </p>
5307
5308             <p>
5309               Unfortunately, the <prgn>ldd</prgn> program shows both
5310               the directly and indirectly used libraries, meaning that
5311               the dependencies determined included both direct and
5312               indirect dependencies.  The use of <prgn>objdump</prgn>
5313               avoids this problem by determining only the directly
5314               used libraries.
5315             </p>
5316
5317             <p>
5318               A good example of where this helps is the following.  We
5319               could update <tt>libimlib</tt> with a new version that
5320               supports a new graphics format called dgf (but retaining
5321               the same major version number).  If we used the old
5322               <prgn>ldd</prgn> method, every package that uses
5323               <tt>libimlib</tt> would need to be recompiled so it
5324               would also depend on <tt>libdgf</tt> or it wouldn't run
5325               due to missing symbols.  However with the new system,
5326               packages using <tt>libimlib</tt> can rely on
5327               <tt>libimlib</tt> itself having the dependency on
5328               <tt>libdgf</tt> and so they would not need rebuilding.
5329             </p>
5330           </footnote>
5331         </p>
5332
5333         <p>
5334           In the following sections, we will first describe where the
5335           various <tt>shlibs</tt> files are to be found, then how to
5336           use <prgn>dpkg-shlibdeps</prgn>, and finally the <tt>shlibs</tt>
5337           file format and how to create them if your package contains a
5338           shared library.
5339         </p>
5340
5341       <sect1>
5342         <heading>The <tt>shlibs</tt> files present on the system</heading>
5343
5344         <p>
5345           There are several places where <tt>shlibs</tt> files are
5346           found.  The following list gives them in the order in which
5347           they are read by
5348           <qref id="pkg-dpkg-shlibdeps"><prgn>dpkg-shlibdeps</prgn></qref>.
5349           (The first one which gives the required information is used.)
5350         </p>
5351
5352         <p>
5353           <list>
5354             <item>
5355               <p><file>debian/shlibs.local</file></p>
5356
5357               <p>
5358                 This lists overrides for this package.  Its use is
5359                 described below (see <ref id="shlibslocal">).
5360               </p>
5361             </item>
5362
5363             <item>
5364               <p><file>/etc/dpkg/shlibs.override</file></p>
5365
5366               <p>
5367                 This lists global overrides.  This list is normally
5368                 empty.  It is maintained by the local system
5369                 administrator.
5370               </p>
5371             </item>
5372
5373             <item>
5374               <p><file>DEBIAN/shlibs</file> files in the "build directory"</p>
5375
5376               <p>
5377                 When packages are being built, any
5378                 <file>debian/shlibs</file> files are copied into the
5379                 control file area of the temporary build directory and
5380                 given the name <file>shlibs</file>.  These files give
5381                 details of any shared libraries included in the
5382                 package.<footnote>
5383                     An example may help here.  Let us say that the
5384                     source package <tt>foo</tt> generates two binary
5385                     packages, <tt>libfoo2</tt> and
5386                     <tt>foo-runtime</tt>.  When building the binary
5387                     packages, the two packages are created in the
5388                     directories <file>debian/libfoo2</file> and
5389                     <file>debian/foo-runtime</file> respectively.
5390                     (<file>debian/tmp</file> could be used instead of one
5391                     of these.)  Since <tt>libfoo2</tt> provides the
5392                     <tt>libfoo</tt> shared library, it will require a
5393                     <tt>shlibs</tt> file, which will be installed in
5394                     <file>debian/libfoo2/DEBIAN/shlibs</file>, eventually
5395                     to become
5396                     <file>/var/lib/dpkg/info/libfoo2.shlibs</file>.  Then
5397                     when <prgn>dpkg-shlibdeps</prgn> is run on the
5398                     executable
5399                     <file>debian/foo-runtime/usr/bin/foo-prog</file>, it
5400                     will examine the
5401                     <file>debian/libfoo2/DEBIAN/shlibs</file> file to
5402                     determine whether <tt>foo-prog</tt>'s library
5403                     dependencies are satisfied by any of the libraries
5404                     provided by <tt>libfoo2</tt>.  For this reason,
5405                     <prgn>dpkg-shlibdeps</prgn> must only be run once
5406                     all of the individual binary packages'
5407                     <tt>shlibs</tt> files have been installed into the
5408                     build directory.
5409                 </footnote>
5410               </p>
5411             </item>
5412
5413             <item>
5414               <p><file>/var/lib/dpkg/info/*.shlibs</file></p>
5415
5416               <p>
5417                 These are the <file>shlibs</file> files corresponding to
5418                 all of the packages installed on the system, and are
5419                 maintained by the relevant package maintainers.
5420               </p>
5421             </item>
5422
5423             <item>
5424               <p><file>/etc/dpkg/shlibs.default</file></p>
5425
5426               <p>
5427                 This file lists any shared libraries whose packages
5428                 have failed to provide correct <file>shlibs</file> files.
5429                 It was used when the <file>shlibs</file> setup was first
5430                 introduced, but it is now normally empty.  It is
5431                 maintained by the <tt>dpkg</tt> maintainer.
5432               </p>
5433             </item>
5434           </list>
5435         </p>
5436       </sect1>
5437
5438       <sect1>
5439         <heading>How to use <prgn>dpkg-shlibdeps</prgn> and the
5440             <file>shlibs</file> files</heading>
5441
5442         <p>
5443           Put a call to
5444           <qref id="pkg-dpkg-shlibdeps"><prgn>dpkg-shlibdeps</prgn></qref>
5445           into your <file>debian/rules</file> file.  If your package
5446           contains only compiled binaries and libraries (but no scripts),
5447           you can use a command such as:
5448           <example compact="compact">
5449 dpkg-shlibdeps debian/tmp/usr/bin/* debian/tmp/usr/sbin/* \
5450   debian/tmp/usr/lib/*
5451           </example>
5452           Otherwise, you will need to explicitly list the compiled
5453           binaries and libraries.<footnote>
5454               If you are using <tt>debhelper</tt>, the
5455               <prgn>dh_shlibdeps</prgn> program will do this work for
5456               you.  It will also correctly handle multi-binary
5457               packages.
5458           </footnote>
5459         </p>
5460
5461         <p>
5462           This command puts the dependency information into the
5463           <file>debian/substvars</file> file, which is then used by
5464           <prgn>dpkg-gencontrol</prgn>.  You will need to place a
5465           <tt>${shlibs:Depends}</tt> variable in the <tt>Depends</tt>
5466           field in the control file for this to work.
5467         </p>
5468
5469         <p>
5470           If <prgn>dpkg-shlibdeps</prgn> doesn't complain, you're
5471           done.  If it does complain you might need to create your own
5472           <file>debian/shlibs.local</file> file, as explained below (see
5473           <ref id="shlibslocal">).
5474         </p>
5475
5476         <p>
5477           If you have multiple binary packages, you will need to call
5478           <prgn>dpkg-shlibdeps</prgn> on each one which contains
5479           compiled libraries or binaries.  In such a case, you will
5480           need to use the <tt>-T</tt> option to the <tt>dpkg</tt>
5481           utilities to specify a different <file>substvars</file> file.
5482         </p>
5483
5484         <p>
5485           If you are creating a udeb for use in the Debian Installer,
5486           you will need to specify that <prgn>dpkg-shlibdeps</prgn>
5487           should use the dependency line of type <tt>udeb</tt> by
5488           adding the <tt>-tudeb</tt> option<footnote>
5489               <prgn>dh_shlibdeps</prgn> from the <tt>debhelper</tt> suite
5490               will automatically add this option if it knows it is
5491               processing a udeb.
5492           </footnote>. If there is no dependency line of type <tt>udeb</tt>
5493           in the <file>shlibs</file> file, <prgn>dpkg-shlibdeps</prgn> will
5494           fall back to the regular dependency line.
5495         </p>
5496
5497         <p>
5498           For more details on dpkg-shlibdeps, please see
5499           <ref id="pkg-dpkg-shlibdeps"> and
5500           <manref name="dpkg-shlibdeps" section="1">.
5501         </p>
5502       </sect1>
5503
5504       <sect1 id="shlibs">
5505         <heading>The <file>shlibs</file> File Format</heading>
5506
5507         <p>
5508           Each <file>shlibs</file> file has the same format.  Lines
5509           beginning with <tt>#</tt> are considered to be comments and
5510           are ignored.  Each line is of the form:
5511           <example compact="compact">
5512 [<var>type</var>: ]<var>library-name</var> <var>soname-version</var> <var>dependencies ...</var>
5513           </example>
5514         </p>
5515
5516         <p>
5517           We will explain this by reference to the example of the
5518           <tt>zlib1g</tt> package, which (at the time of writing)
5519           installs the shared library <file>/usr/lib/libz.so.1.1.3</file>.
5520         </p>
5521
5522         <p>
5523           <var>type</var> is an optional element that indicates the type
5524           of package for which the line is valid. The only type currently
5525           in use is <tt>udeb</tt>. The colon and space after the type are
5526           required.
5527         </p>
5528
5529         <p>
5530           <var>library-name</var> is the name of the shared library,
5531           in this case <tt>libz</tt>.  (This must match the name part
5532           of the soname, see below.)
5533         </p>
5534
5535         <p>
5536           <var>soname-version</var> is the version part of the soname of
5537           the library.  The soname is the thing that must exactly match
5538           for the library to be recognized by the dynamic linker, and is
5539           usually of the form
5540           <tt><var>name</var>.so.<var>major-version</var></tt>, in our
5541           example, <tt>libz.so.1</tt>.<footnote>
5542               This can be determined using the command
5543               <example compact="compact">
5544 objdump -p /usr/lib/libz.so.1.1.3 | grep SONAME
5545               </example>
5546           </footnote>
5547           The version part is the part which comes after
5548           <tt>.so.</tt>, so in our case, it is <tt>1</tt>.
5549         </p>
5550
5551         <p>
5552           <var>dependencies</var> has the same syntax as a dependency
5553           field in a binary package control file.  It should give
5554           details of which packages are required to satisfy a binary
5555           built against the version of the library contained in the
5556           package.  See <ref id="depsyntax"> for details.
5557         </p>
5558
5559         <p>
5560           In our example, if the first version of the <tt>zlib1g</tt>
5561           package which contained a minor number of at least
5562           <tt>1.3</tt> was <var>1:1.1.3-1</var>, then the
5563           <tt>shlibs</tt> entry for this library could say:
5564           <example compact="compact">
5565 libz 1 zlib1g (>= 1:1.1.3)
5566           </example>
5567           The version-specific dependency is to avoid warnings from
5568           the dynamic linker about using older shared libraries with
5569           newer binaries.
5570         </p>
5571
5572         <p>
5573           As zlib1g also provides a udeb containing the shared library,
5574           there would also be a second line:
5575           <example compact="compact">
5576 udeb: libz 1 zlib1g-udeb (>= 1:1.1.3)
5577           </example>
5578         </p>
5579       </sect1>
5580
5581       <sect1>
5582         <heading>Providing a <file>shlibs</file> file</heading>
5583
5584         <p>
5585           If your package provides a shared library, you need to create
5586           a <file>shlibs</file> file following the format described above.
5587           It is usual to call this file <file>debian/shlibs</file> (but if
5588           you have multiple binary packages, you might want to call it
5589           <file>debian/shlibs.<var>package</var></file> instead).  Then
5590           let <file>debian/rules</file> install it in the control area:
5591           <example compact="compact">
5592 install -m644 debian/shlibs debian/tmp/DEBIAN
5593           </example>
5594           or, in the case of a multi-binary package:
5595           <example compact="compact">
5596 install -m644 debian/shlibs.<var>package</var> debian/<var>package</var>/DEBIAN/shlibs
5597           </example>
5598           An alternative way of doing this is to create the
5599           <file>shlibs</file> file in the control area directly from
5600           <file>debian/rules</file> without using a <file>debian/shlibs</file>
5601           file at all,<footnote>
5602               This is what <prgn>dh_makeshlibs</prgn> in the
5603               <tt>debhelper</tt> suite does. If your package also has a udeb
5604               that provides a shared library, <prgn>dh_makeshlibs</prgn> can
5605               automatically generate the <tt>udeb:</tt> lines if you specify
5606               the name of the udeb with the <tt>--add-udeb</tt> option.
5607           </footnote>
5608           since the <file>debian/shlibs</file> file itself is ignored by
5609           <prgn>dpkg-shlibdeps</prgn>.
5610         </p>
5611
5612         <p>
5613           As <prgn>dpkg-shlibdeps</prgn> reads the
5614           <file>DEBIAN/shlibs</file> files in all of the binary packages
5615           being built from this source package, all of the
5616           <file>DEBIAN/shlibs</file> files should be installed before
5617           <prgn>dpkg-shlibdeps</prgn> is called on any of the binary
5618           packages.
5619         </p>
5620       </sect1>
5621
5622       <sect1 id="shlibslocal">
5623         <heading>Writing the <file>debian/shlibs.local</file> file</heading>
5624
5625         <p>
5626           This file is intended only as a <em>temporary</em> fix if
5627           your binaries or libraries depend on a library whose package
5628           does not yet provide a correct <file>shlibs</file> file.
5629         </p>
5630
5631         <p>
5632           We will assume that you are trying to package a binary
5633           <tt>foo</tt>.  When you try running
5634           <prgn>dpkg-shlibdeps</prgn> you get the following error
5635           message (<tt>-O</tt> displays the dependency information on
5636           <tt>stdout</tt> instead of writing it to
5637           <tt>debian/substvars</tt>, and the lines have been wrapped
5638           for ease of reading):
5639           <example compact="compact">
5640 $ dpkg-shlibdeps -O debian/tmp/usr/bin/foo
5641 dpkg-shlibdeps: warning: unable to find dependency
5642   information for shared library libbar (soname 1,
5643   path /usr/lib/libbar.so.1, dependency field Depends)
5644 shlibs:Depends=libc6 (>= 2.2.2-2)
5645           </example>
5646           You can then run <prgn>ldd</prgn> on the binary to find the
5647           full location of the library concerned:
5648           <example compact="compact">
5649 $ ldd foo
5650 libbar.so.1 => /usr/lib/libbar.so.1 (0x4001e000)
5651 libc.so.6 => /lib/libc.so.6 (0x40032000)
5652 /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0x40000000)
5653           </example>
5654           So the <prgn>foo</prgn> binary depends on the
5655           <prgn>libbar</prgn> shared library, but no package seems to
5656           provide a <file>*.shlibs</file> file handling
5657           <file>libbar.so.1</file> in <file>/var/lib/dpkg/info/</file>.  Let's
5658           determine the package responsible:
5659           <example compact="compact">
5660 $ dpkg -S /usr/lib/libbar.so.1
5661 bar1: /usr/lib/libbar.so.1
5662 $ dpkg -s bar1 | grep Version
5663 Version: 1.0-1
5664           </example>
5665           This tells us that the <tt>bar1</tt> package, version 1.0-1,
5666           is the one we are using.  Now we can file a bug against the
5667           <tt>bar1</tt> package and create our own
5668           <file>debian/shlibs.local</file> to locally fix the problem.
5669           Including the following line into your
5670           <file>debian/shlibs.local</file> file:
5671           <example compact="compact">
5672 libbar 1 bar1 (>= 1.0-1)
5673           </example>
5674           should allow the package build to work.
5675         </p>
5676
5677         <p>
5678           As soon as the maintainer of <tt>bar1</tt> provides a
5679           correct <file>shlibs</file> file, you should remove this line
5680           from your <file>debian/shlibs.local</file> file.  (You should
5681           probably also then have a versioned <tt>Build-Depends</tt>
5682           on <tt>bar1</tt> to help ensure that others do not have the
5683           same problem building your package.)
5684         </p>
5685       </sect1>
5686
5687       </sect>
5688
5689     </chapt>
5690
5691
5692     <chapt id="opersys"><heading>The Operating System</heading>
5693
5694       <sect>
5695         <heading>File system hierarchy</heading>
5696
5697
5698         <sect1 id="fhs">
5699           <heading>File System Structure</heading>
5700
5701           <p>
5702             The location of all installed files and directories must
5703             comply with the Filesystem Hierarchy Standard (FHS),
5704             version 2.3, with the exceptions noted below, and except
5705             where doing so would violate other terms of Debian
5706             Policy.  The following exceptions to the FHS apply:
5707
5708             <enumlist>
5709               <item>
5710                 <p>
5711                   The optional rules related to user specific
5712                   configuration files for applications are stored in
5713                   the user's home directory are relaxed.  It is
5714                   recommended that such files start with the
5715                   '<tt>.</tt>' character (a "dot file"), and if an
5716                   application needs to create more than one dot file
5717                   then the preferred placement is in a subdirectory
5718                   with a name starting with a '.' character, (a "dot
5719                   directory"). In this case it is recommended the
5720                   configuration files not start with the '.'
5721                   character.
5722                 </p>
5723               </item>
5724               <item>
5725                 <p>
5726                   The requirement for amd64 to use <file>/lib64</file>
5727                   for 64 bit binaries is removed.
5728                 </p>
5729               </item>
5730               <item>
5731                 <p>
5732                   The requirement for object files, internal binaries, and
5733                   libraries, including <file>libc.so.*</file>, to be located
5734                   directly under <file>/lib{,32}</file> and
5735                   <file>/usr/lib{,32}</file> is amended, permitting files
5736                   to instead be installed to
5737                   <file>/lib/<var>triplet</var></file> and
5738                   <file>/usr/lib/<var>triplet</var></file>, where
5739                   <tt><var>triplet</var></tt> is the value returned by
5740                   <tt>dpkg-architecture -qDEB_HOST_GNU_TYPE</tt> for the
5741                   architecture of the package.  Packages may <em>not</em>
5742                   install files to any <var>triplet</var> path other
5743                   than the one matching the architecture of that package;
5744                   for instance, an <tt>Architecture: amd64</tt> package
5745                   containing 32-bit x86 libraries may not install these
5746                   libraries to <file>/usr/lib/i486-linux-gnu</file>.
5747                   <footnote>
5748                     This is necessary in order to reserve the directories for
5749                     use in cross-installation of library packages from other
5750                     architectures, as part of the planned deployment of
5751                     <tt>multiarch</tt>.
5752                   </footnote>
5753                 </p>
5754                 <p>
5755                   Applications may also use a single subdirectory under
5756                   <file>/usr/lib/<var>triplet</var></file>.
5757                 </p>
5758                 <p>
5759                   The execution time linker/loader, ld*, must still be made
5760                   available in the existing location under /lib or /lib64
5761                   since this is part of the ELF ABI for the architecture.
5762                 </p>
5763               </item>
5764               <item>
5765                 <p>
5766                   The requirement that
5767                   <file>/usr/local/share/man</file> be "synonymous"
5768                   with <file>/usr/local/man</file> is relaxed to a
5769                   recommendation</p>
5770               </item>
5771               <item>
5772                 <p>
5773                   The requirement that windowmanagers with a single
5774                   configuration file call it <file>system.*wmrc</file>
5775                   is removed, as is the restriction that the window
5776                   manager subdirectory be named identically to the
5777                   window manager name itself.
5778                 </p>
5779               </item>
5780               <item>
5781                 <p>
5782                   The requirement that boot manager configuration
5783                   files live in <file>/etc</file>, or at least are
5784                   symlinked there, is relaxed to a recommendation.
5785                 </p>
5786               </item>
5787               <item>
5788                 <p>
5789                   The following directories in the root filesystem are
5790                   additionally allowed: <file>/sys</file> and
5791                   <file>/selinux</file>. <footnote>These directories
5792                   are used as mount points to mount virtual filesystems
5793                   to get access to kernel information.</footnote>
5794                 </p>
5795               </item>
5796             </enumlist>
5797
5798           </p>
5799           <p>
5800             The version of this document referred here can be
5801             found in the <tt>debian-policy</tt> package or on <url
5802             id="http://www.debian.org/doc/packaging-manuals/fhs/"
5803               name="FHS (Debian copy)"> alongside this manual (or, if
5804             you have the <package>debian-policy</package> installed,
5805             you can try <url
5806               id="file:///usr/share/doc/debian-policy/fhs/" name="FHS
5807               (local copy)">). The
5808             latest version, which may be a more recent version, may
5809             be found on
5810             <url id="http://www.pathname.com/fhs/" name="FHS (upstream)">.
5811             Specific questions about following the standard may be
5812             asked on the <tt>debian-devel</tt> mailing list, or
5813             referred to the FHS mailing list (see the
5814             <url id="http://www.pathname.com/fhs/" name="FHS web site"> for
5815             more information).
5816           </p>
5817         </sect1>
5818
5819         <sect1>
5820           <heading>Site-specific programs</heading>
5821
5822           <p>
5823             As mandated by the FHS, packages must not place any
5824             files in <file>/usr/local</file>, either by putting them in
5825             the file system archive to be unpacked by <prgn>dpkg</prgn>
5826             or by manipulating them in their maintainer scripts.
5827           </p>
5828
5829           <p>
5830             However, the package may create empty directories below
5831             <file>/usr/local</file> so that the system administrator knows
5832             where to place site-specific files.  These are not
5833             directories <em>in</em> <file>/usr/local</file>, but are
5834             children of directories in <file>/usr/local</file>.  These
5835             directories (<file>/usr/local/*/dir/</file>)
5836             should be removed on package removal if they are
5837             empty.
5838           </p>
5839
5840           <p>
5841             Note that this applies only to
5842             directories <em>below</em> <file>/usr/local</file>,
5843             not <em>in</em> <file>/usr/local</file>.  Packages must
5844             not create sub-directories in the
5845             directory <file>/usr/local</file> itself, except those
5846             listed in FHS, section 4.5.  However, you may create
5847             directories below them as you wish. You must not remove
5848             any of the directories listed in 4.5, even if you created
5849             them.
5850           </p>
5851
5852           <p>
5853             Since <file>/usr/local</file> can be mounted read-only from a
5854             remote server, these directories must be created and
5855             removed by the <prgn>postinst</prgn> and <prgn>prerm</prgn>
5856             maintainer scripts and not be included in the
5857             <file>.deb</file> archive.  These scripts must not fail if
5858             either of these operations fail.
5859           </p>
5860
5861           <p>
5862             For example, the <tt>emacsen-common</tt> package could
5863             contain something like
5864             <example compact="compact">
5865 if [ ! -e /usr/local/share/emacs ]
5866 then
5867   if mkdir /usr/local/share/emacs 2>/dev/null
5868   then
5869     chown root:staff /usr/local/share/emacs
5870     chmod 2775 /usr/local/share/emacs
5871   fi
5872 fi
5873             </example>
5874             in its <prgn>postinst</prgn> script, and
5875             <example compact="compact">
5876 rmdir /usr/local/share/emacs/site-lisp 2>/dev/null || true
5877 rmdir /usr/local/share/emacs 2>/dev/null || true
5878             </example>
5879             in the <prgn>prerm</prgn> script.  (Note that this form is
5880             used to ensure that if the script is interrupted, the
5881             directory <file>/usr/local/share/emacs</file> will still be
5882             removed.)
5883           </p>
5884
5885           <p>
5886             If you do create a directory in <file>/usr/local</file> for
5887             local additions to a package, you should ensure that
5888             settings in <file>/usr/local</file> take precedence over the
5889             equivalents in <file>/usr</file>.
5890           </p>
5891
5892           <p>
5893             However, because <file>/usr/local</file> and its contents are
5894             for exclusive use of the local administrator, a package
5895             must not rely on the presence or absence of files or
5896             directories in <file>/usr/local</file> for normal operation.
5897           </p>
5898
5899           <p>
5900             The <file>/usr/local</file> directory itself and all the
5901             subdirectories created by the package should (by default) have
5902             permissions 2775 (group-writable and set-group-id) and be
5903             owned by <tt>root:staff</tt>.
5904           </p>
5905         </sect1>
5906
5907         <sect1>
5908           <heading>The system-wide mail directory</heading>
5909           <p>
5910             The system-wide mail directory
5911             is <file>/var/mail</file>. This directory is part of the
5912             base system and should not be owned by any particular mail
5913             agents.  The use of the old
5914             location <file>/var/spool/mail</file> is deprecated, even
5915             though the spool may still be physically located there.
5916           </p>
5917         </sect1>
5918       </sect>
5919
5920       <sect>
5921         <heading>Users and groups</heading>
5922
5923         <sect1>
5924           <heading>Introduction</heading>
5925           <p>
5926             The Debian system can be configured to use either plain or
5927             shadow passwords.
5928           </p>
5929
5930           <p>
5931             Some user ids (UIDs) and group ids (GIDs) are reserved
5932             globally for use by certain packages.  Because some
5933             packages need to include files which are owned by these
5934             users or groups, or need the ids compiled into binaries,
5935             these ids must be used on any Debian system only for the
5936             purpose for which they are allocated. This is a serious
5937             restriction, and we should avoid getting in the way of
5938             local administration policies. In particular, many sites
5939             allocate users and/or local system groups starting at 100.
5940           </p>
5941
5942           <p>
5943             Apart from this we should have dynamically allocated ids,
5944             which should by default be arranged in some sensible
5945             order, but the behavior should be configurable.
5946           </p>
5947
5948           <p>
5949             Packages other than <tt>base-passwd</tt> must not modify
5950             <file>/etc/passwd</file>, <file>/etc/shadow</file>,
5951             <file>/etc/group</file> or <file>/etc/gshadow</file>.
5952           </p>
5953         </sect1>
5954
5955         <sect1>
5956           <heading>UID and GID classes</heading>
5957           <p>
5958             The UID and GID numbers are divided into classes as
5959             follows:
5960             <taglist>
5961               <tag>0-99:</tag>
5962               <item>
5963                 <p>
5964                   Globally allocated by the Debian project, the same
5965                   on every Debian system.  These ids will appear in
5966                   the <file>passwd</file> and <file>group</file> files of all
5967                   Debian systems, new ids in this range being added
5968                   automatically as the <tt>base-passwd</tt> package is
5969                   updated.
5970                 </p>
5971
5972                 <p>
5973                   Packages which need a single statically allocated
5974                   uid or gid should use one of these; their
5975                   maintainers should ask the <tt>base-passwd</tt>
5976                   maintainer for ids.
5977                 </p>
5978               </item>
5979
5980               <tag>100-999:</tag>
5981               <item>
5982                 <p>
5983                   Dynamically allocated system users and groups.
5984                   Packages which need a user or group, but can have
5985                   this user or group allocated dynamically and
5986                   differently on each system, should use <tt>adduser
5987                   --system</tt> to create the group and/or user.
5988                   <prgn>adduser</prgn> will check for the existence of
5989                   the user or group, and if necessary choose an unused
5990                   id based on the ranges specified in
5991                   <file>adduser.conf</file>.
5992                 </p>
5993               </item>
5994
5995               <tag>1000-59999:</tag>
5996               <item>
5997                 <p>
5998                   Dynamically allocated user accounts.  By default
5999                   <prgn>adduser</prgn> will choose UIDs and GIDs for
6000                   user accounts in this range, though
6001                   <file>adduser.conf</file> may be used to modify this
6002                   behavior.
6003                 </p>
6004               </item>
6005
6006               <tag>60000-64999:</tag>
6007               <item>
6008                 <p>
6009                   Globally allocated by the Debian project, but only
6010                   created on demand. The ids are allocated centrally
6011                   and statically, but the actual accounts are only
6012                   created on users' systems on demand.
6013                 </p>
6014
6015                 <p>
6016                   These ids are for packages which are obscure or
6017                   which require many statically-allocated ids.  These
6018                   packages should check for and create the accounts in
6019                   <file>/etc/passwd</file> or <file>/etc/group</file> (using
6020                   <prgn>adduser</prgn> if it has this facility) if
6021                   necessary.  Packages which are likely to require
6022                   further allocations should have a "hole" left after
6023                   them in the allocation, to give them room to
6024                   grow.
6025                 </p>
6026               </item>
6027
6028               <tag>65000-65533:</tag>
6029               <item>
6030                 <p>Reserved.</p>
6031               </item>
6032
6033               <tag>65534:</tag>
6034               <item>
6035                 <p>
6036                   User <tt>nobody</tt>. The corresponding gid refers
6037                   to the group <tt>nogroup</tt>.
6038                 </p>
6039               </item>
6040
6041               <tag>65535:</tag>
6042               <item>
6043                 <p>
6044                   <tt>(uid_t)(-1) == (gid_t)(-1)</tt> <em>must
6045                   not</em> be used, because it is the error return
6046                   sentinel value.
6047                 </p>
6048               </item>
6049             </taglist>
6050           </p>
6051         </sect1>
6052       </sect>
6053
6054       <sect id="sysvinit">
6055         <heading>System run levels and <file>init.d</file> scripts</heading>
6056
6057         <sect1 id="/etc/init.d">
6058           <heading>Introduction</heading>
6059
6060           <p>
6061             The <file>/etc/init.d</file> directory contains the scripts
6062             executed by <prgn>init</prgn> at boot time and when the
6063             init state (or "runlevel") is changed (see <manref
6064             name="init" section="8">).
6065           </p>
6066
6067           <p>
6068             There are at least two different, yet functionally
6069             equivalent, ways of handling these scripts.  For the sake
6070             of simplicity, this document describes only the symbolic
6071             link method. However, it must not be assumed by maintainer
6072             scripts that this method is being used, and any automated
6073             manipulation of the various runlevel behaviors by
6074             maintainer scripts must be performed using
6075             <prgn>update-rc.d</prgn> as described below and not by
6076             manually installing or removing symlinks.  For information
6077             on the implementation details of the other method,
6078             implemented in the <tt>file-rc</tt> package, please refer
6079             to the documentation of that package.
6080           </p>
6081
6082           <p>
6083             These scripts are referenced by symbolic links in the
6084             <file>/etc/rc<var>n</var>.d</file> directories.  When changing
6085             runlevels, <prgn>init</prgn> looks in the directory
6086             <file>/etc/rc<var>n</var>.d</file> for the scripts it should
6087             execute, where <tt><var>n</var></tt> is the runlevel that
6088             is being changed to, or <tt>S</tt> for the boot-up
6089             scripts.
6090           </p>
6091
6092           <p>
6093             The names of the links all have the form
6094             <file>S<var>mm</var><var>script</var></file> or
6095             <file>K<var>mm</var><var>script</var></file> where
6096             <var>mm</var> is a two-digit number and <var>script</var>
6097             is the name of the script (this should be the same as the
6098             name of the actual script in <file>/etc/init.d</file>).
6099           </p>
6100
6101           <p>
6102             When <prgn>init</prgn> changes runlevel first the targets
6103             of the links whose names start with a <tt>K</tt> are
6104             executed, each with the single argument <tt>stop</tt>,
6105             followed by the scripts prefixed with an <tt>S</tt>, each
6106             with the single argument <tt>start</tt>.  (The links are
6107             those in the <file>/etc/rc<var>n</var>.d</file> directory
6108             corresponding to the new runlevel.)  The <tt>K</tt> links
6109             are responsible for killing services and the <tt>S</tt>
6110             link for starting services upon entering the runlevel.
6111           </p>
6112
6113           <p>
6114             For example, if we are changing from runlevel 2 to
6115             runlevel 3, init will first execute all of the <tt>K</tt>
6116             prefixed scripts it finds in <file>/etc/rc3.d</file>, and then
6117             all of the <tt>S</tt> prefixed scripts in that directory.
6118             The links starting with <tt>K</tt> will cause the
6119             referred-to file to be executed with an argument of
6120             <tt>stop</tt>, and the <tt>S</tt> links with an argument
6121             of <tt>start</tt>.
6122           </p>
6123
6124           <p>
6125             The two-digit number <var>mm</var> is used to determine
6126             the order in which to run the scripts: low-numbered links
6127             have their scripts run first.  For example, the
6128             <tt>K20</tt> scripts will be executed before the
6129             <tt>K30</tt> scripts.  This is used when a certain service
6130             must be started before another.  For example, the name
6131             server <prgn>bind</prgn> might need to be started before
6132             the news server <prgn>inn</prgn> so that <prgn>inn</prgn>
6133             can set up its access lists.  In this case, the script
6134             that starts <prgn>bind</prgn> would have a lower number
6135             than the script that starts <prgn>inn</prgn> so that it
6136             runs first:
6137             <example compact="compact">
6138 /etc/rc2.d/S17bind
6139 /etc/rc2.d/S70inn
6140             </example>
6141           </p>
6142
6143           <p>
6144             The two runlevels 0 (halt) and 6 (reboot) are slightly
6145             different.  In these runlevels, the links with an
6146             <tt>S</tt> prefix are still called after those with a
6147             <tt>K</tt> prefix, but they too are called with the single
6148             argument <tt>stop</tt>.
6149           </p>
6150         </sect1>
6151
6152         <sect1 id="writing-init">
6153           <heading>Writing the scripts</heading>
6154
6155           <p>
6156             Packages that include daemons for system services should
6157             place scripts in <file>/etc/init.d</file> to start or stop
6158             services at boot time or during a change of runlevel.
6159             These scripts should be named
6160             <file>/etc/init.d/<var>package</var></file>, and they should
6161             accept one argument, saying what to do:
6162
6163             <taglist>
6164               <tag><tt>start</tt></tag>
6165               <item>start the service,</item>
6166
6167               <tag><tt>stop</tt></tag>
6168               <item>stop the service,</item>
6169
6170               <tag><tt>restart</tt></tag>
6171               <item>stop and restart the service if it's already running,
6172                   otherwise start the service</item>
6173
6174               <tag><tt>reload</tt></tag>
6175               <item><p>cause the configuration of the service to be
6176                   reloaded without actually stopping and restarting
6177                   the service,</item>
6178
6179               <tag><tt>force-reload</tt></tag>
6180               <item>cause the configuration to be reloaded if the
6181                   service supports this, otherwise restart the
6182                   service.</item>
6183             </taglist>
6184
6185             The <tt>start</tt>, <tt>stop</tt>, <tt>restart</tt>, and
6186             <tt>force-reload</tt> options should be supported by all
6187             scripts in <file>/etc/init.d</file>, the <tt>reload</tt>
6188             option is optional.
6189           </p>
6190
6191           <p>
6192             The <file>init.d</file> scripts must ensure that they will
6193             behave sensibly (i.e., returning success and not starting
6194             multiple copies of a service) if invoked with <tt>start</tt>
6195             when the service is already running, or with <tt>stop</tt>
6196             when it isn't, and that they don't kill unfortunately-named
6197             user processes.  The best way to achieve this is usually to
6198             use <prgn>start-stop-daemon</prgn> with the <tt>--oknodo</tt>
6199             option.
6200           </p>
6201
6202           <p>
6203             Be careful of using <tt>set -e</tt> in <file>init.d</file>
6204             scripts.  Writing correct <file>init.d</file> scripts requires
6205             accepting various error exit statuses when daemons are already
6206             running or already stopped without aborting
6207             the <file>init.d</file> script, and common <file>init.d</file>
6208             function libraries are not safe to call with <tt>set -e</tt>
6209             in effect<footnote>
6210               <tt>/lib/lsb/init-functions</tt>, which assists in writing
6211               LSB-compliant init scripts, may fail if <tt>set -e</tt> is
6212               in effect and echoing status messages to the console fails,
6213               for example.
6214             </footnote>.  For <tt>init.d</tt> scripts, it's often easier
6215             to not use <tt>set -e</tt> and instead check the result of
6216             each command separately.
6217           </p>
6218
6219           <p>
6220             If a service reloads its configuration automatically (as
6221             in the case of <prgn>cron</prgn>, for example), the
6222             <tt>reload</tt> option of the <file>init.d</file> script
6223             should behave as if the configuration has been reloaded
6224             successfully.
6225           </p>
6226
6227           <p>
6228             The <file>/etc/init.d</file> scripts must be treated as
6229             configuration files, either (if they are present in the
6230             package, that is, in the .deb file) by marking them as
6231             <tt>conffile</tt>s, or, (if they do not exist in the .deb)
6232             by managing them correctly in the maintainer scripts (see
6233             <ref id="config-files">).  This is important since we want
6234             to give the local system administrator the chance to adapt
6235             the scripts to the local system, e.g., to disable a
6236             service without de-installing the package, or to specify
6237             some special command line options when starting a service,
6238             while making sure their changes aren't lost during the next
6239             package upgrade.
6240           </p>
6241
6242           <p>
6243             These scripts should not fail obscurely when the
6244             configuration files remain but the package has been
6245             removed, as configuration files remain on the system after
6246             the package has been removed.  Only when <prgn>dpkg</prgn>
6247             is executed with the <tt>--purge</tt> option will
6248             configuration files be removed.  In particular, as the
6249             <file>/etc/init.d/<var>package</var></file> script itself is
6250             usually a <tt>conffile</tt>, it will remain on the system
6251             if the package is removed but not purged.  Therefore, you
6252             should include a <tt>test</tt> statement at the top of the
6253             script, like this:
6254             <example compact="compact">
6255 test -f <var>program-executed-later-in-script</var> || exit 0
6256             </example>
6257           </p>
6258
6259           <p>
6260             Often there are some variables in the <file>init.d</file>
6261             scripts whose values control the behavior of the scripts,
6262             and which a system administrator is likely to want to
6263             change.  As the scripts themselves are frequently
6264             <tt>conffile</tt>s, modifying them requires that the
6265             administrator merge in their changes each time the package
6266             is upgraded and the <tt>conffile</tt> changes.  To ease
6267             the burden on the system administrator, such configurable
6268             values should not be placed directly in the script.
6269             Instead, they should be placed in a file in
6270             <file>/etc/default</file>, which typically will have the same
6271             base name as the <file>init.d</file> script.  This extra file
6272             should be sourced by the script when the script runs.  It
6273             must contain only variable settings and comments in SUSv3
6274             <prgn>sh</prgn> format.  It may either be a
6275             <tt>conffile</tt> or a configuration file maintained by
6276             the package maintainer scripts.  See <ref id="config-files">
6277             for more details.
6278           </p>
6279
6280           <p>
6281             To ensure that vital configurable values are always
6282             available, the <file>init.d</file> script should set default
6283             values for each of the shell variables it uses, either
6284             before sourcing the <file>/etc/default/</file> file or
6285             afterwards using something like the <tt>:
6286             ${VAR:=default}</tt> syntax.  Also, the <file>init.d</file>
6287             script must behave sensibly and not fail if the
6288             <file>/etc/default</file> file is deleted.
6289           </p>
6290
6291           <p>
6292             <file>/var/run</file> and <file>/var/lock</file> may be mounted
6293             as temporary filesystems<footnote>
6294                 For example, using the <tt>RAMRUN</tt> and <tt>RAMLOCK</tt>
6295                 options in <file>/etc/default/rcS</file>.
6296             </footnote>, so the <file>init.d</file> scripts must handle this
6297             correctly. This will typically amount to creating any required
6298             subdirectories dynamically when the <file>init.d</file> script
6299             is run, rather than including them in the package and relying on
6300             <prgn>dpkg</prgn> to create them.
6301           </p>
6302         </sect1>
6303
6304         <sect1>
6305           <heading>Interfacing with the initscript system</heading>
6306
6307           <p>
6308             Maintainers should use the abstraction layer provided by
6309             the <prgn>update-rc.d</prgn> and <prgn>invoke-rc.d</prgn>
6310             programs to deal with initscripts in their packages'
6311             scripts such as <prgn>postinst</prgn>, <prgn>prerm</prgn>
6312             and <prgn>postrm</prgn>.
6313           </p>
6314
6315           <p>
6316             Directly managing the /etc/rc?.d links and directly
6317             invoking the <file>/etc/init.d/</file> initscripts should
6318             be done only by packages providing the initscript
6319             subsystem (such as <prgn>sysv-rc</prgn> and
6320             <prgn>file-rc</prgn>).
6321           </p>
6322
6323           <sect2>
6324             <heading>Managing the links</heading>
6325
6326             <p>
6327               The program <prgn>update-rc.d</prgn> is provided for
6328               package maintainers to arrange for the proper creation and
6329               removal of <file>/etc/rc<var>n</var>.d</file> symbolic links,
6330               or their functional equivalent if another method is being
6331               used.  This may be used by maintainers in their packages'
6332               <prgn>postinst</prgn> and <prgn>postrm</prgn> scripts.
6333             </p>
6334
6335             <p>
6336               You must not include any <file>/etc/rc<var>n</var>.d</file>
6337               symbolic links in the actual archive or manually create or
6338               remove the symbolic links in maintainer scripts; you must
6339               use the <prgn>update-rc.d</prgn> program instead.  (The
6340               former will fail if an alternative method of maintaining
6341               runlevel information is being used.)  You must not include
6342               the <file>/etc/rc<var>n</var>.d</file> directories themselves
6343               in the archive either.  (Only the <tt>sysvinit</tt>
6344               package may do so.)
6345             </p>
6346
6347             <p>
6348               By default <prgn>update-rc.d</prgn> will start services in
6349               each of the multi-user state runlevels (2, 3, 4, and 5)
6350               and stop them in the halt runlevel (0), the single-user
6351               runlevel (1) and the reboot runlevel (6).  The system
6352               administrator will have the opportunity to customize
6353               runlevels by simply adding, moving, or removing the
6354               symbolic links in <file>/etc/rc<var>n</var>.d</file> if
6355               symbolic links are being used, or by modifying
6356               <file>/etc/runlevel.conf</file> if the <tt>file-rc</tt> method
6357               is being used.
6358             </p>
6359
6360             <p>
6361               To get the default behavior for your package, put in your
6362               <prgn>postinst</prgn> script
6363               <example compact="compact">
6364                 update-rc.d <var>package</var> defaults
6365               </example>
6366               and in your <prgn>postrm</prgn>
6367               <example compact="compact">
6368                 if [ "$1" = purge ]; then
6369                 update-rc.d <var>package</var> remove
6370                 fi
6371               </example>. Note that if your package changes runlevels
6372               or priority, you may have to remove and recreate the links,
6373               since otherwise the old links may persist. Refer to the
6374               documentation of <prgn>update-rc.d</prgn>.
6375             </p>
6376
6377             <p>
6378               This will use a default sequence number of 20.  If it does
6379               not matter when or in which order the <file>init.d</file>
6380               script is run, use this default.  If it does, then you
6381               should talk to the maintainer of the <prgn>sysvinit</prgn>
6382               package or post to <tt>debian-devel</tt>, and they will
6383               help you choose a number.
6384             </p>
6385
6386             <p>
6387               For more information about using <tt>update-rc.d</tt>,
6388               please consult its man page <manref name="update-rc.d"
6389                 section="8">.
6390             </p>
6391           </sect2>
6392
6393           <sect2>
6394             <heading>Running initscripts</heading>
6395             <p>
6396               The program <prgn>invoke-rc.d</prgn> is provided to make
6397               it easier for package maintainers to properly invoke an
6398               initscript, obeying runlevel and other locally-defined
6399               constraints that might limit a package's right to start,
6400               stop and otherwise manage services. This program may be
6401               used by maintainers in their packages' scripts.
6402             </p>
6403
6404             <p>
6405               The package maintainer scripts must use
6406               <prgn>invoke-rc.d</prgn> to invoke the
6407               <file>/etc/init.d/*</file> initscripts, instead of
6408               calling them directly.
6409             </p>
6410
6411             <p>
6412               By default, <prgn>invoke-rc.d</prgn> will pass any
6413               action requests (start, stop, reload, restart...) to the
6414               <file>/etc/init.d</file> script, filtering out requests
6415               to start or restart a service out of its intended
6416               runlevels.
6417             </p>
6418
6419             <p>
6420               Most packages will simply need to change:
6421               <example compact="compact">/etc/init.d/&lt;package&gt;
6422               &lt;action&gt;</example> in their <prgn>postinst</prgn>
6423               and <prgn>prerm</prgn> scripts to:
6424               <example compact="compact">
6425         if which invoke-rc.d >/dev/null 2>&1; then
6426                 invoke-rc.d <var>package</var> &lt;action&gt;
6427         else
6428                 /etc/init.d/<var>package</var> &lt;action&gt;
6429         fi
6430               </example>
6431             </p>
6432
6433             <p>
6434               A package should register its initscript services using
6435               <prgn>update-rc.d</prgn> before it tries to invoke them
6436               using <prgn>invoke-rc.d</prgn>. Invocation of
6437               unregistered services may fail.
6438             </p>
6439
6440             <p>
6441               For more information about using
6442               <prgn>invoke-rc.d</prgn>, please consult its man page
6443               <manref name="invoke-rc.d" section="8">.
6444             </p>
6445           </sect2>
6446         </sect1>
6447
6448         <sect1>
6449           <heading>Boot-time initialization</heading>
6450
6451           <p>
6452             There used to be another directory, <file>/etc/rc.boot</file>,
6453             which contained scripts which were run once per machine
6454             boot. This has been deprecated in favour of links from
6455             <file>/etc/rcS.d</file> to files in <file>/etc/init.d</file> as
6456             described in <ref id="/etc/init.d">.  Packages must not
6457             place files in <file>/etc/rc.boot</file>.
6458           </p>
6459         </sect1>
6460
6461         <sect1>
6462           <heading>Example</heading>
6463
6464           <p>
6465             An example on which you can base your
6466             <file>/etc/init.d</file> scripts is found in
6467             <file>/etc/init.d/skeleton</file>.
6468           </p>
6469
6470         </sect1>
6471       </sect>
6472
6473       <sect>
6474         <heading>Console messages from <file>init.d</file> scripts</heading>
6475
6476         <p>
6477           This section describes the formats to be used for messages
6478           written to standard output by the <file>/etc/init.d</file>
6479           scripts.  The intent is to improve the consistency of
6480           Debian's startup and shutdown look and feel.  For this
6481           reason, please look very carefully at the details.  We want
6482           the messages to have the same format in terms of wording,
6483           spaces, punctuation and case of letters.
6484         </p>
6485
6486         <p>
6487           Here is a list of overall rules that should be used for
6488           messages generated by <file>/etc/init.d</file> scripts.  
6489         </p>
6490
6491         <p>
6492           <list>
6493             <item>
6494                 The message should fit in one line (fewer than 80
6495                 characters), start with a capital letter and end with
6496                 a period (<tt>.</tt>) and line feed (<tt>"\n"</tt>).
6497             </item>
6498
6499             <item>
6500               If the script is performing some time consuming task in
6501               the background (not merely starting or stopping a
6502               program, for instance), an ellipsis (three dots:
6503               <tt>...</tt>) should be output to the screen, with no
6504               leading or tailing whitespace or line feeds.
6505             </item>
6506
6507             <item>
6508               The messages should appear as if the computer is telling
6509               the user what it is doing (politely :-), but should not
6510                 mention "it" directly.  For example, instead of:
6511                 <example compact="compact">
6512 I'm starting network daemons: nfsd mountd.
6513                 </example>
6514                 the message should say
6515                 <example compact="compact">
6516 Starting network daemons: nfsd mountd.
6517                 </example>
6518             </item>
6519           </list>
6520         </p>
6521
6522         <p>
6523           <tt>init.d</tt> script should use the following  standard
6524           message formats for the situations enumerated below.
6525         </p>
6526
6527         <p>
6528           <list>
6529             <item>
6530               <p>When daemons are started</p>
6531
6532               <p>
6533                 If the script starts one or more daemons, the output
6534                 should look like this (a single line, no leading
6535                 spaces):
6536                 <example compact="compact">
6537 Starting <var>description</var>: <var>daemon-1</var> ... <var>daemon-n</var>.
6538                 </example>
6539                 The <var>description</var> should describe the
6540                 subsystem the daemon or set of daemons are part of,
6541                 while <var>daemon-1</var> up to <var>daemon-n</var>
6542                 denote each daemon's name (typically the file name of
6543                 the program).
6544               </p>
6545
6546               <p>
6547                 For example, the output of <file>/etc/init.d/lpd</file>
6548                 would look like:
6549                 <example compact="compact">
6550 Starting printer spooler: lpd.
6551                 </example>
6552               </p>
6553
6554               <p>
6555                 This can be achieved by saying
6556                 <example compact="compact">
6557 echo -n "Starting printer spooler: lpd"
6558 start-stop-daemon --start --quiet --exec /usr/sbin/lpd
6559 echo "."
6560                 </example>
6561                 in the script. If there are more than one daemon to
6562                 start, the output should look like this:
6563                 <example compact="compact">
6564 echo -n "Starting remote file system services:"
6565 echo -n " nfsd"; start-stop-daemon --start --quiet nfsd
6566 echo -n " mountd"; start-stop-daemon --start --quiet mountd
6567 echo -n " ugidd"; start-stop-daemon --start --quiet ugidd
6568 echo "."
6569                 </example>
6570                 This makes it possible for the user to see what is
6571                 happening and when the final daemon has been started.
6572                 Care should be taken in the placement of white spaces:
6573                 in the example above the system administrators can
6574                 easily comment out a line if they don't want to start
6575                 a specific daemon, while the displayed message still
6576                 looks good.
6577               </p>
6578             </item>
6579
6580             <item>
6581               <p>When a system parameter is being set</p>
6582
6583               <p>
6584                 If you have to set up different system parameters
6585                 during the system boot, you should use this format:
6586                 <example compact="compact">
6587 Setting <var>parameter</var> to "<var>value</var>".
6588                 </example>
6589               </p>
6590
6591               <p>
6592                 You can use a statement such as the following to get
6593                 the quotes right:
6594                 <example compact="compact">
6595 echo "Setting DNS domainname to \"$domainname\"."
6596                 </example>
6597               </p>
6598
6599               <p>
6600                 Note that the same symbol (<tt>"</tt>) <!-- " --> is used
6601                 for the left and right quotation marks.  A grave accent
6602                 (<tt>`</tt>) is not a quote character; neither is an
6603                 apostrophe (<tt>'</tt>).
6604               </p>
6605             </item>
6606
6607             <item>
6608               <p>When a daemon is stopped or restarted</p>
6609
6610               <p>
6611                 When you stop or restart a daemon, you should issue a
6612                 message identical to the startup message, except that
6613                 <tt>Starting</tt> is replaced with <tt>Stopping</tt>
6614                 or <tt>Restarting</tt> respectively.
6615               </p>
6616
6617               <p>
6618                 For example, stopping the printer daemon will look like
6619                 this:
6620                 <example compact="compact">
6621 Stopping printer spooler: lpd.
6622                 </example>
6623               </p>
6624             </item>
6625
6626             <item>
6627               <p>When something is executed</p>
6628
6629               <p>
6630                 There are several examples where you have to run a
6631                 program at system startup or shutdown to perform a
6632                 specific task, for example, setting the system's clock
6633                 using <prgn>netdate</prgn> or killing all processes
6634                 when the system shuts down.  Your message should look
6635                 like this:
6636                 <example compact="compact">
6637 Doing something very useful...done.
6638                 </example>
6639                 You should print the <tt>done.</tt> immediately after
6640                 the job has been completed, so that the user is
6641                 informed why they have to wait.  You can get this
6642                 behavior by saying
6643                 <example compact="compact">
6644 echo -n "Doing something very useful..."
6645 do_something
6646 echo "done."
6647                 </example>
6648                 in your script.
6649               </p>
6650             </item>
6651
6652             <item>
6653               <p>When the configuration is reloaded</p>
6654
6655               <p>
6656                 When a daemon is forced to reload its configuration
6657                 files you should use the following format:
6658                 <example compact="compact">
6659 Reloading <var>description</var> configuration...done.
6660                 </example>
6661                 where <var>description</var> is the same as in the
6662                 daemon starting message.
6663               </p>
6664             </item>
6665           </list>
6666         </p>
6667       </sect>
6668
6669       <sect>
6670         <heading>Cron jobs</heading>
6671
6672         <p>
6673           Packages must not modify the configuration file
6674           <file>/etc/crontab</file>, and they must not modify the files in
6675           <file>/var/spool/cron/crontabs</file>.</p>
6676
6677         <p>
6678           If a package wants to install a job that has to be executed
6679           via cron, it should place a file with the name of the
6680           package in one or more of the following directories:
6681           <example compact="compact">
6682 /etc/cron.hourly
6683 /etc/cron.daily
6684 /etc/cron.weekly
6685 /etc/cron.monthly
6686           </example>
6687           As these directory names imply, the files within them are
6688           executed on an hourly, daily, weekly, or monthly basis,
6689           respectively. The exact times are listed in
6690           <file>/etc/crontab</file>.</p>
6691
6692         <p>
6693           All files installed in any of these directories must be
6694           scripts (e.g., shell scripts or Perl scripts) so that they
6695           can easily be modified by the local system administrator.
6696           In addition, they must be treated as configuration files.
6697         </p>
6698
6699         <p>
6700           If a certain job has to be executed at some other frequency or
6701           at a specific time, the package should install a file
6702           <file>/etc/cron.d/<var>package</var></file>. This file uses the
6703           same syntax as <file>/etc/crontab</file> and is processed by
6704           <prgn>cron</prgn> automatically. The file must also be
6705           treated as a configuration file. (Note that entries in the
6706           <file>/etc/cron.d</file> directory are not handled by
6707           <prgn>anacron</prgn>. Thus, you should only use this
6708           directory for jobs which may be skipped if the system is not
6709           running.)</p>
6710         <p>
6711           Unlike <file>crontab</file> files described in the IEEE Std
6712           1003.1-2008 (POSIX.1) available from
6713           <url id="http://www.opengroup.org/onlinepubs/9699919799/"
6714                name="The Open Group">, the files in
6715           <file>/etc/cron.d</file> and the file
6716           <file>/etc/crontab</file> have seven fields; namely:
6717           <enumlist>
6718             <item>Minute [0,59]</item>
6719             <item>Hour [0,23]</item>
6720             <item>Day of the month [1,31]</item>
6721             <item>Month of the year [1,12]</item>
6722             <item>Day of the week ([0,6] with 0=Sunday)</item>
6723             <item>Username</item>
6724             <item>Command to be run</item>
6725           </enumlist>
6726           Ranges of numbers are allowed.  Ranges are two numbers
6727           separated with a hyphen.  The specified range is inclusive.
6728           Lists are allowed.  A list is a set of numbers (or ranges)
6729           separated by commas. Step values can be used in conjunction
6730           with ranges.
6731         </p>
6732
6733         <p>
6734           The scripts or <tt>crontab</tt> entries in these directories should
6735           check if all necessary programs are installed before they
6736           try to execute them. Otherwise, problems will arise when a
6737           package was removed but not purged since configuration files
6738           are kept on the system in this situation.
6739         </p>
6740
6741         <p>
6742           Any <tt>cron</tt> daemon must provide
6743           <file>/usr/bin/crontab</file> and support normal
6744           <tt>crontab</tt> entries as specified in POSIX. The daemon
6745           must also support names for days and months, ranges, and
6746           step values. It has to support <file>/etc/crontab</file>,
6747           and correctly execute the scripts in
6748           <file>/etc/cron.d</file>. The daemon must also correctly
6749           execute scripts in
6750           <file>/etc/cron.{hourly,daily,weekly,monthly}</file>.
6751         </p>
6752       </sect>
6753
6754       <sect id="menus">
6755         <heading>Menus</heading>
6756
6757         <p>
6758           The Debian <tt>menu</tt> package provides a standard
6759           interface between packages providing applications and
6760           <em>menu programs</em> (either X window managers or
6761           text-based menu programs such as <prgn>pdmenu</prgn>).
6762         </p>
6763
6764         <p>
6765           All packages that provide applications that need not be
6766           passed any special command line arguments for normal
6767           operation should register a menu entry for those
6768           applications, so that users of the <tt>menu</tt> package
6769           will automatically get menu entries in their window
6770           managers, as well in shells like <tt>pdmenu</tt>.
6771         </p>
6772
6773         <p>
6774           Menu entries should follow the current menu policy.
6775         </p>
6776
6777         <p>
6778           The menu policy can be found in the <tt>menu-policy</tt>
6779           files in the <tt>debian-policy</tt> package.
6780           It is also available from the Debian web mirrors at
6781           <tt><url name="/doc/packaging-manuals/menu-policy/"
6782                 id="http://www.debian.org/doc/packaging-manuals/menu-policy/"></tt>.
6783         </p>
6784
6785         <p>
6786           Please also refer to the <em>Debian Menu System</em>
6787           documentation that comes with the <package>menu</package>
6788           package for information about how to register your
6789           applications.
6790         </p>
6791       </sect>
6792
6793       <sect id="mime">
6794         <heading>Multimedia handlers</heading>
6795
6796         <p>
6797           MIME (Multipurpose Internet Mail Extensions, RFCs 2045-2049)
6798           is a mechanism for encoding files and data streams and
6799           providing meta-information about them, in particular their
6800           type (e.g.  audio or video) and format (e.g. PNG, HTML,
6801           MP3).
6802         </p>
6803
6804         <p>
6805           Registration of MIME type handlers allows programs like mail
6806           user agents and web browsers to invoke these handlers to
6807           view, edit or display MIME types they don't support directly.
6808         </p>
6809
6810         <p>
6811           Packages which provide the ability to view/show/play,
6812           compose, edit or print MIME types should register themselves
6813           as such following the current MIME support policy.
6814         </p>
6815
6816         <p>
6817           The MIME support policy can be found in the <tt>mime-policy</tt>
6818           files in the <tt>debian-policy</tt> package.
6819           It is also available from the Debian web mirrors at
6820           <tt><url name="/doc/packaging-manuals/mime-policy/"
6821                 id="http://www.debian.org/doc/packaging-manuals/mime-policy/"></tt>.
6822         </p>
6823
6824       </sect>
6825
6826       <sect>
6827         <heading>Keyboard configuration</heading>
6828
6829         <p>
6830           To achieve a consistent keyboard configuration so that all
6831           applications interpret a keyboard event the same way, all
6832           programs in the Debian distribution must be configured to
6833           comply with the following guidelines.
6834         </p>
6835
6836         <p>
6837           The following keys must have the specified interpretations:
6838
6839           <taglist>
6840             <tag><tt>&lt;--</tt></tag>
6841             <item>delete the character to the left of the cursor</item>
6842
6843             <tag><tt>Delete</tt></tag>
6844             <item>delete the character to the right of the cursor</item>
6845
6846             <tag><tt>Control+H</tt></tag>
6847             <item>emacs: the help prefix</item>
6848           </taglist>
6849
6850           The interpretation of any keyboard events should be
6851           independent of the terminal that is used, be it a virtual
6852           console, an X terminal emulator, an rlogin/telnet session,
6853           etc.
6854         </p>
6855
6856         <p>
6857           The following list explains how the different programs
6858           should be set up to achieve this:
6859         </p>
6860
6861         <p>
6862           <list>
6863             <item>
6864                 <tt>&lt;--</tt> generates <tt>KB_BackSpace</tt> in X.
6865             </item>
6866
6867             <item>
6868                 <tt>Delete</tt> generates <tt>KB_Delete</tt> in X.
6869             </item>
6870
6871             <item>
6872                 X translations are set up to make
6873                 <tt>KB_Backspace</tt> generate ASCII DEL, and to make
6874                 <tt>KB_Delete</tt> generate <tt>ESC [ 3 ~</tt> (this
6875                 is the vt220 escape code for the "delete character"
6876                 key).  This must be done by loading the X resources
6877                 using <prgn>xrdb</prgn> on all local X displays, not
6878                 using the application defaults, so that the
6879                 translation resources used correspond to the
6880                 <prgn>xmodmap</prgn> settings.
6881             </item>
6882
6883             <item>
6884                 The Linux console is configured to make
6885                 <tt>&lt;--</tt> generate DEL, and <tt>Delete</tt>
6886                 generate <tt>ESC [ 3 ~</tt>.
6887             </item>
6888
6889             <item>
6890                 X applications are configured so that <tt>&lt;</tt>
6891                 deletes left, and <tt>Delete</tt> deletes right.  Motif
6892                 applications already work like this.
6893             </item>
6894
6895             <item>
6896                 Terminals should have <tt>stty erase ^?</tt> .
6897             </item>
6898
6899             <item>
6900                 The <tt>xterm</tt> terminfo entry should have <tt>ESC
6901                 [ 3 ~</tt> for <tt>kdch1</tt>, just as for
6902                 <tt>TERM=linux</tt> and <tt>TERM=vt220</tt>.
6903             </item>
6904
6905             <item>
6906                 Emacs is programmed to map <tt>KB_Backspace</tt> or
6907                 the <tt>stty erase</tt> character to
6908                 <tt>delete-backward-char</tt>, and <tt>KB_Delete</tt>
6909                 or <tt>kdch1</tt> to <tt>delete-forward-char</tt>, and
6910                 <tt>^H</tt> to <tt>help</tt> as always.
6911             </item>
6912
6913             <item>
6914                 Other applications use the <tt>stty erase</tt>
6915                 character and <tt>kdch1</tt> for the two delete keys,
6916                 with ASCII DEL being "delete previous character" and
6917                 <tt>kdch1</tt> being "delete character under
6918                 cursor".
6919             </item>
6920
6921           </list>
6922         </p>
6923
6924         <p>
6925           This will solve the problem except for the following
6926           cases:
6927         </p>
6928
6929         <p>
6930           <list>
6931             <item>
6932                 Some terminals have a <tt>&lt;--</tt> key that cannot
6933                 be made to produce anything except <tt>^H</tt>.  On
6934                 these terminals Emacs help will be unavailable on
6935                 <tt>^H</tt> (assuming that the <tt>stty erase</tt>
6936                 character takes precedence in Emacs, and has been set
6937                 correctly).  <tt>M-x help</tt> or <tt>F1</tt> (if
6938                 available) can be used instead.
6939             </item>
6940
6941             <item>
6942                 Some operating systems use <tt>^H</tt> for <tt>stty
6943                 erase</tt>.  However, modern telnet versions and all
6944                 rlogin versions propagate <tt>stty</tt> settings, and
6945                 almost all UNIX versions honour <tt>stty erase</tt>.
6946                 Where the <tt>stty</tt> settings are not propagated
6947                 correctly, things can be made to work by using
6948                 <tt>stty</tt> manually.
6949             </item>
6950
6951             <item>
6952                 Some systems (including previous Debian versions) use
6953                 <prgn>xmodmap</prgn> to arrange for both
6954                 <tt>&lt;--</tt> and <tt>Delete</tt> to generate
6955                 <tt>KB_Delete</tt>.  We can change the behavior of
6956                 their X clients using the same X resources that we use
6957                 to do it for our own clients, or configure our clients
6958                 using their resources when things are the other way
6959                 around.  On displays configured like this
6960                 <tt>Delete</tt> will not work, but <tt>&lt;--</tt>
6961                 will.
6962             </item>
6963
6964             <item>
6965                 Some operating systems have different <tt>kdch1</tt>
6966                 settings in their <tt>terminfo</tt> database for
6967                 <tt>xterm</tt> and others.  On these systems the
6968                 <tt>Delete</tt> key will not work correctly when you
6969                 log in from a system conforming to our policy, but
6970                 <tt>&lt;--</tt> will.
6971             </item>
6972           </list>
6973         </p>
6974       </sect>
6975
6976       <sect>
6977         <heading>Environment variables</heading>
6978
6979         <p>
6980           A program must not depend on environment variables to get
6981           reasonable defaults.  (That's because these environment
6982           variables would have to be set in a system-wide
6983           configuration file like <file>/etc/profile</file>, which is not
6984           supported by all shells.)
6985         </p>
6986
6987         <p>
6988           If a program usually depends on environment variables for its
6989           configuration, the program should be changed to fall back to
6990           a reasonable default configuration if these environment
6991           variables are not present. If this cannot be done easily
6992           (e.g., if the source code of a non-free program is not
6993           available), the program must be replaced by a small
6994           "wrapper" shell script which sets the environment variables
6995           if they are not already defined, and calls the original program.
6996         </p>
6997
6998         <p>
6999           Here is an example of a wrapper script for this purpose:
7000
7001           <example compact="compact">
7002 #!/bin/sh
7003 BAR=${BAR:-/var/lib/fubar}
7004 export BAR
7005 exec /usr/lib/foo/foo "$@"
7006           </example>
7007         </p>
7008
7009         <p>
7010           Furthermore, as <file>/etc/profile</file> is a configuration
7011           file of the <prgn>base-files</prgn> package, other packages must
7012           not put any environment variables or other commands into that
7013           file.
7014         </p>
7015       </sect>
7016
7017       <sect id="doc-base">
7018         <heading>Registering Documents using doc-base</heading>
7019
7020         <p>
7021           The <package>doc-base</package> package implements a
7022           flexible mechanism for handling and presenting
7023           documentation. The recommended practice is for every Debian
7024           package that provides online documentation (other than just
7025           manual pages) to register these documents with
7026           <package>doc-base</package> by installing a
7027           <package>doc-base</package> control file via the
7028           <prgn/install-docs/ script at installation time and
7029           de-register the manuals again when the package is removed.
7030         </p> 
7031         <p>
7032           Please refer to the documentation that comes with the
7033           <package>doc-base</package>  package for information and
7034           details. 
7035         </p>
7036       </sect>
7037
7038     </chapt>
7039
7040
7041     <chapt id="files">
7042       <heading>Files</heading>
7043
7044       <sect>
7045         <heading>Binaries</heading>
7046
7047         <p>
7048           Two different packages must not install programs with
7049           different functionality but with the same filenames.  (The
7050           case of two programs having the same functionality but
7051           different implementations is handled via "alternatives" or
7052           the "Conflicts" mechanism.  See <ref id="maintscripts"> and
7053           <ref id="conflicts"> respectively.)  If this case happens,
7054           one of the programs must be renamed.  The maintainers should
7055           report this to the <tt>debian-devel</tt> mailing list and
7056           try to find a consensus about which program will have to be
7057           renamed.  If a consensus cannot be reached, <em>both</em>
7058           programs must be renamed.
7059         </p>
7060
7061         <p>
7062          By default, when a package is being built, any binaries
7063          created should include debugging information, as well as
7064          being compiled with optimization.  You should also turn on
7065          as many reasonable compilation warnings as possible; this
7066          makes life easier for porters, who can then look at build
7067          logs for possible problems.  For the C programming language,
7068          this means the following compilation parameters should be
7069          used:
7070           <example compact="compact">
7071 CC = gcc
7072 CFLAGS = -O2 -g -Wall # sane warning options vary between programs
7073 LDFLAGS = # none
7074 INSTALL = install -s # (or use strip on the files in debian/tmp)
7075           </example>
7076         </p>
7077
7078         <p>
7079           Note that by default all installed binaries should be stripped,
7080           either by using the <tt>-s</tt> flag to
7081           <prgn>install</prgn>, or by calling <prgn>strip</prgn> on
7082           the binaries after they have been copied into
7083           <file>debian/tmp</file> but before the tree is made into a
7084           package.
7085         </p>
7086
7087         <p>
7088           Although binaries in the build tree should be compiled with
7089           debugging information by default, it can often be difficult to
7090           debug programs if they are also subjected to compiler
7091           optimization.  For this reason, it is recommended to support the
7092           standardized environment variable <tt>DEB_BUILD_OPTIONS</tt>
7093           (see <ref id="debianrules-options">).  This variable can contain
7094           several flags to change how a package is compiled and built.
7095         </p>
7096
7097         <p>
7098           It is up to the package maintainer to decide what
7099           compilation options are best for the package.  Certain
7100           binaries (such as computationally-intensive programs) will
7101           function better with certain flags (<tt>-O3</tt>, for
7102           example); feel free to use them.  Please use good judgment
7103           here.  Don't use flags for the sake of it; only use them
7104           if there is good reason to do so.  Feel free to override
7105           the upstream author's ideas about which compilation
7106           options are best: they are often inappropriate for our
7107           environment.
7108         </p>
7109       </sect>
7110
7111
7112       <sect id="libraries">
7113         <heading>Libraries</heading>
7114
7115         <p>
7116           If the package is <strong>architecture: any</strong>, then
7117           the shared library compilation and linking flags must have
7118           <tt>-fPIC</tt>, or the package shall not build on some of
7119           the supported architectures<footnote>
7120             <p>
7121               If you are using GCC, <tt>-fPIC</tt> produces code with
7122               relocatable position independent code, which is required for
7123               most architectures to create a shared library, with i386 and
7124               perhaps some others where non position independent code is
7125               permitted in a shared library.
7126             </p>
7127             <p>
7128               Position independent code may have a performance penalty,
7129               especially on <tt>i386</tt>. However, in most cases the
7130               speed penalty must be measured against the memory wasted on
7131               the few architectures where non position independent code is
7132               even possible.
7133             </p>
7134           </footnote>. Any exception to this rule must be discussed on
7135           the mailing list <em>debian-devel@lists.debian.org</em>, and
7136           a rough consensus obtained.  The reasons for not compiling
7137           with <tt>-fPIC</tt> flag must be recorded in the file
7138           <tt>README.Debian</tt>, and care must be taken to either
7139           restrict the architecture or arrange for <tt>-fPIC</tt> to
7140           be used on architectures where it is required.<footnote>
7141             <p>
7142               Some of the reasons why this might be required is if the
7143               library contains hand crafted assembly code that is not
7144               relocatable, the speed penalty is excessive for compute
7145               intensive libs, and similar reasons.
7146             </p>
7147           </footnote>
7148         </p>
7149         <p>
7150           As to the static libraries, the common case is not to have
7151           relocatable code, since there is no benefit, unless in specific
7152           cases; therefore the static version must not be compiled
7153           with the <tt>-fPIC</tt> flag. Any exception to this rule
7154           should be discussed on the mailing list
7155           <em>debian-devel@lists.debian.org</em>,  and the reasons for
7156           compiling with the <tt>-fPIC</tt> flag must be recorded in
7157           the file <tt>README.Debian</tt>. <footnote>
7158             <p>
7159               Some of the reasons for linking static libraries with
7160               the <tt>-fPIC</tt> flag are if, for example, one needs a
7161               Perl API for a library that is under rapid development,
7162               and has an unstable API, so shared libraries are
7163               pointless at this phase of the library's development. In
7164               that case, since Perl needs a library with relocatable
7165               code, it may make sense to create a static library with
7166               relocatable code. Another reason cited is if you are
7167               distilling various libraries into a common shared
7168               library, like <tt>mklibs</tt> does in the Debian
7169               installer project.
7170             </p>
7171           </footnote>
7172         </p>
7173         <p>
7174           In other words, if both a shared and a static library is
7175           being built, each source unit (<tt>*.c</tt>, for example,
7176           for C files) will need to be compiled twice, for the normal
7177           case. 
7178         </p>
7179         <p>
7180           You must specify the gcc option <tt>-D_REENTRANT</tt>
7181           when building a library (either static or shared) to make
7182           the library compatible with LinuxThreads.
7183         </p>
7184
7185         <p>
7186           Although not enforced by the build tools, shared libraries
7187           must be linked against all libraries that they use symbols from
7188           in the same way that binaries are.  This ensures the correct
7189           functioning of the <qref id="sharedlibs-shlibdeps">shlibs</qref>
7190           system and guarantees that all libraries can be safely opened
7191           with <tt>dlopen()</tt>.  Packagers may wish to use the gcc
7192           option <tt>-Wl,-z,defs</tt> when building a shared library.
7193           Since this option enforces symbol resolution at build time,
7194           a missing library reference will be caught early as a fatal
7195           build error.
7196         </p>
7197
7198         <p>
7199           All installed shared libraries should be stripped with
7200           <example compact="compact">
7201 strip --strip-unneeded <var>your-lib</var>
7202           </example>
7203           (The option <tt>--strip-unneeded</tt> makes
7204           <prgn>strip</prgn> remove only the symbols which aren't
7205           needed for relocation processing.)  Shared libraries can
7206           function perfectly well when stripped, since the symbols for
7207           dynamic linking are in a separate part of the ELF object
7208           file.<footnote>
7209               You might also want to use the options
7210               <tt>--remove-section=.comment</tt> and
7211               <tt>--remove-section=.note</tt> on both shared libraries
7212               and executables, and <tt>--strip-debug</tt> on static
7213               libraries.
7214           </footnote>
7215         </p>
7216
7217         <p>
7218           Note that under some circumstances it may be useful to
7219           install a shared library unstripped, for example when
7220           building a separate package to support debugging.
7221         </p>
7222
7223         <p>
7224           Shared object files (often <file>.so</file> files) that are not
7225           public libraries, that is, they are not meant to be linked
7226           to by third party executables (binaries of other packages),
7227           should be installed in subdirectories of the
7228           <file>/usr/lib</file> directory.  Such files are exempt from the
7229           rules that govern ordinary shared libraries, except that
7230           they must not be installed executable and should be
7231           stripped.<footnote>
7232               A common example are the so-called "plug-ins",
7233               internal shared objects that are dynamically loaded by
7234               programs using <manref name="dlopen" section="3">.
7235           </footnote>
7236         </p>
7237
7238         <p>
7239           An ever increasing number of packages are using
7240           <prgn>libtool</prgn> to do their linking.  The latest GNU
7241           libtools (>= 1.3a) can take advantage of the metadata in the
7242           installed <prgn>libtool</prgn> archive files (<file>*.la</file>
7243           files).  The main advantage of <prgn>libtool</prgn>'s
7244           <file>.la</file> files is that it allows <prgn>libtool</prgn> to
7245           store and subsequently access metadata with respect to the
7246           libraries it builds.  <prgn>libtool</prgn> will search for
7247           those files, which contain a lot of useful information about
7248           a library (such as library dependency information for static
7249           linking).  Also, they're <em>essential</em> for programs
7250           using <tt>libltdl</tt>.<footnote>
7251               Although <prgn>libtool</prgn> is fully capable of
7252               linking against shared libraries which don't have
7253               <tt>.la</tt> files, as it is a mere shell script it can
7254               add considerably to the build time of a
7255               <prgn>libtool</prgn>-using package if that shell script
7256               has to derive all this information from first principles
7257               for each library every time it is linked.  With the
7258               advent of <prgn>libtool</prgn> version 1.4 (and to a
7259               lesser extent <prgn>libtool</prgn> version 1.3), the
7260               <file>.la</file> files also store information about
7261               inter-library dependencies which cannot necessarily be
7262               derived after the <file>.la</file> file is deleted.
7263           </footnote>
7264         </p>
7265
7266         <p>
7267           Packages that use <prgn>libtool</prgn> to create shared
7268           libraries should include the <file>.la</file> files in the
7269           <tt>-dev</tt> package, unless the package relies on
7270           <tt>libtool</tt>'s <tt>libltdl</tt> library, in which case
7271           the <tt>.la</tt> files must go in the run-time library
7272           package.
7273         </p>
7274
7275         <p>
7276           You must make sure that you use only released versions of
7277           shared libraries to build your packages; otherwise other
7278           users will not be able to run your binaries
7279           properly. Producing source packages that depend on
7280           unreleased compilers is also usually a bad
7281           idea.
7282         </p>
7283       </sect>
7284
7285
7286       <sect>
7287         <heading>Shared libraries</heading>
7288         <p>
7289           This section has moved to <ref id="sharedlibs">.
7290         </p>
7291       </sect>
7292
7293
7294       <sect id="scripts">
7295         <heading>Scripts</heading>
7296
7297         <p>
7298           All command scripts, including the package maintainer
7299           scripts inside the package and used by <prgn>dpkg</prgn>,
7300           should have a <tt>#!</tt> line naming the shell to be used
7301           to interpret them.
7302         </p>
7303
7304         <p>
7305           In the case of Perl scripts this should be
7306           <tt>#!/usr/bin/perl</tt>.
7307         </p>
7308
7309         <p>
7310           When scripts are installed into a directory in the system
7311           PATH, the script name should not include an extension such
7312           as <tt>.sh</tt> or <tt>.pl</tt> that denotes the scripting
7313           language currently used to implement it.
7314         </p>
7315         <p>
7316           Shell scripts (<prgn>sh</prgn> and <prgn>bash</prgn>) other than
7317           <file>init.d</file> scripts should almost certainly start
7318           with <tt>set -e</tt> so that errors are detected.
7319           <file>init.d</file> scripts are something of a special case, due
7320           to how frequently they need to call commands that are allowed to
7321           fail, and it may instead be easier to check the exit status of
7322           commands directly.  See <ref id="writing-init"> for more
7323           information about writing <file>init.d</file> scripts.
7324         </p>
7325         <p>
7326           Every script should use <tt>set -e</tt> or check the exit status
7327           of <em>every</em> command.
7328         </p>
7329         <p>
7330           Scripts may assume that <file>/bin/sh</file> implements the
7331           SUSv3 Shell Command Language<footnote>
7332             Single UNIX Specification, version 3, which is also IEEE
7333             1003.1-2004 (POSIX), and is available on the World Wide Web
7334             from <url id="http://www.unix.org/version3/online.html"
7335                       name="The Open Group"> after free
7336             registration.</footnote>
7337           plus the following additional features not mandated by
7338           SUSv3:<footnote>
7339             These features are in widespread use in the Linux community
7340             and are implemented in all of bash, dash, and ksh, the most
7341             common shells users may wish to use as <file>/bin/sh</file>.
7342           </footnote>
7343           <list>
7344             <item><tt>echo -n</tt>, if implemented as a shell built-in,
7345               must not generate a newline.</item>
7346             <item><tt>test</tt>, if implemented as a shell built-in, must
7347               support <tt>-a</tt> and <tt>-o</tt> as binary logical
7348               operators.</item>
7349             <item><tt>local</tt> to create a scoped variable must be
7350               supported, including listing multiple variables in a single
7351               local command and assigning a value to a variable at the
7352               same time as localizing it.  <tt>local</tt> may or
7353               may not preserve the variable value from an outer scope if
7354               no assignment is present.  Uses such as:
7355 <example compact>
7356 fname () {
7357     local a b c=delta d
7358     # ... use a, b, c, d ...
7359 }
7360 </example>
7361               must be supported and must set the value of <tt>c</tt> to
7362               <tt>delta</tt>.
7363             </item>
7364           </list>
7365           If a shell script requires non-SUSv3 features from the shell
7366           interpreter other than those listed above, the appropriate shell
7367           must be specified in the first line of the script (e.g.,
7368           <tt>#!/bin/bash</tt>) and the package must depend on the package
7369           providing the shell (unless the shell package is marked
7370           "Essential", as in the case of <prgn>bash</prgn>).
7371         </p>
7372
7373         <p>
7374           You may wish to restrict your script to SUSv3 features plus the
7375           above set when possible so that it may use <file>/bin/sh</file>
7376           as its interpreter. If your script works with <prgn>dash</prgn>
7377           (originally called <prgn>ash</prgn>), it probably complies with
7378           the above requirements, but if you are in doubt, use
7379           <file>/bin/bash</file>.
7380         </p>
7381
7382         <p>
7383           Perl scripts should check for errors when making any
7384           system calls, including <tt>open</tt>, <tt>print</tt>,
7385           <tt>close</tt>, <tt>rename</tt> and <tt>system</tt>.
7386         </p>
7387
7388         <p>
7389           <prgn>csh</prgn> and <prgn>tcsh</prgn> should be avoided as
7390           scripting languages.  See <em>Csh Programming Considered
7391           Harmful</em>, one of the <tt>comp.unix.*</tt> FAQs, which
7392           can be found at <url id="http://www.faqs.org/faqs/unix-faq/shell/csh-whynot/">.
7393           If an upstream package comes with <prgn>csh</prgn> scripts
7394           then you must make sure that they start with
7395           <tt>#!/bin/csh</tt> and make your package depend on the
7396           <prgn>c-shell</prgn> virtual package.
7397         </p>
7398
7399         <p>
7400           Any scripts which create files in world-writeable
7401           directories (e.g., in <file>/tmp</file>) must use a
7402           mechanism which will fail atomically if a file with the same
7403           name already exists.
7404         </p>
7405
7406         <p>
7407           The Debian base system provides the <prgn>tempfile</prgn>
7408           and <prgn>mktemp</prgn> utilities for use by scripts for
7409           this purpose.
7410         </p>
7411       </sect>
7412
7413
7414       <sect>
7415         <heading>Symbolic links</heading>
7416
7417         <p>
7418           In general, symbolic links within a top-level directory
7419           should be relative, and symbolic links pointing from one
7420           top-level directory into another should be absolute. (A
7421           top-level directory is a sub-directory of the root
7422           directory <file>/</file>.)
7423         </p>
7424
7425         <p>
7426           In addition, symbolic links should be specified as short as
7427           possible, i.e., link targets like <file>foo/../bar</file> are
7428           deprecated.
7429         </p>
7430
7431         <p>
7432           Note that when creating a relative link using
7433           <prgn>ln</prgn> it is not necessary for the target of the
7434           link to exist relative to the working directory you're
7435           running <prgn>ln</prgn> from, nor is it necessary to change
7436           directory to the directory where the link is to be made.
7437           Simply include the string that should appear as the target
7438           of the link (this will be a pathname relative to the
7439           directory in which the link resides) as the first argument
7440           to <prgn>ln</prgn>.
7441         </p>
7442
7443         <p>
7444           For example, in your <prgn>Makefile</prgn> or
7445           <file>debian/rules</file>, you can do things like:
7446           <example compact="compact">
7447 ln -fs gcc $(prefix)/bin/cc
7448 ln -fs gcc debian/tmp/usr/bin/cc
7449 ln -fs ../sbin/sendmail $(prefix)/bin/runq
7450 ln -fs ../sbin/sendmail debian/tmp/usr/bin/runq
7451           </example>
7452         </p>
7453
7454         <p>
7455           A symbolic link pointing to a compressed file should always
7456           have the same file extension as the referenced file. (For
7457           example, if a file <file>foo.gz</file> is referenced by a
7458           symbolic link, the filename of the link has to end with
7459           "<file>.gz</file>" too, as in <file>bar.gz</file>.)
7460         </p>
7461       </sect>
7462
7463       <sect>
7464         <heading>Device files</heading>
7465
7466         <p>
7467           Packages must not include device files or named pipes in the
7468           package file tree.
7469         </p>
7470
7471         <p>
7472           If a package needs any special device files that are not
7473           included in the base system, it must call
7474           <prgn>MAKEDEV</prgn> in the <prgn>postinst</prgn> script,
7475           after notifying the user<footnote>
7476               This notification could be done via a (low-priority)
7477               debconf message, or an echo (printf) statement.
7478           </footnote>.
7479         </p>
7480
7481         <p>
7482           Packages must not remove any device files in the
7483           <prgn>postrm</prgn> or any other script. This is left to the
7484           system administrator.
7485         </p>
7486
7487         <p>
7488           Debian uses the serial devices
7489           <file>/dev/ttyS*</file>. Programs using the old
7490           <file>/dev/cu*</file> devices should be changed to use
7491           <file>/dev/ttyS*</file>.
7492         </p>
7493
7494         <p>
7495           Named pipes needed by the package must be created in
7496           the <prgn>postinst</prgn> script<footnote>
7497             It's better to use <prgn>mkfifo</prgn> rather
7498             than <prgn>mknod</prgn> to create named pipes so that
7499             automated checks for packages incorrectly creating device
7500             files with <prgn>mknod</prgn> won't have false positives.
7501           </footnote> and removed in
7502           the <prgn>prerm</prgn> or <prgn>postrm</prgn> script as
7503           appropriate.
7504         </p>
7505       </sect>
7506
7507       <sect id="config-files">
7508         <heading>Configuration files</heading>
7509
7510         <sect1>
7511           <heading>Definitions</heading>
7512
7513           <p>
7514             <taglist>
7515               <tag>configuration file</tag>
7516               <item>
7517                   A file that affects the operation of a program, or
7518                   provides site- or host-specific information, or
7519                   otherwise customizes the behavior of a program.
7520                   Typically, configuration files are intended to be
7521                   modified by the system administrator (if needed or
7522                   desired) to conform to local policy or to provide
7523                   more useful site-specific behavior.
7524               </item>
7525
7526               <tag><tt>conffile</tt></tag>
7527               <item>
7528                   A file listed in a package's <tt>conffiles</tt>
7529                   file, and is treated specially by <prgn>dpkg</prgn>
7530                   (see <ref id="configdetails">).
7531               </item>
7532             </taglist>
7533           </p>
7534
7535           <p>
7536             The distinction between these two is important; they are
7537             not interchangeable concepts. Almost all
7538             <tt>conffile</tt>s are configuration files, but many
7539             configuration files are not <tt>conffiles</tt>.
7540           </p>
7541
7542           <p>
7543             As noted elsewhere, <file>/etc/init.d</file> scripts,
7544             <file>/etc/default</file> files, scripts installed in
7545             <file>/etc/cron.{hourly,daily,weekly,monthly}</file>, and cron
7546             configuration installed in <file>/etc/cron.d</file> must be
7547             treated as configuration files.  In general, any script that
7548             embeds configuration information is de-facto a configuration
7549             file and should be treated as such.
7550           </p>
7551         </sect1>
7552
7553         <sect1>
7554           <heading>Location</heading>
7555
7556           <p>
7557             Any configuration files created or used by your package
7558             must reside in <file>/etc</file>. If there are several,
7559             consider creating a subdirectory of <file>/etc</file>
7560             named after your package.
7561           </p>
7562
7563           <p>
7564             If your package creates or uses configuration files
7565             outside of <file>/etc</file>, and it is not feasible to modify
7566             the package to use <file>/etc</file> directly, put the files
7567             in <file>/etc</file> and create symbolic links to those files
7568             from the location that the package requires.
7569           </p>
7570         </sect1>
7571
7572         <sect1>
7573           <heading>Behavior</heading>
7574
7575           <p>
7576             Configuration file handling must conform to the following
7577             behavior:
7578             <list compact="compact">
7579               <item>
7580                   local changes must be preserved during a package
7581                   upgrade, and
7582               </item>
7583               <item>
7584                   configuration files must be preserved when the
7585                   package is removed, and only deleted when the
7586                   package is purged.
7587               </item>
7588             </list>
7589             Obsolete configuration files without local changes may be
7590             removed by the package during upgrade.
7591           </p>
7592
7593           <p>
7594             The easy way to achieve this behavior is to make the
7595             configuration file a <tt>conffile</tt>. This is
7596             appropriate only if it is possible to distribute a default
7597             version that will work for most installations, although
7598             some system administrators may choose to modify it. This
7599             implies that the default version will be part of the
7600             package distribution, and must not be modified by the
7601             maintainer scripts during installation (or at any other
7602             time).
7603           </p>
7604
7605           <p>
7606             In order to ensure that local changes are preserved
7607             correctly, no package may contain or make hard links to
7608             conffiles.<footnote>
7609                 Rationale: There are two problems with hard links.
7610                 The first is that some editors break the link while
7611                 editing one of the files, so that the two files may
7612                 unwittingly become unlinked and different.  The second
7613                 is that <prgn>dpkg</prgn> might break the hard link
7614                 while upgrading <tt>conffile</tt>s.
7615             </footnote>
7616           </p>
7617
7618           <p>
7619             The other way to do it is via the maintainer scripts.  In
7620             this case, the configuration file must not be listed as a
7621             <tt>conffile</tt> and must not be part of the package
7622             distribution. If the existence of a file is required for
7623             the package to be sensibly configured it is the
7624             responsibility of the package maintainer to provide
7625             maintainer scripts which correctly create, update and
7626             maintain the file and remove it on purge.  (See <ref
7627             id="maintainerscripts"> for more information.)  These
7628             scripts must be idempotent (i.e., must work correctly if
7629             <prgn>dpkg</prgn> needs to re-run them due to errors
7630             during installation or removal), must cope with all the
7631             variety of ways <prgn>dpkg</prgn> can call maintainer
7632             scripts, must not overwrite or otherwise mangle the user's
7633             configuration without asking, must not ask unnecessary
7634             questions (particularly during upgrades), and must
7635             otherwise be good citizens.
7636           </p>
7637
7638           <p>
7639             The scripts are not required to configure every possible
7640             option for the package, but only those necessary to get
7641             the package running on a given system. Ideally the
7642             sysadmin should not have to do any configuration other
7643             than that done (semi-)automatically by the
7644             <prgn>postinst</prgn> script.
7645           </p>
7646
7647           <p>
7648             A common practice is to create a script called
7649             <file><var>package</var>-configure</file> and have the
7650             package's <prgn>postinst</prgn> call it if and only if the
7651             configuration file does not already exist.  In certain
7652             cases it is useful for there to be an example or template
7653             file which the maintainer scripts use.  Such files should
7654             be in <file>/usr/share/<var>package</var></file> or
7655             <file>/usr/lib/<var>package</var></file> (depending on whether
7656             they are architecture-independent or not).  There should
7657             be symbolic links to them from
7658             <file>/usr/share/doc/<var>package</var>/examples</file> if
7659             they are examples, and should be perfectly ordinary
7660             <prgn>dpkg</prgn>-handled files (<em>not</em>
7661             configuration files).
7662           </p>
7663
7664           <p>
7665             These two styles of configuration file handling must
7666             not be mixed, for that way lies madness:
7667             <prgn>dpkg</prgn> will ask about overwriting the file
7668             every time the package is upgraded.
7669           </p>
7670         </sect1>
7671
7672         <sect1>
7673           <heading>Sharing configuration files</heading>
7674
7675           <p>
7676             Packages which specify the same file as a
7677             <tt>conffile</tt> must be tagged as <em>conflicting</em>
7678             with each other.  (This is an instance of the general rule
7679             about not sharing files.  Note that neither alternatives
7680             nor diversions are likely to be appropriate in this case;
7681             in particular, <prgn>dpkg</prgn> does not handle diverted
7682             <tt>conffile</tt>s well.)
7683           </p>
7684
7685           <p>
7686             The maintainer scripts must not alter a <tt>conffile</tt>
7687             of <em>any</em> package, including the one the scripts
7688             belong to.
7689           </p>
7690
7691           <p>
7692             If two or more packages use the same configuration file
7693             and it is reasonable for both to be installed at the same
7694             time, one of these packages must be defined as
7695             <em>owner</em> of the configuration file, i.e., it will be
7696             the package which handles that file as a configuration
7697             file.  Other packages that use the configuration file must
7698             depend on the owning package if they require the
7699             configuration file to operate. If the other package will
7700             use the configuration file if present, but is capable of
7701             operating without it, no dependency need be declared.
7702           </p>
7703
7704           <p>
7705             If it is desirable for two or more related packages to
7706             share a configuration file <em>and</em> for all of the
7707             related packages to be able to modify that configuration
7708             file, then the following should be done:
7709             <enumlist compact="compact">
7710               <item>
7711                   One of the related packages (the "owning" package)
7712                   will manage the configuration file with maintainer
7713                   scripts as described in the previous section.
7714               </item>
7715               <item>
7716                   The owning package should also provide a program
7717                   that the other packages may use to modify the
7718                   configuration file.
7719               </item>
7720               <item>
7721                   The related packages must use the provided program
7722                   to make any desired modifications to the
7723                   configuration file.  They should either depend on
7724                   the core package to guarantee that the configuration
7725                   modifier program is available or accept gracefully
7726                   that they cannot modify the configuration file if it
7727                   is not.  (This is in addition to the fact that the
7728                   configuration file may not even be present in the
7729                   latter scenario.)
7730               </item>
7731             </enumlist>
7732           </p>
7733
7734           <p>
7735             Sometimes it's appropriate to create a new package which
7736             provides the basic infrastructure for the other packages
7737             and which manages the shared configuration files.  (The
7738             <tt>sgml-base</tt> package is a good example.)
7739           </p>
7740         </sect1>
7741
7742         <sect1>
7743           <heading>User configuration files ("dotfiles")</heading>
7744
7745           <p>
7746             The files in <file>/etc/skel</file> will automatically be
7747             copied into new user accounts by <prgn>adduser</prgn>.
7748             No other program should reference the files in
7749             <file>/etc/skel</file>.
7750           </p>
7751
7752           <p>
7753             Therefore, if a program needs a dotfile to exist in
7754             advance in <file>$HOME</file> to work sensibly, that dotfile
7755             should be installed in <file>/etc/skel</file> and treated as a
7756             configuration file.
7757           </p>
7758
7759           <p>
7760             However, programs that require dotfiles in order to
7761             operate sensibly are a bad thing, unless they do create
7762             the dotfiles themselves automatically.
7763           </p>
7764
7765           <p>
7766             Furthermore, programs should be configured by the Debian
7767             default installation to behave as closely to the upstream
7768             default behavior as possible.
7769           </p>
7770
7771           <p>
7772             Therefore, if a program in a Debian package needs to be
7773             configured in some way in order to operate sensibly, that
7774             should be done using a site-wide configuration file placed
7775             in <file>/etc</file>.  Only if the program doesn't support a
7776             site-wide default configuration and the package maintainer
7777             doesn't have time to add it may a default per-user file be
7778             placed in <file>/etc/skel</file>.
7779           </p>
7780
7781           <p>
7782             <file>/etc/skel</file> should be as empty as we can make it.
7783             This is particularly true because there is no easy (or
7784             necessarily desirable) mechanism for ensuring that the
7785             appropriate dotfiles are copied into the accounts of
7786             existing users when a package is installed.
7787           </p>
7788         </sect1>
7789       </sect>
7790
7791       <sect>
7792         <heading>Log files</heading>
7793         <p>
7794           Log files should usually be named
7795           <file>/var/log/<var>package</var>.log</file>.  If you have many
7796           log files, or need a separate directory for permission
7797           reasons (<file>/var/log</file> is writable only by
7798           <file>root</file>), you should usually create a directory named
7799           <file>/var/log/<var>package</var></file> and place your log
7800           files there.
7801         </p>
7802
7803         <p>
7804           Log files must be rotated occasionally so that they don't
7805           grow indefinitely; the best way to do this is to drop a log
7806           rotation configuration file into the directory
7807           <file>/etc/logrotate.d</file> and use the facilities provided by
7808           logrotate.<footnote>
7809             <p>
7810               The traditional approach to log files has been to set up
7811               <em>ad hoc</em> log rotation schemes using simple shell
7812               scripts and cron.  While this approach is highly
7813               customizable, it requires quite a lot of sysadmin work.
7814               Even though the original Debian system helped a little
7815               by automatically installing a system which can be used
7816               as a template, this was deemed not enough.
7817             </p>
7818
7819             <p>
7820               The use of <prgn>logrotate</prgn>, a program developed
7821               by Red Hat, is better, as it centralizes log management.
7822               It has both a configuration file
7823               (<file>/etc/logrotate.conf</file>) and a directory where
7824               packages can drop their individual log rotation
7825               configurations (<file>/etc/logrotate.d</file>).
7826             </p>
7827           </footnote>
7828           Here is a good example for a logrotate config
7829           file (for more information see <manref name="logrotate"
7830             section="8">):
7831           <example compact="compact">
7832 /var/log/foo/*.log {
7833 rotate 12
7834 weekly
7835 compress
7836 postrotate
7837 /etc/init.d/foo force-reload
7838 endscript
7839 }
7840           </example>
7841           This rotates all files under <file>/var/log/foo</file>, saves 12
7842           compressed generations, and forces the daemon to reload its
7843           configuration information after the log rotation.
7844         </p>
7845
7846         <p>
7847           Log files should be removed when the package is
7848           purged (but not when it is only removed).  This should be
7849           done by the <prgn>postrm</prgn> script when it is called
7850           with the argument <tt>purge</tt> (see <ref
7851           id="removedetails">).
7852         </p>
7853       </sect>
7854
7855       <sect>
7856         <heading>Permissions and owners</heading>
7857
7858         <p>
7859           The rules in this section are guidelines for general use.
7860           If necessary you may deviate from the details below.
7861           However, if you do so you must make sure that what is done
7862           is secure and you should try to be as consistent as possible
7863           with the rest of the system.  You should probably also
7864           discuss it on <prgn>debian-devel</prgn> first.
7865         </p>
7866
7867         <p>
7868           Files should be owned by <tt>root:root</tt>, and made
7869           writable only by the owner and universally readable (and
7870           executable, if appropriate), that is mode 644 or 755.
7871         </p>
7872
7873         <p>
7874           Directories should be mode 755 or (for group-writability)
7875           mode 2775.  The ownership of the directory should be
7876           consistent with its mode: if a directory is mode 2775, it
7877           should be owned by the group that needs write access to
7878           it.<footnote>
7879             <p>
7880               When a package is upgraded, and the owner or permissions
7881               of a file included in the package has changed, dpkg
7882               arranges for the ownership and permissions to be
7883               correctly set upon installation. However, this does not
7884               extend to directories; the permissions and ownership of
7885               directories already on the system does not change on
7886               install or upgrade of packages.  This makes sense, since
7887               otherwise common directories like <tt>/usr</tt> would
7888               always be in flux.  To correctly change permissions of a
7889               directory the package owns, explicit action is required,
7890               usually in the <tt>postinst</tt> script. Care must be
7891               taken to handle downgrades as well, in that case.
7892             </p>
7893           </footnote>
7894         </p>
7895
7896
7897         <p>
7898           Setuid and setgid executables should be mode 4755 or 2755
7899           respectively, and owned by the appropriate user or group.
7900           They should not be made unreadable (modes like 4711 or
7901           2711 or even 4111); doing so achieves no extra security,
7902           because anyone can find the binary in the freely available
7903           Debian package; it is merely inconvenient.  For the same
7904           reason you should not restrict read or execute permissions
7905           on non-set-id executables.
7906         </p>
7907
7908         <p>
7909           Some setuid programs need to be restricted to particular
7910           sets of users, using file permissions.  In this case they
7911           should be owned by the uid to which they are set-id, and by
7912           the group which should be allowed to execute them.  They
7913           should have mode 4754; again there is no point in making
7914           them unreadable to those users who must not be allowed to
7915           execute them.
7916         </p>
7917
7918         <p>
7919           It is possible to arrange that the system administrator can
7920           reconfigure the package to correspond to their local
7921           security policy by changing the permissions on a binary:
7922           they can do this by using <prgn>dpkg-statoverride</prgn>, as
7923           described below.<footnote>
7924             Ordinary files installed by <prgn>dpkg</prgn> (as
7925             opposed to <tt>conffile</tt>s and other similar objects)
7926             normally have their permissions reset to the distributed
7927             permissions when the package is reinstalled.  However,
7928             the use of <prgn>dpkg-statoverride</prgn> overrides this
7929             default behavior.
7930           </footnote>
7931           Another method you should consider is to create a group for
7932           people allowed to use the program(s) and make any setuid
7933           executables executable only by that group.
7934         </p>
7935
7936         <p>
7937           If you need to create a new user or group for your package
7938           there are two possibilities.  Firstly, you may need to
7939           make some files in the binary package be owned by this
7940           user or group, or you may need to compile the user or
7941           group id (rather than just the name) into the binary
7942           (though this latter should be avoided if possible, as in
7943           this case you need a statically allocated id).</p>
7944
7945         <p>
7946           If you need a statically allocated id, you must ask for a
7947           user or group id from the <tt>base-passwd</tt> maintainer,
7948           and must not release the package until you have been
7949           allocated one.  Once you have been allocated one you must
7950           either make the package depend on a version of the
7951           <tt>base-passwd</tt> package with the id present in
7952           <file>/etc/passwd</file> or <file>/etc/group</file>, or arrange for
7953           your package to create the user or group itself with the
7954           correct id (using <tt>adduser</tt>) in its
7955           <prgn>preinst</prgn> or <prgn>postinst</prgn>.  (Doing it in
7956           the <prgn>postinst</prgn> is to be preferred if it is
7957           possible, otherwise a pre-dependency will be needed on the
7958           <tt>adduser</tt> package.)
7959         </p>
7960
7961         <p>
7962           On the other hand, the program might be able to determine
7963           the uid or gid from the user or group name at runtime, so
7964           that a dynamically allocated id can be used.  In this case
7965           you should choose an appropriate user or group name,
7966           discussing this on <prgn>debian-devel</prgn> and checking
7967           with the <package/base-passwd/ maintainer that it is unique and that
7968           they do not wish you to use a statically allocated id
7969           instead.  When this has been checked you must arrange for
7970           your package to create the user or group if necessary using
7971           <prgn>adduser</prgn> in the <prgn>preinst</prgn> or
7972           <prgn>postinst</prgn> script (again, the latter is to be
7973           preferred if it is possible).
7974         </p>
7975
7976         <p>
7977           Note that changing the numeric value of an id associated
7978           with a name is very difficult, and involves searching the
7979           file system for all appropriate files.  You need to think
7980           carefully whether a static or dynamic id is required, since
7981           changing your mind later will cause problems.
7982         </p>
7983
7984         <sect1><heading>The use of <prgn>dpkg-statoverride</prgn></heading>
7985           <p>
7986             This section is not intended as policy, but as a
7987             description of the use of <prgn>dpkg-statoverride</prgn>.
7988           </p>
7989
7990           <p>
7991             If a system administrator wishes to have a file (or
7992             directory or other such thing) installed with owner and
7993             permissions different from those in the distributed Debian
7994             package, they can use the <prgn>dpkg-statoverride</prgn>
7995             program to instruct <prgn>dpkg</prgn> to use the different
7996             settings every time the file is installed.  Thus the
7997             package maintainer should distribute the files with their
7998             normal permissions, and leave it for the system
7999             administrator to make any desired changes.  For example, a
8000             daemon which is normally required to be setuid root, but
8001             in certain situations could be used without being setuid,
8002             should be installed setuid in the <tt>.deb</tt>.  Then the
8003             local system administrator can change this if they wish.
8004             If there are two standard ways of doing it, the package
8005             maintainer can use <tt>debconf</tt> to find out the
8006             preference, and call <prgn>dpkg-statoverride</prgn> in the
8007             maintainer script if necessary to accommodate the system
8008             administrator's choice. Care must be taken during
8009             upgrades to not override an existing setting.
8010           </p>
8011
8012           <p>
8013             Given the above, <prgn>dpkg-statoverride</prgn> is
8014             essentially a tool for system administrators and would not
8015             normally be needed in the maintainer scripts.  There is
8016             one type of situation, though, where calls to
8017             <prgn>dpkg-statoverride</prgn> would be needed in the
8018             maintainer scripts, and that involves packages which use
8019             dynamically allocated user or group ids.  In such a
8020             situation, something like the following idiom can be very
8021             helpful in the package's <prgn>postinst</prgn>, where
8022             <tt>sysuser</tt> is a dynamically allocated id:
8023             <example>
8024 for i in /usr/bin/foo /usr/sbin/bar
8025 do
8026   # only do something when no setting exists
8027   if ! dpkg-statoverride --list $i >/dev/null 2>&1
8028   then
8029     #include: debconf processing, question about foo and bar
8030     if [ "$RET" = "true" ] ; then
8031       dpkg-statoverride --update --add sysuser root 4755 $i
8032     fi
8033   fi
8034 done
8035             </example>
8036             The corresponding code to remove the override when the package
8037             is purged would be:
8038             <example>
8039 for i in /usr/bin/foo /usr/sbin/bar
8040 do
8041   if dpkg-statoverride --list $i >/dev/null 2>&1
8042   then
8043     dpkg-statoverride --remove $i
8044   fi
8045 done
8046             </example>
8047           </p>
8048         </sect1>
8049       </sect>
8050     </chapt>
8051
8052
8053     <chapt id="customized-programs">
8054       <heading>Customized programs</heading>
8055
8056       <sect id="arch-spec">
8057         <heading>Architecture specification strings</heading>
8058
8059         <p>
8060           If a program needs to specify an <em>architecture specification
8061           string</em> in some place, it should select one of the strings
8062           provided by <tt>dpkg-architecture -L</tt>. The strings are in
8063           the format <tt><var>os</var>-<var>arch</var></tt>, though the OS
8064           part is sometimes elided, as when the OS is Linux.
8065         </p>
8066
8067         <p>
8068           Note that we don't want to use
8069           <tt><var>arch</var>-debian-linux</tt> to apply to the rule
8070           <tt><var>architecture</var>-<var>vendor</var>-<var>os</var></tt>
8071           since this would make our programs incompatible with other
8072           Linux distributions.  We also don't use something like
8073           <tt><var>arch</var>-unknown-linux</tt>, since the
8074           <tt>unknown</tt> does not look very good.
8075         </p>
8076
8077         <sect1 id="arch-wildcard-spec">
8078           <heading>Architecture wildcards</heading>
8079
8080           <p>
8081             A package may specify an architecture wildcard. Architecture
8082             wildcards are in the format <tt>any</tt> (which matches every
8083             architecture), <tt><var>os</var></tt>-any, or
8084             any-<tt><var>cpu</var></tt>. <footnote>
8085               Internally, the package system normalizes the GNU triplets
8086               and the Debian arches into Debian arch triplets (which are
8087               kind of inverted GNU triplets), with the first component of
8088               the triplet representing the libc and ABI in use, and then
8089               does matching against those triplets.  However, such
8090               triplets are an internal implementation detail that should
8091               not be used by packages directly.  The libc and ABI portion
8092               is handled internally by the package system based on
8093               the <var>os</var> and <var>cpu</var>.
8094             </footnote>
8095           </p>
8096         </sect1>
8097       </sect>
8098
8099       <sect>
8100         <heading>Daemons</heading>
8101
8102         <p>
8103           The configuration files <file>/etc/services</file>,
8104           <file>/etc/protocols</file>, and <file>/etc/rpc</file> are managed
8105           by the <prgn>netbase</prgn> package and must not be modified
8106           by other packages.
8107         </p>
8108
8109         <p>
8110           If a package requires a new entry in one of these files, the
8111           maintainer should get in contact with the
8112           <prgn>netbase</prgn> maintainer, who will add the entries
8113           and release a new version of the <prgn>netbase</prgn>
8114           package.
8115         </p>
8116
8117         <p>
8118           The configuration file <file>/etc/inetd.conf</file> must not be
8119           modified by the package's scripts except via the
8120           <prgn>update-inetd</prgn> script or the
8121           <file>DebianNet.pm</file> Perl module.  See their documentation
8122           for details on how to add entries.
8123         </p>
8124
8125         <p>
8126           If a package wants to install an example entry into
8127           <file>/etc/inetd.conf</file>, the entry must be preceded with
8128           exactly one hash character (<tt>#</tt>). Such lines are
8129           treated as "commented out by user" by the
8130           <prgn>update-inetd</prgn> script and are not changed or
8131           activated during package updates.
8132         </p>
8133       </sect>
8134
8135       <sect>
8136         <heading>Using pseudo-ttys and modifying wtmp, utmp and
8137         lastlog</heading>
8138
8139         <p>
8140           Some programs need to create pseudo-ttys. This should be done
8141           using Unix98 ptys if the C library supports it. The resulting
8142           program must not be installed setuid root, unless that
8143           is required for other functionality.
8144         </p>
8145
8146         <p>
8147           The files <file>/var/run/utmp</file>, <file>/var/log/wtmp</file> and
8148           <file>/var/log/lastlog</file> must be installed writable by
8149           group <tt>utmp</tt>.  Programs which need to modify those
8150           files must be installed setgid <tt>utmp</tt>.
8151         </p>
8152       </sect>
8153
8154       <sect>
8155         <heading>Editors and pagers</heading>
8156
8157         <p>
8158           Some programs have the ability to launch an editor or pager
8159           program to edit or display a text document.  Since there are
8160           lots of different editors and pagers available in the Debian
8161           distribution, the system administrator and each user should
8162           have the possibility to choose their preferred editor and
8163           pager.
8164         </p>
8165
8166         <p>
8167           In addition, every program should choose a good default
8168           editor/pager if none is selected by the user or system
8169           administrator.
8170         </p>
8171
8172         <p>
8173           Thus, every program that launches an editor or pager must
8174           use the EDITOR or PAGER environment variable to determine
8175           the editor or pager the user wishes to use.  If these
8176           variables are not set, the programs <file>/usr/bin/editor</file>
8177           and <file>/usr/bin/pager</file> should be used, respectively.
8178         </p>
8179
8180         <p>
8181           These two files are managed through the <prgn>dpkg</prgn>
8182           "alternatives" mechanism.  Thus every package providing an
8183           editor or pager must call the
8184           <prgn>update-alternatives</prgn> script to register these
8185           programs.
8186         </p>
8187
8188         <p>
8189           If it is very hard to adapt a program to make use of the
8190           EDITOR or PAGER variables, that program may be configured to
8191           use <file>/usr/bin/sensible-editor</file> and
8192           <file>/usr/bin/sensible-pager</file> as the editor or pager
8193           program respectively.  These are two scripts provided in the
8194           <package>sensible-utils</package> package that check the EDITOR
8195           and PAGER variables and launch the appropriate program, and fall
8196           back to <file>/usr/bin/editor</file>
8197           and <file>/usr/bin/pager</file> if the variable is not set.
8198         </p>
8199
8200         <p>
8201           A program may also use the VISUAL environment variable to
8202           determine the user's choice of editor.  If it exists, it
8203           should take precedence over EDITOR.  This is in fact what
8204           <file>/usr/bin/sensible-editor</file> does.
8205         </p>
8206
8207         <p>
8208           It is not required for a package to depend on
8209           <tt>editor</tt> and <tt>pager</tt>, nor is it required for a
8210           package to provide such virtual packages.<footnote>
8211               The Debian base system already provides an editor and a
8212               pager program.
8213           </footnote>
8214         </p>
8215       </sect>
8216
8217       <sect id="web-appl">
8218         <heading>Web servers and applications</heading>
8219
8220         <p>
8221           This section describes the locations and URLs that should
8222           be used by all web servers and web applications in the
8223           Debian system.
8224         </p>
8225
8226         <p>
8227           <enumlist>
8228             <item>
8229                 Cgi-bin executable files are installed in the
8230                 directory
8231                 <example compact="compact">
8232 /usr/lib/cgi-bin/<var>cgi-bin-name</var>
8233                 </example>
8234                 and should be referred to as
8235                 <example compact="compact">
8236 http://localhost/cgi-bin/<var>cgi-bin-name</var>
8237                 </example>
8238
8239             </item>
8240
8241             <item>
8242               <p>Access to HTML documents</p>
8243
8244               <p>
8245                 HTML documents for a package are stored in
8246                 <file>/usr/share/doc/<var>package</var></file>
8247                 and can be referred to as
8248                 <example compact="compact">
8249 http://localhost/doc/<var>package</var>/<var>filename</var>
8250                 </example>
8251               </p>
8252
8253               <p>
8254                 The web server should restrict access to the document
8255                 tree so that only clients on the same host can read
8256                 the documents. If the web server does not support such
8257                 access controls, then it should not provide access at
8258                 all, or ask about providing access during installation.
8259               </p>
8260             </item>
8261
8262             <item>
8263               <p>Access to images</p>
8264               <p>
8265                 It is recommended that images for a package be stored
8266                 in <tt>/usr/share/images/<var>package</var></tt> and
8267                 may be referred to through an alias <tt>/images/</tt>
8268                 as
8269                 <example>
8270                   http://localhost/images/&lt;package&gt;/&lt;filename&gt;     
8271                 </example>
8272                 
8273               </p>
8274             </item>
8275
8276             <item>
8277               <p>Web Document Root</p>
8278
8279               <p>
8280                 Web Applications should try to avoid storing files in
8281                 the Web Document Root.  Instead they should use the
8282                 /usr/share/doc/<var>package</var> directory for
8283                 documents and register the Web Application via the
8284                 <package>doc-base</package> package.  If access to the
8285                 web document root is unavoidable then use
8286                 <example compact="compact">
8287 /var/www
8288                 </example>
8289                 as the Document Root.  This might be just a symbolic
8290                 link to the location where the system administrator
8291                 has put the real document root.
8292               </p>
8293             </item>
8294             <item><p>Providing httpd and/or httpd-cgi</p>
8295               <p>
8296                 All web servers should provide the virtual package
8297                 <tt>httpd</tt>. If a web server has CGI support it should
8298                 provide <tt>httpd-cgi</tt> additionally.
8299               </p>
8300               <p>
8301                 All web applications which do not contain CGI scripts should
8302                 depend on <tt>httpd</tt>, all those web applications which
8303                 <tt>do</tt> contain CGI scripts, should depend on
8304                 <tt>httpd-cgi</tt>.
8305               </p>
8306             </item>
8307           </enumlist>
8308         </p>
8309       </sect>
8310
8311       <sect id="mail-transport-agents">
8312         <heading>Mail transport, delivery and user agents</heading>
8313
8314         <p>
8315           Debian packages which process electronic mail, whether mail
8316           user agents (MUAs) or mail transport agents (MTAs), must
8317           ensure that they are compatible with the configuration
8318           decisions below.  Failure to do this may result in lost
8319           mail, broken <tt>From:</tt> lines, and other serious brain
8320           damage!
8321         </p>
8322
8323         <p>
8324           The mail spool is <file>/var/mail</file> and the interface to
8325           send a mail message is <file>/usr/sbin/sendmail</file> (as per
8326           the FHS).  On older systems, the mail spool may be
8327           physically located in <file>/var/spool/mail</file>, but all
8328           access to the mail spool should be via the
8329           <file>/var/mail</file> symlink.  The mail spool is part of the
8330           base system and not part of the MTA package.
8331         </p>
8332
8333         <p>
8334           All Debian MUAs, MTAs, MDAs and other mailbox accessing
8335           programs (such as IMAP daemons) must lock the mailbox in an
8336           NFS-safe way. This means that <tt>fcntl()</tt> locking must
8337           be combined with dot locking.  To avoid deadlocks, a program
8338           should use <tt>fcntl()</tt> first and dot locking after
8339           this, or alternatively implement the two locking methods in
8340           a non blocking way<footnote>
8341               If it is not possible to establish both locks, the
8342               system shouldn't wait for the second lock to be
8343               established, but remove the first lock, wait a (random)
8344               time, and start over locking again.
8345           </footnote>. Using the functions <tt>maillock</tt> and
8346           <tt>mailunlock</tt> provided by the
8347           <tt>liblockfile*</tt><footnote>
8348               You will need to depend on <tt>liblockfile1 (&gt;&gt;1.01)</tt>
8349               to use these functions.
8350           </footnote> packages is the recommended way to realize this.
8351         </p>
8352
8353         <p>
8354           Mailboxes are generally either mode 600 and owned by
8355           <var>user</var> or mode 660 and owned by
8356           <tt><var>user</var>:mail</tt><footnote>
8357             There are two traditional permission schemes for mail spools:
8358             mode 600 with all mail delivery done by processes running as
8359             the destination user, or mode 660 and owned by group mail with
8360             mail delivery done by a process running as a system user in
8361             group mail.  Historically, Debian required mode 660 mail
8362             spools to enable the latter model, but that model has become
8363             increasingly uncommon and the principle of least privilege
8364             indicates that mail systems that use the first model should
8365             use permissions of 600.  If delivery to programs is permitted,
8366             it's easier to keep the mail system secure if the delivery
8367             agent runs as the destination user.  Debian Policy therefore
8368             permits either scheme.
8369           </footnote>. The local system administrator may choose a
8370           different permission scheme; packages should not make
8371           assumptions about the permission and ownership of mailboxes
8372           unless required (such as when creating a new mailbox).  A MUA
8373           may remove a mailbox (unless it has nonstandard permissions) in
8374           which case the MTA or another MUA must recreate it if needed.
8375         </p>
8376
8377         <p>
8378           The mail spool is 2775 <tt>root:mail</tt>, and MUAs should
8379           be setgid mail to do the locking mentioned above (and
8380           must obviously avoid accessing other users' mailboxes
8381           using this privilege).</p>
8382
8383         <p>
8384           <file>/etc/aliases</file> is the source file for the system mail
8385           aliases (e.g., postmaster, usenet, etc.), it is the one
8386           which the sysadmin and <prgn>postinst</prgn> scripts may
8387           edit.  After <file>/etc/aliases</file> is edited the program or
8388           human editing it must call <prgn>newaliases</prgn>.  All MTA
8389           packages must come with a <prgn>newaliases</prgn> program,
8390           even if it does nothing, but older MTA packages did not do
8391           this so programs should not fail if <prgn>newaliases</prgn>
8392           cannot be found.  Note that because of this, all MTA
8393           packages must have <tt>Provides</tt>, <tt>Conflicts</tt> and
8394           <tt>Replaces: mail-transport-agent</tt> control file
8395           fields.
8396         </p>
8397
8398         <p>
8399           The convention of writing <tt>forward to
8400             <var>address</var></tt> in the mailbox itself is not
8401           supported.  Use a <tt>.forward</tt> file instead.</p>
8402
8403         <p>
8404           The <prgn>rmail</prgn> program used by UUCP
8405           for incoming mail should be  <file>/usr/sbin/rmail</file>.
8406           Likewise, <prgn>rsmtp</prgn>, for receiving
8407           batch-SMTP-over-UUCP, should be <file>/usr/sbin/rsmtp</file> if it
8408           is supported.</p>
8409
8410         <p>
8411           If your package needs to know what hostname to use on (for
8412           example) outgoing news and mail messages which are generated
8413           locally, you should use the file <file>/etc/mailname</file>.  It
8414           will contain the portion after the username and <tt>@</tt>
8415           (at) sign for email addresses of users on the machine
8416           (followed by a newline).
8417         </p>
8418
8419         <p>
8420           Such a package should check for the existence of this file
8421           when it is being configured.  If it exists, it should be
8422           used without comment, although an MTA's configuration script
8423           may wish to prompt the user even if it finds that this file
8424           exists.  If the file does not exist, the package should
8425           prompt the user for the value (preferably using
8426           <prgn>debconf</prgn>) and store it in <file>/etc/mailname</file>
8427           as well as using it in the package's configuration.  The
8428           prompt should make it clear that the name will not just be
8429           used by that package.  For example, in this situation the
8430           <tt>inn</tt> package could say something like:
8431           <example compact="compact">
8432 Please enter the "mail name" of your system.  This is the
8433 hostname portion of the address to be shown on outgoing
8434 news and mail messages.  The default is
8435 <var>syshostname</var>, your system's host name.  Mail
8436 name ["<var>syshostname</var>"]:
8437           </example>
8438           where <var>syshostname</var> is the output of <tt>hostname
8439             --fqdn</tt>.
8440         </p>
8441       </sect>
8442
8443       <sect>
8444         <heading>News system configuration</heading>
8445
8446         <p>
8447           All the configuration files related to the NNTP (news)
8448           servers and clients should be located under
8449           <file>/etc/news</file>.</p>
8450
8451         <p>
8452           There are some configuration issues that apply to a number
8453           of news clients and server packages on the machine. These
8454           are:
8455
8456           <taglist>
8457             <tag><file>/etc/news/organization</file></tag>
8458             <item>
8459                 A string which should appear as the
8460                 organization header for all messages posted
8461                 by NNTP clients on the machine
8462             </item>
8463
8464             <tag><file>/etc/news/server</file></tag>
8465             <item>
8466                 Contains the FQDN of the upstream NNTP
8467                 server, or localhost if the local machine is
8468                 an NNTP server.
8469             </item>
8470           </taglist>
8471
8472           Other global files may be added as required for cross-package news
8473           configuration.
8474         </p>
8475       </sect>
8476
8477
8478       <sect>
8479         <heading>Programs for the X Window System</heading>
8480
8481         <sect1>
8482           <heading>Providing X support and package priorities</heading>
8483
8484           <p>
8485             Programs that can be configured with support for the X
8486             Window System must be configured to do so and must declare
8487             any package dependencies necessary to satisfy their
8488             runtime requirements when using the X Window System.  If
8489             such a package is of higher priority than the X packages
8490             on which it depends, it is required that either the
8491             X-specific components be split into a separate package, or
8492             that an alternative version of the package, which includes
8493             X support, be provided, or that the package's priority be
8494             lowered.
8495           </p>
8496         </sect1>
8497
8498         <sect1>
8499           <heading>Packages providing an X server</heading>
8500
8501           <p>
8502             Packages that provide an X server that, directly or
8503             indirectly, communicates with real input and display
8504             hardware should declare in their control data that they
8505             provide the virtual package <tt>xserver</tt>.<footnote>
8506                 This implements current practice, and provides an
8507                 actual policy for usage of the <tt>xserver</tt>
8508                 virtual package which appears in the virtual packages
8509                 list.  In a nutshell, X servers that interface
8510                 directly with the display and input hardware or via
8511                 another subsystem (e.g., GGI) should provide
8512                 <tt>xserver</tt>.  Things like <tt>Xvfb</tt>,
8513                 <tt>Xnest</tt>, and <tt>Xprt</tt> should not.
8514             </footnote>
8515           </p>
8516         </sect1>
8517
8518         <sect1>
8519           <heading>Packages providing a terminal emulator</heading>
8520
8521           <p>
8522             Packages that provide a terminal emulator for the X Window
8523             System which meet the criteria listed below should declare
8524             in their control data that they provide the virtual
8525             package <tt>x-terminal-emulator</tt>.  They should also
8526             register themselves as an alternative for
8527             <file>/usr/bin/x-terminal-emulator</file>, with a priority of
8528             20.
8529           </p>
8530
8531           <p>
8532             To be an <tt>x-terminal-emulator</tt>, a program must:
8533             <list compact="compact">
8534               <item>
8535                   Be able to emulate a DEC VT100 terminal, or a
8536                   compatible terminal.
8537               </item>
8538
8539               <item>
8540                   Support the command-line option <tt>-e
8541                     <var>command</var></tt>, which creates a new
8542                   terminal window<footnote>
8543                       "New terminal window" does not necessarily mean
8544                       a new top-level X window directly parented by
8545                       the window manager; it could, if the terminal
8546                       emulator application were so coded, be a new
8547                       "view" in a multiple-document interface (MDI).
8548                   </footnote>
8549                   and runs the specified <var>command</var>,
8550                   interpreting the entirety of the rest of the command
8551                   line as a command to pass straight to exec, in the
8552                   manner that <tt>xterm</tt> does.
8553               </item>
8554
8555               <item>
8556                   Support the command-line option <tt>-T
8557                     <var>title</var></tt>, which creates a new terminal
8558                   window with the window title <var>title</var>.
8559               </item>
8560             </list>
8561           </p>
8562         </sect1>
8563
8564         <sect1>
8565           <heading>Packages providing a window manager</heading>
8566
8567           <p>
8568             Packages that provide a window manager should declare in
8569             their control data that they provide the virtual package
8570             <tt>x-window-manager</tt>.  They should also register
8571             themselves as an alternative for
8572             <file>/usr/bin/x-window-manager</file>, with a priority
8573             calculated as follows:
8574             <list compact="compact">
8575               <item>
8576                   Start with a priority of 20.
8577               </item>
8578
8579               <item>
8580                   If the window manager supports the Debian menu
8581                   system, add 20 points if this support is available
8582                   in the package's default configuration (i.e., no
8583                   configuration files belonging to the system or user
8584                   have to be edited to activate the feature); if
8585                   configuration files must be modified, add only 10
8586                   points.
8587                 </p>
8588               </item>
8589
8590               <item>
8591                   If the window manager complies with <url
8592                     id="http://www.freedesktop.org/Standards/wm-spec"
8593                     name="The Window Manager Specification Project">,
8594                   written by the <url id="http://www.freedesktop.org/"
8595                     name="Free Desktop Group">, add 40 points.
8596               </item>
8597
8598               <item>
8599                   If the window manager permits the X session to be
8600                   restarted using a <em>different</em> window manager
8601                   (without killing the X server) in its default
8602                   configuration, add 10 points; otherwise add none.
8603               </item>
8604             </list>
8605           </p>
8606         </sect1>
8607
8608         <sect1>
8609           <heading>Packages providing fonts</heading>
8610
8611           <p>
8612             Packages that provide fonts for the X Window
8613             System<footnote>
8614                 For the purposes of Debian Policy, a "font for the X
8615                 Window System" is one which is accessed via X protocol
8616                 requests.  Fonts for the Linux console, for PostScript
8617                 renderer, or any other purpose, do not fit this
8618                 definition.  Any tool which makes such fonts available
8619                 to the X Window System, however, must abide by this
8620                 font policy.
8621             </footnote>
8622             must do a number of things to ensure that they are both
8623             available without modification of the X or font server
8624             configuration, and that they do not corrupt files used by
8625             other font packages to register information about
8626             themselves.
8627             <enumlist>
8628               <item>
8629                   Fonts of any type supported by the X Window System
8630                   must be in a separate binary package from any
8631                   executables, libraries, or documentation (except
8632                   that specific to the fonts shipped, such as their
8633                   license information).  If one or more of the fonts
8634                   so packaged are necessary for proper operation of
8635                   the package with which they are associated the font
8636                   package may be Recommended; if the fonts merely
8637                   provide an enhancement, a Suggests relationship may
8638                   be used.  Packages must not Depend on font
8639                   packages.<footnote>
8640                       This is because the X server may retrieve fonts
8641                       from the local file system or over the network
8642                       from an X font server; the Debian package system
8643                       is empowered to deal only with the local
8644                       file system.
8645                   </footnote>
8646               </item>
8647
8648               <item>
8649                   BDF fonts must be converted to PCF fonts with the
8650                   <prgn>bdftopcf</prgn> utility (available in the
8651                   <tt>xfonts-utils</tt> package, <prgn>gzip</prgn>ped, and
8652                   placed in a directory that corresponds to their
8653                   resolution:
8654                   <list compact="compact">
8655                     <item>
8656                         100 dpi fonts must be placed in
8657                         <file>/usr/share/fonts/X11/100dpi/</file>.
8658                     </item>
8659
8660                     <item>
8661                         75 dpi fonts must be placed in
8662                         <file>/usr/share/fonts/X11/75dpi/</file>.
8663                     </item>
8664
8665                     <item>
8666                         Character-cell fonts, cursor fonts, and other
8667                         low-resolution fonts must be placed in
8668                         <file>/usr/share/fonts/X11/misc/</file>.
8669                     </item>
8670                   </list>
8671               </item>
8672
8673               <item>
8674                   Type 1 fonts must be placed in
8675                   <file>/usr/share/fonts/X11/Type1/</file>.  If font
8676                   metric files are available, they must be placed here
8677                   as well.
8678               </item>
8679
8680               <item>
8681                   Subdirectories of <file>/usr/share/fonts/X11/</file>
8682                   other than those listed above must be neither
8683                   created nor used.  (The <file>PEX</file>, <file>CID</file>,
8684                   <file>Speedo</file>, and <file>cyrillic</file> directories
8685                   are excepted for historical reasons, but installation of
8686                   files into these directories remains discouraged.)
8687               </item>
8688
8689               <item>
8690                   Font packages may, instead of placing files directly
8691                   in the X font directories listed above, provide
8692                   symbolic links in that font directory pointing to
8693                   the files' actual location in the filesystem.  Such
8694                   a location must comply with the FHS.
8695               </item>
8696
8697               <item>
8698                   Font packages should not contain both 75dpi and
8699                   100dpi versions of a font.  If both are available,
8700                   they should be provided in separate binary packages
8701                   with <tt>-75dpi</tt> or <tt>-100dpi</tt> appended to
8702                   the names of the packages containing the
8703                   corresponding fonts.
8704               </item>
8705
8706               <item>
8707                   Fonts destined for the <file>misc</file> subdirectory
8708                   should not be included in the same package as 75dpi
8709                   or 100dpi fonts; instead, they should be provided in
8710                   a separate package with <tt>-misc</tt> appended to
8711                   its name.
8712               </item>
8713
8714               <item>
8715                   Font packages must not provide the files
8716                   <file>fonts.dir</file>, <file>fonts.alias</file>, or
8717                   <file>fonts.scale</file> in a font directory:
8718                   <list>
8719                     <item>
8720                         <file>fonts.dir</file> files must not be provided at all.
8721                     </item>
8722
8723                     <item>
8724                         <file>fonts.alias</file> and <file>fonts.scale</file>
8725                         files, if needed, should be provided in the
8726                         directory
8727                         <file>/etc/X11/fonts/<var>fontdir</var>/<var>package</var>.<var>extension</var></file>,
8728                         where <var>fontdir</var> is the name of the
8729                         subdirectory of
8730                         <file>/usr/share/fonts/X11/</file> where the
8731                         package's corresponding fonts are stored
8732                         (e.g., <tt>75dpi</tt> or <tt>misc</tt>),
8733                         <var>package</var> is the name of the package
8734                         that provides these fonts, and
8735                         <var>extension</var> is either <tt>scale</tt>
8736                         or <tt>alias</tt>, whichever corresponds to
8737                         the file contents.
8738                     </item>
8739                   </list>
8740               </item>
8741
8742               <item>
8743                   Font packages must declare a dependency on
8744                   <tt>xfonts-utils</tt> in their control
8745                   data.
8746               </item>
8747
8748               <item>
8749                   Font packages that provide one or more
8750                   <file>fonts.scale</file> files as described above must
8751                   invoke <prgn>update-fonts-scale</prgn> on each
8752                   directory into which they installed fonts
8753                   <em>before</em> invoking
8754                   <prgn>update-fonts-dir</prgn> on that directory.
8755                   This invocation must occur in both the
8756                   <prgn>postinst</prgn> (for all arguments) and
8757                   <prgn>postrm</prgn> (for all arguments except
8758                   <tt>upgrade</tt>) scripts.
8759               </item>
8760
8761               <item>
8762                   Font packages that provide one or more
8763                   <file>fonts.alias</file> files as described above must
8764                   invoke <prgn>update-fonts-alias</prgn> on each
8765                   directory into which they installed fonts.  This
8766                   invocation must occur in both the
8767                   <prgn>postinst</prgn> (for all arguments) and
8768                   <prgn>postrm</prgn> (for all arguments except
8769                   <tt>upgrade</tt>) scripts.
8770               </item>
8771
8772               <item>
8773                   Font packages must invoke
8774                   <prgn>update-fonts-dir</prgn> on each directory into
8775                   which they installed fonts.  This invocation must
8776                   occur in both the <prgn>postinst</prgn> (for all
8777                   arguments) and <prgn>postrm</prgn> (for all
8778                   arguments except <tt>upgrade</tt>) scripts.
8779               </item>
8780
8781               <item>
8782                   Font packages must not provide alias names for the
8783                   fonts they include which collide with alias names
8784                   already in use by fonts already packaged.
8785               </item>
8786
8787               <item>
8788                   Font packages must not provide fonts with the same
8789                   XLFD registry name as another font already packaged.
8790               </item>
8791             </enumlist>
8792           </p>
8793         </sect1>
8794
8795         <sect1 id="appdefaults">
8796           <heading>Application defaults files</heading>
8797
8798           <p>
8799             Application defaults files must be installed in the
8800             directory <file>/etc/X11/app-defaults/</file> (use of a
8801             localized subdirectory of <file>/etc/X11/</file> as described
8802             in the <em>X Toolkit Intrinsics - C Language
8803             Interface</em> manual is also permitted).  They must be
8804             registered as <tt>conffile</tt>s or handled as
8805             configuration files.
8806           </p>
8807
8808           <p>
8809             Customization of programs' X resources may also be
8810             supported with the provision of a file with the same name
8811             as that of the package placed in
8812             the <file>/etc/X11/Xresources/</file> directory, which
8813             must be registered as a <tt>conffile</tt> or handled as a
8814             configuration file.<footnote>
8815                 Note that this mechanism is not the same as using
8816                 app-defaults; app-defaults are tied to the client
8817                 binary on the local file system, whereas X resources
8818                 are stored in the X server and affect all connecting
8819                 clients.
8820             </footnote>
8821           </p>
8822         </sect1>
8823
8824         <sect1>
8825           <heading>Installation directory issues</heading>
8826
8827           <p>
8828             Historically, packages using the X Window System used a
8829             separate set of installation directories from other packages.
8830             This practice has been discontinued and packages using the X
8831             Window System should now generally be installed in the same
8832             directories as any other package.  Specifically, packages must
8833             not install files under the <file>/usr/X11R6/</file> directory
8834             and the <file>/usr/X11R6/</file> directory hierarchy should be
8835             regarded as obsolete.
8836           </p>
8837
8838           <p>
8839             Include files previously installed under
8840             <file>/usr/X11R6/include/X11/</file> should be installed into
8841             <file>/usr/include/X11/</file>.  For files previously
8842             installed into subdirectories of
8843             <file>/usr/X11R6/lib/X11/</file>, package maintainers should
8844             determine if subdirectories of <file>/usr/lib/</file> and
8845             <file>/usr/share/</file> can be used.  If not, a subdirectory
8846             of <file>/usr/lib/X11/</file> should be used.
8847           </p>
8848
8849           <p>
8850             Configuration files for window, display, or session managers
8851             or other applications that are tightly integrated with the X
8852             Window System may be placed in a subdirectory
8853             of <file>/etc/X11/</file> corresponding to the package name.
8854             Other X Window System applications should use
8855             the <file>/etc/</file> directory unless otherwise mandated by
8856             policy (such as for <ref id="appdefaults">).
8857           </p>
8858         </sect1>
8859
8860         <sect1>
8861           <heading>The OSF/Motif and OpenMotif libraries</heading>
8862
8863           <p>
8864             <em>Programs that require the non-DFSG-compliant OSF/Motif or
8865               OpenMotif libraries</em><footnote>
8866                 OSF/Motif and OpenMotif are collectively referred to as
8867                 "Motif" in this policy document.
8868             </footnote>
8869             should be compiled against and tested with LessTif (a free
8870             re-implementation of Motif) instead.  If the maintainer
8871             judges that the program or programs do not work
8872             sufficiently well with LessTif to be distributed and
8873             supported, but do so when compiled against Motif, then two
8874             versions of the package should be created; one linked
8875             statically against Motif and with <tt>-smotif</tt>
8876             appended to the package name, and one linked dynamically
8877             against Motif and with <tt>-dmotif</tt> appended to the
8878             package name.
8879           </p>
8880
8881           <p>
8882             Both Motif-linked versions are dependent
8883             upon non-DFSG-compliant software and thus cannot be
8884             uploaded to the <em>main</em> distribution; if the
8885             software is itself DFSG-compliant it may be uploaded to
8886             the <em>contrib</em> distribution.  While known existing
8887             versions of Motif permit unlimited redistribution of
8888             binaries linked against the library (whether statically or
8889             dynamically), it is the package maintainer's
8890             responsibility to determine whether this is permitted by
8891             the license of the copy of Motif in their possession.
8892           </p>
8893         </sect1>
8894       </sect>
8895
8896       <sect id="perl">
8897         <heading>Perl programs and modules</heading>
8898
8899         <p>
8900           Perl programs and modules should follow the current Perl policy.
8901         </p>
8902
8903         <p>
8904           The Perl policy can be found in the <tt>perl-policy</tt>
8905           files in the <tt>debian-policy</tt> package.
8906           It is also available from the Debian web mirrors at
8907           <tt><url name="/doc/packaging-manuals/perl-policy/"
8908                 id="http://www.debian.org/doc/packaging-manuals/perl-policy/"></tt>.
8909         </p>
8910       </sect>
8911
8912       <sect id="emacs">
8913         <heading>Emacs lisp programs</heading>
8914
8915         <p>
8916           Please refer to the "Debian Emacs Policy" for details of how to
8917           package emacs lisp programs.
8918         </p>
8919
8920         <p>
8921           The Emacs policy is available in
8922           <file>debian-emacs-policy.gz</file> of the
8923           <package>emacsen-common</package> package.
8924           It is also available from the Debian web mirrors at
8925           <tt><url name="/doc/packaging-manuals/debian-emacs-policy"
8926                 id="http://www.debian.org/doc/packaging-manuals/debian-emacs-policy"></tt>.
8927         </p>
8928       </sect>
8929
8930       <sect>
8931         <heading>Games</heading>
8932
8933         <p>
8934           The permissions on <file>/var/games</file> are mode 755, owner
8935           <tt>root</tt> and group <tt>root</tt>.
8936         </p>
8937
8938         <p>
8939           Each game decides on its own security policy.</p>
8940
8941         <p>
8942           Games which require protected, privileged access to
8943           high-score files, saved games, etc., may be made
8944           set-<em>group</em>-id (mode 2755) and owned by
8945           <tt>root:games</tt>, and use files and directories with
8946           appropriate permissions (770 <tt>root:games</tt>, for
8947           example).  They must not be made
8948           set-<em>user</em>-id, as this causes security problems. (If
8949           an attacker can subvert any set-user-id game they can
8950           overwrite the executable of any other, causing other players
8951           of these games to run a Trojan horse program.  With a
8952           set-group-id game the attacker only gets access to less
8953           important game data, and if they can get at the other
8954           players' accounts at all it will take considerably more
8955           effort.)</p>
8956
8957         <p>
8958           Some packages, for example some fortune cookie programs, are
8959           configured by the upstream authors to install with their
8960           data files or other static information made unreadable so
8961           that they can only be accessed through set-id programs
8962           provided.  You should not do this in a Debian package: anyone can
8963           download the <file>.deb</file> file and read the data from it,
8964           so there is no point making the files unreadable.  Not
8965           making the files unreadable also means that you don't have
8966           to make so many programs set-id, which reduces the risk of a
8967           security hole.</p>
8968
8969         <p>
8970           As described in the FHS, binaries of games should be
8971           installed in the directory <file>/usr/games</file>. This also
8972           applies to games that use the X Window System. Manual pages
8973           for games (X and non-X games) should be installed in
8974           <file>/usr/share/man/man6</file>.</p>
8975       </sect>
8976     </chapt>
8977
8978
8979     <chapt id="docs">
8980       <heading>Documentation</heading>
8981
8982       <sect>
8983         <heading>Manual pages</heading>
8984
8985         <p>
8986           You should install manual pages in <prgn>nroff</prgn> source
8987           form, in appropriate places under <file>/usr/share/man</file>.
8988           You should only use sections 1 to 9 (see the FHS for more
8989           details).  You must not install a pre-formatted "cat page".
8990         </p>
8991
8992         <p>
8993           Each program, utility, and function should have an
8994           associated manual page included in the same package. It is
8995           suggested that all configuration files also have a manual
8996           page included as well. Manual pages for protocols and other
8997           auxiliary things are optional.
8998         </p>
8999
9000         <p>
9001           If no manual page is available, this is considered as a bug
9002           and should be reported to the Debian Bug Tracking System (the
9003           maintainer of the package is allowed to write this bug report
9004           themselves, if they so desire).  Do not close the bug report
9005           until a proper man page is available.<footnote>
9006               It is not very hard to write a man page. See the
9007               <url id="http://www.schweikhardt.net/man_page_howto.html"
9008                 name="Man-Page-HOWTO">,
9009               <manref name="man" section="7">, the examples
9010               created by <prgn>debmake</prgn> or <prgn>dh_make</prgn>,
9011               the helper program <prgn>help2man</prgn>, or the
9012               directory <file>/usr/share/doc/man-db/examples</file>.
9013           </footnote>
9014         </p>
9015
9016         <p>
9017           You may forward a complaint about a missing man page to the
9018           upstream authors, and mark the bug as forwarded in the
9019           Debian bug tracking system.  Even though the GNU Project do
9020           not in general consider the lack of a man page to be a bug,
9021           we do; if they tell you that they don't consider it a bug
9022           you should leave the bug in our bug tracking system open
9023           anyway.
9024         </p>
9025
9026         <p>
9027           Manual pages should be installed compressed using <tt>gzip -9</tt>.
9028         </p>
9029
9030         <p>
9031           If one man page needs to be accessible via several names it
9032           is better to use a symbolic link than the <file>.so</file>
9033           feature, but there is no need to fiddle with the relevant
9034           parts of the upstream source to change from <file>.so</file> to
9035           symlinks: don't do it unless it's easy.  You should not
9036           create hard links in the manual page directories, nor put
9037           absolute filenames in <file>.so</file> directives.  The filename
9038           in a <file>.so</file> in a man page should be relative to the
9039           base of the man page tree (usually
9040           <file>/usr/share/man</file>). If you do not create any links
9041           (whether symlinks, hard links, or <tt>.so</tt> directives)
9042           in the file system to the alternate names of the man page,
9043           then you should not rely on <prgn>man</prgn> finding your
9044           man page under those names based solely on the information in
9045           the man page's header.<footnote>
9046               Supporting this in <prgn>man</prgn> often requires
9047               unreasonable processing time to find a manual page or to
9048               report that none exists, and moves knowledge into man's
9049               database that would be better left in the file system.
9050               This support is therefore deprecated and will cease to
9051               be present in the future.
9052           </footnote>
9053         </p>
9054
9055         <p>
9056           Manual pages in locale-specific subdirectories of
9057           <file>/usr/share/man</file> should use either UTF-8 or the usual
9058           legacy encoding for that language (normally the one corresponding
9059           to the shortest relevant locale name in
9060           <file>/usr/share/i18n/SUPPORTED</file>). For example, pages under
9061           <file>/usr/share/man/fr</file> should use either UTF-8 or
9062           ISO-8859-1.<footnote>
9063             <prgn>man</prgn> will automatically detect whether UTF-8 is in
9064             use. In future, all manual pages will be required to use
9065             UTF-8.
9066           </footnote>
9067         </p>
9068
9069         <p>
9070           A country name (the <tt>DE</tt> in <tt>de_DE</tt>) should not be
9071           included in the subdirectory name unless it indicates a
9072           significant difference in the language, as this excludes
9073           speakers of the language in other countries.<footnote>
9074             At the time of writing, Chinese and Portuguese are the main
9075             languages with such differences, so <file>pt_BR</file>,
9076             <file>zh_CN</file>, and <file>zh_TW</file> are all allowed.
9077           </footnote>
9078         </p>
9079
9080         <p>
9081           If a localized version of a manual page is provided, it should
9082           either be up-to-date or it should be obvious to the reader that
9083           it is outdated and the original manual page should be used
9084           instead.  This can be done either by a note at the beginning of
9085           the manual page or by showing the missing or changed portions in
9086           the original language instead of the target language.
9087         </p>
9088       </sect>
9089
9090       <sect>
9091         <heading>Info documents</heading>
9092
9093         <p>
9094           Info documents should be installed in <file>/usr/share/info</file>.
9095           They should be compressed with <tt>gzip -9</tt>.
9096         </p>
9097
9098         <p>
9099           The <prgn>install-info</prgn> program maintains a directory of
9100           installed info documents in <file>/usr/share/info/dir</file> for
9101           the use of info readers.<footnote>
9102             It was previously necessary for packages installing info
9103             documents to run <prgn>install-info</prgn> from maintainer
9104             scripts.  This is no longer necessary.  The installation
9105             system now uses dpkg triggers.
9106           </footnote>
9107           This file must not be included in packages.  Packages containing
9108           info documents should depend on <tt>dpkg (>= 1.15.4) |
9109           install-info</tt> to ensure that the directory file is properly
9110           rebuilt during partial upgrades from Debian 5.0 (lenny) and
9111           earlier.
9112         </p>
9113
9114         <p>
9115           Info documents should contain section and directory entry
9116           information in the document for the use
9117           of <prgn>install-info</prgn>.  The section should be specified
9118           via a line starting with <tt>INFO-DIR-SECTION</tt> followed by a
9119           space and the section of this info page.  The directory entry or
9120           entries should be included between
9121           a <tt>START-INFO-DIR-ENTRY</tt> line and
9122           an <tt>END-INFO-DIR-ENTRY</tt> line.  For example:
9123           <example>
9124 INFO-DIR-SECTION Individual utilities
9125 START-INFO-DIR-ENTRY
9126 * example: (example).               An example info directory entry.
9127 END-INFO-DIR-ENTRY
9128           </example>
9129           To determine which section to use, you should look
9130           at <file>/usr/share/info/dir</file> on your system and choose
9131           the most relevant (or create a new section if none of the
9132           current sections are relevant).<footnote>
9133             Normally, info documents are generated from Texinfo source.
9134             To include this information in the generated info document, if
9135             it is absent, add commands like:
9136             <example>
9137 @dircategory Individual utilities
9138 @direntry
9139 * example: (example).               An example info directory entry.
9140 @end direntry
9141             </example>
9142             to the Texinfo source of the document and ensure that the info
9143             documents are rebuilt from source during the package build.
9144           </footnote>
9145         </p>
9146       </sect>
9147
9148       <sect>
9149         <heading>Additional documentation</heading>
9150
9151         <p>
9152           Any additional documentation that comes with the package may
9153           be installed at the discretion of the package maintainer.
9154           Plain text documentation should be installed in the directory
9155           <file>/usr/share/doc/<var>package</var></file>, where
9156           <var>package</var> is the name of the package, and
9157           compressed with <tt>gzip -9</tt> unless it is small.
9158         </p>
9159
9160         <p>
9161           If a package comes with large amounts of documentation which
9162           many users of the package will not require you should create
9163           a separate binary package to contain it, so that it does not
9164           take up disk space on the machines of users who do not need
9165           or want it installed.</p>
9166
9167         <p>
9168           It is often a good idea to put text information files
9169           (<file>README</file>s, changelogs, and so forth) that come with
9170           the source package in <file>/usr/share/doc/<var>package</var></file>
9171           in the binary package.  However, you don't need to install
9172           the instructions for building and installing the package, of
9173           course!</p>
9174
9175         <p>
9176           Packages must not require the existence of any files in
9177           <file>/usr/share/doc/</file> in order to function
9178           <footnote>
9179               The system administrator should be able to
9180               delete files in <file>/usr/share/doc/</file> without causing
9181               any programs to break.
9182           </footnote>.
9183           Any files that are referenced by programs but are also
9184           useful as stand alone documentation should be installed under
9185           <file>/usr/share/<var>package</var>/</file> with symbolic links from
9186           <file>/usr/share/doc/<var>package</var></file>.
9187         </p>
9188
9189         <p>
9190           <file>/usr/share/doc/<var>package</var></file> may be a symbolic
9191           link to another directory in <file>/usr/share/doc</file> only if
9192           the two packages both come from the same source and the
9193           first package Depends on the second.<footnote>
9194             <p>
9195               Please note that this does not override the section on
9196               changelog files below, so the file 
9197               <file>/usr/share/doc/<var>package</var>/changelog.Debian.gz</file>
9198               must refer to the changelog for the current version of
9199               <var>package</var> in question. In practice, this means
9200               that the sources of the target and the destination of the
9201               symlink must be the same (same source package and
9202               version). 
9203             </p>
9204           </footnote>
9205         </p>
9206
9207         <p>
9208           Former Debian releases placed all additional documentation
9209           in <file>/usr/doc/<var>package</var></file>.  This has been
9210           changed to <file>/usr/share/doc/<var>package</var></file>,
9211           and packages must not put documentation in the directory
9212           <file>/usr/doc/<var>package</var></file>. <footnote>
9213             At this phase of the transition, we no longer require a
9214             symbolic link in <file>/usr/doc/</file>. At a later point,
9215             policy shall change to make the symbolic links a bug.
9216           </footnote>
9217         </p>
9218       </sect>
9219
9220       <sect>
9221         <heading>Preferred documentation formats</heading>
9222
9223         <p>
9224           The unification of Debian documentation is being carried out
9225           via HTML.</p>
9226
9227         <p>
9228           If your package comes with extensive documentation in a
9229           markup format that can be converted to various other formats
9230           you should if possible ship HTML versions in a binary
9231           package, in the directory
9232           <file>/usr/share/doc/<var>appropriate-package</var></file> or
9233           its subdirectories.<footnote>
9234               The rationale: The important thing here is that HTML
9235               docs should be available in <em>some</em> package, not
9236               necessarily in the main binary package.
9237           </footnote>
9238         </p>
9239
9240         <p>
9241           Other formats such as PostScript may be provided at the
9242           package maintainer's discretion.
9243         </p>
9244       </sect>
9245
9246       <sect id="copyrightfile">
9247         <heading>Copyright information</heading>
9248
9249         <p>
9250           Every package must be accompanied by a verbatim copy of its
9251           copyright information and distribution license in the file
9252           <file>/usr/share/doc/<var>package</var>/copyright</file>. This
9253           file must neither be compressed nor be a symbolic link.
9254         </p>
9255
9256         <p>
9257           In addition, the copyright file must say where the upstream
9258           sources (if any) were obtained.  It should name the original
9259           authors of the package and the Debian maintainer(s) who were
9260           involved with its creation.
9261         </p>
9262
9263         <p>
9264           Packages in the <em>contrib</em> or <em>non-free</em> archive
9265           areas should state in the copyright file that the package is not
9266           part of the Debian GNU/Linux distribution and briefly explain
9267           why.
9268         </p>
9269
9270         <p>
9271           A copy of the file which will be installed in
9272           <file>/usr/share/doc/<var>package</var>/copyright</file> should
9273           be in <file>debian/copyright</file> in the source package.
9274         </p>
9275
9276         <p>
9277           <file>/usr/share/doc/<var>package</var></file> may be a symbolic
9278           link to another directory in <file>/usr/share/doc</file> only if
9279           the two packages both come from the same source and the
9280           first package Depends on the second.  These rules are
9281           important because copyrights must be extractable by
9282           mechanical means.
9283         </p>
9284
9285         <p>
9286           Packages distributed under the Apache license (version 2.0), the
9287           Artistic license, the GNU GPL (version 2 or 3), the GNU LGPL
9288           (versions 2, 2.1, or 3), and the GNU FDL (versions 1.2 or 1.3)
9289           should refer to the corresponding files
9290           under <file>/usr/share/common-licenses</file>,<footnote>
9291             <p>
9292               In particular,
9293               <file>/usr/share/common-licenses/Apache-2.0</file>,
9294               <file>/usr/share/common-licenses/Artistic</file>,
9295               <file>/usr/share/common-licenses/GPL-2</file>,
9296               <file>/usr/share/common-licenses/GPL-3</file>,
9297               <file>/usr/share/common-licenses/LGPL-2</file>,
9298               <file>/usr/share/common-licenses/LGPL-2.1</file>,
9299               <file>/usr/share/common-licenses/LGPL-3</file>,
9300               <file>/usr/share/common-licenses/GFDL-1.2</file>, and
9301               <file>/usr/share/common-licenses/GFDL-1.3</file>
9302               respectively.  The University of California BSD license is
9303               also included in <package>base-files</package> as
9304               <file>/usr/share/common-licenses/BSD</file>, but given the
9305               brevity of this license, its specificity to code whose
9306               copyright is held by the Regents of the University of
9307               California, and the frequency of minor wording changes, its
9308               text should be included in the copyright file rather than
9309               referencing this file.
9310             </p>
9311           </footnote> rather than quoting them in the copyright
9312           file. 
9313         </p>
9314
9315         <p>
9316           You should not use the copyright file as a general <file>README</file>
9317           file.  If your package has such a file it should be
9318           installed in <file>/usr/share/doc/<var>package</var>/README</file> or
9319           <file>README.Debian</file> or some other appropriate place.</p>
9320       </sect>
9321
9322       <sect>
9323         <heading>Examples</heading>
9324
9325         <p>
9326           Any examples (configurations, source files, whatever),
9327           should be installed in a directory
9328           <file>/usr/share/doc/<var>package</var>/examples</file>.  These
9329           files should not be referenced by any program: they're there
9330           for the benefit of the system administrator and users as
9331           documentation only.  Architecture-specific example files
9332           should be installed in a directory
9333           <file>/usr/lib/<var>package</var>/examples</file> with symbolic
9334           links to them from
9335           <file>/usr/share/doc/<var>package</var>/examples</file>, or the
9336           latter directory itself may be a symbolic link to the
9337           former.
9338         </p>
9339
9340         <p>
9341           If the purpose of a package is to provide examples, then the
9342           example files may be installed into
9343           <file>/usr/share/doc/<var>package</var></file>.
9344         </p>
9345       </sect>
9346
9347       <sect id="changelogs">
9348         <heading>Changelog files</heading>
9349
9350         <p>
9351           Packages that are not Debian-native must contain a
9352           compressed copy of the <file>debian/changelog</file> file from
9353           the Debian source tree in
9354           <file>/usr/share/doc/<var>package</var></file> with the name
9355           <file>changelog.Debian.gz</file>.
9356         </p>
9357
9358         <p>
9359           If an upstream changelog is available, it should be accessible as
9360           <file>/usr/share/doc/<var>package</var>/changelog.gz</file> in
9361           plain text.  If the upstream changelog is distributed in
9362           HTML, it should be made available in that form as
9363           <file>/usr/share/doc/<var>package</var>/changelog.html.gz</file>
9364           and a plain text <file>changelog.gz</file> should be generated
9365           from it using, for example, <tt>lynx -dump -nolist</tt>.  If
9366           the upstream changelog files do not already conform to this
9367           naming convention, then this may be achieved either by
9368           renaming the files, or by adding a symbolic link, at the
9369           maintainer's discretion.<footnote>
9370               Rationale: People should not have to look in places for
9371               upstream changelogs merely because they are given
9372               different names or are distributed in HTML format.
9373           </footnote>
9374         </p>
9375
9376         <p>
9377           All of these files should be installed compressed using
9378           <tt>gzip -9</tt>, as they will become large with time even
9379           if they start out small.
9380         </p>
9381
9382         <p>
9383           If the package has only one changelog which is used both as
9384           the Debian changelog and the upstream one because there is
9385           no separate upstream maintainer then that changelog should
9386           usually be installed as
9387           <file>/usr/share/doc/<var>package</var>/changelog.gz</file>; if
9388           there is a separate upstream maintainer, but no upstream
9389           changelog, then the Debian changelog should still be called
9390           <file>changelog.Debian.gz</file>.
9391         </p>
9392
9393         <p>
9394           For details about the format and contents of the Debian
9395           changelog file, please see <ref id="dpkgchangelog">.
9396         </p>
9397       </sect>
9398     </chapt>
9399
9400     <appendix id="pkg-scope">
9401       <heading>Introduction and scope of these appendices</heading>
9402
9403       <p>
9404         These appendices are taken essentially verbatim from the
9405         now-deprecated Packaging Manual, version 3.2.1.0.  They are
9406         the chapters which are likely to be of use to package
9407         maintainers and which have not already been included in the
9408         policy document itself. Most of these sections are very likely
9409         not relevant to policy; they should be treated as
9410         documentation for the packaging system. Please note that these
9411         appendices are included for convenience, and for historical
9412         reasons: they used to be part of policy package, and they have
9413         not yet been incorporated into dpkg documentation. However,
9414         they still have value, and hence they are presented here.
9415       </p>
9416
9417       <p>
9418         They have not yet been checked to ensure that they are
9419         compatible with the contents of policy, and if there are any
9420         contradictions, the version in the main policy document takes
9421         precedence.  The remaining chapters of the old Packaging
9422         Manual have also not been read in detail to ensure that there
9423         are not parts which have been left out.  Both of these will be
9424         done in due course.
9425       </p>
9426
9427       <p>
9428         Certain parts of the Packaging manual were integrated into the
9429         Policy Manual proper, and removed from the appendices. Links
9430         have been placed from the old locations to the new ones.
9431       </p>
9432
9433       <p>
9434         <prgn>dpkg</prgn> is a suite of programs for creating binary
9435         package files and installing and removing them on Unix
9436         systems.<footnote>
9437             <prgn>dpkg</prgn> is targeted primarily at Debian
9438             GNU/Linux, but may work on or be ported to other
9439             systems.
9440         </footnote>
9441       </p>
9442
9443       <p>
9444         The binary packages are designed for the management of
9445         installed executable programs (usually compiled binaries) and
9446         their associated data, though source code examples and
9447         documentation are provided as part of some packages.</p>
9448
9449       <p>
9450         This manual describes the technical aspects of creating Debian
9451         binary packages (<file>.deb</file> files).  It documents the
9452         behavior of the package management programs
9453         <prgn>dpkg</prgn>, <prgn>dselect</prgn> et al. and the way
9454         they interact with packages.</p>
9455
9456       <p>
9457         It also documents the interaction between
9458         <prgn>dselect</prgn>'s core and the access method scripts it
9459         uses to actually install the selected packages, and describes
9460         how to create a new access method.</p>
9461
9462       <p>
9463         This manual does not go into detail about the options and
9464         usage of the package building and installation tools.  It
9465         should therefore be read in conjunction with those programs'
9466         man pages.
9467       </p>
9468
9469       <p>
9470         The utility programs which are provided with <prgn>dpkg</prgn>
9471         for managing various system configuration and similar issues,
9472         such as <prgn>update-rc.d</prgn> and
9473         <prgn>install-info</prgn>, are not described in detail here -
9474         please see their man pages.
9475       </p>
9476
9477       <p>
9478         It is assumed that the reader is reasonably familiar with the
9479         <prgn>dpkg</prgn> System Administrators' manual.
9480         Unfortunately this manual does not yet exist.
9481       </p>
9482
9483       <p>
9484         The Debian version of the FSF's GNU hello program is provided
9485         as an example for people wishing to create Debian
9486         packages. The Debian <prgn>debmake</prgn> package is
9487         recommended as a very helpful tool in creating and maintaining
9488         Debian packages. However, while the tools and examples are
9489         helpful, they do not replace the need to read and follow the
9490         Policy and Programmer's Manual.</p>
9491     </appendix>
9492
9493     <appendix id="pkg-binarypkg">
9494       <heading>Binary packages (from old Packaging Manual)</heading>
9495
9496       <p>
9497         The binary package has two main sections.  The first part
9498         consists of various control information files and scripts used
9499         by <prgn>dpkg</prgn> when installing and removing.  See <ref
9500         id="pkg-controlarea">.
9501       </p>
9502
9503       <p>
9504         The second part is an archive containing the files and
9505         directories to be installed.
9506       </p>
9507
9508       <p>
9509         In the future binary packages may also contain other
9510         components, such as checksums and digital signatures. The
9511         format for the archive is described in full in the
9512         <file>deb(5)</file> man page.
9513       </p>
9514
9515
9516       <sect id="pkg-bincreating"><heading>Creating package files -
9517       <prgn>dpkg-deb</prgn>
9518         </heading>
9519
9520         <p>
9521           All manipulation of binary package files is done by
9522           <prgn>dpkg-deb</prgn>; it's the only program that has
9523           knowledge of the format.  (<prgn>dpkg-deb</prgn> may be
9524           invoked by calling <prgn>dpkg</prgn>, as <prgn>dpkg</prgn>
9525           will spot that the options requested are appropriate to
9526           <prgn>dpkg-deb</prgn> and invoke that instead with the same
9527           arguments.)
9528         </p>
9529
9530         <p>
9531           In order to create a binary package you must make a
9532           directory tree which contains all the files and directories
9533           you want to have in the file system data part of the package.
9534           In Debian-format source packages this directory is usually
9535           <file>debian/tmp</file>, relative to the top of the package's
9536           source tree.
9537         </p>
9538
9539         <p>
9540           They should have the locations (relative to the root of the
9541           directory tree you're constructing) ownerships and
9542           permissions which you want them to have on the system when
9543           they are installed.
9544         </p>
9545
9546         <p>
9547           With current versions of <prgn>dpkg</prgn> the uid/username
9548           and gid/groupname mappings for the users and groups being
9549           used should be the same on the system where the package is
9550           built and the one where it is installed.
9551         </p>
9552
9553         <p>
9554           You need to add one special directory to the root of the
9555           miniature file system tree you're creating:
9556           <prgn>DEBIAN</prgn>.  It should contain the control
9557           information files, notably the binary package control file
9558           (see <ref id="pkg-controlfile">).
9559         </p>
9560
9561         <p>
9562           The <prgn>DEBIAN</prgn> directory will not appear in the
9563           file system archive of the package, and so won't be installed
9564           by <prgn>dpkg</prgn> when the package is installed.
9565         </p>
9566
9567         <p>
9568           When you've prepared the package, you should invoke:
9569           <example>
9570   dpkg --build <var>directory</var>
9571           </example>
9572         </p>
9573
9574         <p>
9575           This will build the package in
9576           <file><var>directory</var>.deb</file>.  (<prgn>dpkg</prgn> knows
9577           that <tt>--build</tt> is a <prgn>dpkg-deb</prgn> option, so
9578           it invokes <prgn>dpkg-deb</prgn> with the same arguments to
9579           build the package.)
9580         </p>
9581
9582         <p>
9583           See the man page <manref name="dpkg-deb" section="8"> for details of how
9584           to examine the contents of this newly-created file.  You may find the
9585           output of following commands enlightening:
9586           <example>
9587   dpkg-deb --info <var>filename</var>.deb
9588   dpkg-deb --contents <var>filename</var>.deb
9589   dpkg --contents <var>filename</var>.deb
9590           </example>
9591           To view the copyright file for a package you could use this command:
9592           <example>
9593   dpkg --fsys-tarfile <var>filename</var>.deb | tar xOf - --wildcards \*/copyright | pager
9594           </example>
9595         </p>
9596       </sect>
9597
9598       <sect id="pkg-controlarea">
9599         <heading>Package control information files</heading>
9600
9601         <p>
9602           The control information portion of a binary package is a
9603           collection of files with names known to <prgn>dpkg</prgn>.
9604           It will treat the contents of these files specially - some
9605           of them contain information used by <prgn>dpkg</prgn> when
9606           installing or removing the package; others are scripts which
9607           the package maintainer wants <prgn>dpkg</prgn> to run.
9608         </p>
9609
9610         <p>
9611           It is possible to put other files in the package control
9612           area, but this is not generally a good idea (though they
9613           will largely be ignored).
9614         </p>
9615
9616         <p>
9617           Here is a brief list of the control info files supported by
9618           <prgn>dpkg</prgn> and a summary of what they're used for.
9619         </p>
9620
9621         <p>
9622           <taglist>
9623             <tag><tt>control</tt>
9624             <item>
9625               <p>
9626                 This is the key description file used by
9627                 <prgn>dpkg</prgn>.  It specifies the package's name
9628                 and version, gives its description for the user,
9629                 states its relationships with other packages, and so
9630                 forth.  See <ref id="sourcecontrolfiles"> and
9631                 <ref id="binarycontrolfiles">.
9632               </p>
9633
9634               <p>
9635                 It is usually generated automatically from information
9636                 in the source package by the
9637                 <prgn>dpkg-gencontrol</prgn> program, and with
9638                 assistance from <prgn>dpkg-shlibdeps</prgn>.
9639                 See <ref id="pkg-sourcetools">.
9640               </p>
9641             </item>
9642
9643             <tag><tt>postinst</tt>, <tt>preinst</tt>, <tt>postrm</tt>,
9644                  <tt>prerm</tt>
9645             </tag>
9646             <item>
9647               <p>
9648                 These are executable files (usually scripts) which
9649                 <prgn>dpkg</prgn> runs during installation, upgrade
9650                 and removal of packages.  They allow the package to
9651                 deal with matters which are particular to that package
9652                 or require more complicated processing than that
9653                 provided by <prgn>dpkg</prgn>.  Details of when and
9654                 how they are called are in <ref id="maintainerscripts">.
9655               </p>
9656
9657               <p>
9658                 It is very important to make these scripts idempotent.
9659                 See <ref id="idempotency">.
9660               </p>
9661
9662               <p>
9663                 The maintainer scripts are not guaranteed to run with a
9664                 controlling terminal and may not be able to interact with
9665                 the user.  See <ref id="controllingterminal">.
9666               </p>
9667             </item>
9668
9669             <tag><tt>conffiles</tt>
9670             </tag>
9671             <item>
9672                 This file contains a list of configuration files which
9673                 are to be handled automatically by <prgn>dpkg</prgn>
9674                 (see <ref id="pkg-conffiles">).  Note that not necessarily
9675                 every configuration file should be listed here.
9676             </item>
9677
9678             <tag><tt>shlibs</tt>
9679             </tag>
9680             <item>
9681                 This file contains a list of the shared libraries
9682                 supplied by the package, with dependency details for
9683                 each.  This is used by <prgn>dpkg-shlibdeps</prgn>
9684                 when it determines what dependencies are required in a
9685                 package control file. The <tt>shlibs</tt> file format
9686                 is described on <ref id="shlibs">.
9687             </item>
9688           </taglist>
9689         </p>
9690
9691       <sect id="pkg-controlfile">
9692         <heading>The main control information file: <tt>control</tt></heading>
9693
9694         <p>
9695           The most important control information file used by
9696           <prgn>dpkg</prgn> when it installs a package is
9697           <tt>control</tt>.  It contains all the package's "vital
9698           statistics".
9699         </p>
9700
9701         <p>
9702           The binary package control files of packages built from
9703           Debian sources are made by a special tool,
9704           <prgn>dpkg-gencontrol</prgn>, which reads
9705           <file>debian/control</file> and <file>debian/changelog</file> to
9706           find the information it needs.  See <ref id="pkg-sourcepkg"> for
9707           more details.
9708         </p>
9709
9710         <p>
9711           The fields in binary package control files are listed in
9712           <ref id="binarycontrolfiles">.
9713         </p>
9714
9715         <p>
9716           A description of the syntax of control files and the purpose
9717           of the fields is available in <ref id="controlfields">.
9718         </p>
9719       </sect>
9720
9721       <sect>
9722         <heading>Time Stamps</heading>
9723
9724         <p>
9725           See <ref id="timestamps">.
9726         </p>
9727       </sect>
9728     </appendix>
9729
9730     <appendix id="pkg-sourcepkg">
9731       <heading>Source packages (from old Packaging Manual) </heading>
9732
9733       <p>
9734         The Debian binary packages in the distribution are generated
9735         from Debian sources, which are in a special format to assist
9736         the easy and automatic building of binaries.
9737       </p>
9738
9739       <sect id="pkg-sourcetools">
9740         <heading>Tools for processing source packages</heading>
9741
9742         <p>
9743           Various tools are provided for manipulating source packages;
9744           they pack and unpack sources and help build of binary
9745           packages and help manage the distribution of new versions.
9746         </p>
9747
9748         <p>
9749           They are introduced and typical uses described here; see
9750           <manref name="dpkg-source" section="1"> for full
9751           documentation about their arguments and operation.
9752         </p>
9753
9754         <p>
9755           For examples of how to construct a Debian source package,
9756           and how to use those utilities that are used by Debian
9757           source packages, please see the <prgn>hello</prgn> example
9758           package.
9759         </p>
9760
9761         <sect1 id="pkg-dpkg-source">
9762           <heading>
9763             <prgn>dpkg-source</prgn> - packs and unpacks Debian source
9764             packages
9765           </heading>
9766
9767           <p>
9768             This program is frequently used by hand, and is also
9769             called from package-independent automated building scripts
9770             such as <prgn>dpkg-buildpackage</prgn>.
9771           </p>
9772
9773           <p>
9774             To unpack a package it is typically invoked with
9775             <example>
9776   dpkg-source -x <var>.../path/to/filename</var>.dsc
9777             </example>
9778           </p>
9779
9780            <p>
9781             with the <file><var>filename</var>.tar.gz</file> and
9782             <file><var>filename</var>.diff.gz</file> (if applicable) in
9783             the same directory.  It unpacks into
9784             <file><var>package</var>-<var>version</var></file>, and if
9785             applicable
9786             <file><var>package</var>-<var>version</var>.orig</file>, in
9787             the current directory.
9788           </p>
9789
9790           <p>
9791             To create a packed source archive it is typically invoked:
9792             <example>
9793   dpkg-source -b <var>package</var>-<var>version</var>
9794           </example>
9795           </p>
9796
9797           <p>
9798             This will create the <file>.dsc</file>, <file>.tar.gz</file> and
9799             <file>.diff.gz</file> (if appropriate) in the current
9800             directory.  <prgn>dpkg-source</prgn> does not clean the
9801             source tree first - this must be done separately if it is
9802             required.
9803           </p>
9804
9805           <p>
9806             See also <ref id="pkg-sourcearchives">.</p>
9807         </sect1>
9808
9809
9810         <sect1 id="pkg-dpkg-buildpackage">
9811           <heading>
9812             <prgn>dpkg-buildpackage</prgn> - overall package-building
9813             control script
9814           </heading>
9815
9816           <p>
9817             <prgn>dpkg-buildpackage</prgn> is a script which invokes
9818             <prgn>dpkg-source</prgn>, the <file>debian/rules</file>
9819             targets <tt>clean</tt>, <tt>build</tt> and
9820             <tt>binary</tt>, <prgn>dpkg-genchanges</prgn> and
9821             <prgn>gpg</prgn> (or <prgn>pgp</prgn>) to build a signed
9822             source and binary package upload.
9823           </p>
9824
9825           <p>
9826             It is usually invoked by hand from the top level of the
9827             built or unbuilt source directory.  It may be invoked with
9828             no arguments; useful arguments include:
9829             <taglist compact="compact">
9830               <tag><tt>-uc</tt>, <tt>-us</tt></tag>
9831               <item>
9832                 <p>
9833                   Do not sign the <tt>.changes</tt> file or the
9834                   source package <tt>.dsc</tt> file, respectively.</p>
9835               </item>
9836               <tag><tt>-p<var>sign-command</var></tt></tag>
9837               <item>
9838                 <p>
9839                   Invoke <var>sign-command</var> instead of finding
9840                   <tt>gpg</tt> or <tt>pgp</tt> on the <prgn>PATH</prgn>.
9841                   <var>sign-command</var> must behave just like
9842                   <prgn>gpg</prgn> or <tt>pgp</tt>.</p>
9843               </item>
9844               <tag><tt>-r<var>root-command</var></tt></tag>
9845               <item>
9846                 <p>
9847                   When root privilege is required, invoke the command
9848                   <var>root-command</var>.  <var>root-command</var>
9849                   should invoke its first argument as a command, from
9850                   the <prgn>PATH</prgn> if necessary, and pass its
9851                   second and subsequent arguments to the command it
9852                   calls.  If no <var>root-command</var> is supplied
9853                   then <var>dpkg-buildpackage</var> will take no
9854                   special action to gain root privilege, so that for
9855                   most packages it will have to be invoked as root to
9856                   start with.</p>
9857               </item>
9858               <tag><tt>-b</tt>, <tt>-B</tt></tag>
9859               <item>
9860                 <p>
9861                   Two types of binary-only build and upload - see
9862                   <manref name="dpkg-source" section="1">.
9863                 </p>
9864               </item>
9865             </taglist>
9866           </p>
9867         </sect1>
9868
9869         <sect1 id="pkg-dpkg-gencontrol">
9870           <heading>
9871             <prgn>dpkg-gencontrol</prgn> - generates binary package
9872             control files
9873           </heading>
9874
9875           <p>
9876             This program is usually called from <file>debian/rules</file>
9877             (see <ref id="pkg-sourcetree">) in the top level of the source
9878             tree.
9879           </p>
9880
9881           <p>
9882             This is usually done just before the files and directories in the
9883             temporary directory tree where the package is being built have their
9884             permissions and ownerships set and the package is constructed using
9885             <prgn>dpkg-deb/</prgn>
9886               <footnote>
9887                 This is so that the control file which is produced has
9888                 the right permissions
9889             </footnote>.
9890           </p>
9891
9892           <p>
9893             <prgn>dpkg-gencontrol</prgn> must be called after all the
9894             files which are to go into the package have been placed in
9895             the temporary build directory, so that its calculation of
9896             the installed size of a package is correct.
9897           </p>
9898
9899           <p>
9900             It is also necessary for <prgn>dpkg-gencontrol</prgn> to
9901             be run after <prgn>dpkg-shlibdeps</prgn> so that the
9902             variable substitutions created by
9903             <prgn>dpkg-shlibdeps</prgn> in <file>debian/substvars</file>
9904             are available.
9905           </p>
9906
9907           <p>
9908             For a package which generates only one binary package, and
9909             which builds it in <file>debian/tmp</file> relative to the top
9910             of the source package, it is usually sufficient to call
9911             <prgn>dpkg-gencontrol</prgn>.
9912           </p>
9913
9914           <p>
9915             Sources which build several binaries will typically need
9916             something like:
9917             <example>
9918   dpkg-gencontrol -Pdebian/tmp-<var>pkg</var> -p<var>package</var>
9919             </example> The <tt>-P</tt> tells
9920             <prgn>dpkg-gencontrol</prgn> that the package is being
9921             built in a non-default directory, and the <tt>-p</tt>
9922             tells it which package's control file should be generated.
9923           </p>
9924
9925           <p>
9926             <prgn>dpkg-gencontrol</prgn> also adds information to the
9927             list of files in <file>debian/files</file>, for the benefit of
9928             (for example) a future invocation of
9929             <prgn>dpkg-genchanges</prgn>.</p>
9930         </sect1>
9931
9932         <sect1 id="pkg-dpkg-shlibdeps">
9933           <heading>
9934             <prgn>dpkg-shlibdeps</prgn> - calculates shared library
9935             dependencies
9936           </heading>
9937
9938           <p>
9939             This program is usually called from <file>debian/rules</file>
9940             just before <prgn>dpkg-gencontrol</prgn> (see <ref
9941             id="pkg-sourcetree">), in the top level of the source tree.
9942           </p>
9943
9944           <p>
9945             Its arguments are executables and shared libraries
9946             <footnote>
9947               <p>
9948                 They may be specified either in the locations in the
9949                 source tree where they are created or in the locations
9950                 in the temporary build tree where they are installed
9951                 prior to binary package creation.
9952               </p>
9953             </footnote> for which shared library dependencies should
9954             be included in the binary package's control file.
9955           </p>
9956
9957           <p>
9958             If some of the found shared libraries should only
9959             warrant a <tt>Recommends</tt> or <tt>Suggests</tt>, or if
9960             some warrant a <tt>Pre-Depends</tt>, this can be achieved
9961             by using the <tt>-d<var>dependency-field</var></tt> option
9962             before those executable(s).  (Each <tt>-d</tt> option
9963             takes effect until the next <tt>-d</tt>.)
9964           </p>
9965
9966           <p>
9967             <prgn>dpkg-shlibdeps</prgn> does not directly cause the
9968             output control file to be modified.  Instead by default it
9969             adds to the <file>debian/substvars</file> file variable
9970             settings like <tt>shlibs:Depends</tt>.  These variable
9971             settings must be referenced in dependency fields in the
9972             appropriate per-binary-package sections of the source
9973             control file.
9974           </p>
9975
9976           <p>
9977             For example, a package that generates an essential part
9978             which requires dependencies, and optional parts that 
9979             which only require a recommendation, would separate those
9980             two sets of dependencies into two different fields.<footnote>
9981                 At the time of writing, an example for this was the
9982                 <package/xmms/ package, with Depends used for the xmms
9983                 executable, Recommends for the plug-ins and Suggests for
9984                 even more optional features provided by unzip.
9985             </footnote>
9986             It can say in its <file>debian/rules</file>:
9987             <example>
9988   dpkg-shlibdeps -dDepends <var>program anotherprogram ...</var> \
9989                  -dRecommends <var>optionalpart anotheroptionalpart</var>
9990             </example>
9991             and then in its main control file <file>debian/control</file>:
9992             <example>
9993   <var>...</var>
9994   Depends: ${shlibs:Depends}
9995   Recommends: ${shlibs:Recommends}
9996   <var>...</var>
9997             </example>
9998           </p>
9999
10000           <p>
10001             Sources which produce several binary packages with
10002             different shared library dependency requirements can use
10003             the <tt>-p<var>varnameprefix</var></tt> option to override
10004             the default <tt>shlibs:</tt> prefix (one invocation of
10005             <prgn>dpkg-shlibdeps</prgn> per setting of this option).
10006             They can thus produce several sets of dependency
10007             variables, each of the form
10008             <tt><var>varnameprefix</var>:<var>dependencyfield</var></tt>,
10009             which can be referred to in the appropriate parts of the
10010             binary package control files.
10011           </p>
10012         </sect1>
10013
10014
10015         <sect1 id="pkg-dpkg-distaddfile">
10016           <heading>
10017             <prgn>dpkg-distaddfile</prgn> - adds a file to
10018             <file>debian/files</file>
10019           </heading>
10020
10021           <p>
10022             Some packages' uploads need to include files other than
10023             the source and binary package files.
10024           </p>
10025
10026           <p>
10027             <prgn>dpkg-distaddfile</prgn> adds a file to the
10028             <file>debian/files</file> file so that it will be included in
10029             the <file>.changes</file> file when
10030             <prgn>dpkg-genchanges</prgn> is run.
10031           </p>
10032
10033           <p>
10034             It is usually invoked from the <tt>binary</tt> target of
10035             <file>debian/rules</file>:
10036             <example>
10037   dpkg-distaddfile <var>filename</var> <var>section</var> <var>priority</var>
10038             </example>
10039             The <var>filename</var> is relative to the directory where
10040             <prgn>dpkg-genchanges</prgn> will expect to find it - this
10041             is usually the directory above the top level of the source
10042             tree.  The <file>debian/rules</file> target should put the
10043             file there just before or just after calling
10044             <prgn>dpkg-distaddfile</prgn>.
10045           </p>
10046
10047           <p>
10048             The <var>section</var> and <var>priority</var> are passed
10049             unchanged into the resulting <file>.changes</file> file.
10050           </p>
10051         </sect1>
10052
10053
10054         <sect1 id="pkg-dpkg-genchanges">
10055           <heading>
10056             <prgn>dpkg-genchanges</prgn> - generates a <file>.changes</file>
10057             upload control file
10058           </heading>
10059
10060           <p>
10061             This program is usually called by package-independent
10062             automatic building scripts such as
10063             <prgn>dpkg-buildpackage</prgn>, but it may also be called
10064             by hand.
10065           </p>
10066
10067           <p>
10068             It is usually called in the top level of a built source
10069             tree, and when invoked with no arguments will print out a
10070             straightforward <file>.changes</file> file based on the
10071             information in the source package's changelog and control
10072             file and the binary and source packages which should have
10073             been built.
10074           </p>
10075         </sect1>
10076
10077
10078         <sect1 id="pkg-dpkg-parsechangelog">
10079           <heading>
10080             <prgn>dpkg-parsechangelog</prgn> - produces parsed
10081             representation of a changelog
10082           </heading>
10083
10084           <p>
10085             This program is used internally by
10086             <prgn>dpkg-source</prgn> et al.  It may also occasionally
10087             be useful in <file>debian/rules</file> and elsewhere.  It
10088             parses a changelog, <file>debian/changelog</file> by default,
10089             and prints a control-file format representation of the
10090             information in it to standard output.
10091           </p>
10092         </sect1>
10093
10094         <sect1 id="pkg-dpkg-architecture">
10095           <heading>
10096             <prgn>dpkg-architecture</prgn> - information about the build and
10097             host system
10098           </heading>
10099
10100           <p>
10101             This program can be used manually, but is also invoked by
10102             <tt>dpkg-buildpackage</tt> or <file>debian/rules</file> to set
10103             environment or make variables which specify the build and host
10104             architecture for the package building process.
10105           </p>
10106         </sect1>
10107       </sect>
10108
10109       <sect id="pkg-sourcetree">
10110         <heading>The Debianised source tree</heading>
10111
10112         <p>
10113           The source archive scheme described later is intended to
10114           allow a Debianised source tree with some associated control
10115           information to be reproduced and transported easily.  The
10116           Debianised source tree is a version of the original program
10117           with certain files added for the benefit of the
10118           Debianisation process, and with any other changes required
10119           made to the rest of the source code and installation
10120           scripts.
10121         </p>
10122
10123         <p>
10124           The extra files created for Debian are in the subdirectory
10125           <file>debian</file> of the top level of the Debianised source
10126           tree.  They are described below.
10127         </p>
10128
10129         <sect1 id="pkg-debianrules">
10130           <heading><file>debian/rules</file> - the main building script</heading>
10131
10132           <p>
10133             See <ref id="debianrules">.
10134           </p>
10135         </sect1>
10136
10137         <sect1 id="pkg-srcsubstvars">
10138           <heading><file>debian/substvars</file> and variable substitutions</heading>
10139
10140           <p>
10141             See <ref id="substvars">.
10142           </p>
10143
10144         </sect1>
10145
10146         <sect1>
10147           <heading><file>debian/files</file></heading>
10148
10149           <p>
10150             See <ref id="debianfiles">.
10151           </p>
10152         </sect1>
10153
10154         <sect1><heading><file>debian/tmp</file>
10155           </heading>
10156
10157           <p>
10158             This is the canonical temporary location for the
10159             construction of binary packages by the <tt>binary</tt>
10160             target.  The directory <file>tmp</file> serves as the root of
10161             the file system tree as it is being constructed (for
10162             example, by using the package's upstream makefiles install
10163             targets and redirecting the output there), and it also
10164             contains the <tt>DEBIAN</tt> subdirectory.  See <ref
10165             id="pkg-bincreating">.
10166           </p>
10167
10168           <p>
10169             If several binary packages are generated from the same
10170             source tree it is usual to use several
10171             <file>debian/tmp<var>something</var></file> directories, for
10172             example <file>tmp-a</file> or <file>tmp-doc</file>.
10173           </p>
10174
10175           <p>
10176             Whatever <file>tmp</file> directories are created and used by
10177             <tt>binary</tt> must of course be removed by the
10178             <tt>clean</tt> target.</p></sect1>
10179       </sect>
10180
10181
10182       <sect id="pkg-sourcearchives"><heading>Source packages as archives
10183         </heading>
10184
10185         <p>
10186           As it exists on the FTP site, a Debian source package
10187           consists of three related files.  You must have the right
10188           versions of all three to be able to use them.
10189         </p>
10190
10191         <p>
10192           <taglist>
10193             <tag>Debian source control file - <tt>.dsc</tt></tag>
10194             <item>
10195                 This file is a control file used by <prgn>dpkg-source</prgn>
10196                 to extract a source package.
10197                 See <ref id="debiansourcecontrolfiles">.
10198             </item>
10199
10200             <tag>
10201               Original source archive -
10202               <file>
10203                 <var>package</var>_<var>upstream-version</var>.orig.tar.gz
10204               </file>
10205             </tag>
10206
10207             <item>
10208               <p>
10209                 This is a compressed (with <tt>gzip -9</tt>)
10210                 <prgn>tar</prgn> file containing the source code from
10211                 the upstream authors of the program.
10212               </p>
10213             </item>
10214
10215             <tag>
10216               Debianisation diff -
10217               <file>
10218                 <var>package</var>_<var>upstream_version-revision</var>.diff.gz
10219               </file>
10220             </tag>
10221             <item>
10222
10223               <p>
10224                 This is a unified context diff (<tt>diff -u</tt>)
10225                 giving the changes which are required to turn the
10226                 original source into the Debian source.  These changes
10227                 may only include editing and creating plain files.
10228                 The permissions of files, the targets of symbolic
10229                 links and the characteristics of special files or
10230                 pipes may not be changed and no files may be removed
10231                 or renamed.
10232               </p>
10233
10234               <p>
10235                 All the directories in the diff must exist, except the
10236                 <file>debian</file> subdirectory of the top of the source
10237                 tree, which will be created by
10238                 <prgn>dpkg-source</prgn> if necessary when unpacking.
10239               </p>
10240
10241               <p>
10242                 The <prgn>dpkg-source</prgn> program will
10243                 automatically make the <file>debian/rules</file> file
10244                 executable (see below).</p></item>
10245           </taglist>
10246         </p>
10247
10248         <p>
10249           If there is no original source code - for example, if the
10250           package is specially prepared for Debian or the Debian
10251           maintainer is the same as the upstream maintainer - the
10252           format is slightly different: then there is no diff, and the
10253           tarfile is named
10254           <file><var>package</var>_<var>version</var>.tar.gz</file>,
10255           and preferably contains a directory named
10256           <file><var>package</var>-<var>version</var></file>.
10257         </p>
10258       </sect>
10259
10260       <sect>
10261         <heading>Unpacking a Debian source package without <prgn>dpkg-source</prgn></heading>
10262
10263         <p>
10264           <tt>dpkg-source -x</tt> is the recommended way to unpack a
10265           Debian source package.  However, if it is not available it
10266           is possible to unpack a Debian source archive as follows:
10267         <enumlist compact="compact">
10268           <item>
10269             <p>
10270               Untar the tarfile, which will create a <file>.orig</file>
10271               directory.</p>
10272           </item>
10273           <item>
10274             <p>Rename the <file>.orig</file> directory to
10275               <file><var>package</var>-<var>version</var></file>.</p>
10276           </item>
10277             <item>
10278             <p>
10279               Create the subdirectory <file>debian</file> at the top of
10280               the source tree.</p>
10281           </item>
10282           <item><p>Apply the diff using <tt>patch -p0</tt>.</p>
10283           </item>
10284           <item><p>Untar the tarfile again if you want a copy of the original
10285               source code alongside the Debianised version.</p>
10286           </item>
10287         </enumlist>
10288
10289         <p>
10290           It is not possible to generate a valid Debian source archive
10291           without using <prgn>dpkg-source</prgn>.  In particular,
10292           attempting to use <prgn>diff</prgn> directly to generate the
10293           <file>.diff.gz</file> file will not work.
10294         </p>
10295
10296         <sect1>
10297           <heading>Restrictions on objects in source packages</heading>
10298
10299           <p>
10300             The source package may not contain any hard links
10301             <footnote>
10302                 This is not currently detected when building source
10303                 packages, but only when extracting
10304                 them.
10305             </footnote>
10306             <footnote>
10307                 Hard links may be permitted at some point in the
10308                 future, but would require a fair amount of
10309                 work.
10310             </footnote>, device special files, sockets or setuid or
10311             setgid files.
10312             <footnote>
10313                 Setgid directories are allowed.
10314             </footnote>
10315           </p>
10316
10317           <p>
10318             The source packaging tools manage the changes between the
10319             original and Debianised source using <prgn>diff</prgn> and
10320             <prgn>patch</prgn>.  Turning the original source tree as
10321             included in the <file>.orig.tar.gz</file> into the debianised
10322             source must not involve any changes which cannot be
10323             handled by these tools.  Problematic changes which cause
10324             <prgn>dpkg-source</prgn> to halt with an error when
10325             building the source package are:
10326             <list compact="compact">
10327               <item><p>Adding or removing symbolic links, sockets or pipes.</p>
10328               </item>
10329               <item><p>Changing the targets of symbolic links.</p>
10330               </item>
10331               <item><p>Creating directories, other than <file>debian</file>.</p>
10332               </item>
10333               <item><p>Changes to the contents of binary files.</p></item>
10334             </list> Changes which cause <prgn>dpkg-source</prgn> to
10335             print a warning but continue anyway are:
10336             <list compact="compact">
10337               <item>
10338                 <p>
10339                   Removing files, directories or symlinks.
10340                   <footnote>
10341                       Renaming a file is not treated specially - it is
10342                       seen as the removal of the old file (which
10343                       generates a warning, but is otherwise ignored),
10344                       and the creation of the new one.
10345                   </footnote>
10346                 </p>
10347               </item>
10348               <item>
10349                 <p>
10350                   Changed text files which are missing the usual final
10351                   newline (either in the original or the modified
10352                   source tree).
10353                 </p>
10354               </item>
10355             </list>
10356             Changes which are not represented, but which are not detected by
10357             <prgn>dpkg-source</prgn>, are:
10358             <list compact="compact">
10359               <item><p>Changing the permissions of files (other than
10360                   <file>debian/rules</file>) and directories.</p></item>
10361             </list>
10362           </p>
10363
10364           <p>
10365             The <file>debian</file> directory and <file>debian/rules</file>
10366             are handled specially by <prgn>dpkg-source</prgn> - before
10367             applying the changes it will create the <file>debian</file>
10368             directory, and afterwards it will make
10369             <file>debian/rules</file> world-executable.
10370           </p>
10371         </sect1>
10372       </sect>
10373     </appendix>
10374
10375     <appendix id="pkg-controlfields">
10376       <heading>Control files and their fields (from old Packaging Manual)</heading>
10377
10378       <p>
10379         Many of the tools in the <prgn>dpkg</prgn> suite manipulate
10380         data in a common format, known as control files.  Binary and
10381         source packages have control data as do the <file>.changes</file>
10382         files which control the installation of uploaded files, and
10383         <prgn>dpkg</prgn>'s internal databases are in a similar
10384         format.
10385       </p>
10386
10387       <sect>
10388         <heading>Syntax of control files</heading>
10389
10390         <p>
10391           See <ref id="controlsyntax">.
10392         </p>
10393
10394         <p>
10395           It is important to note that there are several fields which
10396           are optional as far as <prgn>dpkg</prgn> and the related
10397           tools are concerned, but which must appear in every Debian
10398           package, or whose omission may cause problems.
10399         </p>
10400       </sect>
10401
10402       <sect>
10403         <heading>List of fields</heading>
10404
10405         <p>
10406           See <ref id="controlfieldslist">.
10407         </p>
10408
10409         <p>
10410           This section now contains only the fields that didn't belong
10411           to the Policy manual.
10412         </p>
10413
10414         <sect1 id="pkg-f-Filename">
10415           <heading><tt>Filename</tt> and <tt>MSDOS-Filename</tt></heading>
10416
10417           <p>
10418             These fields in <tt>Packages</tt> files give the
10419             filename(s) of (the parts of) a package in the
10420             distribution directories, relative to the root of the
10421             Debian hierarchy.  If the package has been split into
10422             several parts the parts are all listed in order, separated
10423             by spaces.
10424           </p>
10425         </sect1>
10426
10427         <sect1 id="pkg-f-Size">
10428           <heading><tt>Size</tt> and <tt>MD5sum</tt></heading>
10429
10430           <p>
10431             These fields in <file>Packages</file> files give the size (in
10432             bytes, expressed in decimal) and MD5 checksum of the
10433             file(s) which make(s) up a binary package in the
10434             distribution.  If the package is split into several parts
10435             the values for the parts are listed in order, separated by
10436             spaces.
10437           </p>
10438         </sect1>
10439
10440         <sect1 id="pkg-f-Status">
10441           <heading><tt>Status</tt></heading>
10442
10443           <p>
10444             This field in <prgn>dpkg</prgn>'s status file records
10445             whether the user wants a package installed, removed or
10446             left alone, whether it is broken (requiring
10447             re-installation) or not and what its current state on the
10448             system is.  Each of these pieces of information is a
10449             single word.
10450           </p>
10451         </sect1>
10452
10453         <sect1 id="pkg-f-Config-Version">
10454           <heading><tt>Config-Version</tt></heading>
10455
10456           <p>
10457             If a package is not installed or not configured, this
10458             field in <prgn>dpkg</prgn>'s status file records the last
10459             version of the package which was successfully
10460             configured.
10461           </p>
10462         </sect1>
10463
10464         <sect1 id="pkg-f-Conffiles">
10465           <heading><tt>Conffiles</tt></heading>
10466
10467           <p>
10468             This field in <prgn>dpkg</prgn>'s status file contains
10469             information about the automatically-managed configuration
10470             files held by a package.  This field should <em>not</em>
10471             appear anywhere in a package!
10472           </p>
10473         </sect1>
10474
10475         <sect1>
10476           <heading>Obsolete fields</heading>
10477
10478           <p>
10479             These are still recognized by <prgn>dpkg</prgn> but should
10480             not appear anywhere any more.
10481
10482             <taglist compact="compact">
10483
10484               <tag><tt>Revision</tt></tag>
10485               <tag><tt>Package-Revision</tt></tag>
10486               <tag><tt>Package_Revision</tt></tag>
10487               <item>
10488                   The Debian revision part of the package version was
10489                   at one point in a separate control file field.  This
10490                   field went through several names.
10491               </item>
10492
10493               <tag><tt>Recommended</tt></tag>
10494               <item>Old name for <tt>Recommends</tt>.</item>
10495
10496               <tag><tt>Optional</tt></tag>
10497               <item>Old name for <tt>Suggests</tt>.</item>
10498
10499               <tag><tt>Class</tt></tag>
10500               <item>Old name for <tt>Priority</tt>.</item>
10501
10502             </taglist>
10503           </p>
10504         </sect1>
10505       </sect>
10506
10507     </appendix>
10508
10509     <appendix id="pkg-conffiles">
10510       <heading>Configuration file handling (from old Packaging Manual)</heading>
10511
10512       <p>
10513         <prgn>dpkg</prgn> can do a certain amount of automatic
10514         handling of package configuration files.
10515       </p>
10516
10517       <p>
10518         Whether this mechanism is appropriate depends on a number of
10519         factors, but basically there are two approaches to any
10520         particular configuration file.
10521       </p>
10522
10523       <p>
10524         The easy method is to ship a best-effort configuration in the
10525         package, and use <prgn>dpkg</prgn>'s conffile mechanism to
10526         handle updates.  If the user is unlikely to want to edit the
10527         file, but you need them to be able to without losing their
10528         changes, and a new package with a changed version of the file
10529         is only released infrequently, this is a good approach.
10530       </p>
10531
10532       <p>
10533         The hard method is to build the configuration file from
10534         scratch in the <prgn>postinst</prgn> script, and to take the
10535         responsibility for fixing any mistakes made in earlier
10536         versions of the package automatically.  This will be
10537         appropriate if the file is likely to need to be different on
10538         each system.
10539       </p>
10540
10541       <sect><heading>Automatic handling of configuration files by
10542       <prgn>dpkg</prgn>
10543         </heading>
10544
10545         <p>
10546           A package may contain a control area file called
10547           <tt>conffiles</tt>.  This file should be a list of filenames
10548           of configuration files needing automatic handling, separated
10549           by newlines.  The filenames should be absolute pathnames,
10550           and the files referred to should actually exist in the
10551           package.
10552         </p>
10553
10554         <p>
10555           When a package is upgraded <prgn>dpkg</prgn> will process
10556           the configuration files during the configuration stage,
10557           shortly before it runs the package's <prgn>postinst</prgn>
10558           script,
10559         </p>
10560
10561         <p>
10562           For each file it checks to see whether the version of the
10563           file included in the package is the same as the one that was
10564           included in the last version of the package (the one that is
10565           being upgraded from); it also compares the version currently
10566           installed on the system with the one shipped with the last
10567           version.
10568         </p>
10569
10570         <p>
10571           If neither the user nor the package maintainer has changed
10572           the file, it is left alone.  If one or the other has changed
10573           their version, then the changed version is preferred - i.e.,
10574           if the user edits their file, but the package maintainer
10575           doesn't ship a different version, the user's changes will
10576           stay, silently, but if the maintainer ships a new version
10577           and the user hasn't edited it the new version will be
10578           installed (with an informative message).  If both have
10579           changed their version the user is prompted about the problem
10580           and must resolve the differences themselves.
10581         </p>
10582
10583         <p>
10584           The comparisons are done by calculating the MD5 message
10585           digests of the files, and storing the MD5 of the file as it
10586           was included in the most recent version of the package.
10587         </p>
10588
10589         <p>
10590           When a package is installed for the first time
10591           <prgn>dpkg</prgn> will install the file that comes with it,
10592           unless that would mean overwriting a file already on the
10593           file system.
10594         </p>
10595
10596         <p>
10597           However, note that <prgn>dpkg</prgn> will <em>not</em>
10598           replace a conffile that was removed by the user (or by a
10599           script).  This is necessary because with some programs a
10600           missing file produces an effect hard or impossible to
10601           achieve in another way, so that a missing file needs to be
10602           kept that way if the user did it.
10603         </p>
10604
10605         <p>
10606           Note that a package should <em>not</em> modify a
10607           <prgn>dpkg</prgn>-handled conffile in its maintainer
10608           scripts.  Doing this will lead to <prgn>dpkg</prgn> giving
10609           the user confusing and possibly dangerous options for
10610           conffile update when the package is upgraded.</p>
10611       </sect>
10612
10613       <sect><heading>Fully-featured maintainer script configuration
10614       handling
10615         </heading>
10616
10617         <p>
10618           For files which contain site-specific information such as
10619           the hostname and networking details and so forth, it is
10620           better to create the file in the package's
10621           <prgn>postinst</prgn> script.
10622         </p>
10623
10624         <p>
10625           This will typically involve examining the state of the rest
10626           of the system to determine values and other information, and
10627           may involve prompting the user for some information which
10628           can't be obtained some other way.
10629         </p>
10630
10631         <p>
10632           When using this method there are a couple of important
10633           issues which should be considered:
10634         </p>
10635
10636         <p>
10637           If you discover a bug in the program which generates the
10638           configuration file, or if the format of the file changes
10639           from one version to the next, you will have to arrange for
10640           the postinst script to do something sensible - usually this
10641           will mean editing the installed configuration file to remove
10642           the problem or change the syntax.  You will have to do this
10643           very carefully, since the user may have changed the file,
10644           perhaps to fix the very problem that your script is trying
10645           to deal with - you will have to detect these situations and
10646           deal with them correctly.
10647         </p>
10648
10649         <p>
10650           If you do go down this route it's probably a good idea to
10651           make the program that generates the configuration file(s) a
10652           separate program in <file>/usr/sbin</file>, by convention called
10653           <file><var>package</var>config</file> and then run that if
10654           appropriate from the post-installation script.  The
10655           <tt><var>package</var>config</tt> program should not
10656           unquestioningly overwrite an existing configuration - if its
10657           mode of operation is geared towards setting up a package for
10658           the first time (rather than any arbitrary reconfiguration
10659           later) you should have it check whether the configuration
10660           already exists, and require a <tt>--force</tt> flag to
10661           overwrite it.</p></sect>
10662     </appendix>
10663
10664     <appendix id="pkg-alternatives"><heading>Alternative versions of
10665         an interface - <prgn>update-alternatives</prgn> (from old
10666     Packaging Manual)
10667       </heading>
10668
10669       <p>
10670         When several packages all provide different versions of the
10671         same program or file it is useful to have the system select a
10672         default, but to allow the system administrator to change it
10673         and have their decisions respected.
10674       </p>
10675
10676       <p>
10677         For example, there are several versions of the <prgn>vi</prgn>
10678         editor, and there is no reason to prevent all of them from
10679         being installed at once, each under their own name
10680         (<prgn>nvi</prgn>, <prgn>vim</prgn> or whatever).
10681         Nevertheless it is desirable to have the name <tt>vi</tt>
10682         refer to something, at least by default.
10683       </p>
10684
10685       <p>
10686         If all the packages involved cooperate, this can be done with
10687         <prgn>update-alternatives</prgn>.
10688       </p>
10689
10690       <p>
10691         Each package provides its own version under its own name, and
10692         calls <prgn>update-alternatives</prgn> in its postinst to
10693         register its version (and again in its prerm to deregister
10694         it).
10695       </p>
10696
10697       <p>
10698         See the man page <manref name="update-alternatives"
10699         section="8"> for details.
10700       </p>
10701
10702       <p>
10703         If <prgn>update-alternatives</prgn> does not seem appropriate
10704         you may wish to consider using diversions instead.</p>
10705     </appendix>
10706
10707     <appendix id="pkg-diversions"><heading>Diversions - overriding a
10708     package's version of a file (from old Packaging Manual)
10709       </heading>
10710
10711       <p>
10712         It is possible to have <prgn>dpkg</prgn> not overwrite a file
10713         when it reinstalls the package it belongs to, and to have it
10714         put the file from the package somewhere else instead.
10715       </p>
10716
10717       <p>
10718         This can be used locally to override a package's version of a
10719         file, or by one package to override another's version (or
10720         provide a wrapper for it).
10721       </p>
10722
10723       <p>
10724         Before deciding to use a diversion, read <ref
10725         id="pkg-alternatives"> to see if you really want a diversion
10726         rather than several alternative versions of a program.
10727       </p>
10728
10729       <p>
10730         There is a diversion list, which is read by <prgn>dpkg</prgn>,
10731         and updated by a special program <prgn>dpkg-divert</prgn>.
10732         Please see <manref name="dpkg-divert" section="8"> for full
10733         details of its operation.
10734       </p>
10735
10736       <p>
10737         When a package wishes to divert a file from another, it should
10738         call <prgn>dpkg-divert</prgn> in its preinst to add the
10739         diversion and rename the existing file.  For example,
10740         supposing that a <prgn>smailwrapper</prgn> package wishes to
10741         install a wrapper around <file>/usr/sbin/smail</file>:
10742         <example>
10743    dpkg-divert --package smailwrapper --add --rename \
10744       --divert /usr/sbin/smail.real /usr/sbin/smail
10745         </example> The <tt>--package smailwrapper</tt> ensures that
10746         <prgn>smailwrapper</prgn>'s copy of <file>/usr/sbin/smail</file>
10747         can bypass the diversion and get installed as the true version.
10748         It's safe to add the diversion unconditionally on upgrades since
10749         it will be left unchanged if it already exists, but
10750         <prgn>dpkg-divert</prgn> will display a message.  To suppress that
10751         message, make the command conditional on the version from which
10752         the package is being upgraded:
10753         <example>
10754    if [ upgrade != "$1" ] || dpkg --compare-versions "$2" lt 1.0-2; then
10755       dpkg-divert --package smailwrapper --add --rename \
10756          --divert /usr/sbin/smail.real /usr/sbin/smail
10757    fi
10758         </example> where <tt>1.0-2</tt> is the version at which the
10759         diversion was first added to the package.  Running the command
10760         during abort-upgrade is pointless but harmless.
10761       </p>
10762
10763       <p>
10764         The postrm has to do the reverse:
10765         <example>
10766   if [ remove = "$1" -o abort-install = "$1" -o disappear = "$1" ]; then
10767      dpkg-divert --package smailwrapper --remove --rename \
10768         --divert /usr/sbin/smail.real /usr/sbin/smail
10769   fi
10770         </example> If the diversion was added at a particular version, the
10771         postrm should also handle the failure case of upgrading from an
10772         older version (unless the older version is so old that direct
10773         upgrades are no longer supported):
10774         <example>
10775   if [ abort-upgrade = "$1" ] && dpkg --compare-versions "$2" lt 1.0-2; then
10776      dpkg-divert --package smailwrapper --remove --rename \
10777         --divert /usr/sbin/smail.real /usr/sbin/smail
10778   fi
10779         </example> where <tt>1.02-2</tt> is the version at which the
10780         diversion was first added to the package.  The postrm should not
10781         remove the diversion on upgrades both because there's no reason to
10782         remove the diversion only to immediately re-add it and since the
10783         postrm of the old package is run after unpacking so the removal of
10784         the diversion will fail.
10785       </p>
10786
10787       <p>
10788         Do not attempt to divert a file which is vitally important for
10789         the system's operation - when using <prgn>dpkg-divert</prgn>
10790         there is a time, after it has been diverted but before
10791         <prgn>dpkg</prgn> has installed the new version, when the file
10792         does not exist.</p>
10793     </appendix>
10794
10795   </book>
10796 </debiandoc>
10797 <!-- Local variables: -->
10798 <!-- indent-tabs-mode: t -->
10799 <!-- End: -->
10800 <!-- vim:set ai et sts=2 sw=2 tw=76: -->