doc/examples/configure-index

   1 // $Id: configure-index,v 1.10 2004/07/17 19:37:16 mdz Exp $
   2 /* This file is an index of all APT configuration directives. It should
   3    NOT actually be used as a real config file, though it is (except for the
   4    last line) a completely valid file. Most of the options have sane default
   5    values, unless you have specific needs you should NOT include arbitary
   6    items in a custom configuration.
   7
   8    In some instances involving filenames it is possible to set the default
   9    directory when the path is evaluated. This means you can use relative
  10    paths within the sub scope.
  11
  12    The configuration directives are specified in a tree with {} designating
  13    a subscope relative to the tag before the {}. You can further specify
  14    a subscope using scope notation eg,
  15      APT::Architecture "i386";
  16    This is prefixed with the current scope. Scope notation must be used
  17    if an option is specified on the command line with -o.
  18 */
  19
  20 quiet "0";
  21
  22 // Options for APT in general
  23 APT
  24 {
  25   Architecture "i386";
  26   Build-Essential "build-essential";
  27
  28   NeverAutoRemove  { "linux-kernel.*";  };  // packages that should never
  29                                             // considered for autoRemove
  30
  31   // Options for apt-get
  32   Get
  33   {
  34      Arch-Only "false";
  35      AutomaticRemove "false";
  36      Download-Only "false";
  37      Simulate "false";
  38      Assume-Yes "false";
  39      Force-Yes "false";             // I would never set this.
  40      Fix-Broken "false";
  41      Fix-Missing "false";
  42      Show-Upgraded "false";
  43      Show-Versions "false";
  44      Upgrade "true";
  45      Print-URIs "false";
  46      Compile "false";
  47      Download "true";
  48      Purge "false";
  49      List-Cleanup "true";
  50      ReInstall "false";
  51      Trivial-Only "false";
  52      Remove "true";
  53      Only-Source "";
  54      Diff-Only "false";
  55      Tar-Only "false";
  56   };
  57
  58   Cache
  59   {
  60      Important "false";
  61      AllVersions "false";
  62      GivenOnly "false";
  63      RecurseDepends "false";
  64      ShowFull "false";
  65      Generate "true";
  66      NamesOnly "false";
  67      AllNames "false";
  68      Installed "false";
  69   };
  70
  71   CDROM
  72   {
  73      Rename "false";
  74      NoMount "false";
  75      Fast "false";
  76      NoAct "false";
  77   };
  78
  79   GPGV
  80   {
  81      TrustedKeyring "/etc/apt/trusted.gpg";
  82   };
  83
  84   // Some general options
  85   Ignore-Hold "false";
  86   Clean-Installed "true";
  87   Immediate-Configure "true";      // DO NOT turn this off, see the man page
  88   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
  89   Cache-Limit "4194304";
  90   Default-Release "";
  91 };
  92
  93 // Options for the downloading routines
  94 Acquire
  95 {
  96   Queue-Mode "host";       // host|access
  97   Retries "0";
  98   Source-Symlinks "true";
  99
 100   // HTTP method configuration
 101   http
 102   {
 103     Proxy "http://127.0.0.1:3128";
 104     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 105     Timeout "120";
 106     Pipeline-Depth "5";
 107
 108     // Cache Control. Note these do not work with Squid 2.0.2
 109     No-Cache "false";
 110     Max-Age "86400";     // 1 Day age on index files
 111     No-Store "false";    // Prevent the cache from storing archives
 112   };
 113
 114   ftp
 115   {
 116     Proxy "ftp://127.0.0.1/";
 117     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 118
 119     /* Required script to perform proxy login. This example should work
 120        for tisfwtk */
 121     ProxyLogin
 122     {
 123        "USER $(PROXY_USER)";
 124        "PASS $(PROXY_PASS)";
 125        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 126        "PASS $(SITE_PASS)";
 127     };
 128
 129     Timeout "120";
 130
 131     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 132        is prefered if possible */
 133     Passive "true";
 134     Proxy::Passive "true";
 135     Passive::http.us.debian.org "true"; // Specific per-host setting
 136   };
 137
 138   cdrom
 139   {
 140     mount "/cdrom";
 141
 142     // You need the trailing slash!
 143     "/cdrom/"
 144     {
 145        Mount "sleep 1000";
 146        UMount "sleep 500";
 147     }
 148   };
 149
 150   gpgv
 151   {
 152    Options {"--ignore-time-conflict";}  // not very usefull on a normal system
 153   };
 154 };
 155
 156 // Directory layout
 157 Dir "/"
 158 {
 159   // Location of the state dir
 160   State "var/lib/apt/"
 161   {
 162      Lists "lists/";
 163      xstatus "xstatus";
 164      userstatus "status.user";
 165      status "/var/lib/dpkg/status";
 166      cdroms "cdroms.list";
 167   };
 168
 169   // Location of the cache dir
 170   Cache "var/cache/apt/" {
 171      Archives "archives/";
 172      srcpkgcache "srcpkgcache.bin";
 173      pkgcache "pkgcache.bin";
 174   };
 175
 176   // Config files
 177   Etc "etc/apt/" {
 178      SourceList "sources.list";
 179      Main "apt.conf";
 180      Preferences "preferences";
 181      Parts "apt.conf.d/";
 182   };
 183
 184   // Locations of binaries
 185   Bin {
 186      methods "/usr/lib/apt/methods/";
 187      gzip "/bin/gzip";
 188      gpg  "/usr/bin/gpgv";
 189      dpkg "/usr/bin/dpkg";
 190      dpkg-source "/usr/bin/dpkg-source";
 191      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 192      apt-get "/usr/bin/apt-get";
 193      apt-cache "/usr/bin/apt-cache";
 194   };
 195 };
 196
 197 // Things that effect the APT dselect method
 198 DSelect
 199 {
 200    Clean "auto";   // always|auto|prompt|never
 201    Options "-f";
 202    UpdateOptions "";
 203    PromptAfterUpdate "no";
 204    CheckDir "no";
 205 }
 206
 207 DPkg
 208 {
 209    // Probably don't want to use force-downgrade..
 210    Options {"--force-overwrite";"--force-downgrade";}
 211
 212    // Auto re-mounting of a readonly /usr
 213    Pre-Invoke {"mount -o remount,rw /usr";};
 214    Post-Invoke {"mount -o remount,ro /usr";};
 215
 216    // Prevents daemons from getting cwd as something mountable (default)
 217    Run-Directory "/";
 218
 219    // Build options for apt-get source --compile
 220    Build-Options "-b -uc";
 221
 222    // Pre-configure all packages before they are installed using debconf.
 223    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 224
 225    // Flush the contents of stdin before forking dpkg.
 226    FlushSTDIN "true";
 227
 228    // Control the size of the command line passed to dpkg.
 229    MaxBytes 1024;
 230    MaxArgs 350;
 231 }
 232
 233 /* Options you can set to see some debugging text They correspond to names
 234    of classes in the source code */
 235 Debug
 236 {
 237   pkgProblemResolver "false";
 238   pkgAcquire "false";
 239   pkgAcquire::Worker "false";
 240   pkgDPkgPM "false";
 241   pkgOrderList "false";
 242   pkgAutoRemove "false";   // show information about automatic removes
 243
 244   pkgInitialize "false";   // This one will dump the configuration space
 245   NoLocking "false";
 246   Acquire::Ftp "false";    // Show ftp command traffic
 247   Acquire::Http "false";   // Show http command traffic
 248   Acquire::gpgv "false";   // Show the gpgv traffic
 249   aptcdrom "false";        // Show found package files
 250   IdentCdrom "false";
 251
 252 }
 253
 254 /* Whatever you do, do not use this configuration file!! Take out ONLY
 255    the portions you need! */
 256 This Is Not A Valid Config File