]> git.saurik.com Git - apt.git/blobdiff - doc/apt.ent
projects / apt.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
configure-index: document Dir::Etc::SourceParts and some other options
[apt.git] / doc / apt.ent
diff --git a/doc/apt.ent b/doc/apt.ent
index 56a08a087f9338c2208d465d396ec2dd7ad73b7b..4cfc0006963ee45e1d24df12da7beef0e0d3dc7e 100644 (file)
--- a/doc/apt.ent
+++ b/doc/apt.ent
@@ -2,158 +2,303 @@
 
 <!-- Some common paths.. -->
 <!ENTITY docdir "/usr/share/doc/apt/">
-<!ENTITY configureindex "<filename>&docdir;/examples/configure-index</>">
-<!ENTITY aptconfdir "<filename>/etc/apt.conf</>">
+<!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">
 <!ENTITY cachedir "/var/cache/apt">
 
 <!-- Cross references to other man pages -->
-<!ENTITY apt-conf "
-  <CiteRefEntry>
-    <RefEntryTitle><filename/apt.conf/</RefEntryTitle>
-    <ManVolNum/5/
-  </CiteRefEntry>
-">
+<!ENTITY apt-conf "<citerefentry>
+    <refentrytitle><filename>apt.conf</filename></refentrytitle>
+    <manvolnum>5</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY apt-get "<citerefentry>
+    <refentrytitle><command>apt-get</command></refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY apt-config "<citerefentry>
+    <refentrytitle><command>apt-config</command></refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY apt-cdrom "<citerefentry>
+    <refentrytitle><command>apt-cdrom</command></refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY apt-cache "<citerefentry>
+    <refentrytitle><command>apt-cache</command></refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY apt-preferences "<citerefentry>
+    <refentrytitle><command>apt_preferences</command></refentrytitle>
+    <manvolnum>5</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY apt-key "<citerefentry>
+    <refentrytitle><command>apt-key</command></refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY apt-secure "<citerefentry>
+    <refentrytitle>apt-secure</refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY apt-ftparchive "<citerefentry>
+    <refentrytitle><filename>apt-ftparchive</filename></refentrytitle>
+    <manvolnum>1</manvolnum>
+  </citerefentry>"
+>
+
+
+<!ENTITY sources-list "<citerefentry>
+    <refentrytitle><filename>sources.list</filename></refentrytitle>
+    <manvolnum>5</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY reportbug "<citerefentry>
+    <refentrytitle><command>reportbug</command></refentrytitle>
+    <manvolnum>1</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY dpkg "<citerefentry>
+    <refentrytitle><command>dpkg</command></refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY dpkg-buildpackage "<citerefentry>
+    <refentrytitle><command>dpkg-buildpackage</command></refentrytitle>
+    <manvolnum>1</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY gzip "<citerefentry>
+    <refentrytitle><command>gzip</command></refentrytitle>
+    <manvolnum>1</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY dpkg-scanpackages "<citerefentry>
+    <refentrytitle><command>dpkg-scanpackages</command></refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY dpkg-scansources "<citerefentry>
+    <refentrytitle><command>dpkg-scansources</command></refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY dselect "<citerefentry>
+    <refentrytitle><command>dselect</command></refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
 
-<!ENTITY apt-get "
-  <CiteRefEntry>
-    <RefEntryTitle><command/apt-get/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!ENTITY aptitude "<citerefentry>
+    <refentrytitle><command>aptitude</command></refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY synaptic "<citerefentry>
+    <refentrytitle><command>synaptic</command></refentrytitle>
+    <manvolnum>8</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY debsign "<citerefentry>
+    <refentrytitle><command>debsign</command></refentrytitle>
+    <manvolnum>1</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY debsig-verify "<citerefentry>
+    <refentrytitle><command>debsig-verify</command></refentrytitle>
+    <manvolnum>1</manvolnum>
+  </citerefentry>"
+>
+
+<!ENTITY gpg "<citerefentry>
+    <refentrytitle><command>gpg</command></refentrytitle>
+    <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>
+   <copyright><year>1998-2001</year> <holder>Jason Gunthorpe</holder></copyright>
+   <date>28 October 2008</date>
+   <productname>Linux</productname>
+
+ </refentryinfo>
+"> 
+
+<!ENTITY apt-email "
+   <address>
+    <email>apt@packages.debian.org</email>
+   </address>
 ">
 
-<!ENTITY apt-cdrom "
-  <CiteRefEntry>
-    <RefEntryTitle><command/apt-cdrom/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!ENTITY apt-author.jgunthorpe "
+   <author>
+    <firstname>Jason</firstname>
+    <surname>Gunthorpe</surname>
+   </author>
 ">
 
-<!ENTITY apt-cache "
-  <CiteRefEntry>
-    <RefEntryTitle><command/apt-cache/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!ENTITY apt-author.moconnor "
+   <author>
+    <firstname>Mike</firstname>
+    <surname>O'Connor</surname>
+   </author>
 ">
 
-<!ENTITY sources-list "
-  <CiteRefEntry>
-    <RefEntryTitle><filename/sources.list/</RefEntryTitle>
-    <ManVolNum/5/
-  </CiteRefEntry>
+<!ENTITY apt-author.team "
+   <author>
+    <othername>APT team</othername>
+   </author>
 ">
 
