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