doc/apt-verbatim.ent

   1 <!-- -*- mode: xml; 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-mark "<citerefentry>
  43     <refentrytitle><command>apt-mark</command></refentrytitle>
  44     <manvolnum>8</manvolnum>
  45   </citerefentry>"
  46 >
  47
  48 <!ENTITY apt "<citerefentry>
  49     <refentrytitle><command>apt</command></refentrytitle>
  50     <manvolnum>8</manvolnum>
  51   </citerefentry>"
  52 >
  53
  54 <!ENTITY apt-preferences "<citerefentry>
  55     <refentrytitle><filename>apt_preferences</filename></refentrytitle>
  56     <manvolnum>5</manvolnum>
  57   </citerefentry>"
  58 >
  59
  60 <!ENTITY apt-key "<citerefentry>
  61     <refentrytitle><command>apt-key</command></refentrytitle>
  62     <manvolnum>8</manvolnum>
  63   </citerefentry>"
  64 >
  65
  66 <!ENTITY apt-secure "<citerefentry>
  67     <refentrytitle>apt-secure</refentrytitle>
  68     <manvolnum>8</manvolnum>
  69   </citerefentry>"
  70 >
  71
  72 <!ENTITY apt-ftparchive "<citerefentry>
  73     <refentrytitle><command>apt-ftparchive</command></refentrytitle>
  74     <manvolnum>1</manvolnum>
  75   </citerefentry>"
  76 >
  77
  78
  79 <!ENTITY sources-list "<citerefentry>
  80     <refentrytitle><filename>sources.list</filename></refentrytitle>
  81     <manvolnum>5</manvolnum>
  82   </citerefentry>"
  83 >
  84
  85 <!ENTITY reportbug "<citerefentry>
  86     <refentrytitle><command>reportbug</command></refentrytitle>
  87     <manvolnum>1</manvolnum>
  88   </citerefentry>"
  89 >
  90
  91 <!ENTITY dpkg "<citerefentry>
  92     <refentrytitle><command>dpkg</command></refentrytitle>
  93     <manvolnum>1</manvolnum>
  94   </citerefentry>"
  95 >
  96
  97 <!ENTITY dpkg-buildpackage "<citerefentry>
  98     <refentrytitle><command>dpkg-buildpackage</command></refentrytitle>
  99     <manvolnum>1</manvolnum>
 100   </citerefentry>"
 101 >
 102
 103 <!ENTITY gzip "<citerefentry>
 104     <refentrytitle><command>gzip</command></refentrytitle>
 105     <manvolnum>1</manvolnum>
 106   </citerefentry>"
 107 >
 108
 109 <!ENTITY dpkg-scanpackages "<citerefentry>
 110     <refentrytitle><command>dpkg-scanpackages</command></refentrytitle>
 111     <manvolnum>1</manvolnum>
 112   </citerefentry>"
 113 >
 114
 115 <!ENTITY dpkg-scansources "<citerefentry>
 116     <refentrytitle><command>dpkg-scansources</command></refentrytitle>
 117     <manvolnum>1</manvolnum>
 118   </citerefentry>"
 119 >
 120
 121 <!ENTITY dselect "<citerefentry>
 122     <refentrytitle><command>dselect</command></refentrytitle>
 123     <manvolnum>1</manvolnum>
 124   </citerefentry>"
 125 >
 126
 127 <!ENTITY aptitude "<citerefentry>
 128     <refentrytitle><command>aptitude</command></refentrytitle>
 129     <manvolnum>8</manvolnum>
 130   </citerefentry>"
 131 >
 132
 133 <!ENTITY synaptic "<citerefentry>
 134     <refentrytitle><command>synaptic</command></refentrytitle>
 135     <manvolnum>8</manvolnum>
 136   </citerefentry>"
 137 >
 138
 139 <!ENTITY squid-deb-proxy-client "<citerefentry>
 140     <refentrytitle><command>squid-deb-proxy-client</command></refentrytitle>
 141     <manvolnum>1</manvolnum>
 142   </citerefentry>"
 143 >
 144
 145 <!ENTITY debsign "<citerefentry>
 146     <refentrytitle><command>debsign</command></refentrytitle>
 147     <manvolnum>1</manvolnum>
 148   </citerefentry>"
 149 >
 150
 151 <!ENTITY debsig-verify "<citerefentry>
 152     <refentrytitle><command>debsig-verify</command></refentrytitle>
 153     <manvolnum>1</manvolnum>
 154   </citerefentry>"
 155 >
 156
 157 <!ENTITY gpg "<citerefentry>
 158     <refentrytitle><command>gpg</command></refentrytitle>
 159     <manvolnum>1</manvolnum>
 160   </citerefentry>"
 161 >
 162
 163 <!ENTITY wajig "<citerefentry>
 164     <refentrytitle><command>wajig</command></refentrytitle>
 165     <manvolnum>1</manvolnum>
 166   </citerefentry>"
 167 >
 168
 169 <!ENTITY wget "<citerefentry>
 170     <refentrytitle><command>wget</command></refentrytitle>
 171     <manvolnum>1</manvolnum>
 172   </citerefentry>"
 173 >
 174
 175 <!ENTITY apt-transport-debtorrent "<citerefentry>
 176     <refentrytitle><package>apt-transport-debtorrent</package></refentrytitle>
 177     <manvolnum>1</manvolnum>
 178   </citerefentry>"
 179 >
 180
 181 <!ENTITY regex "<citerefentry>
 182      <refentrytitle><abbrev>regex</abbrev></refentrytitle>
 183      <manvolnum>7</manvolnum>
 184   </citerefentry>"
 185 >
 186
 187 <!ENTITY glob "<citerefentry>
 188      <refentrytitle><abbrev>glob</abbrev></refentrytitle>
 189      <manvolnum>7</manvolnum>
 190   </citerefentry>"
 191 >
 192
 193 <!ENTITY apt-file "<citerefentry>
 194      <refentrytitle><command>apt-file</command></refentrytitle>
 195      <manvolnum>1</manvolnum>
 196   </citerefentry>"
 197 >
 198
 199 <!-- Boiler plate docinfo section -->
 200 <!ENTITY apt-email "
 201    <address>
 202     <email>apt@packages.debian.org</email>
 203    </address>
 204 ">
 205
 206 <!ENTITY apt-author.jgunthorpe "
 207    <author>
 208     <firstname>Jason</firstname>
 209     <surname>Gunthorpe</surname>
 210     <contrib></contrib>
 211    </author>
 212 ">
 213
 214 <!ENTITY apt-author.moconnor "
 215    <author>
 216     <firstname>Mike</firstname>
 217     <surname>O'Connor</surname>
 218     <contrib></contrib>
 219    </author>
 220 ">
 221
 222 <!ENTITY apt-name.dburrows "
 223      <firstname>Daniel</firstname>
 224      <surname>Burrows</surname>
 225 ">
 226
 227 <!ENTITY apt-copyright "
 228     <copyright>
 229      <holder>Jason Gunthorpe</holder>
 230      <year>1998-2001</year>
 231     </copyright>
 232 ">
 233
 234 <!ENTITY apt-product "
 235    <productname>APT</productname>
 236    <releaseinfo role='version'>&apt-product-version;</releaseinfo>
 237 ">
 238
 239 <!-- this will be updated by 'prepare-release' -->
 240 <!ENTITY apt-product-version "1.2.9">
 241
 242 <!-- (Code)names for various things used all over the place -->
 243 <!ENTITY debian-oldstable-codename "wheezy">
 244 <!ENTITY debian-stable-codename "jessie">
 245 <!ENTITY debian-testing-codename "stretch">
 246 <!ENTITY debian-stable-version "8">
 247 <!ENTITY ubuntu-codename "trusty">
 248
 249 <!-- good and bad just refers to matching and not matching a pattern…
 250      It is not a remark about the specific perl version.
 251      There is no way perl could be clasified "good" (or "bad") in any version… -->
 252 <!ENTITY good-perl "5.10">
 253 <!ENTITY bad-perl "5.14">
 254
 255 <!-- Arguments -->
 256 <!ENTITY synopsis-arg-option "<arg><option>-o=<replaceable>&synopsis-config-string;</replaceable></option></arg>">
 257 <!ENTITY synopsis-arg-config "<arg><option>-c=<filename><replaceable>&synopsis-config-file;</replaceable></filename></option></arg>">
 258 <!ENTITY synopsis-arg-target-release "<arg><option>-t=<replaceable>&synopsis-target-release;</replaceable></option></arg>">
 259 <!ENTITY synopsis-arg-architecture "<arg><option>-a=<replaceable>&synopsis-architecture;</replaceable></option></arg>">
 260 <!ENTITY synopsis-arg-pkgver "<arg choice='plain' rep='repeat'><replaceable>&synopsis-pkg;</replaceable><arg><group choice='req'>
 261         <arg choice='plain'>=<replaceable>&synopsis-pkg-ver-number;</replaceable></arg>
 262         <arg choice='plain'>/<replaceable>&synopsis-target-release;</replaceable></arg>
 263 </group></arg></arg>">
 264 <!ENTITY synopsis-arg-pkg "<arg choice='plain' rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg>">
 265 <!ENTITY synopsis-param-filename "<filename><replaceable>&synopsis-filename;</replaceable></filename>">
 266 <!ENTITY synopsis-help "<arg choice='plain'><group choice='req'><arg choice='plain'>-v</arg><arg choice='plain'>--version</arg></group></arg>
 267         <arg choice='plain'><group choice='req'><arg choice='plain'>-h</arg><arg choice='plain'>--help</arg></group></arg>">
 268 <!ENTITY synopsis-command-apt "<refsynopsisdiv><cmdsynopsis>
 269         <command>apt</command>
 270         <arg><option>-h</option></arg>
 271         &synopsis-arg-option;
 272         &synopsis-arg-config;
 273         &synopsis-arg-target-release;
 274         &synopsis-arg-architecture;
 275         <group choice='req'>
 276                 <arg choice='plain'>list</arg>
 277                 <arg choice='plain'>search</arg>
 278                 <arg choice='plain'>show</arg>
 279                 <arg choice='plain'>update</arg>
 280                 <arg choice='plain'>install &synopsis-arg-pkgver;</arg>
 281                 <arg choice='plain'>remove &synopsis-arg-pkg;</arg>
 282                 <arg choice='plain'>upgrade</arg>
 283                 <arg choice='plain'>full-upgrade</arg>
 284                 <arg choice='plain'>edit-sources</arg>
 285                 &synopsis-help;
 286         </group>
 287 </cmdsynopsis></refsynopsisdiv>">
 288 <!ENTITY synopsis-command-apt-get "<refsynopsisdiv><cmdsynopsis>
 289         <command>apt-get</command>
 290         <arg><option>-asqdyfmubV</option></arg>
 291         &synopsis-arg-option;
 292         &synopsis-arg-config;
 293         &synopsis-arg-target-release;
 294         &synopsis-arg-architecture;
 295         <group choice='req'>
 296                 <arg choice='plain'>update</arg>
 297                 <arg choice='plain'>upgrade</arg>
 298                 <arg choice='plain'>dselect-upgrade</arg>
 299                 <arg choice='plain'>dist-upgrade</arg>
 300                 <arg choice='plain'>install &synopsis-arg-pkgver;</arg>
 301                 <arg choice='plain'>remove &synopsis-arg-pkg;</arg>
 302                 <arg choice='plain'>purge &synopsis-arg-pkg;</arg>
 303                 <arg choice='plain'>source &synopsis-arg-pkgver;</arg>
 304                 <arg choice='plain'>build-dep &synopsis-arg-pkgver;</arg>
 305                 <arg choice='plain'>download &synopsis-arg-pkgver;</arg>
 306                 <arg choice='plain'>check</arg>
 307                 <arg choice='plain'>clean</arg>
 308                 <arg choice='plain'>autoclean</arg>
 309                 <arg choice='plain'>autoremove</arg>
 310                 &synopsis-help;
 311         </group>
 312 </cmdsynopsis></refsynopsisdiv>">
 313 <!ENTITY synopsis-command-apt-cache "<refsynopsisdiv><cmdsynopsis>
 314         <command>apt-cache</command>
 315         <arg><option>-agipns</option></arg>
 316         &synopsis-arg-option;
 317         &synopsis-arg-config;
 318         <group choice='req'>
 319                 <arg choice='plain'>gencaches</arg>
 320                 <arg choice='plain'>showpkg &synopsis-arg-pkg;</arg>
 321                 <arg choice='plain'>showsrc &synopsis-arg-pkg;</arg>
 322                 <arg choice='plain'>stats</arg>
 323                 <arg choice='plain'>dump</arg>
 324                 <arg choice='plain'>dumpavail</arg>
 325                 <arg choice='plain'>unmet</arg>
 326                 <arg choice='plain'>search <arg choice='plain' rep='repeat'><replaceable>&synopsis-regex;</replaceable></arg></arg>
 327                 <arg choice='plain'>show &synopsis-arg-pkgver;</arg>
 328                 <arg choice='plain'>depends &synopsis-arg-pkgver;</arg>
 329                 <arg choice='plain'>rdepends &synopsis-arg-pkgver;</arg>
 330                 <arg choice='plain'>pkgnames <arg><replaceable>&synopsis-prefix;</replaceable></arg></arg>
 331                 <arg choice='plain'>dotty &synopsis-arg-pkgver;</arg>
 332                 <arg choice='plain'>xvcg &synopsis-arg-pkgver;</arg>
 333                 <arg choice='plain'>policy <arg rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg></arg>
 334                 <arg choice='plain'>madison &synopsis-arg-pkg;</arg>
 335                 &synopsis-help;
 336         </group>
 337 </cmdsynopsis></refsynopsisdiv>">
 338 <!ENTITY synopsis-command-apt-cdrom "<refsynopsisdiv><cmdsynopsis>
 339         <command>apt-cdrom</command>
 340         <arg><option>-rmfan</option></arg>
 341         <arg><option>-d=<replaceable>&synopsis-cdrom-mount;</replaceable></option></arg>
 342         &synopsis-arg-option;
 343         &synopsis-arg-config;
 344         <group choice='req'>
 345                 <arg choice='plain'>add</arg>
 346                 <arg choice='plain'>ident</arg>
 347                 &synopsis-help;
 348         </group>
 349 </cmdsynopsis></refsynopsisdiv>">
 350 <!--<arg><option>- -format '<replaceable>&#37;f \"&#37;v\";&#37;n</replaceable>'</option></arg>-->
 351 <!ENTITY synopsis-command-apt-config "<refsynopsisdiv><cmdsynopsis>
 352         <command>apt-config</command>
 353         <arg><option>--empty</option></arg>
 354         <arg><option>--format '<replaceable>&percnt;f &#x0022;&percnt;v&#x0022;;&percnt;n</replaceable>'</option></arg>
 355         &synopsis-arg-option;
 356         &synopsis-arg-config;
 357         <group choice='req'>
 358                 <arg choice='plain'>shell</arg>
 359                 <arg choice='plain'>dump</arg>
 360                 &synopsis-help;
 361         </group>
 362 </cmdsynopsis></refsynopsisdiv>">
 363 <!ENTITY synopsis-command-apt-extracttemplates "<refsynopsisdiv><cmdsynopsis>
 364         <command>apt-extracttemplates</command>
 365         <arg><option>-t=<replaceable>&synopsis-tmp-directory;</replaceable></option></arg>
 366         <arg choice='plain' rep='repeat'>&synopsis-param-filename;</arg>
 367         &synopsis-help;
 368 </cmdsynopsis></refsynopsisdiv>">
 369 <!ENTITY synopsis-arg-ftparchive "<arg choice='plain' rep='repeat'><replaceable>&synopsis-path;</replaceable></arg><arg><filename><replaceable>&synopsis-override;</replaceable></filename><arg><replaceable>&synopsis-pathprefix;</replaceable></arg></arg>">
 370 <!ENTITY synopsis-command-apt-ftparchive "<refsynopsisdiv><cmdsynopsis>
 371         <command>apt-ftparchive</command>
 372         <arg><option>-dsq</option></arg>
 373         <arg><option>--md5</option></arg>
 374         <arg><option>--delink</option></arg>
 375         <arg><option>--readonly</option></arg>
 376         <arg><option>--contents</option></arg>
 377         <arg><option>--arch <replaceable>architecture</replaceable></option></arg>
 378         &synopsis-arg-option;
 379         &synopsis-arg-config;
 380         <group choice='req'>
 381                 <arg choice='plain'>packages &synopsis-arg-ftparchive;</arg>
 382                 <arg choice='plain'>sources &synopsis-arg-ftparchive;</arg>
 383                 <arg choice='plain'>contents <arg choice='plain'><replaceable>&synopsis-path;</replaceable></arg></arg>
 384                 <arg choice='plain'>release <arg choice='plain'><replaceable>&synopsis-path;</replaceable></arg></arg>
 385                 <arg choice='plain'>generate <arg choice='plain'><replaceable>&synopsis-config-file;</replaceable></arg> <arg choice='plain' rep='repeat'><replaceable>&synopsis-section;</replaceable></arg></arg>
 386                 <arg choice='plain'>clean <arg choice='plain'><replaceable>&synopsis-config-file;</replaceable></arg></arg>
 387                 &synopsis-help;
 388         </group>
 389 </cmdsynopsis></refsynopsisdiv>">
 390 <!ENTITY synopsis-param-keyid "<replaceable>&synopsis-keyid;</replaceable>">
 391 <!ENTITY synopsis-command-apt-key "<refsynopsisdiv><cmdsynopsis>
 392         <command>apt-key</command>
 393         <arg><option>--keyring &synopsis-param-filename;</option></arg>
 394         <group choice='req'>
 395                 <arg choice='plain'>add &synopsis-param-filename;</arg>
 396                 <arg choice='plain'>del &synopsis-param-keyid;</arg>
 397                 <arg choice='plain'>export &synopsis-param-keyid;</arg>
 398                 <arg choice='plain'>exportall</arg>
 399                 <arg choice='plain'>list</arg>
 400                 <arg choice='plain'>finger</arg>
 401                 <arg choice='plain'>adv</arg>
 402                 <arg choice='plain'>update</arg>
 403                 <arg choice='plain'>net-update</arg>
 404                 &synopsis-help;
 405         </group>
 406 </cmdsynopsis></refsynopsisdiv>">
 407 <!ENTITY synopsis-command-apt-mark "<refsynopsisdiv><cmdsynopsis>
 408         <command>apt-mark</command>
 409         <group choice='plain'>
 410                 <group choice='req'>
 411                         <arg choice='plain'><option>-f=&synopsis-param-filename;</option></arg>
 412                         <arg choice='plain'>
 413                                 <group choice='req'>
 414                                         <arg choice='plain'>auto</arg>
 415                                         <arg choice='plain'>manual</arg>
 416                                 </group>
 417                                 &synopsis-arg-pkg;
 418                         </arg>
 419                         <arg choice='plain'>
 420                                 <group choice='req'>
 421                                         <arg choice='plain'>showauto</arg>
 422                                         <arg choice='plain'>showmanual</arg>
 423                                 </group>
 424                                 <arg choice='opt' rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg>
 425                         </arg>
 426                 </group>
 427                 &synopsis-help;
 428         </group>
 429 </cmdsynopsis><cmdsynopsis><command>apt-mark</command>
 430         <group choice='plain'>
 431                 <arg choice='plain'>
 432                         <group choice='req'>
 433                                 <arg choice='plain'>hold</arg>
 434                                 <arg choice='plain'>unhold</arg>
 435                                 <arg choice='plain'>install</arg>
 436                                 <arg choice='plain'>remove</arg>
 437                                 <arg choice='plain'>purge</arg>
 438                         </group>
 439                         &synopsis-arg-pkg;
 440                 </arg>
 441                 <arg choice='plain'>
 442                         <group choice='req'>
 443                                 <arg choice='plain'>showhold</arg>
 444                                 <arg choice='plain'>showinstall</arg>
 445                                 <arg choice='plain'>showremove</arg>
 446                                 <arg choice='plain'>showpurge</arg>
 447                         </group>
 448                         <arg choice='opt' rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg>
 449                 </arg>
 450         </group>
 451 </cmdsynopsis></refsynopsisdiv>">
 452 <!ENTITY synopsis-command-apt-sortpkgs "<refsynopsisdiv><cmdsynopsis>
 453         <command>apt-sortpkgs</command>
 454         <arg><option>-s</option></arg>
 455         &synopsis-arg-option;
 456         &synopsis-arg-config;
 457         <arg choice='plain' rep='repeat'>&synopsis-param-filename;</arg>
 458         &synopsis-help;
 459 </cmdsynopsis></refsynopsisdiv>">