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      HideAutoRemove "false";
  37      Download-Only "false";
  38      Simulate "false";
  39      Assume-Yes "false";
  40      Force-Yes "false";             // I would never set this.
  41      Fix-Broken "false";
  42      Fix-Missing "false";
  43      Show-Upgraded "false";
  44      Show-Versions "false";
  45      Upgrade "true";
  46      Print-URIs "false";
  47      Compile "false";
  48      Download "true";
  49      Purge "false";
  50      List-Cleanup "true";
  51      ReInstall "false";
  52      Trivial-Only "false";
  53      Remove "true";
  54      Only-Source "";
  55      Diff-Only "false";
  56      Tar-Only "false";
  57   };
  58
  59   Cache
  60   {
  61      Important "false";
  62      AllVersions "false";
  63      GivenOnly "false";
  64      RecurseDepends "false";
  65      ShowFull "false";
  66      Generate "true";
  67      NamesOnly "false";
  68      AllNames "false";
  69      Installed "false";
  70   };
  71
  72   CDROM
  73   {
  74      Rename "false";
  75      NoMount "false";
  76      Fast "false";
  77      NoAct "false";
  78   };
  79
  80   Authentication
  81   {
  82      TrustCDROM "false";            // consider the CDROM always trusted
  83   };
  84
  85   GPGV
  86   {
  87      TrustedKeyring "/etc/apt/trusted.gpg";
  88   };
  89
  90   // Some general options
  91   Ignore-Hold "false";
  92   Clean-Installed "true";
  93   Immediate-Configure "true";      // DO NOT turn this off, see the man page
  94   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
  95   Cache-Limit "4194304";
  96   Default-Release "";
  97
  98   // consider Recommends, Suggests as important dependencies that should
  99   // be installed by default
 100   Install-Recommends "false";
 101   Install-Suggests "false";
 102
 103   // install recommends automatically for packages in this section
 104   Install-Recommends-Section "metapackages";
 105
 106   // consider dependencies of packages in this section manual
 107   Never-MarkAuto-Section "metapackages";
 108
 109   // Write progress messages on this fd (for stuff like base-config)
 110   Status-Fd "-1";
 111   // Keep the list of FDs open (normally apt closes all fds when it
 112   // does a ExecFork)
 113   Keep-Fds {};
 114 };
 115
 116 // Options for the downloading routines
 117 Acquire
 118 {
 119   Queue-Mode "host";       // host|access
 120   Retries "0";
 121   Source-Symlinks "true";
 122
 123   // HTTP method configuration
 124   http
 125   {
 126     Proxy "http://127.0.0.1:3128";
 127     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 128     Timeout "120";
 129     Pipeline-Depth "5";
 130
 131     // Cache Control. Note these do not work with Squid 2.0.2
 132     No-Cache "false";
 133     Max-Age "86400";     // 1 Day age on index files
 134     No-Store "false";    // Prevent the cache from storing archives
 135     Dl-Limit "7";        // 7Kb/sec maximum download rate
 136   };
 137
 138   // HTTPS method configuration:
 139   // - uses the http proxy config
 140   // - uses the http cache-control values
 141   // - uses the http Dl-Limit values
 142   https
 143   {
 144         Verify-Peer "false";
 145         SslCert "/etc/apt/some.pem";
 146         CaPath  "/etc/ssl/certs";
 147         Verify-Host" "2";
 148   };
 149
 150   ftp
 151   {
 152     Proxy "ftp://127.0.0.1/";
 153     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 154
 155     /* Required script to perform proxy login. This example should work
 156        for tisfwtk */
 157     ProxyLogin
 158     {
 159        "USER $(PROXY_USER)";
 160        "PASS $(PROXY_PASS)";
 161        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 162        "PASS $(SITE_PASS)";
 163     };
 164
 165     Timeout "120";
 166
 167     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 168        is prefered if possible */
 169     Passive "true";
 170     Proxy::Passive "true";
 171     Passive::http.us.debian.org "true"; // Specific per-host setting
 172   };
 173
 174   cdrom
 175   {
 176     mount "/cdrom";
 177
 178     // You need the trailing slash!
 179     "/cdrom/"
 180     {
 181        Mount "sleep 1000";
 182        UMount "sleep 500";
 183     }
 184   };
 185
 186   gpgv
 187   {
 188    Options {"--ignore-time-conflict";}  // not very usefull on a normal system
 189   };
 190
 191   mirror
 192   {
 193    RefreshInterval "360"; // refresh interval in minutes
 194    MaxAge "90";           // max age for a mirror file in days before
 195                           // it gets deleted
 196    // mirror failure reporting script
 197    ProblemReporting "/usr/lib/apt/apt-report-mirror-failure";
 198    // mirror failure reporting url
 199    ReportFailures "http://example.com/mirror-failure";
 200   };
 201
 202   // translations can be set here to "none", "environment" or "$locale"
 203   Translation "none";
 204 };
 205
 206 // Directory layout
 207 Dir "/"
 208 {
 209   // Location of the state dir
 210   State "var/lib/apt/"
 211   {
 212      Lists "lists/";
 213      xstatus "xstatus";
 214      userstatus "status.user";
 215      status "/var/lib/dpkg/status";
 216      cdroms "cdroms.list";
 217      mirrors "mirrors/";
 218   };
 219
 220   // Location of the cache dir
 221   Cache "var/cache/apt/" {
 222      Archives "archives/";
 223      srcpkgcache "srcpkgcache.bin";
 224      pkgcache "pkgcache.bin";
 225   };
 226
 227   // Config files
 228   Etc "etc/apt/" {
 229      SourceList "sources.list";
 230      Main "apt.conf";
 231      Preferences "preferences";
 232      Parts "apt.conf.d/";
 233   };
 234
 235   // Locations of binaries
 236   Bin {
 237      methods "/usr/lib/apt/methods/";
 238      gzip "/bin/gzip";
 239      gpg  "/usr/bin/gpgv";
 240      dpkg "/usr/bin/dpkg";
 241      dpkg-source "/usr/bin/dpkg-source";
 242      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 243      apt-get "/usr/bin/apt-get";
 244      apt-cache "/usr/bin/apt-cache";
 245   };
 246 };
 247
 248 // Things that effect the APT dselect method
 249 DSelect
 250 {
 251    Clean "auto";   // always|auto|prompt|never
 252    Options "-f";
 253    UpdateOptions "";
 254    PromptAfterUpdate "no";
 255    CheckDir "no";
 256 }
 257
 258 DPkg
 259 {
 260    // Probably don't want to use force-downgrade..
 261    Options {"--force-overwrite";"--force-downgrade";}
 262
 263    // Auto re-mounting of a readonly /usr
 264    Pre-Invoke {"mount -o remount,rw /usr";};
 265    Post-Invoke {"mount -o remount,ro /usr";};
 266
 267    // Prevents daemons from getting cwd as something mountable (default)
 268    Run-Directory "/";
 269
 270    // Build options for apt-get source --compile
 271    Build-Options "-b -uc";
 272
 273    // Pre-configure all packages before they are installed using debconf.
 274    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 275
 276    // Flush the contents of stdin before forking dpkg.
 277    FlushSTDIN "true";
 278
 279    // Control the size of the command line passed to dpkg.
 280    MaxBytes 1024;
 281    MaxArgs 350;
 282
 283    // controls if apt will apport on the first dpkg error or if it
 284    // tries to install as many packages as possible
 285    StopOnError "true";
 286 }
 287
 288 /* Options you can set to see some debugging text They correspond to names
 289    of classes in the source code */
 290 Debug
 291 {
 292   pkgProblemResolver "false";
 293   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
 294   pkgAcquire "false";
 295   pkgAcquire::Worker "false";
 296   pkgAcquire::Auth "false";
 297   pkgDPkgPM "false";
 298   pkgDPkgProgressReporting "false";
 299   pkgOrderList "false";
 300   pkgAutoRemove "false";   // show information about automatic removes
 301   BuildDeps "false";
 302   pkgInitialize "false";   // This one will dump the configuration space
 303   NoLocking "false";
 304   Acquire::Ftp "false";    // Show ftp command traffic
 305   Acquire::Http "false";   // Show http command traffic
 306   Acquire::Https "false";   // Show https debug
 307   Acquire::gpgv "false";   // Show the gpgv traffic
 308   Acquire::Mirror "false"; // Show debugging of the mirror method
 309   aptcdrom "false";        // Show found package files
 310   IdentCdrom "false";
 311 }
 312
 313 /* Whatever you do, do not use this configuration file!! Take out ONLY
 314    the portions you need! */
 315 This Is Not A Valid Config File