merge with debian-experimental-ma to get the final 0.8.0~pre1

[apt.git] / doc / files.sgml

diff --git a/doc/files.sgml b/doc/files.sgml
index 2b68cf9bcd6443381be745a9cb48bdc1378a0ccd..108e73670a289db1022dc2249806db8be925c9d9 100644 (file)
--- a/doc/files.sgml
+++ b/doc/files.sgml
@@ -1,10 +1,10 @@
-<!doctype debiandoc system>

 <!-- -*- mode: sgml; mode: fold -*- -->
 <!-- -*- mode: sgml; mode: fold -*- -->

+<!doctype debiandoc  PUBLIC  "-//DebianDoc//DTD DebianDoc//EN">

 <book>
 <title>APT Files</title>
 
 <author>Jason Gunthorpe <email>jgg@debian.org</email></author>
 <book>
 <title>APT Files</title>
 
 <author>Jason Gunthorpe <email>jgg@debian.org</email></author>

-<version>$Id: files.sgml,v 1.7 1999/02/15 06:38:03 jgg Exp $</version>
+<version>$Id: files.sgml,v 1.12 2003/04/26 23:26:13 doogie Exp $</version>

 
 <abstract>
 This document describes the complete implementation and format of the 
 
 <abstract>
 This document describes the complete implementation and format of the 


@@ -22,7 +22,7 @@ option) any later version.
 
 <p>
 For more details, on Debian GNU/Linux systems, see the file
 
 <p>
 For more details, on Debian GNU/Linux systems, see the file

-/usr/doc/copyright/GPL for the full license.
+/usr/share/common-licenses/GPL for the full license.

 </copyright>
 
 <toc sect>
 </copyright>
 
 <toc sect>


@@ -41,41 +41,69 @@ multiple package files.
 <p>
 The var directory structure is as follows:
 <example>
 <p>
 The var directory structure is as follows:
 <example>

-  /var/state/apt/
-                 lists/
+  /var/lib/apt/
+               lists/

                       partial/
                       partial/

-                 xstatus
-                 userstatus
-                 cdroms.list
+               periodic/
+               extended_states
+               cdroms.list

   /var/cache/apt/
   /var/cache/apt/

-                  pkgcache.bin
-                 srcpkgcache.bin

                  archives/
                          partial/
                  archives/
                          partial/

+                 pkgcache.bin
+                 srcpkgcache.bin

   /etc/apt/
   /etc/apt/

-           sources.list
-          apt.conf
+           sources.list.d/
+           apt.conf.d/
+           preferences.d/
+           trusted.gpg.d/
+           sources.list
+           apt.conf
+           apt_preferences
+           trusted.gpg

   /usr/lib/apt/
   /usr/lib/apt/

-                methods/
-                      cdrom
-                      ftp
-                      http
-                      file
-                      gzip
-                      copy
+               methods/
+                        bzip2
+                        cdrom
+                        copy
+                        file
+                        ftp
+                        gpgv
+                        gzip
+                        http
+                        https
+                        lzma
+                        rred
+                        rsh
+                        ssh

 </example>
 
 <p>
 </example>
 
 <p>

-As is specified in the FHS 2.0 /var/state/apt is used for application 
+As is specified in the FHS 2.1 /var/lib/apt is used for application 

 data that is not expected to be user modified. /var/cache/apt is used
 for regeneratable data and is where the package cache and downloaded .debs
 data that is not expected to be user modified. /var/cache/apt is used
 for regeneratable data and is where the package cache and downloaded .debs

