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