summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Kalnischkies <david@kalnischkies.de>2015-09-25 19:58:43 +0200
committerDavid Kalnischkies <david@kalnischkies.de>2015-11-04 18:04:00 +0100
commit64e3414e00906e6eaa72d7b63ca76d1c59ecadf6 (patch)
tree5425586b556798bc1dbbb35c53e697a5a916394e /doc
parentb49068c566d749130e023536d54588c948c16edf (diff)
allow all dpkg selections to be set via apt-mark and libapt
As we have support for 'hold', we need support for undoing a hold which in effect means that we implemented most other states as well, just that they weren't exposed in the interface directly so far.
Diffstat (limited to 'doc')
-rw-r--r--doc/apt-mark.8.xml110
-rw-r--r--doc/apt-verbatim.ent41
2 files changed, 99 insertions, 52 deletions
diff --git a/doc/apt-mark.8.xml b/doc/apt-mark.8.xml
index 94f24437e..8dd157a60 100644
--- a/doc/apt-mark.8.xml
+++ b/doc/apt-mark.8.xml
@@ -14,7 +14,7 @@
&apt-email;
&apt-product;
<!-- The last update date -->
- <date>2012-06-09T00:00:00Z</date>
+ <date>2015-09-25T00:00:00Z</date>
</refentryinfo>
<refmeta>
@@ -26,31 +26,37 @@
<!-- Man page title -->
<refnamediv>
<refname>apt-mark</refname>
- <refpurpose>mark/unmark a package as being automatically-installed</refpurpose>
+ <refpurpose>show, set and unset various settings for a package</refpurpose>
</refnamediv>
&synopsis-command-apt-mark;
<refsect1><title>Description</title>
- <para><command>apt-mark</command> will change whether a package has
- been marked as being automatically installed.
+ <para><command>apt-mark</command> can be used as a unified frontend to set
+ various settings for a package like marking a package as being
+ automatically/manually installed or changing <command>dpkg</command>
+ selections such as hold, install, deinstall and purge which are respected
+ e.g. by <command>apt-get dselect-upgrade</command> or <command>aptitude</command>.
</para>
+ </refsect1><refsect1><title>Automatically and manually installed packages</title>
<para>
When you request that a package is installed, and as a result
other packages are installed to satisfy its dependencies, the
- dependencies are marked as being automatically installed. Once
- these automatically installed packages are no longer depended on
- by any manually installed packages, they will be removed by e.g.
- <command>apt-get</command> or <command>aptitude</command>.
+ dependencies are marked as being automatically installed, while
+ package you installed explicitely is marked as manually installed.
+ Once a automatically installed package is no longer depended on
+ by any manually installed package it is considered no longer needed
+ and e.g. <command>apt-get</command> or <command>aptitude</command>
+ will at least suggest removing them.
</para>
- <variablelist>
+ <variablelist>
<varlistentry><term><option>auto</option></term>
<listitem><para><literal>auto</literal> is used to mark a
package as being automatically installed, which will cause the
package to be removed when no more manually installed packages
depend on this package.
</para></listitem>
- </varlistentry>
+ </varlistentry>
<varlistentry><term><option>manual</option></term>
<listitem><para><literal>manual</literal> is used to mark a
@@ -58,23 +64,7 @@
package from being automatically removed if no other packages
depend on it.
</para></listitem>
- </varlistentry>
-
- <varlistentry><term><option>hold</option></term>
- <listitem><para><literal>hold</literal> is used to mark a
- package as held back, which will prevent the package from being
- automatically installed, upgraded or removed.
- The command is only a wrapper around <command>dpkg --set-selections</command>
- and the state is therefore maintained by &dpkg; and not affected
- by the <option>--file</option> option.
- </para></listitem>
- </varlistentry>
-
- <varlistentry><term><option>unhold</option></term>
- <listitem><para><literal>unhold</literal> is used to cancel a
- previously set hold on a package to allow all actions again.
- </para></listitem>
- </varlistentry>
+ </varlistentry>
<varlistentry><term><option>showauto</option></term>
<listitem><para><literal>showauto</literal> is used to print a
@@ -82,38 +72,66 @@
All automatically installed packages will be listed if no package is given.
If packages are given only those which are automatically installed will be shown.
</para></listitem>
- </varlistentry>
+ </varlistentry>
<varlistentry><term><option>showmanual</option></term>
<listitem><para><literal>showmanual</literal> can be used in
the same way as <literal>showauto</literal> except that it will print
a list of manually installed packages instead.
</para></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <refsect2><title>Options</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>-f=&synopsis-param-filename;</option></term>
+ <term><option>--file=&synopsis-param-filename;</option></term>
+ <listitem><para>
+ Read/Write package stats from the filename given with the parameter
+ &synopsis-param-filename; instead of from the default location, which
+ is <filename>extended_status</filename> in the directory defined
+ by the Configuration Item: <literal>Dir::State</literal>.
+ </para></listitem>
</varlistentry>
+ </variablelist>
+ </refsect2>
- <varlistentry><term><option>showhold</option></term>
- <listitem><para><literal>showhold</literal> is used to print a list
- of packages on hold in the same way as for the other show commands.
+ </refsect1><refsect1><title>Prevent changes for a package</title>
+ <variablelist>
+ <varlistentry><term><option>hold</option></term>
+ <listitem><para><literal>hold</literal> is used to mark a
+ package as held back, which will prevent the package from being
+ automatically installed, upgraded or removed.
</para></listitem>
- </varlistentry>
+ </varlistentry>
+ <varlistentry><term><option>unhold</option></term>
+ <listitem><para><literal>unhold</literal> is used to cancel a
+ previously set hold on a package to allow all actions again.
+ </para></listitem>
+ </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1><title>options</title>
-
- <variablelist>
- <varlistentry>
- <term><option>-f=&synopsis-param-filename;</option></term>
- <term><option>--file=&synopsis-param-filename;</option></term>
- <listitem><para>
- Read/Write package stats from the filename given with the parameter
- &synopsis-param-filename; instead of from the default location, which
- is <filename>extended_status</filename> in the directory defined
- by the Configuration Item: <literal>Dir::State</literal>.</para></listitem>
+ <varlistentry><term><option>showhold</option></term>
+ <listitem><para><literal>showhold</literal> is used to print a list
+ of packages on hold in the same way as for the other show commands.
+ </para></listitem>
</varlistentry>
+ </variablelist>
+ </refsect1><refsect1><title>Shedule packages for install, remove and purge</title>
+ <para>
+ Some frontends like <command>apt-get dselect-upgrade</command> can be used to
+ apply previously sheduled changes to the install state of packages. Such changes
+ can be sheduled with the <option>install</option>, <option>remove</option>
+ (also known as <option>deinstall</option>) and <option>purge</option> commands.
+ Packages with a specific selection can be displayed with <option>showinstall</option>,
+ <option>showremove</option> and <option>showpurge</option> respectively.
+ More information about these so called dpkg selections can be found in &dpkg;.
+ </para>
+ </refsect1>
+ <refsect1><title>Options</title>
+ <variablelist>
&apt-commonoptions;
</variablelist>
</refsect1>
diff --git a/doc/apt-verbatim.ent b/doc/apt-verbatim.ent
index 448e6c2df..f5e322e11 100644
--- a/doc/apt-verbatim.ent
+++ b/doc/apt-verbatim.ent
@@ -394,18 +394,47 @@
</cmdsynopsis></refsynopsisdiv>">
<!ENTITY synopsis-command-apt-mark "<refsynopsisdiv><cmdsynopsis>
<command>apt-mark</command>
- <arg><option>-f=&synopsis-param-filename;</option></arg>
+ <group choice='plain'>
+ <group choice='req'>
+ <arg choice='plain'><option>-f=&synopsis-param-filename;</option></arg>
+ <arg choice='plain'>
+ <group choice='req'>
+ <arg choice='plain'>auto</arg>
+ <arg choice='plain'>manual</arg>
+ </group>
+ &synopsis-arg-pkg;
+ </arg>
+ <arg choice='plain'>
+ <group choice='req'>
+ <arg choice='plain'>showauto</arg>
+ <arg choice='plain'>showmanual</arg>
+ </group>
+ <arg choice='opt' rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg>
+ </arg>
+ </group>
+ &synopsis-help;
+ </group>
+</cmdsynopsis><cmdsynopsis><command>apt-mark</command>
<group choice='plain'>
<arg choice='plain'>
<group choice='req'>
- <arg choice='plain'>auto</arg>
- <arg choice='plain'>manual</arg>
- <arg choice='plain'>showauto</arg>
- <arg choice='plain'>showmanual</arg>
+ <arg choice='plain'>hold</arg>
+ <arg choice='plain'>unhold</arg>
+ <arg choice='plain'>install</arg>
+ <arg choice='plain'>remove</arg>
+ <arg choice='plain'>purge</arg>
</group>
&synopsis-arg-pkg;
</arg>
- &synopsis-help;
+ <arg choice='plain'>
+ <group choice='req'>
+ <arg choice='plain'>showhold</arg>
+ <arg choice='plain'>showinstall</arg>
+ <arg choice='plain'>showremove</arg>
+ <arg choice='plain'>showpurge</arg>
+ </group>
+ <arg choice='opt' rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg>
+ </arg>
</group>
</cmdsynopsis></refsynopsisdiv>">
<!ENTITY synopsis-command-apt-sortpkgs "<refsynopsisdiv><cmdsynopsis>