* Replace SGML manpages with XML man pages from richard...

[ntk/apt.git] / doc / apt.ent

<!-- -*- mode: sgml; mode: fold -*- -->

<!-- Some common paths.. -->
<!ENTITY docdir "/usr/share/doc/apt/">
<!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</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 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>"
>
    
<!-- 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>14 December 2003</date>
   <productname>Linux</productname>

 </refentryinfo>
"> 

<!-- Boiler plate Bug reporting section -->
<!ENTITY manbugs "
 <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</title>
   <para>APT was written by the APT team <email>apt@packages.debian.org</email>.
   </para>
 </refsect1>
">

<!-- Should be used in every man page to get the date bottom center of
     the man page -->
<!ENTITY apt-preamble "
  <refentryinfo>
    <date>14 December 2003</date>
    <productname>Linux</productname>
  </refentryinfo>
">

<!-- 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</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>

     <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.     
     </para>
     </listitem>
     </varlistentry>
     
     <varlistentry>
      <term><option>-o</option></term>
      <term><option>--option</option></term>
     <listitem><para>Set a Configuration Option; This will set an arbitary
      configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
     </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
   descriptions indicate the configuration option to set. For boolean
   options you can override the config file by using something like 
   <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>
   or several other variations.
   </para>
">