-go.
+go. /etc/apt is the place where configuration should happen and
+/usr/lib/apt is the place where the apt and other packages can place
+binaries which can be used by the acquire system of APT.

 </sect>
                                                                   <!-- }}} -->
 
 <chapt>Files
 <!-- Distribution Source List                                         {{{ -->
 <!-- ===================================================================== -->
 </sect>
                                                                   <!-- }}} -->
 
 <chapt>Files
 <!-- Distribution Source List                                         {{{ -->
 <!-- ===================================================================== -->

+<sect>Files and fragment directories in /etc/apt
+
+<p>
+All files in /etc/apt are used to modify specific aspects of APT. To enable
+other packages to ship needed configuration herself all these files have
+a fragment directory packages can place their files in instead of mangling
+with the main files. The main files are therefore considered to be only
+used by the user and not by a package. The documentation omits this directories
+most of the time to be easier readable, so every time the documentation includes
+a reference to a main file it really means the file or the fragment directories.
+
+</sect>
+

 <sect>Distribution Source list (sources.list)
 
 <p>
 <sect>Distribution Source list (sources.list)
 
 <p>


@@ -97,11 +125,11 @@ which indicates a standard debian archive with a dists dir.
    <p>
    The <em>deb</em> type is to be a typical two level debian distributions,
    dist/<var>distribution</var>/<var>component</var>. Typically distribution
    <p>
    The <em>deb</em> type is to be a typical two level debian distributions,
    dist/<var>distribution</var>/<var>component</var>. Typically distribution

-   is one of stable, unstable or frozen while component is one of main, 
+   is one of stable, unstable or testing while component is one of main, 

    contrib, non-free or non-us. The format for the deb line is as follows:
 
    <p>
    contrib, non-free or non-us. The format for the deb line is as follows:
 
    <p>

-   deb <var>uri</var> <var>distribution</var> <var>compontent</var> 
+   deb <var>uri</var> <var>distribution</var> <var>component</var> 

    [<var>component</var> ...]
 
    <p>
    [<var>component</var> ...]
 
    <p>


@@ -116,21 +144,24 @@ which indicates a standard debian archive with a dists dir.
    necessary to list a number of deb lines for the same URI. APT will
    sort the URI list after it has generated a complete set to allow 
    connection reuse. It is important to order things in the sourcelist
    necessary to list a number of deb lines for the same URI. APT will
    sort the URI list after it has generated a complete set to allow 
    connection reuse. It is important to order things in the sourcelist

-   from most prefered to least prefered (fastest to slowest).
+   from most preferred to least preferred (fastest to slowest).

 </sect1>
 
 <sect1>URI specification
 <p> 
 </sect1>
 
 <sect1>URI specification
 <p> 

-URIs in the source list support a large number of access schemes.
+URIs in the source list support a large number of access schemes which
+are listed in the sources.list manpage and can be further extended by
+transport binaries placed in /usr/lib/apt/methods. The most important
+builtin schemes are:

 
 <taglist>
 <tag>cdrom<item>
 
 <taglist>
 <tag>cdrom<item>

-   The cdrom scheme is special in that If Modifed Since queries are never
+   The cdrom scheme is special in that If Modified Since queries are never

    performed and that APT knows how to match a cdrom to the name it
    was given when first inserted. APT also knows all of the possible 
    mount points the cdrom drives and that the user should be prompted
    to insert a CD if it cannot be found. The path is relative to an 
    performed and that APT knows how to match a cdrom to the name it
    was given when first inserted. APT also knows all of the possible 
    mount points the cdrom drives and that the user should be prompted
    to insert a CD if it cannot be found. The path is relative to an 

-   arbitary mount point (of APT's choosing) and must not start with a 
+   arbitrary mount point (of APT's choosing) and must not start with a 

    slash. The first pathname component is the given name and is purely
    descriptive and of the users choice. However, if a file in the root of 
    the cdrom is called '.disk/info' its contents will be used instead of 
    slash. The first pathname component is the given name and is purely
    descriptive and of the users choice. However, if a file in the root of 
    the cdrom is called '.disk/info' its contents will be used instead of 


@@ -140,7 +171,7 @@ URIs in the source list support a large number of access schemes.
    </example>
 
 <tag>http<item>
    </example>
 
 <tag>http<item>

-   This scheme specifies a HTTP server for the debian archive. HTTP is prefered
+   This scheme specifies a HTTP server for the debian archive. HTTP is preferred

    over FTP because If Modified Since queries against the Package file are
    possible as well as deep pipelining and resume capabilities.
    <example>
    over FTP because If Modified Since queries against the Package file are
    possible as well as deep pipelining and resume capabilities.
    <example>


@@ -155,38 +186,31 @@ URIs in the source list support a large number of access schemes.
    </example>
 
 <tag>file<item>
    </example>
 
 <tag>file<item>

-   The file scheme allows an arbitary directory in the file system to be 
-   considered as a debian archive. This is usefull for NFS mounts and 
+   The file scheme allows an arbitrary directory in the file system to be 
+   considered as a debian archive. This is useful for NFS mounts and 

    local mirrors/archives.
    <example>
    file:/var/debian
    </example>
    local mirrors/archives.
    <example>
    file:/var/debian
    </example>

-   
-<tag>smb<item>
-   A possible future expansion may be to have direct support for smb (Samba 
-   servers).
-   <example>
-   smb://ftp.kernel.org/pub/mirrors/debian
-   </example>

 </taglist>
 </sect1>
 
 <sect1>Hashing the URI
 <p>
 </taglist>
 </sect1>
 
 <sect1>Hashing the URI
 <p>

-All permanent information aquired from any of the sources is stored in the
+All permanent information acquired from any of the sources is stored in the

 lists directory. Thus, there must be a way to relate the filename in the
 lists directory to a line in the sourcelist. To simplify things this is
 done by quoting the URI and treating _'s as quoteable characters and
 converting / to _. The URI spec says this is done by converting a 
 sensitive character into %xx where xx is the hexadecimal representation 
 lists directory. Thus, there must be a way to relate the filename in the
 lists directory to a line in the sourcelist. To simplify things this is
 done by quoting the URI and treating _'s as quoteable characters and
 converting / to _. The URI spec says this is done by converting a 
 sensitive character into %xx where xx is the hexadecimal representation 

-from the ascii character set. Examples:
+from the ASCII character set. Examples:

 
 <example>
 http://www.debian.org/archive/dists/stable/binary-i386/Packages 
 
 <example>
 http://www.debian.org/archive/dists/stable/binary-i386/Packages 

-/var/state/apt/lists/www.debian.org_archive_dists_stable_binary-i386_Packages
+/var/lib/apt/lists/www.debian.org_archive_dists_stable_binary-i386_Packages

 
 cdrom:Debian 1.3/debian/Packages
 
 cdrom:Debian 1.3/debian/Packages

-/var/state/apt/info/Debian%201.3_debian_Packages
+/var/lib/apt/info/Debian%201.3_debian_Packages

 </example>
 
 <p> 
 </example>
 
 <p> 


@@ -201,38 +225,31 @@ here as well.
 
 </sect>
                                                                   <!-- }}} -->
 
 </sect>
                                                                   <!-- }}} -->

