* Merged from the mvo branch

[apt.git] / doc / apt.ent

diff --git a/doc/apt.ent b/doc/apt.ent
index cf22df6d2dd968f94ff2417e15a94751f4ae346e..0b341ec14550c1e8a3178341c11891e1962fc732 100644 (file)
--- a/doc/apt.ent
+++ b/doc/apt.ent
@@ -2,6 +2,7 @@
 
 <!-- Some common paths.. -->
 <!ENTITY docdir "/usr/share/doc/apt/">
+<!ENTITY guidesdir "/usr/share/doc/apt-doc/">
 <!ENTITY configureindex "<filename>&docdir;examples/configure-index.gz</filename>">
 <!ENTITY aptconfdir "<filename>/etc/apt.conf</filename>">
 <!ENTITY statedir "/var/lib/apt">
@@ -56,8 +57,8 @@
   </citerefentry>"
 >
 
-<!ENTITY apt-archive "<citerefentry>
-    <refentrytitle><filename>apt-archive</filename></refentrytitle>
+<!ENTITY apt-ftparchive "<citerefentry>
+    <refentrytitle><filename>apt-ftparchive</filename></refentrytitle>
     <manvolnum>1</manvolnum>
   </citerefentry>"
 >
@@ -77,7 +78,7 @@
 
 <!ENTITY dpkg "<citerefentry>
     <refentrytitle><command>dpkg</command></refentrytitle>
-    <manvolnum>8</manvolnum>
+    <manvolnum>1</manvolnum>
   </citerefentry>"
 >
 
@@ -95,19 +96,19 @@
 
 <!ENTITY dpkg-scanpackages "<citerefentry>
     <refentrytitle><command>dpkg-scanpackages</command></refentrytitle>
-    <manvolnum>8</manvolnum>
+    <manvolnum>1</manvolnum>
   </citerefentry>"
 >
 
 <!ENTITY dpkg-scansources "<citerefentry>
     <refentrytitle><command>dpkg-scansources</command></refentrytitle>
-    <manvolnum>8</manvolnum>
+    <manvolnum>1</manvolnum>
   </citerefentry>"
 >
 
 <!ENTITY dselect "<citerefentry>
     <refentrytitle><command>dselect</command></refentrytitle>
-    <manvolnum>8</manvolnum>
+    <manvolnum>1</manvolnum>
   </citerefentry>"
 >
 
@@ -140,14 +141,29 @@
     <manvolnum>1</manvolnum>
   </citerefentry>"
 >
-    
+
+<!ENTITY gnome-apt "<citerefentry>
+    <refentrytitle><command>gnome-apt</command></refentrytitle>
+    <manvolnum>1</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY wajig "<citerefentry>
+    <refentrytitle><command>wajig</command></refentrytitle>
+    <manvolnum>1</manvolnum>
+  </citerefentry>"
+>
+ 
 <!-- Boiler plate docinfo section -->
 <!ENTITY apt-docinfo "
  <refentryinfo>
    <address><email>apt@packages.debian.org</email></address>
-   <author><firstname>Jason</firstname> <surname>Gunthorpe</surname></author>
+   <author>
+     <firstname>Jason</firstname> <surname>Gunthorpe</surname>
+     <contrib></contrib>
+   </author>
    <copyright><year>1998-2001</year> <holder>Jason Gunthorpe</holder></copyright>
-   <date>14 December 2003</date>
+   <date>28 October 2008</date>
    <productname>Linux</productname>
 
  </refentryinfo>
@@ -163,38 +179,29 @@
    <author>
     <firstname>Jason</firstname>
     <surname>Gunthorpe</surname>
+    <contrib></contrib>
    </author>
 ">
 
-<!ENTITY apt-author.team "
+<!ENTITY apt-author.moconnor "
    <author>
