edsp: dump: support dumping into compressed file

[apt.git] / doc / apt-get.8.xml

diff --git a/doc/apt-get.8.xml b/doc/apt-get.8.xml
index b97bc268ef7175cf6da381e548f874dd8610df66..46660e4dbc725bf52fbccbb91e10a0902d05d933 100644 (file)
--- a/doc/apt-get.8.xml
+++ b/doc/apt-get.8.xml
@@ -1,15 +1,9 @@
 <?xml version="1.0" encoding="utf-8" standalone="no"?>
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 <?xml version="1.0" encoding="utf-8" standalone="no"?>
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

-
-<!ENTITY % aptent SYSTEM "apt.ent">
-%aptent;
-
-<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
-%aptverbatiment;
-
-<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
-%aptvendor;
+<!ENTITY % aptent SYSTEM "apt.ent"> %aptent;
+<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment;
+<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor;

 ]>
 
 <refentry>
 ]>
 
 <refentry>


@@ -20,7 +14,7 @@
    &apt-email;
    &apt-product;
    <!-- The last update date -->
    &apt-email;
    &apt-product;
    <!-- The last update date -->

-   <date>2012-06-09T00:00:00Z</date>
+   <date>2016-05-08T00:00:00Z</date>

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


@@ -40,7 +34,7 @@
  <refsect1><title>Description</title>
    <para><command>apt-get</command> is the command-line tool for handling packages, and may be 
    considered the user's "back-end" to other tools using the APT
  <refsect1><title>Description</title>
    <para><command>apt-get</command> is the command-line tool for handling packages, and may be 
    considered the user's "back-end" to other tools using the APT

-   library.  Several "front-end" interfaces exist, such as &dselect;,
+   library.  Several "front-end" interfaces exist, such as

    &aptitude;, &synaptic; and &wajig;.</para>
 
    <para>Unless the <option>-h</option>, or <option>--help</option> option is given, one of the
    &aptitude;, &synaptic; and &wajig;.</para>
 
    <para>Unless the <option>-h</option>, or <option>--help</option> option is given, one of the


@@ -217,13 +211,10 @@
      <listitem><para><literal>clean</literal> clears out the local repository of retrieved package 
      files. It removes everything but the lock file from 
      <filename>&cachedir;/archives/</filename> and 
      <listitem><para><literal>clean</literal> clears out the local repository of retrieved package 
      files. It removes everything but the lock file from 
      <filename>&cachedir;/archives/</filename> and 

-     <filename>&cachedir;/archives/partial/</filename>. When APT is used as a 
-     &dselect; method, <literal>clean</literal> is run automatically.
-     Those who do not use dselect will likely want to run <literal>apt-get clean</literal>
-     from time to time to free up disk space.</para></listitem>
+     <filename>&cachedir;/archives/partial/</filename>.</para></listitem>

      </varlistentry>
 
      </varlistentry>
 

-     <varlistentry><term><option>autoclean</option></term>
+     <varlistentry><term><option>autoclean</option> (and the <option>auto-clean</option> alias since 1.1)</term>

      <listitem><para>Like <literal>clean</literal>, <literal>autoclean</literal> clears out the local 
      repository of retrieved package files. The difference is that it only 
      removes package files that can no longer be downloaded, and are largely 
      <listitem><para>Like <literal>clean</literal>, <literal>autoclean</literal> clears out the local 
      repository of retrieved package files. The difference is that it only 
      removes package files that can no longer be downloaded, and are largely 


@@ -233,25 +224,36 @@
      erased if it is set to off.</para></listitem>
      </varlistentry>
 
      erased if it is set to off.</para></listitem>
      </varlistentry>
 

