X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=policy.sgml;h=0bf1001f2486ae6ff362216a9efc69f0c09581fb;hb=c74ac744418a3a09b897fba405045aa079a086d2;hp=7d54e2920623f12542491f21d95e408885d6bed3;hpb=4e4e5d8bb9e85c94c19208a79ae61b7173bba55a;p=debian%2Fdebian-policy.git diff --git a/policy.sgml b/policy.sgml index 7d54e29..0bf1001 100644 --- a/policy.sgml +++ b/policy.sgml @@ -24,6 +24,13 @@ Copyright © 1996,1997,1998 Ian Jackson and Christian Schwarz. +

+ These are the copyright dates of the original Policy manual. + Since then, this manual has been updated by many others. No + comprehensive collection of copyright notices for subsequent + work exists. +

+

This manual is free software; you may redistribute it and/or modify it under the terms of the GNU General Public License @@ -318,8 +325,12 @@ system, but not every package we want to make accessible is free in our sense (see the Debian Free Software Guidelines, below), or may be imported/exported without - restrictions. Thus, the archive is split into the distribution - areas or categories based on their licenses and other restrictions. + restrictions. Thus, the archive is split into areas + The Debian archive software uses the term "component" internally + and in the Release file format to refer to the division of an + archive. The Debian Social Contract simply refers to "areas." + This document uses terminology similar to the Social Contract. + based on their licenses and other restrictions.

@@ -336,12 +347,12 @@

- The main category forms the - Debian GNU/Linux distribution. + The main archive area forms the Debian GNU/Linux + distribution.

