* apt-pkg/clean.cc:

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

diff --git a/doc/apt-mark.8.xml b/doc/apt-mark.8.xml
index 5af27a337a493e0878c5db252eb68d676ce0b016..3503ece8fe47da095edf7b0a45b01cf210778ec2 100644 (file)
--- a/doc/apt-mark.8.xml
+++ b/doc/apt-mark.8.xml
@@ -1,10 +1,13 @@
 <?xml version="1.0" encoding="utf-8" standalone="no"?>
 <?xml version="1.0" encoding="utf-8" standalone="no"?>

-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!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 % aptent SYSTEM "apt.ent">
 %aptent;
 

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

 ]>
 
 <refentry>
 ]>
 
 <refentry>


@@ -15,31 +18,23 @@
    &apt-email;
    &apt-product;
    <!-- The last update date -->
    &apt-email;
    &apt-product;
    <!-- The last update date -->

-   <date>2 November 2007</date>
+   <date>2012-06-09T00:00:00Z</date>

  </refentryinfo>
  
  <refmeta>
    <refentrytitle>apt-mark</refentrytitle>
    <manvolnum>8</manvolnum>
  </refentryinfo>
  
  <refmeta>
    <refentrytitle>apt-mark</refentrytitle>
    <manvolnum>8</manvolnum>

+   <refmiscinfo class="manual">APT</refmiscinfo>

  </refmeta>
  
  <!-- Man page title -->
  <refnamediv>
     <refname>apt-mark</refname>
  </refmeta>
  
  <!-- Man page title -->
  <refnamediv>
     <refname>apt-mark</refname>

-    <refpurpose>Utility to sort package index files</refpurpose>
+    <refpurpose>mark/unmark a package as being automatically-installed</refpurpose>

  </refnamediv>
 
  </refnamediv>
 

- <!-- Arguments -->
- <refsynopsisdiv>
-   <cmdsynopsis>
-      <command>apt-mark</command>
-      <arg><option>-hv</option></arg>
-      <arg><option>-f=<replaceable>FILENAME</replaceable></option></arg>
-      <group choice="req"><arg>markauto</arg><arg>unmarkauto</arg></group>
-      <arg choice="plain" rep="repeat"><replaceable>package</replaceable></arg>
-   </cmdsynopsis>
- </refsynopsisdiv>
- 
+ &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.
  <refsect1><title>Description</title>
    <para><command>apt-mark</command> will change whether a package has
    been marked as being automatically installed.


@@ -47,62 +42,94 @@
    <para>
      When you request that a package is installed, and as a result
      other packages are installed to satisfy its dependencies, the
    <para>
      When you request that a package is installed, and as a result
      other packages are installed to satisfy its dependencies, the

-     depedencies are marked as being automatically installed.  Once
+     dependencies are marked as being automatically installed.  Once

      these automatically installed packages are no longer depended on
      these automatically installed packages are no longer depended on

-     by any manually installed packages, they will be removed.
+     by any manually installed packages, they will be removed by e.g.
+     <command>apt-get</command> or <command>aptitude</command>.

    </para>
      <variablelist>
    </para>
      <variablelist>

-       <varlistentry><term>markauto</term>
-        <listitem><para><literal>markauto</literal> is used to mark a
+     <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>
 
      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><term>unmarkauto</term>
-        <listitem><para><literal>unmarkauto</literal> is used to mark a
+     <varlistentry><term><option>manual</option></term>
+        <listitem><para><literal>manual</literal> is used to mark a

      package as being manually installed, which will prevent the
      package from being automatically removed if no other packages
      depend on it.
        </para></listitem>
        </varlistentry>
      package as being manually installed, which will prevent the
      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><term><option>showauto</option></term>
+        <listitem><para><literal>showauto</literal> is used to print a
+     list of automatically installed packages with each package on a new line.
+     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><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>
+
+       <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>options</title>
    
    <variablelist>
      </variablelist>
  </refsect1>
  
  <refsect1><title>options</title>
    
    <variablelist>

-     <varlistentry><term><option>-f=<filename>FILENAME</filename></option></term><term><option>--file=<filename>FILENAME</filename></option></term>
+       <varlistentry>
+          <term><option>-f=&synopsis-param-filename;</option></term>
+          <term><option>--file=&synopsis-param-filename;</option></term>

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

-      
-     Read/Write package stats from <filename>FILENAME</filename>
-     instead of the default location, which
+     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>
      is <filename>extended_status</filename> in the directory defined
      by the Configuration Item: <literal>Dir::State</literal>.</para></listitem>
      </varlistentry>

-   
-     <varlistentry><term><option>-h</option></term>
-     <term><option>--help</option></term>
-     <listitem><para>Show a short usage summary.
-     </para>
-     </listitem>
-     </varlistentry>
-     
-     <varlistentry>
-      <term><option>-v</option></term>
-      <term><option>--version</option></term>
-      <listitem><para>Show the program version.
-     </para>
-     </listitem>
-     </varlistentry>

 
 

-     
+     &apt-commonoptions;
+   </variablelist>
+ </refsect1>
+
+ <refsect1><title>Files</title>
+   <variablelist>
+       &file-extended_states;

    </variablelist>
  </refsect1>
 
  <refsect1><title>See Also</title>
    </variablelist>
  </refsect1>
 
  <refsect1><title>See Also</title>

-   <para>&apt-conf;</para>
+    <para><phrase>&apt-get;,&aptitude;,&apt-conf;</phrase></para>

  </refsect1>
 
  <refsect1><title>Diagnostics</title>
  </refsect1>
 
  <refsect1><title>Diagnostics</title>