doc/apt.ent

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