* doc/*.xml:

[apt.git] / doc / sources.list.5.xml

diff --git a/doc/sources.list.5.xml b/doc/sources.list.5.xml
index 6029a745762eecb49bdc2e0eb3a99fefb3468df3..6499df7e3ef3d24623e619338c13498f4d136954 100644 (file)
--- a/doc/sources.list.5.xml
+++ b/doc/sources.list.5.xml
@@ -18,7 +18,7 @@
    &apt-email;
    &apt-product;
    <!-- The last update date -->
    &apt-email;
    &apt-product;
    <!-- The last update date -->

-   <date>29 February 2004</date>
+   <date>2004-02-29T00:00:00Z</date>

  </refentryinfo>
  
  <refmeta>
  </refentryinfo>
  
  <refmeta>


@@ -57,17 +57,19 @@
    File names need to end with
    <filename>.list</filename> and may only contain letters (a-z and A-Z),
    digits (0-9), underscore (_), hyphen (-) and period (.) characters.
    File names need to end with
    <filename>.list</filename> and may only contain letters (a-z and A-Z),
    digits (0-9), underscore (_), hyphen (-) and period (.) characters.

-   Otherwise they will be silently ignored.</para>
+   Otherwise APT will print a notice that it has ignored a file if the file
+   doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal>
+   configuration list - in this case it will be silently ignored.</para>

  </refsect1>
 
  <refsect1><title>The deb and deb-src types</title>
    <para>The <literal>deb</literal> type describes a typical two-level Debian
    archive, <filename>distribution/component</filename>. Typically,
  </refsect1>
 
  <refsect1><title>The deb and deb-src types</title>
    <para>The <literal>deb</literal> type describes a typical two-level Debian
    archive, <filename>distribution/component</filename>. Typically,

-   <literal>distribution</literal> is generally one of
-   <literal>stable</literal> <literal>unstable</literal> or 
-   <literal>testing</literal> while component is one of <literal>main</literal> 
-   <literal>contrib</literal> <literal>non-free</literal> or
-   <literal>non-us</literal>. The 
+   <literal>distribution</literal> is generally an archivename like
+   <literal>stable</literal> or <literal>testing</literal> or a codename like
+   <literal>&stable-codename;</literal> or <literal>&testing-codename;</literal>
+   while component is one of <literal>main</literal> <literal>contrib</literal> or
+   <literal>non-free</literal>. The

    <literal>deb-src</literal> type describes a debian distribution's source
    code in the same form as the <literal>deb</literal> type.
    A <literal>deb-src</literal> line is required to fetch source indexes.</para>
    <literal>deb-src</literal> type describes a debian distribution's source
    code in the same form as the <literal>deb</literal> type.
    A <literal>deb-src</literal> line is required to fetch source indexes.</para>


@@ -76,7 +78,7 @@
    <para>The format for a <filename>sources.list</filename> entry using the
    <literal>deb</literal> and <literal>deb-src</literal> types is:</para>
 
    <para>The format for a <filename>sources.list</filename> entry using the
    <literal>deb</literal> and <literal>deb-src</literal> types is:</para>
 

-   <literallayout>deb uri distribution [component1] [component2] [...]</literallayout>
+   <literallayout>deb [ options ] uri distribution [component1] [component2] [...]</literallayout>

 
    <para>The URI for the <literal>deb</literal> type must specify the base of the
    Debian distribution, from which APT will find the information it needs. 
 
    <para>The URI for the <literal>deb</literal> type must specify the base of the
    Debian distribution, from which APT will find the information it needs. 


@@ -107,6 +109,22 @@
    simultaneous anonymous users. APT also parallelizes connections to 
    different hosts to more effectively deal with sites with low bandwidth.</para>
 
    simultaneous anonymous users. APT also parallelizes connections to 
    different hosts to more effectively deal with sites with low bandwidth.</para>
 

+   <para><literal>options</literal> is always optional and needs to be surounded by
+   square brackets. It can consist of multiple settings in the form
+   <literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>.
+   Multiple settings are separated by spaces. The following settings are supported by APT,
+   note though that unsupported settings will be ignored silently:
+   <itemizedlist><listitem><para><literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal>
+   can be used to specify for which architectures packages information should
+   be downloaded. If this option is not set all architectures defined by the
+   <literal>APT::Architectures</literal> option will be downloaded.</para></listitem>
+   <listitem><para><literal>trusted=yes</literal> can be set to indicate that packages
+   from this source are always authenticated even if the <filename>Release</filename> file
+   is not signed or the signature can't be checked. This disables parts of &apt-secure;
+   and should therefore only be used in a local and trusted context. <literal>trusted=no</literal>
+   is the opposite which handles even correctly authenticated sources as not authenticated.</para></listitem>
+   </itemizedlist></para>
+

    <para>It is important to list sources in order of preference, with the most
    preferred source listed first. Typically this will result in sorting
    by speed from fastest to slowest (CD-ROM followed by hosts on a local
    <para>It is important to list sources in order of preference, with the most
    preferred source listed first. Typically this will result in sorting
    by speed from fastest to slowest (CD-ROM followed by hosts on a local


@@ -122,24 +140,23 @@ deb http://security.debian.org/ &stable-codename;/updates main contrib non-free
 
  <refsect1><title>URI specification</title>
 
 
  <refsect1><title>URI specification</title>
 

-   <para>The currently recognized URI types are cdrom, file, http, ftp, copy,
-   ssh, rsh.
+    <para>The currently recognized URI types are:

    <variablelist>
    <variablelist>

-    <varlistentry><term>file</term>
+    <varlistentry><term><command>file</command></term>

     <listitem><para>
     The file scheme allows an arbitrary directory in the file system to be
     considered an archive. This is useful for NFS mounts and local mirrors or
     archives.</para></listitem>
     </varlistentry>
     
     <listitem><para>
     The file scheme allows an arbitrary directory in the file system to be
     considered an archive. This is useful for NFS mounts and local mirrors or
     archives.</para></listitem>
     </varlistentry>
     

-    <varlistentry><term>cdrom</term>
+    <varlistentry><term><command>cdrom</command></term>

     <listitem><para>
     The cdrom scheme allows APT to use a local CDROM drive with media
     swapping. Use the &apt-cdrom; program to create cdrom entries in the
     source list.</para></listitem>
     </varlistentry>
 
     <listitem><para>
     The cdrom scheme allows APT to use a local CDROM drive with media
     swapping. Use the &apt-cdrom; program to create cdrom entries in the
     source list.</para></listitem>
     </varlistentry>
 

-    <varlistentry><term>http</term>
+    <varlistentry><term><command>http</command></term>

     <listitem><para>
     The http scheme specifies an HTTP server for the archive. If an environment
     variable <envar>http_proxy</envar> is set with the format 
     <listitem><para>
     The http scheme specifies an HTTP server for the archive. If an environment
     variable <envar>http_proxy</envar> is set with the format 


@@ -150,7 +167,7 @@ deb http://security.debian.org/ &stable-codename;/updates main contrib non-free
     Note that this is an insecure method of authentication.</para></listitem>
     </varlistentry>
 
     Note that this is an insecure method of authentication.</para></listitem>
     </varlistentry>
 

-    <varlistentry><term>ftp</term>
+    <varlistentry><term><command>ftp</command></term>

     <listitem><para>
     The ftp scheme specifies an FTP server for the archive. APT's FTP behavior
     is highly configurable; for more information see the
     <listitem><para>
     The ftp scheme specifies an FTP server for the archive. APT's FTP behavior
     is highly configurable; for more information see the


@@ -161,14 +178,14 @@ deb http://security.debian.org/ &stable-codename;/updates main contrib non-free
     the configuration file will be ignored.</para></listitem>
     </varlistentry>
 
     the configuration file will be ignored.</para></listitem>
     </varlistentry>
 

-    <varlistentry><term>copy</term>
+    <varlistentry><term><command>copy</command></term>

     <listitem><para>
     The copy scheme is identical to the file scheme except that packages are
     copied into the cache directory instead of used directly at their location.
     This is useful for people using a zip disk to copy files around with APT.</para></listitem>
     </varlistentry>
     
     <listitem><para>
     The copy scheme is identical to the file scheme except that packages are
     copied into the cache directory instead of used directly at their location.
     This is useful for people using a zip disk to copy files around with APT.</para></listitem>
     </varlistentry>
     

-    <varlistentry><term>rsh</term><term>ssh</term>
+    <varlistentry><term><command>rsh</command></term><term><command>ssh</command></term>

     <listitem><para>
     The rsh/ssh method invokes rsh/ssh to connect to a remote host
        as a given user and access the files. It is a good idea to do prior
     <listitem><para>
     The rsh/ssh method invokes rsh/ssh to connect to a remote host
        as a given user and access the files. It is a good idea to do prior


@@ -178,15 +195,13 @@ deb http://security.debian.org/ &stable-codename;/updates main contrib non-free
     commands to perform the file transfers from the remote.</para></listitem>
     </varlistentry>
 
     commands to perform the file transfers from the remote.</para></listitem>
     </varlistentry>
 

-    <varlistentry><term>more recognizable URI types</term>
+    <varlistentry><term>adding more recognizable URI types</term>

     <listitem><para>
     APT can be extended with more methods shipped in other optional packages which should
     <listitem><para>
     APT can be extended with more methods shipped in other optional packages which should

-    follow the nameing scheme <literal>apt-transport-<replaceable>method</replaceable></literal>.
-    The APT team e.g. maintains also the <literal>apt-transport-https</literal> package which
+    follow the nameing scheme <package>apt-transport-<replaceable>method</replaceable></package>.
+    The APT team e.g. maintains also the <package>apt-transport-https</package> package which

     provides access methods for https-URIs with features similar to the http method, but other
     provides access methods for https-URIs with features similar to the http method, but other

-    methods for using e.g. debtorrent are also available, see <citerefentry>
-    <refentrytitle><filename>apt-transport-debtorrent</filename></refentrytitle>
-    <manvolnum>1</manvolnum></citerefentry>.
+    methods for using e.g. debtorrent are also available, see &apt-transport-debtorrent;.

     </para></listitem>
     </varlistentry>
   </variablelist>
     </para></listitem>
     </varlistentry>
   </variablelist>


@@ -204,6 +219,11 @@ deb http://security.debian.org/ &stable-codename;/updates main contrib non-free
    <para>Source line for the above</para>
    <literallayout>deb-src file:/home/jason/debian unstable main contrib non-free</literallayout>
 
    <para>Source line for the above</para>
    <literallayout>deb-src file:/home/jason/debian unstable main contrib non-free</literallayout>
 

+   <para>The first line gets package information for the architectures in <literal>APT::Architectures</literal>
+   while the second always retrieves <literal>amd64</literal> and <literal>armel</literal>.</para>
+   <literallayout>deb http://ftp.debian.org/debian &stable-codename; main
+deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main</literallayout>
+

    <para>Uses HTTP to access the archive at archive.debian.org, and uses only
    the hamm/main area.</para>
    <literallayout>deb http://archive.debian.org/debian-archive hamm main</literallayout>
    <para>Uses HTTP to access the archive at archive.debian.org, and uses only
    the hamm/main area.</para>
    <literallayout>deb http://archive.debian.org/debian-archive hamm main</literallayout>


@@ -218,18 +238,14 @@ deb http://security.debian.org/ &stable-codename;/updates main contrib non-free
    a single FTP session will be used for both resource lines.</para>
    <literallayout>deb ftp://ftp.debian.org/debian unstable contrib</literallayout>
 
    a single FTP session will be used for both resource lines.</para>
    <literallayout>deb ftp://ftp.debian.org/debian unstable contrib</literallayout>
 

-   <para>Uses HTTP to access the archive at nonus.debian.org, under the
-    debian-non-US directory.</para>
-   <literallayout>deb http://nonus.debian.org/debian-non-US stable/non-US main contrib non-free</literallayout>
-
-   <para>Uses HTTP to access the archive at nonus.debian.org, under the
-   debian-non-US directory, and uses only files found under
-   <filename>unstable/binary-i386</filename> on i386 machines, 
-   <filename>unstable/binary-m68k</filename> on m68k, and so
-   forth for other supported architectures. [Note this example only 
-   illustrates how to use the substitution variable; non-us is no longer 
-   structured like this] 
-   <literallayout>deb http://ftp.de.debian.org/debian-non-US unstable/binary-$(ARCH)/</literallayout>
+   <para>Uses HTTP to access the archive at ftp.tlh.debian.org, under the
+   universe directory, and uses only files found under
+   <filename>unstable/binary-i386</filename> on i386 machines,
+   <filename>unstable/binary-amd64</filename> on amd64, and so
+   forth for other supported architectures. [Note this example only
+   illustrates how to use the substitution variable; official debian
+   archives are not structured like this]
+   <literallayout>deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/</literallayout>

    </para>
  </refsect1>
  
    </para>
  </refsect1>