doc/apt.ent

   1 <!-- -*- mode: sgml; mode: fold -*- -->
   2
   3 <!-- Some common paths.. -->
   4 <!ENTITY docdir "/usr/share/doc/apt/">
   5 <!ENTITY configureindex "<filename>&docdir;examples/configure-index.gz</filename>">
   6 <!ENTITY aptconfdir "<filename>/etc/apt.conf</filename>">
   7 <!ENTITY statedir "/var/lib/apt">
   8 <!ENTITY cachedir "/var/cache/apt">
   9
  10 <!-- Cross references to other man pages -->
  11 <!ENTITY apt-conf "<citerefentry>
  12     <refentrytitle><filename>apt.conf</filename></refentrytitle>
  13     <manvolnum>5</manvolnum>
  14   </citerefentry>"
  15 >
  16
  17 <!ENTITY apt-get "<citerefentry>
  18     <refentrytitle><command>apt-get</command></refentrytitle>
  19     <manvolnum>8</manvolnum>
  20   </citerefentry>"
  21 >
  22
  23 <!ENTITY apt-config "<citerefentry>
  24     <refentrytitle><command>apt-config</command></refentrytitle>
  25     <manvolnum>8</manvolnum>
  26   </citerefentry>"
  27 >
  28
  29 <!ENTITY apt-cdrom "<citerefentry>
  30     <refentrytitle><command>apt-cdrom</command></refentrytitle>
  31     <manvolnum>8</manvolnum>
  32   </citerefentry>"
  33 >
  34
  35 <!ENTITY apt-cache "<citerefentry>
  36     <refentrytitle><command>apt-cache</command></refentrytitle>
  37     <manvolnum>8</manvolnum>
  38   </citerefentry>"
  39 >
  40
  41 <!ENTITY apt-preferences "<citerefentry>
  42     <refentrytitle><command>apt_preferences</command></refentrytitle>
  43     <manvolnum>5</manvolnum>
  44   </citerefentry>"
  45 >
  46
  47 <!ENTITY sources-list "<citerefentry>
  48     <refentrytitle><filename>sources.list</filename></refentrytitle>
  49     <manvolnum>5</manvolnum>
  50   </citerefentry>"
  51 >
  52
  53 <!ENTITY reportbug "<citerefentry>
  54     <refentrytitle><command>reportbug</command></refentrytitle>
  55     <manvolnum>1</manvolnum>
  56   </citerefentry>"
  57 >
  58
  59 <!ENTITY dpkg "<citerefentry>
  60     <refentrytitle><command>dpkg</command></refentrytitle>
  61     <manvolnum>8</manvolnum>
  62   </citerefentry>"
  63 >
  64
  65 <!ENTITY dpkg-buildpackage "<citerefentry>
  66     <refentrytitle><command>dpkg-buildpackage</command></refentrytitle>
  67     <manvolnum>1</manvolnum>
  68   </citerefentry>"
  69 >
  70
  71 <!ENTITY gzip "<citerefentry>
  72     <refentrytitle><command>gzip</command></refentrytitle>
  73     <manvolnum>1</manvolnum>
  74   </citerefentry>"
  75 >
  76
  77 <!ENTITY dpkg-scanpackages "<citerefentry>
  78     <refentrytitle><command>dpkg-scanpackages</command></refentrytitle>
  79     <manvolnum>8</manvolnum>
  80   </citerefentry>"
  81 >
  82
  83 <!ENTITY dpkg-scansources "<citerefentry>
  84     <refentrytitle><command>dpkg-scansources</command></refentrytitle>
  85     <manvolnum>8</manvolnum>
  86   </citerefentry>"
  87 >
  88
  89 <!ENTITY dselect "<citerefentry>
  90     <refentrytitle><command>dselect</command></refentrytitle>
  91     <manvolnum>8</manvolnum>
  92   </citerefentry>"
  93 >
  94
  95 <!-- Boiler plate docinfo section -->
  96 <!ENTITY apt-docinfo "
  97  <refentryinfo>
  98    <address><email>apt@packages.debian.org</email></address>
  99    <author><firstname>Jason</firstname> <surname>Gunthorpe</surname></author>
 100    <copyright><year>1998-2001</year> <holder>Jason Gunthorpe</holder></copyright>
 101    <date>14 December 2003</date>
 102    <productname>Linux</productname>
 103
 104  </refentryinfo>
 105 ">
 106
 107 <!ENTITY apt-email "
 108    <address>
 109     <email>apt@packages.debian.org</email>
 110    </address>
 111 ">
 112
 113 <!ENTITY apt-author.jgunthorpe "
 114    <author>
 115     <firstname>Jason</firstname>
 116     <surname>Gunthorpe</surname>
 117    </author>
 118 ">
 119
 120 <!ENTITY apt-author.team "
 121    <author>
 122     <othername>APT team</othername>
 123    </author>
 124 ">
 125
 126 <!ENTITY apt-copyright "
 127     <copyright>
 128      <holder>Jason Gunthorpe</holder>
 129      <year>1998-2001</year>
 130     </copyright>
 131 ">
 132
 133 <!ENTITY apt-product "
 134    <productname>Linux</productname>
 135 ">
 136
 137 <!-- Boiler plate Bug reporting section -->
 138 <!ENTITY manbugs "
 139  <refsect1><title>Bugs</title>
 140    <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.
 141    If you wish to report a bug in APT, please see
 142    <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the
 143    &reportbug; command.
 144    </para>
 145  </refsect1>
 146 ">
 147
 148 <!-- Boiler plate Author section -->
 149 <!ENTITY manauthor "
 150  <refsect1><title>Author</title>
 151    <para>APT was written by the APT team <email>apt@packages.debian.org</email>.
 152    </para>
 153  </refsect1>
 154 ">
 155
 156 <!-- Should be used within the option section of the text to
 157      put in the blurb about -h, -v, -c and -o -->
 158 <!ENTITY apt-commonoptions "
 159      <varlistentry><term><option>-h</option></term>
 160      <term><option>--help</option></term>
 161      <listitem><para>Show a short usage summary.
 162      </para>
 163      </listitem>
 164      </varlistentry>
 165
 166      <varlistentry>
 167       <term><option>-v</option></term>
 168       <term><option>--version</option></term>
 169       <listitem><para>Show the program version.
 170      </para>
 171      </listitem>
 172      </varlistentry>
 173
 174      <varlistentry>
 175       <term><option>-c</option></term>
 176       <term><option>--config-file</option></term>
 177      <listitem><para>Configuration File; Specify a configuration file to use.
 178      The program will read the default configuration file and then this
 179      configuration file. See &apt-conf; for syntax information.
 180      </para>
 181      </listitem>
 182      </varlistentry>
 183
 184      <varlistentry>
 185       <term><option>-o</option></term>
 186       <term><option>--option</option></term>
 187      <listitem><para>Set a Configuration Option; This will set an arbitary
 188       configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
 189      </para>
 190      </listitem>
 191      </varlistentry>
 192 ">
 193
 194 <!-- Should be used within the option section of the text to
 195      put in the blurb about -h, -v, -c and -o -->
 196 <!ENTITY apt-cmdblurb "
 197    <para>All command line options may be set using the configuration file, the
 198    descriptions indicate the configuration option to set. For boolean
 199    options you can override the config file by using something like
 200    <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>
 201    or several other variations.
 202    </para>
 203 ">
 204