doc/apt.ent

   1 <!-- -*- mode: sgml; mode: fold -*- -->
   2
   3 <!-- Some common paths.. -->
   4 <!ENTITY docdir "/usr/share/doc/apt/">
   5 <!ENTITY configureindex "<filename>&docdir;/examples/configure-index</>">
   6 <!ENTITY aptconfdir "<filename>/etc/apt.conf</>">
   7 <!ENTITY statedir "/var/lib/apt">
   8 <!ENTITY cachedir "/var/cache/apt">
   9
  10 <!-- Cross references to other man pages -->
  11 <!ENTITY apt-conf "
  12   <CiteRefEntry>
  13     <RefEntryTitle><filename/apt.conf/</RefEntryTitle>
  14     <ManVolNum/5/
  15   </CiteRefEntry>
  16 ">
  17
  18 <!ENTITY apt-get "
  19   <CiteRefEntry>
  20     <RefEntryTitle><command/apt-get/</RefEntryTitle>
  21     <ManVolNum/8/
  22   </CiteRefEntry>
  23 ">
  24
  25 <!ENTITY apt-cdrom "
  26   <CiteRefEntry>
  27     <RefEntryTitle><command/apt-cdrom/</RefEntryTitle>
  28     <ManVolNum/8/
  29   </CiteRefEntry>
  30 ">
  31
  32 <!ENTITY apt-cache "
  33   <CiteRefEntry>
  34     <RefEntryTitle><command/apt-cache/</RefEntryTitle>
  35     <ManVolNum/8/
  36   </CiteRefEntry>
  37 ">
  38
  39 <!ENTITY sources-list "
  40   <CiteRefEntry>
  41     <RefEntryTitle><filename/sources.list/</RefEntryTitle>
  42     <ManVolNum/5/
  43   </CiteRefEntry>
  44 ">
  45
  46 <!ENTITY bug "
  47   <CiteRefEntry>
  48     <RefEntryTitle><command/bug/</RefEntryTitle>
  49     <ManVolNum/1/
  50   </CiteRefEntry>
  51 ">
  52
  53 <!ENTITY dpkg "
  54   <CiteRefEntry>
  55     <RefEntryTitle><command/dpkg/</RefEntryTitle>
  56     <ManVolNum/8/
  57   </CiteRefEntry>
  58 ">
  59
  60 <!ENTITY dpkg-buildpackage "
  61   <CiteRefEntry>
  62     <RefEntryTitle><command/dpkg-buildpackage/</RefEntryTitle>
  63     <ManVolNum/1/
  64   </CiteRefEntry>
  65 ">
  66
  67 <!ENTITY gzip "
  68   <CiteRefEntry>
  69     <RefEntryTitle><command/gzip/</RefEntryTitle>
  70     <ManVolNum/1/
  71   </CiteRefEntry>
  72 ">
  73
  74 <!ENTITY dpkg-scanpackages "
  75   <CiteRefEntry>
  76     <RefEntryTitle><command/dpkg-scanpackages/</RefEntryTitle>
  77     <ManVolNum/8/
  78   </CiteRefEntry>
  79 ">
  80
  81 <!ENTITY dpkg-scansources "
  82   <CiteRefEntry>
  83     <RefEntryTitle><command/dpkg-scansources/</RefEntryTitle>
  84     <ManVolNum/8/
  85   </CiteRefEntry>
  86 ">
  87
  88 <!ENTITY dselect "
  89   <CiteRefEntry>
  90     <RefEntryTitle><command/dselect/</RefEntryTitle>
  91     <ManVolNum/8/
  92   </CiteRefEntry>
  93 ">
  94
  95 <!-- Boiler plate docinfo section -->
  96 <!ENTITY apt-docinfo "
  97  <docinfo>
  98    <address><email>apt@packages.debian.org</></address>
  99    <author><firstname>Jason</> <surname>Gunthorpe</></>
 100    <copyright><year>1998-2000</> <holder>Jason Gunthorpe</></>
 101    <date>20 September 2000</>
 102  </docinfo>
 103 ">
 104
 105 <!-- Boiler plate Bug reporting section -->
 106 <!ENTITY manbugs "
 107  <RefSect1><Title>Bugs</>
 108    <para>
 109    See the <ulink url='http://bugs.debian.org/apt'>APT bug page</>.
 110    If you wish to report a bug in APT, please see
 111    <filename>/usr/doc/debian/bug-reporting.txt</> or the &bug; command.
 112  </RefSect1>
 113 ">
 114
 115 <!-- Boiler plate Author section -->
 116 <!ENTITY manauthor "
 117  <RefSect1><Title>Author</>
 118    <para>
 119    APT was written by the APT team <email>apt@packages.debian.org</>.
 120  </RefSect1>
 121 ">
 122
 123 <!-- Should be used within the option section of the text to
 124      put in the blurb about -h, -v, -c and -o -->
 125 <!ENTITY apt-commonoptions "
 126      <VarListEntry><term><option/-h/</><term><option/--help/</>
 127      <ListItem><Para>
 128      Show a short usage summary.
 129      </VarListEntry>
 130
 131      <VarListEntry><term><option/-v/</><term><option/--version/</>
 132      <ListItem><Para>
 133      Show the program verison.
 134      </VarListEntry>
 135
 136      <VarListEntry><term><option/-c/</><term><option/--config-file/</>
 137      <ListItem><Para>
 138      Configuration File; Specify a configuration file to use.
 139      The program will read the default configuration file and then this
 140      configuration file. See &apt-conf; for syntax information.
 141      </VarListEntry>
 142
 143      <VarListEntry><term><option/-o/</><term><option/--option/</>
 144      <ListItem><Para>
 145      Set a Configuration Option; This will set an arbitary configuration
 146      option. The syntax is <option>-o Foo::Bar=bar</>.
 147      </VarListEntry>
 148 ">
 149
 150 <!-- Should be used within the option section of the text to
 151      put in the blurb about -h, -v, -c and -o -->
 152 <!ENTITY apt-cmdblurb "
 153    <para>
 154    All command line options may be set using the configuration file, the
 155    descriptions indicate the configuration option to set. For boolean
 156    options you can override the config file by using something like
 157    <option/-f-/,<option/--no-f/, <option/-f=no/ or several other variations.
 158    </para>
 159 ">