add by-hash sources.list option and document all of by-hash

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

diff --git a/doc/sources.list.5.xml b/doc/sources.list.5.xml
index aded8ecefcf7adefbf1743a1abd5c452dc4e78c3..71447e84f1fdc02b7b5fe35469828dd67a81bf61 100644 (file)
--- a/doc/sources.list.5.xml
+++ b/doc/sources.list.5.xml
@@ -36,7 +36,7 @@
       designed to support any number of active sources and a variety of source
       media. The files list one source per line (one line style) or contain multiline
       stanzas defining one or more sources per stanza (deb822 style), with the
       designed to support any number of active sources and a variety of source
       media. The files list one source per line (one line style) or contain multiline
       stanzas defining one or more sources per stanza (deb822 style), with the

-      most preferred source listed first. The information available from the
+      most preferred source listed first (in case a single version is available from more than one source). The information available from the

       configured sources is acquired by <command>apt-get update</command> (or
       by an equivalent command from another APT front-end).
    </para>
       configured sources is acquired by <command>apt-get update</command> (or
       by an equivalent command from another APT front-end).
    </para>


@@ -221,8 +221,41 @@ deb-src [ option1=value1 option2=value2 ] uri suite [component1] [component2] [.
                (<option>target</option>) is a multivalue option defining
                which download targets apt will try to acquire from this
                source. If not specified, the default set is defined by the
                (<option>target</option>) is a multivalue option defining
                which download targets apt will try to acquire from this
                source. If not specified, the default set is defined by the

-               <option>APT::Acquire::Targets</option> configuration scope.
+               <option>Acquire::IndexTargets</option> configuration scope.
+               Aditionally, specific targets can be enabled or disabled by
+               using the identifier as field name instead of using this
+               multivalue option.

          </para></listitem>
          </para></listitem>

+
+         <listitem><para><option>PDiffs</option> (<option>pdiffs</option>)
+               is a yes/no value which controls if APT should try to use PDiffs
+               to update old indexes instead of downloading the new indexes
+               entirely. The value of this option is ignored if the repository
+               doesn't announce the availability of PDiffs.  Defaults to the
+               value of the option with the same name for a specific index file
+               defined in the <option>Acquire::IndexTargets</option> scope,
+               which itself default to the value of configuration option
+               <option>Acquire::PDiffs</option> which defaults to
+               <literal>yes</literal>.
+         </para></listitem>
+
+         <listitem><para><option>By-Hash</option> (<option>by-hash</option>)
+               can have the value "yes", "no" or "force" and controls if APT
+               should try to acquire indexes via an URI constructed from a
+               hashsum of the expected file instead of using the well-known
+               stable filename of the index. Using this can avoid hashsum
+               mismatches, but requires a supporting mirror. The value
+               "yes"/"no" activates/disables the use of this feature if this
+               source indicates support for it, while "force" will enable the
+               feature regardless of what the source indicates.
+               Defaults to the value of the option of the same name for a
+               specific index file defined in the
+               <option>Acquire::IndexTargets</option> scope, which itself
+               defaults to the value of configuration option
+               <option>Acquire::By-Hash</option> which defaults to
+               <literal>yes</literal>.
+         </para></listitem>
+

        </itemizedlist>
 
        Further more, there are options which if set effect
        </itemizedlist>
 
        Further more, there are options which if set effect


@@ -232,18 +265,18 @@ deb-src [ option1=value1 option2=value2 ] uri suite [component1] [component2] [.
        anomalies.
 
        <itemizedlist>
        anomalies.
 
        <itemizedlist>

-         <listitem><para><option>Trusted</option> (<option>trusted</option>)
-               is a tri-state value which defaults to APT deciding if a source
-               is considered trusted or if warnings should be raised before e.g.
-               packages are installed from this source. This option can be used
-               to override this decision either with the value <literal>yes</literal>,
-               which lets APT consider this source always as a trusted source
-               even if it has no or fails authentication checks by disabling parts
-               of &apt-secure; and should therefore only be used in a local and trusted
-               context (if at all) as otherwise security is breached. The opposite
-               can be achieved with the value no, which causes the source to be handled
-               as untrusted even if the authentication checks passed successfully.
-               The default value can't be set explicitly.
+         <listitem><para><option>Signed-By</option> (<option>signed-by</option>)
+               is either an absolute path to a keyring file (has to be
+               accessible and readable for the <literal>_apt</literal> user,
+               so ensure everyone has read-permissions on the file) or a
+               fingerprint of a key in either the
+               <filename>trusted.gpg</filename> keyring or in one of the
+               keyrings in the <filename>trusted.gpg.d/</filename> directory
+               (see <command>apt-key fingerprint</command>). If the option is
+               set only the key(s) in this keyring or only the key with this
+               fingerprint is used for the &apt-secure; verification of this
+               repository. Otherwise all keys in the trusted keyrings are
+               considered valid signers for this repository.

          </para></listitem>
 
          <listitem><para><option>Check-Valid-Until</option> (<option>check-valid-until</option>)
          </para></listitem>
 
          <listitem><para><option>Check-Valid-Until</option> (<option>check-valid-until</option>)


@@ -264,14 +297,14 @@ deb-src [ option1=value1 option2=value2 ] uri suite [component1] [component2] [.
          </para></listitem>
 
          <listitem><para><option>Valid-Until-Min</option>
          </para></listitem>
 
          <listitem><para><option>Valid-Until-Min</option>

-               (<option>check-valid-min</option>) and
+               (<option>valid-until-min</option>) and

                <option>Valid-Until-Max</option>
                (<option>valid-until-max</option>) can be used to raise or
                lower the time period in seconds in which the data from this
                repository is considered valid. -Max can be especially useful
                if the repository provides no Valid-Until field on its Release
                file to set your own value, while -Min can be used to increase
                <option>Valid-Until-Max</option>
                (<option>valid-until-max</option>) can be used to raise or
                lower the time period in seconds in which the data from this
                repository is considered valid. -Max can be especially useful
                if the repository provides no Valid-Until field on its Release
                file to set your own value, while -Min can be used to increase

-               the valid time on seldomly updated (local) mirrors of a more
+               the valid time on seldom updated (local) mirrors of a more

                frequently updated but less accessible archive (which is in the
                sources.list as well) instead of disabling the check entirely.
                Default to the value of the configuration options
                frequently updated but less accessible archive (which is in the
                sources.list as well) instead of disabling the check entirely.
                Default to the value of the configuration options