-<!ENTITY bug "
-  <CiteRefEntry>
-    <RefEntryTitle><command/bug/</RefEntryTitle>
-    <ManVolNum/1/
-  </CiteRefEntry>
+<!ENTITY apt-product "
+   <productname>Linux</productname>
 ">
 
-<!ENTITY dpkg "
-  <CiteRefEntry>
-    <RefEntryTitle><command/dpkg/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!ENTITY apt-email "
+   <address>
+    <email>apt@packages.debian.org</email>
+   </address>
 ">
 
-<!ENTITY dpkg-buildpackage "
-  <CiteRefEntry>
-    <RefEntryTitle><command/dpkg-buildpackage/</RefEntryTitle>
-    <ManVolNum/1/
-  </CiteRefEntry>
+<!ENTITY apt-author.jgunthorpe "
+   <author>
+    <firstname>Jason</firstname>
+    <surname>Gunthorpe</surname>
+   </author>
 ">
 
-<!ENTITY gzip "
-  <CiteRefEntry>
-    <RefEntryTitle><command/gzip/</RefEntryTitle>
-    <ManVolNum/1/
-  </CiteRefEntry>
+<!ENTITY apt-author.team "
+   <author>
+    <othername>APT team</othername>
+   </author>
 ">
 
-<!ENTITY dpkg-scanpackages "
-  <CiteRefEntry>
-    <RefEntryTitle><command/dpkg-scanpackages/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!ENTITY apt-copyright "
+    <copyright>
+     <holder>Jason Gunthorpe</holder>
+     <year>1998-2001</year>
+    </copyright>
 ">
 
-<!ENTITY dpkg-scansources "
-  <CiteRefEntry>
-    <RefEntryTitle><command/dpkg-scansources/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!ENTITY apt-product "
+   <productname>Linux</productname>
 ">
 
-<!ENTITY dselect "
-  <CiteRefEntry>
-    <RefEntryTitle><command/dselect/</RefEntryTitle>
-    <ManVolNum/8/
-  </CiteRefEntry>
+<!ENTITY apt-qapage "
+       <para>
+               <ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>
+       </para>
 ">
-    
-<!-- Boiler plate docinfo section -->
-<!ENTITY apt-docinfo "
- <docinfo>
-   <address><email>apt@packages.debian.org</></address>
-   <author><firstname>Jason</> <surname>Gunthorpe</></>
-   <copyright><year>1998-2000</> <holder>Jason Gunthorpe</></>
-   <date>20 September 2000</>
- </docinfo>
-"> 
 
 <!-- Boiler plate Bug reporting section -->
 <!ENTITY manbugs "
- <RefSect1><Title>Bugs</>
-   <para>
-   See the <ulink url='http://bugs.debian.org/apt'>APT bug page</>.  
-   If you wish to report a bug in APT, please see 
-   <filename>/usr/share/doc/debian/bug-reporting.txt</> or the &bug; command.
- </RefSect1>
+ <refsect1><title>Bugs</title>
+   <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>. 
+   If you wish to report a bug in APT, please see
+   <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the
+   &reportbug; command.
+   </para>
+ </refsect1>
 ">
 
 <!-- Boiler plate Author section -->
 <!ENTITY manauthor "
- <RefSect1><Title>Author</>
-   <para>
-   APT was written by the APT team <email>apt@packages.debian.org</>.
- </RefSect1>
+ <refsect1><title>Author</title>
+   <para>APT was written by the APT team <email>apt@packages.debian.org</email>.
+   </para>
+ </refsect1>
 ">
 
 <!-- Should be used within the option section of the text to
      put in the blurb about -h, -v, -c and -o -->
 <!ENTITY apt-commonoptions "
-     <VarListEntry><term><option/-h/</><term><option/--help/</>
-     <ListItem><Para>
-     Show a short usage summary.
-     </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/</><term><option/--version/</>
-     <ListItem><Para>
-     Show the program verison.
-     </VarListEntry>
-
-     <VarListEntry><term><option/-c/</><term><option/--config-file/</>
-     <ListItem><Para>
-     Configuration File; Specify a configuration file to use. 
+     <varlistentry>
+      <term><option>-v</option></term>
+      <term><option>--version</option></term>
+      <listitem><para>Show the program version.
+     </para>
+     </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><option>-c</option></term>
+      <term><option>--config-file</option></term>
+     <listitem><para>Configuration File; Specify a configuration file to use. 
      The program will read the default configuration file and then this 
      configuration file. See &apt-conf; for syntax information.     
-     </VarListEntry>
+     </para>
+     </listitem>
+     </varlistentry>
      
-     <VarListEntry><term><option/-o/</><term><option/--option/</>
-     <ListItem><Para>
-     Set a Configuration Option; This will set an arbitary configuration 
-     option. The syntax is <option>-o Foo::Bar=bar</>.
-     </VarListEntry>
+     <varlistentry>
+      <term><option>-o</option></term>
+      <term><option>--option</option></term>
+     <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>
 ">
 
 <!-- Should be used within the option section of the text to
      put in the blurb about -h, -v, -c and -o -->
 <!ENTITY apt-cmdblurb "
-   <para>
-   All command line options may be set using the configuration file, the
+   <para>All command line options may be set using the configuration file, the
    descriptions indicate the configuration option to set. For boolean
    options you can override the config file by using something like 
-   <option/-f-/,<option/--no-f/, <option/-f=no/ or several other variations.
+   <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>
+   or several other variations.
    </para>
 ">
+
APT (for Cydia)