- Packages in the other distribution areas (contrib, + Packages in the other archive areas (contrib, non-free) are not considered to be part of the Debian distribution, although we support their use and provide infrastructure for them (such as our bug-tracking system and @@ -448,10 +459,10 @@ - Categories + Archive areas - The main category + The main archive area

Every package in main must comply with the DFSG @@ -482,7 +493,7 @@ - The contrib category + The contrib archive area

Every package in contrib must comply with the DFSG. @@ -522,7 +533,7 @@ - The non-free category + The non-free archive area

Packages must be placed in non-free if they are @@ -638,27 +649,27 @@ Sections

- The packages in the categories main, - contrib and non-free are grouped further - into sections to simplify handling. + The packages in the archive areas main, + contrib and non-free are grouped further into + sections to simplify handling.

- The category and section for each package should be - specified in the package's Section control record - (see ). However, the maintainer of the - Debian archive may override this selection to ensure the - consistency of the Debian distribution. The - Section field should be of the form: + The archive area and section for each package should be + specified in the package's Section control record (see + ). However, the maintainer of the Debian + archive may override this selection to ensure the consistency of + the Debian distribution. The Section field should be + of the form: section if the package is in the - main category, + main archive area, - segment/section if the package is in + area/section if the package is in the contrib or non-free - distribution areas. + archive areas.

@@ -666,18 +677,20 @@

The Debian archive maintainers provide the authoritative list of sections. At present, they are: - admin, comm, - devel, doc, - editors, electronics, embedded, - games, gnome, graphics, - hamradio, interpreters, kde, - libs, libdevel, mail, - math, misc, net, news, - oldlibs, - otherosfs, perl, python, - science, shells, - sound, tex, text, - utils, web, x11. + admin, cli-mono, comm, database, + devel, debug, doc, editors, + electronics, embedded, fonts, + games, gnome, graphics, gnu-r, + gnustep, hamradio, haskell, + httpd, interpreters, java, kde, + kernel, libs, libdevel, lisp, + localization, mail, math, misc, + net, news, ocaml, oldlibs, + otherosfs, perl, php, python, + ruby, science, shells, sound, + tex, text, utils, vcs, + video, web, x11, xfce, + zope.

@@ -753,7 +766,8 @@ with required, important, standard or optional priorities, or are only likely to be useful if you already know what they are or have specialized - requirements. + requirements (such as packages containing only detached + debugging symbols).

@@ -1011,29 +1025,23 @@ (see below), and should not do so unless they depend on a particular version of that package.

- Essential is defined as the minimal set of functionality - that must be available and usable on the system even - when packages are in an unconfigured (but unpacked) - state. This is needed to avoid unresolvable dependency - loops on upgrade. If packages add unnecessary - dependencies on packages in this set, the chances that - there will be an unresolvable - dependency loop caused by forcing these Essential - packages to be configured first before they need to be - is greatly increased. It also increases the chances - that frontends will be unable to - calculate an upgrade path, even if one - exists. + Essential is needed in part to avoid unresolvable dependency + loops on upgrade. If packages add unnecessary dependencies + on packages in this set, the chances that there + will be an unresolvable dependency loop + caused by forcing these Essential packages to be configured + first before they need to be is greatly increased. It also + increases the chances that frontends will be unable to + calculate an upgrade path, even if one + exists.

- Also, it's pretty unlikely that functionality from - Essential shall ever be removed (which is one reason why - care must be taken before adding to the Essential - packages set), but packages have been removed - from the Essential set when the functionality moved to a - different package. So depending on these packages - just in case they stop being essential does way - more harm than good. + Also, functionality is rarely ever removed from the + Essential set, but packages have been removed from + the Essential set when the functionality moved to a + different package. So depending on these packages just + in case they stop being essential does way more harm + than good.

@@ -1120,10 +1128,13 @@ Essential packages

- Some packages are tagged essential for a system - using the Essential control file field. - The format of the Essential control field is - described in . + Essential is defined as the minimal set of functionality that + must be available and usable on the system at all times, even + when packages are in an unconfigured (but unpacked) state. + Packages are tagged essential for a system using the + Essential control file field. The format of the + Essential control field is described in .

@@ -1147,6 +1158,19 @@ appropriate.

+

+ Maintainers should take great care in adding any programs, + interfaces, or functionality to essential packages. + Packages may assume that functionality provided by + essential packages is always available without + declaring explicit dependencies, which means that removing + functionality from the Essential set is very difficult and is + almost never done. Any capability added to an + essential package therefore creates an obligation to + support that capability as part of the Essential set in + perpetuity. +

+

You must not tag any packages essential before this has been discussed on the debian-devel @@ -1203,21 +1227,20 @@ Prompting in maintainer scripts

Package maintainer scripts may prompt the user if - necessary. Prompting should be done by communicating + necessary. Prompting must be done by communicating through a program, such as debconf, which - conforms to the Debian Configuration management - specification, version 2 or higher. Prompting the user by - other means, such as by hand - From the Jargon file: by hand 2. By extension, - writing code which does something in an explicit or - low-level way for which a presupplied library - (debconf, in this instance) routine ought - to have been available. - , is now deprecated. + conforms to the Debian Configuration Management + Specification, version 2 or higher. +

+ +

+ Packages which are essential, or which are dependencies of + essential packages, may fall back on another prompting method + if no such interface is available when they are executed.

- The Debian Configuration management specification is included + The Debian Configuration Management Specification is included in the debconf_specification files in the debian-policy package. It is also available from the Debian web mirrors at @@ -1226,8 +1249,8 @@

- Packages which use the Debian Configuration management - specification may contain an additional + Packages which use the Debian Configuration Management + Specification may contain an additional config script and a templates file in their control archive The control.tar.gz inside the .deb. @@ -1239,18 +1262,18 @@ Therefore it must work using only the tools present in essential packages. Debconf or another tool that - implements the Debian Configuration management - specification will also be installed, and any + implements the Debian Configuration Management + Specification will also be installed, and any versioned dependencies on it will be satisfied before preconfiguration begins.

- Packages which use the Debian Configuration management - specification must allow for translation of their messages - by using a gettext-based system such as the one provided by - the po-debconf package. + Packages which use the Debian Configuration Management + Specification must allow for translation of their user-visible + messages by using a gettext-based system such as the one + provided by the po-debconf package.

@@ -1620,7 +1643,7 @@ its copyright and distribution license in the file /usr/share/doc/package/copyright (see for further details). Also see - for further considerations relayed + for further considerations related to copyrights for packages.

@@ -1969,6 +1992,12 @@ DEB_*_ARCH (the Debian architecture) + + DEB_*_ARCH_CPU (the Debian CPU name) + + + DEB_*_ARCH_OS (the Debian System name) + DEB_*_GNU_TYPE (the GNU style architecture specification string) @@ -1997,8 +2026,10 @@ It is important to understand that the DEB_*_ARCH string only determines which Debian architecture we are building on or for. It should not be used to get the CPU - or system information; the GNU style variables should be - used for that. + or system information; the DEB_*_ARCH_CPU and + DEB_*_ARCH_OS variables should be used for that. + GNU style variables should generally only be used with upstream + build systems.

@@ -2348,6 +2379,8 @@ Package: libc6

Field names are not case-sensitive, but it is usual to capitalize the field names using mixed case as shown below. + Field values are case-sensitive unless the description of the + field says otherwise.

@@ -2435,6 +2468,15 @@ Package: libc6 See for details.

+

+ In addition to the control file syntax described above, this file may also contain + comment lines starting with # without any preceding + whitespace. All such lines are ignored, even in the middle of + continuation lines for a multiline field, and do not end a + multiline field. +

+ @@ -2563,6 +2605,15 @@ Package: libc6 package control file when the source package has the same name and version as the binary package.

+ +

+ Package names (both source and binary, + see ) must consist only of lower case + letters (a-z), digits (0-9), plus + (+) and minus (-) signs, and periods + (.). They must be at least two characters long and + must start with an alphanumeric character. +

@@ -2660,11 +2711,9 @@ Package: libc6

- Package names must consist only of lower case letters - (a-z), digits (0-9), plus (+) - and minus (-) signs, and periods (.). - They must be at least two characters long and must start - with an alphanumeric character. + Binary package names must follow the same syntax and + restrictions as source package names. See + for the details.

@@ -2677,7 +2726,7 @@ Package: libc6 values: A unique single word identifying a Debian machine - architecture, see . + architecture as described in . all, which indicates an architecture-independent package. any, which indicates a package available @@ -2688,31 +2737,53 @@ Package: libc6

In the main debian/control file in the source - package, or in the source package control file - .dsc, one may specify a list of architectures - separated by spaces, or the special values any or - all. + package, this field may contain the special value + any, the special value all, or a list of + architectures separated by spaces. If any or + all appear, they must be the entire contents of the + field. Most packages will use either any or + all. Specifying a specific list of architectures is + for the minority of cases where a program is not portable or + is not useful on some architectures, and where possible the + program should be made portable instead. +

+ +

+ In the source package control file .dsc, this + field may contain either the special value any or a + list of architectures separated by spaces. If a list is given, + it may include (or consist solely of) the special value + all. In other words, in .dsc files + unlike the debian/control, all may occur + in combination with specific architectures. The + Architecture field in the source package control file + .dsc is generally constructed from the + Architecture fields in the + debian/control in the source package.

Specifying any indicates that the source package isn't dependent on any particular architecture and should compile fine on any one. The produced binary package(s) - will be specific to whatever the current build architecture - is. - This is the most often used setting, and is recommended - for new packages that aren't Architecture: all. - + will either be specific to whatever the current build + architecture is or will be architecture-independent. +

+ +

+ Specifying only all indicates that the source package + will only build architecture-independent packages. If this is + the case, all must be used rather than any; + any implies that the source package will build at + least one architecture-dependent package.

Specifying a list of architectures indicates that the source will build an architecture-dependent package, and will only - work correctly on the listed architectures. - This is a setting used for a minority of cases where the - program is not portable. Generally, it should not be used - for new packages. - + work correctly on the listed architectures. If the source + package also builds at least one architecture-independent + package, all will also be included in the list.

@@ -2720,7 +2791,11 @@ Package: libc6 field lists the architecture(s) of the package(s) currently being uploaded. This will be a list; if the source for the package is also being uploaded, the special - entry source is also present. + entry source is also present. all will be + present if any architecture-independent packages are being + uploaded. any may never occur in the + Architecture field in the .changes + file.

@@ -3028,18 +3103,16 @@ Package: libc6

- In a .changes file, the Description field - contains a summary of the descriptions for the packages being - uploaded. -

- -

- The part of the field before the first newline is empty; - thereafter each line has the name of a binary package and - the summary description line from that binary package. - Each line is indented by one space. + In a .changes file, the Description + field contains a summary of the descriptions for the packages + being uploaded. For this case, the first line of the field + value (the part on the same line as Description:) is + always empty. The content of the field is expressed as + continuation lines, one line per package. Each line is + indented by one space and contains the name of a binary + package, a space, a hyphen (-), a space, and the + short description line from that package.

- @@ -3051,76 +3124,39 @@ Package: libc6 distribution(s) where this version of the package should be installed. Valid distributions are determined by the archive maintainers. - Current distribution names are: + Example distribution names in the Debian archive used in + .changes files are: - stable - - This is the current "released" version of Debian - GNU/Linux. Once the distribution is - stable only security fixes and other - major bug fixes are allowed. When changes are - made to this distribution, the release number is - increased (for example: 2.2r1 becomes 2.2r2 then - 2.2r3, etc). - - unstable - This distribution value refers to the - developmental part of the Debian - distribution tree. New packages, new upstream - versions of packages and bug fixes go into the - unstable directory tree. Download from - this distribution at your own risk. - - - testing - - This distribution value refers to the - testing part of the Debian distribution - tree. It receives its packages from the - unstable distribution after a short time lag to - ensure that there are no major issues with the - unstable packages. It is less prone to breakage - than unstable, but still risky. It is not - possible to upload packages directly to - testing. - - - frozen - - From time to time, the testing - distribution enters a state of "code-freeze" in - anticipation of release as a stable - version. During this period of testing only - fixes for existing or newly-discovered bugs will - be allowed. The exact details of this stage are - determined by the Release Manager. + This distribution value refers to the + developmental part of the Debian distribution + tree. Most new packages, new upstream versions of + packages and bug fixes go into the unstable + directory tree. experimental - The packages with this distribution value are - deemed by their maintainers to be high - risk. Oftentimes they represent early beta or - developmental packages from various sources that - the maintainers want people to try, but are not - ready to be a part of the other parts of the - Debian distribution tree. Download at your own - risk. + The packages with this distribution value are deemed + by their maintainers to be high risk. Oftentimes they + represent early beta or developmental packages from + various sources that the maintainers want people to + try, but are not ready to be a part of the other parts + of the Debian distribution tree.

- You should list all distributions that the - package should be installed into. -

- -

- More information is available in the Debian Developer's - Reference, section "The Debian archive". + Others are used for updating stable releases or for + security uploads. More information is available in the + Debian Developer's Reference, section "The Debian + archive".

+ The Debian archive software only supports listing a single + distribution. Migration of packages to other distributions is + handled outside of the upload process.

@@ -3193,10 +3229,12 @@ Package: libc6

- There should be nothing in this field before the first - newline; all the subsequent lines must be indented by at - least one space; blank lines must be represented by a line - consisting only of a space and a full stop. + The first line of the field value (the part on the same line + as Changes:) is always empty. The content of the + field is expressed as continuation lines, with each line + indented by at least one space. Blank lines must be + represented by a line consisting only of a space and a full + stop (.).

@@ -3224,29 +3262,27 @@ Package: libc6 Binary

- This field is a list of binary packages. + This field is a list of binary packages. Its syntax and + meaning varies depending on the control file in which it + appears.

- When it appears in the .dsc file it is the list - of binary packages which a source package can produce. It - does not necessarily produce all of these binary packages - for every architecture. The source control file doesn't - contain details of which architectures are appropriate for - which of the binary packages. + When it appears in the .dsc file, it lists binary + packages which a source package can produce, separated by + commas + A space after each comma is conventional. + . It may span multiple lines. The source package + does not necessarily produce all of these binary packages for + every architecture. The source control file doesn't contain + details of which architectures are appropriate for which of + the binary packages.

- When it appears in a .changes file it lists the - names of the binary packages actually being uploaded. -

- -

- The syntax is a list of binary packages separated by - commas - A space after each comma is conventional. - . Currently the packages must be separated using - only spaces in the .changes file. + When it appears in a .changes file, it lists the + names of the binary packages being uploaded, separated by + whitespace (not commas). It may span multiple lines.

@@ -3254,15 +3290,17 @@ Package: libc6 Installed-Size

- This field appears in the control files of binary - packages, and in the Packages files. It gives - the total amount of disk space required to install the - named package. + This field appears in the control files of binary packages, + and in the Packages files. It gives an estimate + of the total amount of disk space required to install the + named package. Actual installed size may vary based on block + size, file system properties, or actions taken by package + maintainer scripts.

- The disk space is represented in kilobytes as a simple - decimal number. + The disk space is given as the integer value of the estimated + installed size in bytes, divided by 1024 and rounded up.

@@ -3272,20 +3310,30 @@ Package: libc6

This field contains a list of files with information about each one. The exact information and syntax varies with - the context. In all cases the part of the field - contents on the same line as the field name is empty. The - remainder of the field is one line per file, each line - being indented by one space and containing a number of - sub-fields separated by spaces. + the context. +

+ +

+ In all cases, Files is a multiline field. The first line of + the field value (the part on the same line as Files:) + is always empty. The content of the field is expressed as + continuation lines, one line per file. Each line must be + indented by one space and contain a number of sub-fields, + separated by spaces, as described below.

In the .dsc file, each line contains the MD5 - checksum, size and filename of the tar file and (if applicable) - diff file which make up the remainder of the source - package - That is, the parts which are not the .dsc. - . + checksum, size and filename of the tar file and (if + applicable) diff file which make up the remainder of the + source package + That is, the parts which are not the .dsc. + . For example: + +Files: + c6f698f19f2a2aa07dbb9bbda90a2754 571925 example_1.2.orig.tar.gz + 938512f08422f3509ff36f125f5873ba 6220 example_1.2-1.diff.gz + The exact forms of the filenames are described in .

@@ -3293,14 +3341,20 @@ Package: libc6

In the .changes file this contains one line per file being uploaded. Each line contains the MD5 checksum, - size, section and priority and the filename. + size, section and priority and the filename. For example: + +Files: + 4c31ab7bfc40d3cf49d7811987390357 1428 text extra example_1.2-1.dsc + c6f698f19f2a2aa07dbb9bbda90a2754 571925 text extra example_1.2.orig.tar.gz + 938512f08422f3509ff36f125f5873ba 6220 text extra example_1.2-1.diff.gz + 7c98fe853b3bbb47a00e5cd129b6cb56 703542 text extra example_1.2-1_i386.deb + The section - and priority - are the values of the corresponding fields in - the main source control file. If no section or priority is - specified then - should be used, though section - and priority values must be specified for new packages to - be installed properly. + and priority are the values of + the corresponding fields in the main source control file. If + no section or priority is specified then - should be + used, though section and priority values must be specified for + new packages to be installed properly.

@@ -3425,8 +3479,7 @@ Package: libc6 scripts this means that you almost always need to use set -e (this is usually true when writing shell scripts, in fact). It is also important, of course, that - they don't exit with a non-zero status if everything went - well. + they exit with a zero status if everything went well.

@@ -4178,6 +4231,22 @@ Build-Depends-Indep: texinfo Build-Depends: kernel-headers-2.2.10 [!hurd-i386], hurd-dev [hurd-i386], gnumach-dev [hurd-i386] + requires kernel-headers-2.2.10 on all architectures + other than hurd-i386 and requires hurd-dev and + gnumach-dev only on hurd-i386. +

+ +

+ If the architecture-restricted dependency is part of a set of + alternatives using |, that alternative is ignored + completely on architectures that do not match the restriction. + For example: + +Build-Depends: foo [!i386] | bar [!amd64] + + is equivalent to bar on the i386 architecture, to + foo on the amd64 architecture, and to foo | + bar on all other architectures.

@@ -4207,6 +4276,9 @@ Build-Depends: kernel-headers-2.2.10 [!hurd-i386], This is done using the Depends, Pre-Depends, Recommends, Suggests, Enhances, Breaks and Conflicts control file fields. + Breaks is described in , and + Conflicts is described in . The + rest are described below.

@@ -4394,12 +4466,6 @@ Build-Depends: kernel-headers-2.2.10 [!hurd-i386], Packages which break other packages - Breaks -

- Using Breaks may cause problems for upgrades from older - versions of Debian and should not be used until the stable - release of Debian supports Breaks. -

-

When one binary package declares that it breaks another, dpkg will refuse to allow the package which @@ -4484,8 +4550,7 @@ Build-Depends: kernel-headers-2.2.10 [!hurd-i386], dpkg from upgrading or installing the package which declared such a conflict until the upgrade or removal of the conflicted-with package had been completed. Instead, - Breaks may be used (once Breaks is supported - by the stable release of Debian). + Breaks may be used.

@@ -5486,23 +5551,16 @@ libbar 1 bar1 (>= 1.0-1) - File system Structure + File System Structure

The location of all installed files and directories must - comply with the File system Hierarchy Standard (FHS), + comply with the Filesystem Hierarchy Standard (FHS), version 2.3, with the exceptions noted below, and except where doing so would violate other terms of Debian Policy. The following exceptions to the FHS apply: - -

- Legacy XFree86 servers are permitted to retain the - configuration file location - /etc/X11/XF86Config-4. -

-

The optional rules related to user specific @@ -5524,6 +5582,40 @@ libbar 1 bar1 (>= 1.0-1) for 64 bit binaries is removed.

+ +

+ The requirement for object files, internal binaries, and + libraries, including libc.so.*, to be located + directly under /lib{,32} and + /usr/lib{,32} is amended, permitting files + to instead be installed to + /lib/triplet and + /usr/lib/triplet, where + triplet is the value returned by + dpkg-architecture -qDEB_HOST_GNU_TYPE for the + architecture of the package. Packages may not + install files to any triplet path other + than the one matching the architecture of that package; + for instance, an Architecture: amd64 package + containing 32-bit x86 libraries may not install these + libraries to /usr/lib/i486-linux-gnu. + + This is necessary in order to reserve the directories for + use in cross-installation of library packages from other + architectures, as part of the planned deployment of + multiarch. + +

+

+ Applications may also use a single subdirectory under + /usr/lib/triplet. +

+

+ The execution time linker/loader, ld*, must still be made + available in the existing location under /lib or /lib64 + since this is part of the ELF ABI for the architecture. +

+

The requirement that @@ -5664,12 +5756,6 @@ rmdir /usr/local/share/emacs 2>/dev/null || true by any particular mail agents. The use of the old location /var/spool/mail is deprecated, even though the spool may still be physically located there. - To maintain partial upgrade compatibility for systems - which have /var/spool/mail as their physical mail - spool, packages using /var/mail must depend on - either libc6 (>= 2.1.3-13), or on - base-files (>= 2.2.0), or on later - versions of either one of these packages.

@@ -5909,13 +5995,6 @@ rmdir /usr/local/share/emacs 2>/dev/null || true K prefix, but they too are called with the single argument stop.

- -

- Also, if the script name ends in .sh, the script - will be sourced in runlevel S rather than being - run in a forked subprocess, but will be explicitly run by - sh in all other runlevels. -

@@ -6039,6 +6118,18 @@ test -f program-executed-later-in-script || exit 0 script must behave sensibly and not fail if the /etc/default file is deleted.

+ +

+ /var/run and /var/lock may be mounted + as temporary filesystems + For example, using the RAMRUN and RAMLOCK + options in /etc/default/rcS. + , so the init.d scripts must handle this + correctly. This will typically amount to creating any required + subdirectories dynamically when the init.d script + is run, rather than including them in the package and relying on + dpkg to create them. +

@@ -6337,10 +6428,10 @@ echo "Setting DNS domainname to \"$domainname\"."

- Note that the same symbol (") is used for the left - and right quotation marks. A grave accent (`) is - not a quote character; neither is an apostrophe - ('). + Note that the same symbol (") is used + for the left and right quotation marks. A grave accent + (`) is not a quote character; neither is an + apostrophe (').

@@ -6940,17 +7031,6 @@ strip --strip-unneeded your-lib

-

- Packages containing shared libraries that may be linked to - by other packages' binaries, but which for some - compelling reason can not be installed in - /usr/lib directory, may install the shared library - files in subdirectories of the /usr/lib directory, - in which case they should arrange to add that directory in - /etc/ld.so.conf in the package's post-installation - script, and remove it in the package's post-removal script. -

-

An ever increasing number of packages are using libtool to do their linking. The latest GNU @@ -7732,9 +7812,17 @@ do fi done - The corresponding dpkg-statoverride --remove - calls can then be made unconditionally when the package is - purged. + The corresponding code to remove the override when the package + is purged would be: + +for i in /usr/bin/foo /usr/sbin/bar +do + if dpkg-statoverride --list $i >/dev/null 2>&1 + then + dpkg-statoverride --remove $i + fi +done +

@@ -7902,10 +7990,10 @@ done use /usr/bin/sensible-editor and /usr/bin/sensible-pager as the editor or pager program respectively. These are two scripts provided in the - Debian base system that check the EDITOR and PAGER variables - and launch the appropriate program, and fall back to - /usr/bin/editor and /usr/bin/pager if the - variable is not set. + sensible-utils package that check the EDITOR + and PAGER variables and launch the appropriate program, and fall + back to /usr/bin/editor + and /usr/bin/pager if the variable is not set.

@@ -8062,12 +8150,27 @@ http://localhost/doc/package/filename

- Mailboxes are generally mode 660 - user:mail unless the system - administrator has chosen otherwise. A MUA may remove a - mailbox (unless it has nonstandard permissions) in which - case the MTA or another MUA must recreate it if needed. - Mailboxes must be writable by group mail. + Mailboxes are generally either mode 600 and owned by + user or mode 660 and owned by + user:mail + There are two traditional permission schemes for mail spools: + mode 600 with all mail delivery done by processes running as + the destination user, or mode 660 and owned by group mail with + mail delivery done by a process running as a system user in + group mail. Historically, Debian required mode 660 mail + spools to enable the latter model, but that model has become + increasingly uncommon and the principle of least privilege + indicates that mail systems that use the first model should + use permissions of 600. If delivery to programs is permitted, + it's easier to keep the mail system secure if the delivery + agent runs as the destination user. Debian Policy therefore + permits either scheme. + . The local system administrator may choose a + different permission scheme; packages should not make + assumptions about the permission and ownership of mailboxes + unless required (such as when creating a new mailbox). A MUA + may remove a mailbox (unless it has nonstandard permissions) in + which case the MTA or another MUA must recreate it if needed.

@@ -8366,11 +8469,6 @@ name ["syshostname"]: - - Speedo fonts must be placed in - /usr/share/fonts/X11/Speedo/. - - Type 1 fonts must be placed in /usr/share/fonts/X11/Type1/. If font @@ -8382,9 +8480,9 @@ name ["syshostname"]: Subdirectories of /usr/share/fonts/X11/ other than those listed above must be neither created nor used. (The PEX, CID, - and cyrillic directories are excepted for - historical reasons, but installation of files into - these directories remains discouraged.) + Speedo, and cyrillic directories + are excepted for historical reasons, but installation of + files into these directories remains discouraged.) @@ -8493,7 +8591,7 @@ name ["syshostname"]:

- + Application defaults files

@@ -8526,54 +8624,35 @@ name ["syshostname"]: Installation directory issues

- Packages using the X Window System should not be - configured to install files under the - /usr/X11R6/ directory. The - /usr/X11R6/ directory hierarchy should be + Historically, packages using the X Window System used a + separate set of installation directories from other packages. + This practice has been discontinued and packages using the X + Window System should now generally be installed in the same + directories as any other package. Specifically, packages must + not install files under the /usr/X11R6/ directory + and the /usr/X11R6/ directory hierarchy should be regarded as obsolete.

- Programs that use GNU autoconf and - automake are usually easily configured at - compile time to use /usr/ instead of - /usr/X11R6/, and this should be done whenever - possible. Configuration files for window managers and - display managers should be placed in a subdirectory of - /etc/X11/ corresponding to the package name due - to these programs' tight integration with the mechanisms - of the X Window System. Application-level programs should - use the /etc/ directory unless otherwise mandated - by policy. + Include files previously installed under + /usr/X11R6/include/X11/ should be installed into + /usr/include/X11/. For files previously + installed into subdirectories of + /usr/X11R6/lib/X11/, package maintainers should + determine if subdirectories of /usr/lib/ and + /usr/share/ can be used. If not, a subdirectory + of /usr/lib/X11/ should be used.

- The installation of files into subdirectories - of /usr/X11R6/include/X11/ and - /usr/X11R6/lib/X11/ is now prohibited; - package maintainers should determine if subdirectories of - /usr/lib/ and /usr/share/ can be used - instead. -

- -

- Packages should install any relevant files into the - directories /usr/include/X11/ and - /usr/lib/X11/, but if they do so, they must - pre-depend on x11-common (>= - 1:7.0.0) -

- These libraries used to be all symbolic - links. However, with X11R7, - /usr/include/X11 and /usr/lib/X11 - are now real directories, and packages - should ship their files here instead - of in /usr/X11R6/{include,lib}/X11. - x11-common (>= 1:7.0.0) is the package - responsible for converting these symlinks into - directories. -

- + Configuration files for window, display, or session managers + or other applications that are tightly integrated with the X + Window System may be placed in a subdirectory + of /etc/X11/ corresponding to the package name. + Other X Window System applications should use + the /etc/ directory unless otherwise mandated by + policy (such as for ).

@@ -8798,12 +8877,12 @@ name ["syshostname"]:

- Due to limitations in current implementations, all characters - in the manual page source should be representable in the usual - legacy encoding for that language, even if the file is - actually encoded in UTF-8. Safe alternative ways to write many - characters outside that range may be found in - . + If a localized version of a manual page is provided, it should + either be up-to-date or it should be obvious to the reader that + it is outdated and the original manual page should be used + instead. This can be done either by a note at the beginning of + the manual page or by showing the missing or changed portions in + the original language instead of the target language.

@@ -8816,37 +8895,53 @@ name ["syshostname"]:

- Your package should call install-info to update - the Info dir file in its postinst - script when called with a configure argument, for - example: - -install-info --quiet --section Development Development \ - /usr/share/info/foobar.info -

- -

- It is a good idea to specify a section for the location of - your program; this is done with the --section - switch. To determine which section to use, you should look - at /usr/share/info/dir on your system and choose the most - relevant (or create a new section if none of the current - sections are relevant). Note that the --section - flag takes two arguments; the first is a regular expression - to match (case-insensitively) against an existing section, - the second is used when creating a new one.

- -

- You should remove the entries in the prerm - script when called with a remove argument: - -install-info --quiet --remove /usr/share/info/foobar.info -

- -

- If install-info cannot find a description entry - in the Info file you must supply one. See for details.

+ The install-info program maintains a directory of + installed info documents in /usr/share/info/dir for + the use of info readers. + It was previously necessary for packages installing info + documents to run install-info from maintainer + scripts. This is no longer necessary. The installation + system now uses dpkg triggers. + + This file must not be included in packages. Packages containing + info documents should depend on dpkg (>= 1.15.4) | + install-info to ensure that the directory file is properly + rebuilt during partial upgrades from Debian 5.0 (lenny) and + earlier. +

+ +

+ Info documents should contain section and directory entry + information in the document for the use + of install-info. The section should be specified + via a line starting with INFO-DIR-SECTION followed by a + space and the section of this info page. The directory entry or + entries should be included between + a START-INFO-DIR-ENTRY line and + an END-INFO-DIR-ENTRY line. For example: + +INFO-DIR-SECTION Individual utilities +START-INFO-DIR-ENTRY +* example: (example). An example info directory entry. +END-INFO-DIR-ENTRY + + To determine which section to use, you should look + at /usr/share/info/dir on your system and choose + the most relevant (or create a new section if none of the + current sections are relevant). + Normally, info documents are generated from Texinfo source. + To include this information in the generated info document, if + it is absent, add commands like: + +@dircategory Individual utilities +@direntry +* example: (example). An example info directory entry. +@end direntry + + to the Texinfo source of the document and ensure that the info + documents are rebuilt from source during the package build. + +

@@ -8965,9 +9060,10 @@ install-info --quiet --remove /usr/share/info/foobar.info

- Packages in the contrib or non-free categories - should state in the copyright file that the package is not part - of the Debian GNU/Linux distribution and briefly explain why. + Packages in the contrib or non-free archive + areas should state in the copyright file that the package is not + part of the Debian GNU/Linux distribution and briefly explain + why.

@@ -8988,8 +9084,8 @@ install-info --quiet --remove /usr/share/info/foobar.info

Packages distributed under the UCB BSD license, the Apache license (version 2.0), the Artistic license, the GNU GPL - (version 2 or 3), the GNU LGPL (versions 2, 2.1, or 3), and - the GNU FDL (version 1.2) should refer to the corresponding + (version 2 or 3), the GNU LGPL (versions 2, 2.1, or 3), and the + GNU FDL (versions 1.2 or 1.3) should refer to the corresponding files under /usr/share/common-licenses,

In particular, @@ -9000,8 +9096,9 @@ install-info --quiet --remove /usr/share/info/foobar.info /usr/share/common-licenses/GPL-3, /usr/share/common-licenses/LGPL-2, /usr/share/common-licenses/LGPL-2.1, - /usr/share/common-licenses/LGPL-3, and - /usr/share/common-licenses/GFDL-1.2 + /usr/share/common-licenses/LGPL-3, + /usr/share/common-licenses/GFDL-1.2, and + /usr/share/common-licenses/GFDL-1.3 respectively.

rather than quoting them in the copyright @@ -9286,7 +9383,7 @@ install-info --quiet --remove /usr/share/info/foobar.info To view the copyright file for a package you could use this command: - dpkg --fsys-tarfile filename.deb | tar xOf - \*/copyright | pager + dpkg --fsys-tarfile filename.deb | tar xOf - --wildcards \*/copyright | pager

@@ -10550,26 +10647,48 @@ install-info --quiet --remove /usr/share/info/foobar.info supposing that a smailwrapper package wishes to install a wrapper around /usr/sbin/smail: - if [ install = "$1" ]; then - dpkg-divert --package smailwrapper --add --rename \ - --divert /usr/sbin/smail.real /usr/sbin/smail - fi - Testing $1 is necessary so that the script - doesn't try to add the diversion again when - smailwrapper is upgraded. The --package - smailwrapper ensures that smailwrapper's - copy of /usr/sbin/smail can bypass the diversion and - get installed as the true version. + dpkg-divert --package smailwrapper --add --rename \ + --divert /usr/sbin/smail.real /usr/sbin/smail + The --package smailwrapper ensures that + smailwrapper's copy of /usr/sbin/smail + can bypass the diversion and get installed as the true version. + It's safe to add the diversion unconditionally on upgrades since + it will be left unchanged if it already exists, but + dpkg-divert will display a message. To suppress that + message, make the command conditional on the version from which + the package is being upgraded: + + if [ upgrade != "$1" ] || dpkg --compare-versions "$2" lt 1.0-2; then + dpkg-divert --package smailwrapper --add --rename \ + --divert /usr/sbin/smail.real /usr/sbin/smail + fi + where 1.0-2 is the version at which the + diversion was first added to the package. Running the command + during abort-upgrade is pointless but harmless.

The postrm has to do the reverse: - if [ remove = "$1" ]; then + if [ remove = "$1" -o abort-install = "$1" -o disappear = "$1" ]; then + dpkg-divert --package smailwrapper --remove --rename \ + --divert /usr/sbin/smail.real /usr/sbin/smail + fi + If the diversion was added at a particular version, the + postrm should also handle the failure case of upgrading from an + older version (unless the older version is so old that direct + upgrades are no longer supported): + + if [ abort-upgrade = "$1" ] && dpkg --compare-versions "$2" lt 1.0-2; then dpkg-divert --package smailwrapper --remove --rename \ --divert /usr/sbin/smail.real /usr/sbin/smail fi - + where 1.02-2 is the version at which the + diversion was first added to the package. The postrm should not + remove the diversion on upgrades both because there's no reason to + remove the diversion only to immediately re-add it and since the + postrm of the old package is run after unpacking so the removal of + the diversion will fail.