-<!-- Extra Status                                                     {{{ -->
+<!-- Extended Status                                                  {{{ -->

 <!-- ===================================================================== -->
 <!-- ===================================================================== -->

-<sect>Extra Status File (xstatus)
+<sect>Extended States File (extended_states)

 
 <p>
 
 <p>

-The extra status file serves the same purpose as the normal dpkg status file
+The extended_states file serves the same purpose as the normal dpkg status file

 (/var/lib/dpkg/status) except that it stores information unique to apt.
 (/var/lib/dpkg/status) except that it stores information unique to apt.

-This includes the autoflag, target distribution and version and any other
-uniqe features that come up over time. It duplicates nothing from the normal
+This includes currently only the autoflag but is open to store more
+unique data that come up over time. It duplicates nothing from the normal

 dpkg status file.  Please see other APT documentation for a discussion
 dpkg status file.  Please see other APT documentation for a discussion

-of the exact internal behavior of these fields. The Package field is
-placed directly before the new fields to indicate which package they
-apply to. The new fields are as follows:
+of the exact internal behaviour of these fields. The Package and the
+Architecture field are placed directly before the new fields to indicate
+which package they apply to. The new fields are as follows:

 
 <taglist>
 
 <taglist>

-<tag>X-Auto<item>
-   The Auto flag can be Yes or No and controls whether the package is in
-   auto mode. 
-
-<tag>X-TargetDist<item>
-   The TargetDist item indicates which distribution versions are offered for
-   installation from. It should be stable, unstable or frozen.
-   
-<tag>X-TargetVersion<item>
-   The target version item is set if the user selects a specific version, it
-   overrides the TargetDist selection if both are present.
+<tag>Auto-Installed<item>
+   The Auto flag can be 1 (Yes) or 0 (No) and controls whether the package
+   was automatical installed to satisfy a dependency or if the user requested
+   the installation

 </taglist>
 </sect>
                                                                   <!-- }}} -->
 <!-- Binary Package Cache                                             {{{ -->
 <!-- ===================================================================== -->
 </taglist>
 </sect>
                                                                   <!-- }}} -->
 <!-- Binary Package Cache                                             {{{ -->
 <!-- ===================================================================== -->

-<sect>Binary Package Cache (pkgcache.bin)
+<sect>Binary Package Cache (srcpkgcache.bin and pkgcache.bin)

 
 <p>
 Please see cache.sgml for a complete description of what this file is. The 
 
 <p>
 Please see cache.sgml for a complete description of what this file is. The 


@@ -251,12 +268,12 @@ change to use a prebuilt version for greater speed.
 <p>
 The archives directory is where all downloaded .deb archives go. When the
 file transfer is initiated the deb is placed in partial. Once the file
 <p>
 The archives directory is where all downloaded .deb archives go. When the
 file transfer is initiated the deb is placed in partial. Once the file

-is fully downloaded and its MD5 hash and size are verifitied it is moved
+is fully downloaded and its MD5 hash and size are verified it is moved

 from partial into archives/. Any files found in archives/ can be assumed 
 to be verified.
 
 <p>
 from partial into archives/. Any files found in archives/ can be assumed 
 to be verified.
 
 <p>

-No dirctory structure is transfered from the receiving site and all .deb
+No directory structure is transfered from the receiving site and all .deb

 file names conform to debian conventions. No short (msdos) filename should
 be placed in archives. If the need arises .debs should be unpacked, scanned
 and renamed to their correct internal names. This is mostly to prevent
 file names conform to debian conventions. No short (msdos) filename should
 be placed in archives. If the need arises .debs should be unpacked, scanned
 and renamed to their correct internal names. This is mostly to prevent


@@ -278,69 +295,27 @@ The Methods directory is more fully described in the APT Methods interface
 document.
 </sect>
                                                                   <!-- }}} -->
 document.
 </sect>
                                                                   <!-- }}} -->

