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-ftparchive "<citerefentry>
  61     <refentrytitle><filename>apt-ftparchive</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 <!ENTITY gnome-apt "<citerefentry>
 146     <refentrytitle><command>gnome-apt</command></refentrytitle>
 147     <manvolnum>1</manvolnum>
 148   </citerefentry>"
 149 >
 150
 151 <!ENTITY wajig "<citerefentry>
 152     <refentrytitle><command>wajig</command></refentrytitle>
 153     <manvolnum>1</manvolnum>
 154   </citerefentry>"
 155 >
 156
 157 <!-- Boiler plate docinfo section -->
 158 <!ENTITY apt-docinfo "
 159  <refentryinfo>
 160    <address><email>apt@packages.debian.org</email></address>
 161    <author><firstname>Jason</firstname> <surname>Gunthorpe</surname></author>
 162    <copyright><year>1998-2001</year> <holder>Jason Gunthorpe</holder></copyright>
 163    <date>28 October 2008</date>
 164    <productname>Linux</productname>
 165
 166  </refentryinfo>
 167 ">
 168
 169 <!ENTITY apt-email "
 170    <address>
 171     <email>apt@packages.debian.org</email>
 172    </address>
 173 ">
 174
 175 <!ENTITY apt-author.jgunthorpe "
 176    <author>
 177     <firstname>Jason</firstname>
 178     <surname>Gunthorpe</surname>
 179    </author>
 180 ">
 181
 182 <!ENTITY apt-author.moconnor "
 183    <author>
 184     <firstname>Mike</firstname>
 185     <surname>O'Connor</surname>
 186    </author>
 187 ">
 188
 189 <!ENTITY apt-author.team "
 190    <author>
 191     <othername>APT team</othername>
 192    </author>
 193 ">
 194
 195 <!ENTITY apt-product "
 196    <productname>Linux</productname>
 197 ">
 198
 199 <!ENTITY apt-email "
 200    <address>
 201     <email>apt@packages.debian.org</email>
 202    </address>
 203 ">
 204
 205 <!ENTITY apt-author.jgunthorpe "
 206    <author>
 207     <firstname>Jason</firstname>
 208     <surname>Gunthorpe</surname>
 209    </author>
 210 ">
 211
 212 <!ENTITY apt-author.team "
 213    <author>
 214     <othername>APT team</othername>
 215    </author>
 216 ">
 217
 218 <!ENTITY apt-copyright "
 219     <copyright>
 220      <holder>Jason Gunthorpe</holder>
 221      <year>1998-2001</year>
 222     </copyright>
 223 ">
 224
 225 <!ENTITY apt-product "
 226    <productname>Linux</productname>
 227 ">
 228
 229 <!ENTITY apt-qapage "
 230         <para>
 231                 <ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>
 232         </para>
 233 ">
 234
 235 <!-- Boiler plate Bug reporting section -->
 236 <!ENTITY manbugs "
 237  <refsect1><title>Bugs</title>
 238    <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.
 239    If you wish to report a bug in APT, please see
 240    <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the
 241    &reportbug; command.
 242    </para>
 243  </refsect1>
 244 ">
 245
 246 <!-- Boiler plate Author section -->
 247 <!ENTITY manauthor "
 248  <refsect1><title>Author</title>
 249    <para>APT was written by the APT team <email>apt@packages.debian.org</email>.
 250    </para>
 251  </refsect1>
 252 ">
 253
 254 <!-- Should be used within the option section of the text to
 255      put in the blurb about -h, -v, -c and -o -->
 256 <!ENTITY apt-commonoptions "
 257      <varlistentry><term><option>-h</option></term>
 258      <term><option>--help</option></term>
 259      <listitem><para>Show a short usage summary.
 260      </para>
 261      </listitem>
 262      </varlistentry>
 263
 264      <varlistentry>
 265       <term><option>-v</option></term>
 266       <term><option>--version</option></term>
 267       <listitem><para>Show the program version.
 268      </para>
 269      </listitem>
 270      </varlistentry>
 271
 272      <varlistentry>
 273       <term><option>-c</option></term>
 274       <term><option>--config-file</option></term>
 275      <listitem><para>Configuration File; Specify a configuration file to use.
 276      The program will read the default configuration file and then this
 277      configuration file. See &apt-conf; for syntax information.
 278      </para>
 279      </listitem>
 280      </varlistentry>
 281
 282      <varlistentry>
 283       <term><option>-o</option></term>
 284       <term><option>--option</option></term>
 285      <listitem><para>Set a Configuration Option; This will set an arbitrary
 286       configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
 287       <option>-o</option> and <option>--option</option> can be used multiple
 288       times to set different options.
 289      </para>
 290      </listitem>
 291      </varlistentry>
 292 ">
 293
 294 <!-- Should be used within the option section of the text to
 295      put in the blurb about -h, -v, -c and -o -->
 296 <!ENTITY apt-cmdblurb "
 297    <para>All command line options may be set using the configuration file, the
 298    descriptions indicate the configuration option to set. For boolean
 299    options you can override the config file by using something like
 300    <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>
 301    or several other variations.
 302    </para>
 303 ">
 304