-     <varlistentry><term><option>autoremove</option></term>
+     <varlistentry><term><option>autoremove</option> (and the <option>auto-remove</option> alias since 1.1)</term>

      <listitem><para><literal>autoremove</literal> is used to remove packages that were automatically
      installed to satisfy dependencies for other packages and are now no longer needed.</para></listitem>
      </varlistentry>
 
      <varlistentry><term><option>changelog</option></term>
      <listitem><para><literal>autoremove</literal> is used to remove packages that were automatically
      installed to satisfy dependencies for other packages and are now no longer needed.</para></listitem>
      </varlistentry>
 
      <varlistentry><term><option>changelog</option></term>

-       <listitem><para><literal>changelog</literal> downloads a package changelog and displays
-           it through <command>sensible-pager</command>. The server name and base
-           directory is defined in the <literal>APT::Changelogs::Server</literal>
-          variable (e.g. <ulink url="http://packages.debian.org/changelogs">packages.debian.org/changelogs</ulink> for
-          Debian or <ulink url="http://changelogs.ubuntu.com/changelogs">changelogs.ubuntu.com/changelogs</ulink> for
-           Ubuntu).
-           By default it displays the changelog for the version that is
-           installed.  However, you can specify the same options as for
-           the <option>install</option> command.
-         </para>
+       <listitem><para><literal>changelog</literal> tries to download the
+             changelog of a package and displays it through
+             <command>sensible-pager</command>.  By default it
+             displays the changelog for the version that is installed.
+             However, you can specify the same options as for the
+             <option>install</option> command.</para>

        </listitem>
      </varlistentry>
 
        </listitem>
      </varlistentry>
 

+     <varlistentry><term><option>indextargets</option></term>
+       <listitem><para>Displays by default a deb822 formatted listing of
+             information about all data files (aka index targets) <command>apt-get
+                update</command> would download. Supports a
+             <option>--format</option> option to modify the output format as
+             well as accepts lines of the default output to filter the records
+             by. The command is mainly used as an interface for external tools
+             working with APT to get information as well as filenames for
+             downloaded files so they can use them as well instead of
+             downloading them again on their own. Detailed documentation is
+             omitted here and can instead be found in the file
+             &apt-acquire-additional-files; shipped by the <package>apt-doc</package> package.
+          </para>
+       </listitem>
+     </varlistentry>

 
 
    </variablelist>
 
 
    </variablelist>


@@ -284,7 +286,7 @@
      running APT for the first time; APT itself does not allow broken package 
      dependencies to exist on a system. It is possible that a system's 
      dependency structure can be so corrupt as to require manual intervention 
      running APT for the first time; APT itself does not allow broken package 
      dependencies to exist on a system. It is possible that a system's 
      dependency structure can be so corrupt as to require manual intervention 

-     (which usually means using &dselect; or <command>dpkg --remove</command> to eliminate some of 
+     (which usually means using <command>dpkg --remove</command> to eliminate some of

      the offending packages). Use of this option together with <option>-m</option> may produce an
      error in some situations. 
      Configuration Item: <literal>APT::Get::Fix-Broken</literal>.</para></listitem>
      the offending packages). Use of this option together with <option>-m</option> may produce an
      error in some situations. 
      Configuration Item: <literal>APT::Get::Fix-Broken</literal>.</para></listitem>


@@ -325,17 +327,15 @@
                   <term><option>--dry-run</option></term>
                   <term><option>--recon</option></term>
                   <term><option>--no-act</option></term>
                   <term><option>--dry-run</option></term>
                   <term><option>--recon</option></term>
                   <term><option>--no-act</option></term>

