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   Authentication
  80   {
  81      TrustCDROM "false";            // consider the CDROM always trusted
  82   };
  83
  84   GPGV
  85   {
  86      TrustedKeyring "/etc/apt/trusted.gpg";
  87   };
  88
  89   // Some general options
  90   Ignore-Hold "false";
  91   Clean-Installed "true";
  92   Immediate-Configure "true";      // DO NOT turn this off, see the man page
  93   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
  94   Cache-Limit "4194304";
  95   Default-Release "";
  96
  97
  98   // Write progress messages on this fd (for stuff like base-config)
  99   Status-Fd "-1";
 100   // Keep the list of FDs open (normally apt closes all fds when it
 101   // does a ExecFork)
 102   Keep-Fds {};
 103 };
 104
 105 // Options for the downloading routines
 106 Acquire
 107 {
 108   Queue-Mode "host";       // host|access
 109   Retries "0";
 110   Source-Symlinks "true";
 111
 112   // HTTP method configuration
 113   http
 114   {
 115     Proxy "http://127.0.0.1:3128";
 116     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 117     Timeout "120";
 118     Pipeline-Depth "5";
 119
 120     // Cache Control. Note these do not work with Squid 2.0.2
 121     No-Cache "false";
 122     Max-Age "86400";     // 1 Day age on index files
 123     No-Store "false";    // Prevent the cache from storing archives
 124     Dl-Limit "7";        // 7Kb/sec maximum download rate
 125   };
 126
 127   ftp
 128   {
 129     Proxy "ftp://127.0.0.1/";
 130     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 131
 132     /* Required script to perform proxy login. This example should work
 133        for tisfwtk */
 134     ProxyLogin
 135     {
 136        "USER $(PROXY_USER)";
 137        "PASS $(PROXY_PASS)";
 138        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 139        "PASS $(SITE_PASS)";
 140     };
 141
 142     Timeout "120";
 143
 144     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 145        is prefered if possible */
 146     Passive "true";
 147     Proxy::Passive "true";
 148     Passive::http.us.debian.org "true"; // Specific per-host setting
 149   };
 150
 151   cdrom
 152   {
 153     mount "/cdrom";
 154
 155     // You need the trailing slash!
 156     "/cdrom/"
 157     {
 158        Mount "sleep 1000";
 159        UMount "sleep 500";
 160     }
 161   };
 162
 163   gpgv
 164   {
 165    Options {"--ignore-time-conflict";}  // not very usefull on a normal system
 166   };
 167 };
 168
 169 // Directory layout
 170 Dir "/"
 171 {
 172   // Location of the state dir
 173   State "var/lib/apt/"
 174   {
 175      Lists "lists/";
 176      xstatus "xstatus";
 177      userstatus "status.user";
 178      status "/var/lib/dpkg/status";
 179      cdroms "cdroms.list";
 180   };
 181
 182   // Location of the cache dir
 183   Cache "var/cache/apt/" {
 184      Archives "archives/";
 185      srcpkgcache "srcpkgcache.bin";
 186      pkgcache "pkgcache.bin";
 187   };
 188
 189   // Config files
 190   Etc "etc/apt/" {
 191      SourceList "sources.list";
 192      Main "apt.conf";
 193      Preferences "preferences";
 194      Parts "apt.conf.d/";
 195   };
 196
 197   // Locations of binaries
 198   Bin {
 199      methods "/usr/lib/apt/methods/";
 200      gzip "/bin/gzip";
 201      gpg  "/usr/bin/gpgv";
 202      dpkg "/usr/bin/dpkg";
 203      dpkg-source "/usr/bin/dpkg-source";
 204      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 205      apt-get "/usr/bin/apt-get";
 206      apt-cache "/usr/bin/apt-cache";
 207   };
 208 };
 209
 210 // Things that effect the APT dselect method
 211 DSelect
 212 {
 213    Clean "auto";   // always|auto|prompt|never
 214    Options "-f";
 215    UpdateOptions "";
 216    PromptAfterUpdate "no";
 217    CheckDir "no";
 218 }
 219
 220 DPkg
 221 {
 222    // Probably don't want to use force-downgrade..
 223    Options {"--force-overwrite";"--force-downgrade";}
 224
 225    // Auto re-mounting of a readonly /usr
 226    Pre-Invoke {"mount -o remount,rw /usr";};
 227    Post-Invoke {"mount -o remount,ro /usr";};
 228
 229    // Prevents daemons from getting cwd as something mountable (default)
 230    Run-Directory "/";
 231
 232    // Build options for apt-get source --compile
 233    Build-Options "-b -uc";
 234
 235    // Pre-configure all packages before they are installed using debconf.
 236    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 237
 238    // Flush the contents of stdin before forking dpkg.
 239    FlushSTDIN "true";
 240
 241    // Control the size of the command line passed to dpkg.
 242    MaxBytes 1024;
 243    MaxArgs 350;
 244 }
 245
 246 /* Options you can set to see some debugging text They correspond to names
 247    of classes in the source code */
 248 Debug
 249 {
 250   pkgProblemResolver "false";
 251   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
 252   pkgAcquire "false";
 253   pkgAcquire::Worker "false";
 254   pkgAcquire::Auth "false";
 255   pkgDPkgPM "false";
 256   pkgDPkgProgressReporting "false";
 257   pkgOrderList "false";
 258   pkgAutoRemove "false";   // show information about automatic removes
 259
 260   pkgInitialize "false";   // This one will dump the configuration space
 261   NoLocking "false";
 262   Acquire::Ftp "false";    // Show ftp command traffic
 263   Acquire::Http "false";   // Show http command traffic
 264   Acquire::gpgv "false";   // Show the gpgv traffic
 265   aptcdrom "false";        // Show found package files
 266   IdentCdrom "false";
 267
 268 }
 269
 270 /* Whatever you do, do not use this configuration file!! Take out ONLY
 271    the portions you need! */
 272 This Is Not A Valid Config File