in <term> mark all options with <option> and mark <term><option>

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

diff --git a/doc/apt-mark.8.xml b/doc/apt-mark.8.xml
index f078f2de50560539398c378b8e4a2a6e597e3390..f56115635e0325f578661a0f77bd98b4199e446a 100644 (file)
--- a/doc/apt-mark.8.xml
+++ b/doc/apt-mark.8.xml
@@ -5,6 +5,9 @@
 <!ENTITY % aptent SYSTEM "apt.ent">
 %aptent;
 
 <!ENTITY % aptent SYSTEM "apt.ent">
 %aptent;
 

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

 ]>
 
 <refentry>
 ]>
 
 <refentry>


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

-   <date>9 August 2009</date>
+   <date>21 April 2011</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 -->
  </refmeta>
  
  <!-- Man page title -->


@@ -29,25 +33,8 @@
     <refpurpose>mark/unmark a package as being automatically-installed</refpurpose>
  </refnamediv>
 
     <refpurpose>mark/unmark a package as being automatically-installed</refpurpose>
  </refnamediv>
 

- <!-- Arguments -->
- <refsynopsisdiv>
-   <cmdsynopsis>
-       <command>apt-mark</command>
-       <arg><option>-hv</option></arg>
-       <arg><option>-f=<replaceable>FILENAME</replaceable></option></arg>
-       <group choice="plain">
-               <arg choice="plain">
-                       <group choice="req">
-                               <arg choice="plain">markauto</arg>
-                               <arg choice="plain">unmarkauto</arg>
-                       </group>
-                       <arg choice="plain" rep="repeat"><replaceable>package</replaceable></arg>
-               </arg>
-               <arg choice="plain">showauto</arg>
-       </group>
-   </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.


@@ -61,27 +48,60 @@
      <command>apt-get</command> or <command>aptitude</command>.
    </para>
      <variablelist>
      <command>apt-get</command> or <command>aptitude</command>.
    </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>showauto</term>
+       <varlistentry><term><option>hold</option></term>
+        <listitem><para><literal>hold</literal> is used to mark a
+       package as hold 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 effected
+       by the <option>--filename</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
         <listitem><para><literal>showauto</literal> is used to print a

-     list of manually installed packages with each package on a new line.
+     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>
        </para></listitem>
        </varlistentry>

+
+

      </variablelist>
  </refsect1>
  
      </variablelist>
  </refsect1>
  


@@ -89,43 +109,23 @@
    
    <variablelist>
        <varlistentry>
    
    <variablelist>
        <varlistentry>

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

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

-      
-     Read/Write package stats from <filename><replaceable>FILENAME</replaceable></filename>
-     instead of the default location, which
+     Read/Write package stats from the filename given with the parameter
+     <filename><replaceable>&synopsis-filename;</replaceable></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>
    </variablelist>
  </refsect1>
 
  <refsect1><title>Files</title>
    <variablelist>

-      <varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>
-      <listitem><para>Status list of auto-installed packages.
-                     Configuration Item: <literal>Dir::State</literal>
-                     sets the path to the <filename>extended_states</filename> file.
-      </para></listitem>
-      </varlistentry>
+       &file-extended_states;

    </variablelist>
  </refsect1>
 
    </variablelist>
  </refsect1>