Update Status field values handling

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

diff --git a/doc/apt-mark.8.xml b/doc/apt-mark.8.xml
index 01c8665ddc646b531baf9b6faefd53796625f8c1..94f24437eacd72cebf8ed1bbf85d5ae54e54d6c6 100644 (file)
--- a/doc/apt-mark.8.xml
+++ b/doc/apt-mark.8.xml
@@ -1,13 +1,9 @@
 <?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" [
-
-<!ENTITY % aptent SYSTEM "apt.ent">
-%aptent;
-
-<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
-%aptverbatiment;
-
+<!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;
 ]>
 
 <refentry>
@@ -18,7 +14,7 @@
    &apt-email;
    &apt-product;
    <!-- The last update date -->
-   <date>21 April 2011</date>
+   <date>2012-06-09T00:00:00Z</date>
  </refentryinfo>
  
  <refmeta>
@@ -33,26 +29,8 @@
     <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">auto</arg>
-                               <arg choice="plain">manual</arg>
-                               <arg choice="plain">showauto</arg>
-                               <arg choice="plain">showmanual</arg>
-                       </group>
-                       <arg choice="plain" rep="repeat"><replaceable>package</replaceable></arg>
-               </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.
@@ -66,7 +44,7 @@
      <command>apt-get</command> or <command>aptitude</command>.
    </para>
      <variablelist>
-       <varlistentry><term>auto</term>
+     <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
@@ -74,7 +52,7 @@
        </para></listitem>
        </varlistentry>
 
-       <varlistentry><term>manual</term>
+     <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
@@ -82,23 +60,23 @@
        </para></listitem>
        </varlistentry>
 
-       <varlistentry><term>hold</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
+       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 effected
-       by the <option>--filename</option> option.
+       and the state is therefore maintained by &dpkg; and not affected
+       by the <option>--file</option> option.
        </para></listitem>
        </varlistentry>
 
-       <varlistentry><term>unhold</term>
+       <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>showauto</term>
+       <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.
@@ -106,14 +84,14 @@
        </para></listitem>
        </varlistentry>
 
-       <varlistentry><term>showmanual</term>
+       <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>showhold</term>
+       <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>
@@ -127,12 +105,11 @@
    
    <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=&synopsis-param-filename;</option></term>
+          <term><option>--file=&synopsis-param-filename;</option></term>
      <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
+     &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>
@@ -148,7 +125,7 @@
  </refsect1>
 
  <refsect1><title>See Also</title>
-   <para>&apt-get;,&aptitude;,&apt-conf;</para>
+    <para><phrase>&apt-get;,&aptitude;,&apt-conf;</phrase></para>
  </refsect1>
 
  <refsect1><title>Diagnostics</title>