-<!-- The Mirror List                                                  {{{ -->
+<!-- The Configuration File                                           {{{ -->

 <!-- ===================================================================== -->
 <!-- ===================================================================== -->

-<sect> The Mirror List
+<sect> The Configuration File (/etc/apt/apt.conf)

 
 <p>
 
 <p>

-The mirror list is stored on the primary debian web server (www.debian.org)
-and contains a machine readable list of all known debian mirrors. It's 
-format and style mirror the Package file.
-
-<taglist>
-<tag>Site<item>
-This is the proper host name of the site. It should not be a host within
-debian.org and generally cnames should be advoided here.
-
-<tag>Aliases<item>
-These list any commonly used aliases for the site. This field is used to make
-sure that a site is not added twice.
-
-<tag>Type<item>
-This field can either be <em>Push-Primary</> or <em>leaf</>. 
-<em>Push-Primary</> are authorized top level mirrors of the archive, all 
-other mirrors are leaf. 
-
-<tag>Archive-[access]<item>
-The Archive field gives the path(s) to the debian archive. [access] 
-specifies the access method and may be one of ftp, http, rsync, nfs, or
-smb. For many of the types it is possible to prefix the path with :###
-indicating that an alternate port should be used. Generaly paths
-start with a / and end with a /, rsync is an exception in that the
-first directory component is not a path but a label.
-
-<tag>WWW-[access]<item>
-The WWW field gives the path(s) to the debian web site.
-
-<tag>CDImage-[access]<item>
-The WWW field gives the path(s) to the debian CD-ROM images
-
-<tag>Incoming-[access]<item>
-The Incoming field gives the path(s) to a mirror of the debian incoming
-directory.
-
-<tag>nonUS-[access]<item>
-The nonUS field gives the path(s) to a mirror of the non-US distribution.
-
-<tag>Maintainer<item>
-This is the email address of the maintainer of the mirror.
-
-<tag>Location<item>
-Location gives the general geographical region the mirror is in.
-
-<tag>Sponsor<item>
-The Sponsor field indicates who owns the mirror and a URL to a web page
-describing the organization.
-
-<tag>Comment<item>
-General free-form text.
-
-</taglist>
+The configuration file (and the associated fragments directory
+/etc/apt/apt.conf.d/) is described in the apt.conf manpage.
+</sect>
+                                                                  <!-- }}} -->
+<!-- The trusted.gpg File                                             {{{ -->
+<!-- ===================================================================== -->
+<sect> The trusted.gpg File (/etc/apt/trusted.gpg)

 
 <p>
 
 <p>

-Some form of network measurement will have to be used to gauge performance
-of each of the mirrors. This will be discussed later, initial versions
-will use the first found URI.
+The trusted.gpg file (and the files in the associated fragments directory
+/etc/apt/trusted.gpg.d/) is a binary file including the keyring used
+by apt to validate that the information (e.g. the Release file) it
+downloads are really from the distributor it clams to be and is
+unmodified and is therefore the last step in the chain of trust between
+the archive and the end user. This security system is described in the
+apt-secure manpage.

 </sect>
                                                                   <!-- }}} -->
 <!-- The Release File                                                 {{{ -->
 </sect>
                                                                   <!-- }}} -->
 <!-- The Release File                                                 {{{ -->


@@ -348,7 +323,7 @@ will use the first found URI.
 <sect> The Release File
 
 <p>
 <sect> The Release File
 
 <p>

-This file plays and important role in how APT presents the archive to the 
+This file plays an important role in how APT presents the archive to the 

 user. Its main purpose is to present a descriptive name for the source
 of each version of each package. It also is used to detect when new versions
 of debian are released. It augments the package file it is associated with 
 user. Its main purpose is to present a descriptive name for the source
 of each version of each package. It also is used to detect when new versions
 of debian are released. It augments the package file it is associated with 


@@ -370,7 +345,7 @@ This is the common name we give our archives, such as <em>stable</> or
 <em>unstable</>.
 
 <tag>Component<item>
 <em>unstable</>.
 
 <tag>Component<item>

-Referes to the sub-component of the archive, <em>main</>, <em>contrib</>
+Refers to the sub-component of the archive, <em>main</>, <em>contrib</>

 etc. Component may be omitted if there are no components for this archive.
 
 <tag>Version<item>
 etc. Component may be omitted if there are no components for this archive.
 
 <tag>Version<item>


@@ -409,7 +384,7 @@ release, 1.3.1r6
 
 <example>
 Archive: stable
 
 <example>
 Archive: stable

-Compontent: main
+Component: main

 Version: 1.3.1r6
 Origin: Debian
 Label: Debian
 Version: 1.3.1r6
 Origin: Debian
 Label: Debian


@@ -429,7 +404,7 @@ NotAutomatic: Yes
 And unstable,
 <example>
 Archive: unstable
 And unstable,
 <example>
 Archive: unstable

-Compontent: main
+Component: main

 Version: 2.1
 Origin: Debian
 Label: Debian
 Version: 2.1
 Origin: Debian
 Label: Debian