-     <listitem><para>No action; perform a simulation of events that would occur but do not
-     actually change the system. 
-     Configuration Item: <literal>APT::Get::Simulate</literal>.</para>
-
-     <para>Simulated runs performed as a user will automatically deactivate locking
-     (<literal>Debug::NoLocking</literal>), and if the option
-     <literal>APT::Get::Show-User-Simulation-Note</literal> is set
-     (as it is by default) a notice will also be displayed indicating that
-     this is only a simulation. Runs performed as root do not trigger either
-     NoLocking or the notice - superusers should know what they are doing
-     without further warnings from <literal>apt-get</literal>.</para>
+     <listitem><para>No action; perform a simulation of events that would occur
+          based on the current system state but do not actually change the
+          system. Locking will be disabled (<option>Debug::NoLocking</option>)
+          so the system state could change while <command>apt-get</command> is
+          running. Simulations can also be executed by non-root users which might
+          not have read access to all apt configuration distorting the simulation.
+          A notice expressing this warning is also shown by default for non-root
+          users (<option>APT::Get::Show-User-Simulation-Note</option>).
+          Configuration Item: <literal>APT::Get::Simulate</literal>.</para>

 
      <para>Simulated runs print out a series of lines, each representing a <command>dpkg</command>
      operation: configure (<literal>Conf</literal>), remove (<literal>Remv</literal>)
 
      <para>Simulated runs print out a series of lines, each representing a <command>dpkg</command>
      operation: configure (<literal>Conf</literal>), remove (<literal>Remv</literal>)


@@ -357,9 +357,8 @@
      Configuration Item: <literal>APT::Get::Assume-No</literal>.</para></listitem>
      </varlistentry>
 
      Configuration Item: <literal>APT::Get::Assume-No</literal>.</para></listitem>
      </varlistentry>
 

-     <varlistentry><term><option>-u</option></term><term><option>--show-upgraded</option></term>
-     <listitem><para>Show upgraded packages; print out a list of all packages that are to be
-     upgraded. 
+     <varlistentry><term><option>--no-show-upgraded</option></term>
+     <listitem><para>Do not show a list of all packages that are to be upgraded.

      Configuration Item: <literal>APT::Get::Show-Upgraded</literal>.</para></listitem>
      </varlistentry>
 
      Configuration Item: <literal>APT::Get::Show-Upgraded</literal>.</para></listitem>
      </varlistentry>
 


@@ -374,7 +373,18 @@
      by <command>apt-get source --compile</command> and how cross-builddependencies
      are satisfied. By default is it not set which means that the host architecture
      is the same as the build architecture (which is defined by <literal>APT::Architecture</literal>).
      by <command>apt-get source --compile</command> and how cross-builddependencies
      are satisfied. By default is it not set which means that the host architecture
      is the same as the build architecture (which is defined by <literal>APT::Architecture</literal>).

-     Configuration Item: <literal>APT::Get::Host-Architecture</literal>
+     Configuration Item: <literal>APT::Get::Host-Architecture</literal>.
+     </para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>-P</option></term>
+                   <term><option>--build-profiles</option></term>
+     <listitem><para>This option controls the activated build profiles for which
+     a source package is built by <command>apt-get source --compile</command> and
+     how build dependencies are satisfied. By default no build profile is active.
+     More than one build profile can be activated at a time by concatenating them
+     with a comma.
+     Configuration Item: <literal>APT::Build-Profiles</literal>.

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


@@ -418,12 +428,36 @@
      Configuration Item: <literal>APT::Get::Only-Upgrade</literal>.</para></listitem>
      </varlistentry>
 
      Configuration Item: <literal>APT::Get::Only-Upgrade</literal>.</para></listitem>
      </varlistentry>
 

+     <varlistentry><term><option>--allow-downgrades</option></term>
+     <listitem><para>This is a dangerous option that will cause apt to continue
+     without prompting if it is doing downgrades. It
+     should not be used except in very special situations. Using
+     it can potentially destroy your system!
+     Configuration Item: <literal>APT::Get::allow-downgrades</literal>. Introduced in APT 1.1.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>--allow-remove-essential</option></term>
+     <listitem><para>Force yes; this is a dangerous option that will cause apt to continue
+     without prompting if it is removing essentials. It
+     should not be used except in very special situations. Using
+     it can potentially destroy your system!
+     Configuration Item: <literal>APT::Get::allow-remove-essential</literal>. Introduced in APT 1.1.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>--allow-change-held-packages</option></term>
+     <listitem><para>Force yes; this is a dangerous option that will cause apt to continue
+     without prompting if it is changing held packages. It
+     should not be used except in very special situations. Using
+     it can potentially destroy your system!
+     Configuration Item: <literal>APT::Get::allow-change-held-packages</literal>. Introduced in APT 1.1.</para></listitem>
+     </varlistentry>
+

      <varlistentry><term><option>--force-yes</option></term>
      <listitem><para>Force yes; this is a dangerous option that will cause apt to continue 
      without prompting if it is doing something potentially harmful. It 
      should not be used except in very special situations. Using 
      <literal>force-yes</literal> can potentially destroy your system! 
      <varlistentry><term><option>--force-yes</option></term>
      <listitem><para>Force yes; this is a dangerous option that will cause apt to continue 
      without prompting if it is doing something potentially harmful. It 
      should not be used except in very special situations. Using 
      <literal>force-yes</literal> can potentially destroy your system! 

