diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/apt-cache.8.xml | 17 | ||||
| -rw-r--r-- | doc/apt-get.8.xml | 55 | ||||
| -rw-r--r-- | doc/apt.conf.5.xml | 42 | ||||
| -rw-r--r-- | doc/apt.ent | 64 | ||||
| -rw-r--r-- | doc/apt_preferences.5.xml | 10 | ||||
| -rw-r--r-- | doc/examples/configure-index | 9 |
6 files changed, 116 insertions, 81 deletions
diff --git a/doc/apt-cache.8.xml b/doc/apt-cache.8.xml index 8b76f55b9..26d55a519 100644 --- a/doc/apt-cache.8.xml +++ b/doc/apt-cache.8.xml @@ -357,21 +357,8 @@ Reverse Provides: <refsect1><title>Files</title> <variablelist> - <varlistentry><term><filename>/etc/apt/sources.list</filename></term> - <listitem><para>Locations to fetch packages from. - Configuration Item: <literal>Dir::Etc::SourceList</literal>.</para></listitem> - </varlistentry> - - <varlistentry><term><filename>&statedir;/lists/</filename></term> - <listitem><para>Storage area for state information for each package resource specified in - &sources-list; - Configuration Item: <literal>Dir::State::Lists</literal>.</para></listitem> - </varlistentry> - - <varlistentry><term><filename>&statedir;/lists/partial/</filename></term> - <listitem><para>Storage area for state information in transit. - Configuration Item: <literal>Dir::State::Lists</literal> (implicit partial).</para></listitem> - </varlistentry> + &file-sourceslist; + &file-statelists; </variablelist> </refsect1> diff --git a/doc/apt-get.8.xml b/doc/apt-get.8.xml index b87e17247..ec773edeb 100644 --- a/doc/apt-get.8.xml +++ b/doc/apt-get.8.xml @@ -384,9 +384,9 @@ Configuration Item: <literal>APT::Get::Simulate</literal>.</para> <para>Simulation run as user will deactivate locking (<literal>Debug::NoLocking</literal>) - automatical. Also a notice will be displayed indicating that this is only a simulation, - if the option <literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: true) - Neigther NoLocking nor the notice will be triggered if run as root (root should know what + automatic. Also a notice will be displayed indicating that this is only a simulation, + if the option <literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: true). + Neither NoLocking nor the notice will be triggered if run as root (root should know what he is doing without further warnings by <literal>apt-get</literal>).</para> <para>Simulate prints out @@ -558,50 +558,11 @@ <refsect1><title>Files</title> <variablelist> - <varlistentry><term><filename>/etc/apt/sources.list</filename></term> - <listitem><para>Locations to fetch packages from. - Configuration Item: <literal>Dir::Etc::SourceList</literal>.</para></listitem> - </varlistentry> - - <varlistentry><term><filename>/etc/apt/apt.conf</filename></term> - <listitem><para>APT configuration file. - Configuration Item: <literal>Dir::Etc::Main</literal>.</para></listitem> - </varlistentry> - - <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term> - <listitem><para>APT configuration file fragments. - Configuration Item: <literal>Dir::Etc::Parts</literal>.</para></listitem> - </varlistentry> - - <varlistentry><term><filename>/etc/apt/preferences</filename></term> - <listitem><para>Version preferences file. - This is where you would specify "pinning", - i.e. a preference to get certain packages - from a separate source - or from a different version of a distribution. - Configuration Item: <literal>Dir::Etc::Preferences</literal>.</para></listitem> - </varlistentry> - - <varlistentry><term><filename>&cachedir;/archives/</filename></term> - <listitem><para>Storage area for retrieved package files. - Configuration Item: <literal>Dir::Cache::Archives</literal>.</para></listitem> - </varlistentry> - - <varlistentry><term><filename>&cachedir;/archives/partial/</filename></term> - <listitem><para>Storage area for package files in transit. - Configuration Item: <literal>Dir::Cache::Archives</literal> (implicit partial). </para></listitem> - </varlistentry> - - <varlistentry><term><filename>&statedir;/lists/</filename></term> - <listitem><para>Storage area for state information for each package resource specified in - &sources-list; - Configuration Item: <literal>Dir::State::Lists</literal>.</para></listitem> - </varlistentry> - - <varlistentry><term><filename>&statedir;/lists/partial/</filename></term> - <listitem><para> Storage area for state information in transit. - Configuration Item: <literal>Dir::State::Lists</literal> (implicit partial).</para></listitem> - </varlistentry> + &file-sourceslist; + &file-aptconf; + &file-preferences; + &file-cachearchives; + &file-statelists; </variablelist> </refsect1> diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml index e0ce0db40..81be753f9 100644 --- a/doc/apt.conf.5.xml +++ b/doc/apt.conf.5.xml @@ -90,7 +90,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; <literal>#include</literal> will include the given file, unless the filename ends in a slash, then the whole directory is included. <literal>#clear</literal> is used to erase a part of the configuration tree. The - specified element and all its descendents are erased.</para> + specified element and all its descendants are erased.</para> <para>All of the APT tools take a -o option which allows an arbitrary configuration directive to be specified on the command line. The syntax is a full option @@ -312,16 +312,30 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; <varlistentry><term>CompressionTypes</term> <listitem><para>List of compression types which are understood by the acquire methods. Files like <filename>Packages</filename> can be available in various compression formats. - This list defines in which order the acquire methods will try to download these files. - Per default <command>bzip2</command> compressed files will be prefered over - <command>lzma</command>, <command>gzip</command> and uncompressed files. The syntax for - the configuration fileentry is + Per default the acquire methods can decompress <command>bzip2</command>, <command>lzma</command> + and <command>gzip</command> compressed files, with this setting more formats can be added + on the fly or the used method can be changed. The syntax for this is: <synopsis>Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "<replaceable>Methodname</replaceable>";</synopsis> - e.g. <synopsis>Acquire::CompressionTypes::bz2 "bzip2";</synopsis> - Note that at runtime the <literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will + </para><para>Also the <literal>Order</literal> subgroup can be used to define in which order + the acquire system will try to download the compressed files. The acquire system will try the first + and proceed with the next compression type in this list on error, so to prefer one over the other type + simple add the preferred type at first - not already added default types will be added at run time + to the end of the list, so e.g. <synopsis>Acquire::CompressionTypes::Order:: "gz";</synopsis> can + be used to prefer <command>gzip</command> compressed files over <command>bzip2</command> and <command>lzma</command>. + If <command>lzma</command> should be preferred over <command>gzip</command> and <command>bzip2</command> the + configure setting should look like this <synopsis>Acquire::CompressionTypes::Order { "lzma"; "gz"; };</synopsis> + It is not needed to add <literal>bz2</literal> explicit to the list as it will be added automatic.</para> + <para>Note that at run time the <literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be checked: If this setting exists the method will only be used if this file exists, e.g. for - the bzip2 method above (the inbuilt) setting is <literallayout>Dir::Bin::bzip2 "/bin/bzip2";</literallayout> - </para></listitem> + the bzip2 method (the inbuilt) setting is <literallayout>Dir::Bin::bzip2 "/bin/bzip2";</literallayout> + Note also that list entries specified on the commandline will be added at the end of the list + specified in the configuration files, but before the default entries. To prefer a type in this case + over the ones specified in in the configuration files you can set the option direct - not in list style. + This will not override the defined list, it will only prefix the list with this type.</para> + <para>While it is possible to add an empty compression type to the order list, but APT in its current + version doesn't understand it correctly and will display many warnings about not downloaded files - + these warnings are most of the time false negatives. Future versions will maybe include a way to + really prefer uncompressed files to support the usage of local mirrors.</para></listitem> </varlistentry> </variablelist> </para> @@ -844,15 +858,7 @@ is commented. <refsect1><title>Files</title> <variablelist> - <varlistentry><term><filename>/etc/apt/apt.conf</filename></term> - <listitem><para>APT configuration file. - Configuration Item: <literal>Dir::Etc::Main</literal>.</para></listitem> - </varlistentry> - - <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term> - <listitem><para>APT configuration file fragments. - Configuration Item: <literal>Dir::Etc::Parts</literal>.</para></listitem> - </varlistentry> + &file-aptconf; </variablelist> </refsect1> diff --git a/doc/apt.ent b/doc/apt.ent index 43ac2f8e5..9a4c17bcd 100644 --- a/doc/apt.ent +++ b/doc/apt.ent @@ -289,3 +289,67 @@ </para> "> +<!ENTITY file-aptconf " + <varlistentry><term><filename>/etc/apt/apt.conf</filename></term> + <listitem><para>APT configuration file. + Configuration Item: <literal>Dir::Etc::Main</literal>.</para></listitem> + </varlistentry> + + <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term> + <listitem><para>APT configuration file fragments. + Configuration Item: <literal>Dir::Etc::Parts</literal>.</para></listitem> + </varlistentry> +"> + +<!ENTITY file-cachearchives " + <varlistentry><term><filename>&cachedir;/archives/</filename></term> + <listitem><para>Storage area for retrieved package files. + Configuration Item: <literal>Dir::Cache::Archives</literal>.</para></listitem> + </varlistentry> + + <varlistentry><term><filename>&cachedir;/archives/partial/</filename></term> + <listitem><para>Storage area for package files in transit. + Configuration Item: <literal>Dir::Cache::Archives</literal> (implicit partial). </para></listitem> + </varlistentry> +"> + +<!ENTITY file-preferences " + <varlistentry><term><filename>/etc/apt/preferences</filename></term> + <listitem><para>Version preferences file. + This is where you would specify "pinning", + i.e. a preference to get certain packages + from a separate source + or from a different version of a distribution. + Configuration Item: <literal>Dir::Etc::Preferences</literal>.</para></listitem> + </varlistentry> + + <varlistentry><term><filename>/etc/apt/preferences.d/</filename></term> + <listitem><para>File fragments for the version preferences. + Configuration Item: <literal>Dir::Etc::PreferencesParts</literal>.</para></listitem> + </varlistentry> +"> + +<!ENTITY file-sourceslist " + <varlistentry><term><filename>/etc/apt/sources.list</filename></term> + <listitem><para>Locations to fetch packages from. + Configuration Item: <literal>Dir::Etc::SourceList</literal>.</para></listitem> + </varlistentry> + + <varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term> + <listitem><para>File fragments for locations to fetch packages from. + Configuration Item: <literal>Dir::Etc::SourceParts</literal>.</para></listitem> + </varlistentry> +"> + +<!ENTITY file-statelists " + <varlistentry><term><filename>&statedir;/lists/</filename></term> + <listitem><para>Storage area for state information for each package resource specified in + &sources-list; + Configuration Item: <literal>Dir::State::Lists</literal>.</para></listitem> + </varlistentry> + + <varlistentry><term><filename>&statedir;/lists/partial/</filename></term> + <listitem><para>Storage area for state information in transit. + Configuration Item: <literal>Dir::State::Lists</literal> (implicit partial).</para></listitem> + </varlistentry> +"> diff --git a/doc/apt_preferences.5.xml b/doc/apt_preferences.5.xml index 12ea606b7..159d61f2b 100644 --- a/doc/apt_preferences.5.xml +++ b/doc/apt_preferences.5.xml @@ -32,7 +32,8 @@ <refsect1> <title>Description</title> <para>The APT preferences file <filename>/etc/apt/preferences</filename> -can be used to control which versions of packages will be selected +and the fragment files in the <filename>/etc/apt/preferences.d/</filename> +folder can be used to control which versions of packages will be selected for installation.</para> <para>Several versions of a package may be available for installation when @@ -611,6 +612,13 @@ apt-get install <replaceable>package</replaceable>/sid </refsect1> <refsect1> +<title>Files</title> + <variablelist> + &file-preferences; + </variablelist> +</refsect1> + +<refsect1> <title>See Also</title> <para>&apt-get; &apt-cache; &apt-conf; &sources-list; </para> diff --git a/doc/examples/configure-index b/doc/examples/configure-index index 5dc7b5246..8025fa4b4 100644 --- a/doc/examples/configure-index +++ b/doc/examples/configure-index @@ -246,6 +246,15 @@ Acquire { Options {"--ignore-time-conflict";} // not very useful on a normal system }; + + CompressionTypes + { + bz2 "bzip2"; + lzma "lzma"; + gz "gzip"; + + Order { "gz"; "lzma"; "bz2"; }; + }; }; // Directory layout |