-    <othername>APT team</othername>
-   </author>
-">
-
-<!ENTITY apt-product "
-   <productname>Linux</productname>
-">
-
-<!ENTITY apt-email "
-   <address>
-    <email>apt@packages.debian.org</email>
-   </address>
-">
-
-<!ENTITY apt-author.jgunthorpe "
-   <author>
-    <firstname>Jason</firstname>
-    <surname>Gunthorpe</surname>
+    <firstname>Mike</firstname>
+    <surname>O'Connor</surname>
+    <contrib></contrib>
    </author>
 ">
 
 <!ENTITY apt-author.team "
    <author>
     <othername>APT team</othername>
+    <contrib></contrib>
    </author>
 ">
 
+<!ENTITY apt-product "
+   <productname>Linux</productname>
+">
+
 <!ENTITY apt-copyright "
     <copyright>
      <holder>Jason Gunthorpe</holder>
@@ -206,6 +213,12 @@
    <productname>Linux</productname>
 ">
 
+<!ENTITY apt-qapage "
+       <para>
+               <ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>
+       </para>
+">
+
 <!-- Boiler plate Bug reporting section -->
 <!ENTITY manbugs "
  <refsect1><title>Bugs</title>
@@ -256,8 +269,10 @@
      <varlistentry>
       <term><option>-o</option></term>
       <term><option>--option</option></term>
-     <listitem><para>Set a Configuration Option; This will set an arbitary
+     <listitem><para>Set a Configuration Option; This will set an arbitrary
       configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
+      <option>-o</option> and <option>--option</option> can be used multiple
+      times to set different options.
      </para>
      </listitem>
      </varlistentry>
@@ -274,3 +289,67 @@
    </para>
 ">
 
+<!ENTITY file-aptconf "
+     <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>
+     <listitem><para>APT configuration file.
+     Configuration Item: <literal>Dir::Etc::Main</literal>.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>
+     <listitem><para>APT configuration file fragments.
+     Configuration Item: <literal>Dir::Etc::Parts</literal>.</para></listitem>
+     </varlistentry>
+">
+
+<!ENTITY file-cachearchives "
+     <varlistentry><term><filename>&cachedir;/archives/</filename></term>
+     <listitem><para>Storage area for retrieved package files.
+     Configuration Item: <literal>Dir::Cache::Archives</literal>.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>
+     <listitem><para>Storage area for package files in transit.
+     Configuration Item: <literal>Dir::Cache::Archives</literal> (implicit partial). </para></listitem>
+     </varlistentry>
+">
+
+<!ENTITY file-preferences "
+     <varlistentry><term><filename>/etc/apt/preferences</filename></term>
+     <listitem><para>Version preferences file.
+     This is where you would specify &quot;pinning&quot;,
+     i.e. a preference to get certain packages
+     from a separate source
+     or from a different version of a distribution.
+     Configuration Item: <literal>Dir::Etc::Preferences</literal>.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>
+     <listitem><para>File fragments for the version preferences.
+     Configuration Item: <literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>
+     </varlistentry>
+">
+
+<!ENTITY file-sourceslist "
+     <varlistentry><term><filename>/etc/apt/sources.list</filename></term>
+     <listitem><para>Locations to fetch packages from.
+     Configuration Item: <literal>Dir::Etc::SourceList</literal>.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>
+     <listitem><para>File fragments for locations to fetch packages from.
+     Configuration Item: <literal>Dir::Etc::SourceParts</literal>.</para></listitem>
+     </varlistentry>
+">
+
+<!ENTITY file-statelists "
+     <varlistentry><term><filename>&statedir;/lists/</filename></term>
+     <listitem><para>Storage area for state information for each package resource specified in
+     &sources-list;
+     Configuration Item: <literal>Dir::State::Lists</literal>.</para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><filename>&statedir;/lists/partial/</filename></term>
+     <listitem><para>Storage area for state information in transit.
+     Configuration Item: <literal>Dir::State::Lists</literal> (implicit partial).</para></listitem>
+     </varlistentry>
+">