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 <!-- 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>28 October 2008</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 <!ENTITY apt-qapage "
 211         <para>
 212                 <ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>
 213         </para>
 214 ">
 215
 216 <!-- Boiler plate Bug reporting section -->
 217 <!ENTITY manbugs "
 218  <refsect1><title>Bugs</title>
 219    <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.
 220    If you wish to report a bug in APT, please see
 221    <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the
 222    &reportbug; command.
 223    </para>
 224  </refsect1>
 225 ">
 226
 227 <!-- Boiler plate Author section -->
 228 <!ENTITY manauthor "
 229  <refsect1><title>Author</title>
 230    <para>APT was written by the APT team <email>apt@packages.debian.org</email>.
 231    </para>
 232  </refsect1>
 233 ">
 234
 235 <!-- Should be used within the option section of the text to
 236      put in the blurb about -h, -v, -c and -o -->
 237 <!ENTITY apt-commonoptions "
 238      <varlistentry><term><option>-h</option></term>
 239      <term><option>--help</option></term>
 240      <listitem><para>Show a short usage summary.
 241      </para>
 242      </listitem>
 243      </varlistentry>
 244
 245      <varlistentry>
 246       <term><option>-v</option></term>
 247       <term><option>--version</option></term>
 248       <listitem><para>Show the program version.
 249      </para>
 250      </listitem>
 251      </varlistentry>
 252
 253      <varlistentry>
 254       <term><option>-c</option></term>
 255       <term><option>--config-file</option></term>
 256      <listitem><para>Configuration File; Specify a configuration file to use.
 257      The program will read the default configuration file and then this
 258      configuration file. See &apt-conf; for syntax information.
 259      </para>
 260      </listitem>
 261      </varlistentry>
 262
 263      <varlistentry>
 264       <term><option>-o</option></term>
 265       <term><option>--option</option></term>
 266      <listitem><para>Set a Configuration Option; This will set an arbitrary
 267       configuration option. The syntax is <option>-o Foo::Bar=bar</option>.
 268       <option>-o</option> and <option>--option</option> can be used multiple
 269       times to set different options.
 270      </para>
 271      </listitem>
 272      </varlistentry>
 273 ">
 274
 275 <!-- Should be used within the option section of the text to
 276      put in the blurb about -h, -v, -c and -o -->
 277 <!ENTITY apt-cmdblurb "
 278    <para>All command line options may be set using the configuration file, the
 279    descriptions indicate the configuration option to set. For boolean
 280    options you can override the config file by using something like
 281    <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>
 282    or several other variations.
 283    </para>
 284 ">
 285