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-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>1</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>1</manvolnum>
 100   </citerefentry>"
 101 >
 102
 103 <!ENTITY dpkg-scansources "<citerefentry>
 104     <refentrytitle><command>dpkg-scansources</command></refentrytitle>
 105     <manvolnum>1</manvolnum>
 106   </citerefentry>"
 107 >
 108
 109 <!ENTITY dselect "<citerefentry>
 110     <refentrytitle><command>dselect</command></refentrytitle>
 111     <manvolnum>1</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 wajig "<citerefentry>
 146     <refentrytitle><command>wajig</command></refentrytitle>
 147     <manvolnum>1</manvolnum>
 148   </citerefentry>"
 149 >
 150
 151 <!ENTITY wget "<citerefentry>
 152     <refentrytitle><command>wget</command></refentrytitle>
 153     <manvolnum>1</manvolnum>
 154   </citerefentry>"
 155 >
 156
 157 <!-- Boiler plate docinfo section -->
 158 <!ENTITY apt-email "
 159    <address>
 160     <email>apt@packages.debian.org</email>
 161    </address>
 162 ">
 163
 164 <!ENTITY apt-author.jgunthorpe "
 165    <author>
 166     <firstname>Jason</firstname>
 167     <surname>Gunthorpe</surname>
 168     <contrib></contrib>
 169    </author>
 170 ">
 171
 172 <!ENTITY apt-author.moconnor "
 173    <author>
 174     <firstname>Mike</firstname>
 175     <surname>O'Connor</surname>
 176     <contrib></contrib>
 177    </author>
 178 ">
 179
 180 <!ENTITY apt-name.dburrows "
 181      <firstname>Daniel</firstname>
 182      <surname>Burrows</surname>
 183      <email>dburrows@debian.org</email>
 184 ">
 185
 186 <!ENTITY apt-copyright "
 187     <copyright>
 188      <holder>Jason Gunthorpe</holder>
 189      <year>1998-2001</year>
 190     </copyright>
 191 ">
 192
 193 <!ENTITY apt-product "
 194    <productname>Linux</productname>
 195 ">
 196
 197 <!-- Codenames for debian releases -->
 198 <!ENTITY oldstable-codename "lenny">
 199 <!ENTITY stable-codename "squeeze">
 200 <!ENTITY testing-codename "wheezy">
 201
 202
 203 <!-- Arguments -->
 204 <!ENTITY synopsis-arg-option "<arg><option>-o=<replaceable>&synopsis-config-string;</replaceable></option></arg>">
 205 <!ENTITY synopsis-arg-config "<arg><option>-c=<filename><replaceable>&synopsis-config-file;</replaceable></filename></option></arg>">
 206 <!ENTITY synopsis-arg-target-release "<arg><option>-t=<replaceable>&synopsis-target-release;</replaceable></option></arg>">
 207 <!ENTITY synopsis-arg-architecture "<arg><option>-a=<replaceable>&synopsis-architecture;</replaceable></option></arg>">
 208 <!ENTITY synopsis-arg-pkgver "<arg choice='plain' rep='repeat'><replaceable>&synopsis-pkg;</replaceable><arg><group choice='req'>
 209         <arg choice='plain'>=<replaceable>&synopsis-pkg-ver-number;</replaceable></arg>
 210         <arg choice='plain'>/<replaceable>&synopsis-target-release;</replaceable></arg>
 211 </group></arg></arg>">
 212 <!ENTITY synopsis-arg-pkg "<arg choice='plain' rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg>">
 213 <!ENTITY synopsis-param-filename "<filename><replaceable>&synopsis-filename;</replaceable></filename>">
 214 <!ENTITY synopsis-help "<arg choice='plain'><group choice='req'><arg choice='plain'>-v</arg><arg choice='plain'>--version</arg></group></arg>
 215         <arg choice='plain'><group choice='req'><arg choice='plain'>-h</arg><arg choice='plain'>--help</arg></group></arg>">
 216 <!ENTITY synopsis-command-apt-get "<refsynopsisdiv><cmdsynopsis>
 217         <command>apt-get</command>
 218         <arg><option>-asqdyfmubV</option></arg>
 219         &synopsis-arg-option;
 220         &synopsis-arg-config;
 221         &synopsis-arg-target-release;
 222         &synopsis-arg-architecture;
 223         <group choice='req'>
 224                 <arg choice='plain'>update</arg>
 225                 <arg choice='plain'>upgrade</arg>
 226                 <arg choice='plain'>dselect-upgrade</arg>
 227                 <arg choice='plain'>dist-upgrade</arg>
 228                 <arg choice='plain'>install &synopsis-arg-pkgver;</arg>
 229                 <arg choice='plain'>remove &synopsis-arg-pkg;</arg>
 230                 <arg choice='plain'>purge &synopsis-arg-pkg;</arg>
 231                 <arg choice='plain'>source &synopsis-arg-pkgver;</arg>
 232                 <arg choice='plain'>build-dep &synopsis-arg-pkgver;</arg>
 233                 <arg choice='plain'>download &synopsis-arg-pkgver;</arg>
 234                 <arg choice='plain'>check</arg>
 235                 <arg choice='plain'>clean</arg>
 236                 <arg choice='plain'>autoclean</arg>
 237                 <arg choice='plain'>autoremove</arg>
 238                 &synopsis-help;
 239         </group>
 240 </cmdsynopsis></refsynopsisdiv>">
 241 <!ENTITY synopsis-command-apt-cache "<refsynopsisdiv><cmdsynopsis>
 242         <command>apt-cache</command>
 243         <arg><option>-agipns</option></arg>
 244         &synopsis-arg-option;
 245         &synopsis-arg-config;
 246         <group choice='req'>
 247                 <arg choice='plain'>gencaches</arg>
 248                 <arg choice='plain'>showpkg &synopsis-arg-pkg;</arg>
 249                 <arg choice='plain'>showsrc &synopsis-arg-pkg;</arg>
 250                 <arg choice='plain'>stats</arg>
 251                 <arg choice='plain'>dump</arg>
 252                 <arg choice='plain'>dumpavail</arg>
 253                 <arg choice='plain'>unmet</arg>
 254                 <arg choice='plain'>search <arg choice='plain' rep='repeat'><replaceable>&synopsis-regex;</replaceable></arg></arg>
 255                 <arg choice='plain'>show &synopsis-arg-pkgver;</arg>
 256                 <arg choice='plain'>depends &synopsis-arg-pkgver;</arg>
 257                 <arg choice='plain'>rdepends &synopsis-arg-pkgver;</arg>
 258                 <arg choice='plain'>pkgnames <arg><replaceable>&synopsis-prefix;</replaceable></arg></arg>
 259                 <arg choice='plain'>dotty &synopsis-arg-pkgver;</arg>
 260                 <arg choice='plain'>xvcg &synopsis-arg-pkgver;</arg>
 261                 <arg choice='plain'>policy <arg rep='repeat'><replaceable>&synopsis-pkg;</replaceable></arg></arg>
 262                 <arg choice='plain'>madison &synopsis-arg-pkg;</arg>
 263                 &synopsis-help;
 264         </group>
 265 </cmdsynopsis></refsynopsisdiv>">
 266 <!ENTITY synopsis-command-apt-cdrom "<refsynopsisdiv><cmdsynopsis>
 267         <command>apt-cdrom</command>
 268         <arg><option>-rmfan</option></arg>
 269         <arg><option>-d=<replaceable>&synopsis-cdrom-mount;</replaceable></option></arg>
 270         &synopsis-arg-option;
 271         &synopsis-arg-config;
 272         <group choice='req'>
 273                 <arg choice='plain'>add</arg>
 274                 <arg choice='plain'>ident</arg>
 275                 &synopsis-help;
 276         </group>
 277 </cmdsynopsis></refsynopsisdiv>">
 278 <!--<arg><option>- -format '<replaceable>&#37;f \"&#37;v\";&#37;n</replaceable>'</option></arg>-->
 279 <!ENTITY synopsis-command-apt-config "<refsynopsisdiv><cmdsynopsis>
 280         <command>apt-config</command>
 281         <arg><option>--empty</option></arg>
 282         <arg><option>--format '<replaceable>&percnt;f &#x0022;&percnt;v&#x0022;;&percnt;n</replaceable>'</option></arg>
 283         &synopsis-arg-option;
 284         &synopsis-arg-config;
 285         <group choice='req'>
 286                 <arg choice='plain'>shell</arg>
 287                 <arg choice='plain'>dump</arg>
 288                 &synopsis-help;
 289         </group>
 290 </cmdsynopsis></refsynopsisdiv>">
 291 <!ENTITY synopsis-command-apt-extracttemplates "<refsynopsisdiv><cmdsynopsis>
 292         <command>apt-extracttemplates</command>
 293         <arg><option>-t=<replaceable>&synopsis-tmp-directory;</replaceable></option></arg>
 294         <arg choice='plain' rep='repeat'>&synopsis-param-filename;</arg>
 295         &synopsis-help;
 296 </cmdsynopsis></refsynopsisdiv>">
 297 <!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>">
 298 <!ENTITY synopsis-command-apt-ftparchive "<refsynopsisdiv><cmdsynopsis>
 299         <command>apt-ftparchive</command>
 300         <arg><option>-dsq</option></arg>
 301         <arg><option>--md5</option></arg>
 302         <arg><option>--delink</option></arg>
 303         <arg><option>--readonly</option></arg>
 304         <arg><option>--contents</option></arg>
 305         <arg><option>--arch <replaceable>architecture</replaceable></option></arg>
 306         &synopsis-arg-option;
 307         &synopsis-arg-config;
 308         <group choice='req'>
 309                 <arg choice='plain'>packages &synopsis-arg-ftparchive;</arg>
 310                 <arg choice='plain'>sources &synopsis-arg-ftparchive;</arg>
 311                 <arg choice='plain'>contents <arg choice='plain'><replaceable>&synopsis-path;</replaceable></arg></arg>
 312                 <arg choice='plain'>release <arg choice='plain'><replaceable>&synopsis-path;</replaceable></arg></arg>
 313                 <arg choice='plain'>generate <arg choice='plain'><replaceable>&synopsis-config-file;</replaceable></arg> <arg choice='plain' rep='repeat'><replaceable>&synopsis-section;</replaceable></arg></arg>
 314                 <arg choice='plain'>clean <arg choice='plain'><replaceable>&synopsis-config-file;</replaceable></arg></arg>
 315                 &synopsis-help;
 316         </group>
 317 </cmdsynopsis></refsynopsisdiv>">
 318 <!ENTITY synopsis-param-keyid "<replaceable>&synopsis-keyid;</replaceable>">
 319 <!ENTITY synopsis-command-apt-key "<refsynopsisdiv><cmdsynopsis>
 320         <command>apt-key</command>
 321         <arg><option>--keyring &synopsis-param-filename;</option></arg>
 322         <group choice='req'>
 323                 <arg choice='plain'>add &synopsis-param-filename;</arg>
 324                 <arg choice='plain'>del &synopsis-param-keyid;</arg>
 325                 <arg choice='plain'>export &synopsis-param-keyid;</arg>
 326                 <arg choice='plain'>exportall</arg>
 327                 <arg choice='plain'>list</arg>
 328                 <arg choice='plain'>finger</arg>
 329                 <arg choice='plain'>adv</arg>
 330                 <arg choice='plain'>update</arg>
 331                 <arg choice='plain'>net-update</arg>
 332                 &synopsis-help;
 333         </group>
 334 </cmdsynopsis></refsynopsisdiv>">
 335 <!ENTITY synopsis-command-apt-mark "<refsynopsisdiv><cmdsynopsis>
 336         <command>apt-mark</command>
 337         <arg><option>-f=&synopsis-param-filename;</option></arg>
 338         <group choice='plain'>
 339                 <arg choice='plain'>
 340                         <group choice='req'>
 341                                 <arg choice='plain'>auto</arg>
 342                                 <arg choice='plain'>manual</arg>
 343                                 <arg choice='plain'>showauto</arg>
 344                                 <arg choice='plain'>showmanual</arg>
 345                         </group>
 346                         &synopsis-arg-pkg;
 347                 </arg>
 348                 &synopsis-help;
 349         </group>
 350 </cmdsynopsis></refsynopsisdiv>">
 351 <!ENTITY synopsis-command-apt-sortpkgs "<refsynopsisdiv><cmdsynopsis>
 352         <command>apt-sortpkgs</command>
 353         <arg><option>-s</option></arg>
 354         &synopsis-arg-option;
 355         &synopsis-arg-config;
 356         <arg choice='plain' rep='repeat'>&synopsis-param-filename;</arg>
 357         &synopsis-help;
 358 </cmdsynopsis></refsynopsisdiv>">