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