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 apt-key "<citerefentry>
  48     <refentrytitle><command>apt-key</command></refentrytitle>
  49     <manvolnum>8</manvolnum>
  50   </citerefentry>"
  51 >
  52
  53 <!ENTITY apt-secure "<citerefentry>
  54     <refentrytitle>apt-secure</refentrytitle>
  55     <manvolnum>8</manvolnum>
  56   </citerefentry>"
  57 >
  58
  59 <!ENTITY apt-archive "<citerefentry>
  60     <refentrytitle><filename>apt-archive</filename></refentrytitle>
  61     <manvolnum>1</manvolnum>
  62   </citerefentry>"
  63 >
  64
  65
  66 <!ENTITY sources-list "<citerefentry>
  67     <refentrytitle><filename>sources.list</filename></refentrytitle>
  68     <manvolnum>5</manvolnum>
  69   </citerefentry>"
  70 >
  71
  72 <!ENTITY reportbug "<citerefentry>
  73     <refentrytitle><command>reportbug</command></refentrytitle>
  74     <manvolnum>1</manvolnum>
  75   </citerefentry>"
  76 >
  77
  78 <!ENTITY dpkg "<citerefentry>
  79     <refentrytitle><command>dpkg</command></refentrytitle>
  80     <manvolnum>8</manvolnum>
  81   </citerefentry>"
  82 >
  83
  84 <!ENTITY dpkg-buildpackage "<citerefentry>
  85     <refentrytitle><command>dpkg-buildpackage</command></refentrytitle>
  86     <manvolnum>1</manvolnum>
  87   </citerefentry>"
  88 >
  89
  90 <!ENTITY gzip "<citerefentry>
  91     <refentrytitle><command>gzip</command></refentrytitle>
  92     <manvolnum>1</manvolnum>
  93   </citerefentry>"
  94 >
  95
  96 <!ENTITY dpkg-scanpackages "<citerefentry>
  97     <refentrytitle><command>dpkg-scanpackages</command></refentrytitle>
  98     <manvolnum>8</manvolnum>
  99   </citerefentry>"
 100 >
 101
 102 <!ENTITY dpkg-scansources "<citerefentry>
 103     <refentrytitle><command>dpkg-scansources</command></refentrytitle>
 104     <manvolnum>8</manvolnum>
 105   </citerefentry>"
 106 >
 107
 108 <!ENTITY dselect "<citerefentry>
 109     <refentrytitle><command>dselect</command></refentrytitle>
 110     <manvolnum>8</manvolnum>
 111   </citerefentry>"
 112 >
 113
 114 <!ENTITY aptitude "<citerefentry>
 115     <refentrytitle><command>aptitude</command></refentrytitle>
 116     <manvolnum>8</manvolnum>
 117   </citerefentry>"
 118 >
 119
 120 <!ENTITY synaptic "<citerefentry>
 121     <refentrytitle><command>synaptic</command></refentrytitle>
 122     <manvolnum>8</manvolnum>
 123   </citerefentry>"
 124 >
 125
 126 <!ENTITY debsign "<citerefentry>
 127     <refentrytitle><command>debsign</command></refentrytitle>
 128     <manvolnum>1</manvolnum>
 129   </citerefentry>"
 130 >
 131
 132 <!ENTITY debsig-verify "<citerefentry>
 133     <refentrytitle><command>debsig-verify</command></refentrytitle>
 134     <manvolnum>1</manvolnum>
 135   </citerefentry>"
 136 >
 137
 138 <!ENTITY gpg "<citerefentry>
 139     <refentrytitle><command>gpg</command></refentrytitle>
 140     <manvolnum>1</manvolnum>
 141   </citerefentry>"
 142 >
 143
 144 <!-- Boiler plate docinfo section -->
 145 <!ENTITY apt-docinfo "
 146  <refentryinfo>
 147    <address><email>apt@packages.debian.org</email></address>
 148    <author><firstname>Jason</firstname> <surname>Gunthorpe</surname></author>
 149    <copyright><year>1998-2001</year> <holder>Jason Gunthorpe</holder></copyright>
 150    <date>14 December 2003</date>
 151    <productname>Linux</productname>
 152
 153  </refentryinfo>
 154 ">
 155
 156 <!ENTITY apt-email "
 157    <address>
 158     <email>apt@packages.debian.org</email>
 159    </address>
 160 ">
 161
 162 <!ENTITY apt-author.jgunthorpe "
 163    <author>
 164     <firstname>Jason</firstname>
 165     <surname>Gunthorpe</surname>
 166    </author>
 167 ">
 168
 169 <!ENTITY apt-author.team "
 170    <author>
 171     <othername>APT team</othername>
 172    </author>
 173 ">
 174
 175 <!ENTITY apt-product "
 176    <productname>Linux</productname>
 177 ">
 178
 179 <!ENTITY apt-email "
 180    <address>
 181     <email>apt@packages.debian.org</email>
 182    </address>
 183 ">
 184
 185 <!ENTITY apt-author.jgunthorpe "
 186    <author>
 187     <firstname>Jason</firstname>
 188     <surname>Gunthorpe</surname>
 189    </author>
 190 ">
 191
 192 <!ENTITY apt-author.team "
 193    <author>
 194     <othername>APT team</othername>
 195    </author>
 196 ">
 197
 198 <!ENTITY apt-copyright "
 199     <copyright>
 200      <holder>Jason Gunthorpe</holder>
 201      <year>1998-2001</year>
 202     </copyright>
 203 ">
 204
 205 <!ENTITY apt-product "
 206    <productname>Linux</productname>
 207 ">
 208
 209 <!-- Boiler plate Bug reporting section -->
 210 <!ENTITY manbugs "
 211  <refsect1><title>Bugs</title>
 212    <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.
 213    If you wish to report a bug in APT, please see
 214    <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the
 215    &reportbug; command.
 216    </para>
 217  </refsect1>
 218 ">
 219
 220 <!-- Boiler plate Author section -->
 221 <!ENTITY manauthor "
 222  <refsect1><title>Author</title>
 223    <para>APT was written by the APT team <email>apt@packages.debian.org</email>.
 224    </para>
 225  </refsect1>
 226 ">
 227
 228 <!-- Should be used within the option section of the text to
 229      put in the blurb about -h, -v, -c and -o -->
 230 <!ENTITY apt-commonoptions "
 231      <varlistentry><term><option>-h</option></term>
 232      <term><option>--help</option></term>
 233      <listitem><para>Show a short usage summary.
 234      </para>
 235      </listitem>
 236      </varlistentry>
 237
 238      <varlistentry>
 239       <term><option>-v</option></term>
 240       <term><option>--version</option></term>
 241       <listitem><para>Show the program version.
 242      </para>
 243      </listitem>
 244      </varlistentry>
 245
 246      <varlistentry>
 247       <term><option>-c</option></term>
 248       <term><option>--config-file</option></term>
 249      <listitem><para>Configuration File; Specify a configuration file to use.
 250      The program will read the default configuration file and then this
 251      configuration file. See &apt-conf; for syntax information.
 252      </para>
 253      </listitem>
 254      </varlistentry>
 255
 256      <varlistentry>
 257       <term><option>-o</option></term>
 258       <term><option>--option</option></term>
 259      <listitem><para>Set a Configuration Option; This will set an arbitary
 260       configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
 261      </para>
 262      </listitem>
 263      </varlistentry>
 264 ">
 265
 266 <!-- Should be used within the option section of the text to
 267      put in the blurb about -h, -v, -c and -o -->
 268 <!ENTITY apt-cmdblurb "
 269    <para>All command line options may be set using the configuration file, the
 270    descriptions indicate the configuration option to set. For boolean
 271    options you can override the config file by using something like
 272    <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>
 273    or several other variations.
 274    </para>
 275 ">
 276