-     Configuration Item: <literal>APT::Get::force-yes</literal>.</para></listitem>
+     Configuration Item: <literal>APT::Get::force-yes</literal>. This is deprecated and replaced by <option>--allow-downgrades</option>, <option>--allow-remove-essential</option>, <option>--allow-change-held-packages</option> in 1.1. </para></listitem>

      </varlistentry>
 
      <varlistentry><term><option>--print-uris</option></term>
      </varlistentry>
 
      <varlistentry><term><option>--print-uris</option></term>


@@ -518,9 +552,21 @@
      </varlistentry>
 
      <varlistentry><term><option>--allow-unauthenticated</option></term>
      </varlistentry>
 
      <varlistentry><term><option>--allow-unauthenticated</option></term>

-     <listitem><para>Ignore if packages can't be authenticated and don't prompt about it.
-     This is useful for tools like pbuilder.
-     Configuration Item: <literal>APT::Get::AllowUnauthenticated</literal>.</para></listitem>
+     <listitem><para>Ignore if packages can't be authenticated and don't prompt
+          about it.  This can be useful while working with local repositories,
+          but is a huge security risk if data authenticity isn't ensured in
+          another way by the user itself.  The usage of the
+          <option>Trusted</option> option for &sources-list; entries should
+          usually be preferred over this global override.  Configuration Item:
+          <literal>APT::Get::AllowUnauthenticated</literal>.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>--no-allow-insecure-repositories</option></term>
+     <listitem><para>Forbid the update command to acquire unverifiable
+     data from configured sources. Apt will fail at the update command
+     for repositories without valid cryptographically signatures.
+
+     Configuration Item: <literal>Acquire::AllowInsecureRepositories</literal>.</para></listitem>

      </varlistentry>
 
      <varlistentry><term><option>--show-progress</option></term>
      </varlistentry>
 
      <varlistentry><term><option>--show-progress</option></term>


@@ -528,7 +574,7 @@
      terminal window when packages are installed, upgraded or
      removed. For a machine parsable version of this data see
      README.progress-reporting in the apt doc directory.
      terminal window when packages are installed, upgraded or
      removed. For a machine parsable version of this data see
      README.progress-reporting in the apt doc directory.

-     Configuration Item: <literal>DpkgPM::Progress</literal> and <literal>Dpkg::Progress-Fancy</literal>.</para></listitem>
+     Configuration Item: <literal>Dpkg::Progress</literal> and <literal>Dpkg::Progress-Fancy</literal>.</para></listitem>

      </varlistentry>
     
 
      </varlistentry>
     
 


@@ -548,7 +594,7 @@
  </refsect1>
 
  <refsect1><title>See Also</title>
  </refsect1>
 
  <refsect1><title>See Also</title>

-   <para>&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;,
+   <para>&apt-cache;, &apt-cdrom;, &dpkg;, &sources-list;,

    &apt-conf;, &apt-config;, &apt-secure;, 
    The APT User's guide in &guidesdir;, &apt-preferences;, the APT Howto.</para>
  </refsect1>
    &apt-conf;, &apt-config;, &apt-secure;, 
    The APT User's guide in &guidesdir;, &apt-preferences;, the APT Howto.</para>
  </refsect1>