doc/examples/configure-index

   1 /* This file is an index of all APT configuration directives. It should
   2    NOT actually be used as a real config file, though it is (except for the
   3    last line) a completely valid file. Most of the options have sane default
   4    values, unless you have specific needs you should NOT include arbitrary
   5    items in a custom configuration.
   6
   7    In some instances involving filenames it is possible to set the default
   8    directory when the path is evaluated. This means you can use relative
   9    paths within the sub scope.
  10
  11    The configuration directives are specified in a tree with {} designating
  12    a subscope relative to the tag before the {}. You can further specify
  13    a subscope using scope notation eg,
  14      APT::Architecture "i386";
  15    This is prefixed with the current scope. Scope notation must be used
  16    if an option is specified on the command line with -o.
  17 */
  18
  19 quiet "0";
  20
  21 // Options for APT in general
  22 APT
  23 {
  24   Architecture "i386";
  25   Build-Essential "build-essential";
  26
  27   NeverAutoRemove  { "linux-image.*";  };  // packages that should never
  28                                             // considered for autoRemove
  29
  30   // Options for apt-get
  31   Get
  32   {
  33      Arch-Only "false";
  34      AllowUnauthenticated "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      Build-Dep-Automatic "true";
  58      Show-User-Simulation-Note "true";
  59   };
  60
  61   Cache
  62   {
  63      Important "false";
  64      AllVersions "false";
  65      GivenOnly "false";
  66      RecurseDepends "false";
  67      ShowFull "false";
  68      Generate "true";
  69      NamesOnly "false";
  70      AllNames "false";
  71      Installed "false";
  72   };
  73
  74   CDROM
  75   {
  76      Rename "false";
  77      NoMount "false";
  78      Fast "false";
  79      NoAct "false";
  80   };
  81
  82   Update
  83   {
  84      Pre-Invoke {"touch /var/lib/apt/pre-update-stamp"; };
  85      Post-Invoke {"touch /var/lib/apt/post-update-stamp"; };
  86   };
  87
  88   Authentication
  89   {
  90      TrustCDROM "false";            // consider the CDROM always trusted
  91   };
  92
  93   GPGV
  94   {
  95      TrustedKeyring "/etc/apt/trusted.gpg";
  96   };
  97
  98   // Some general options
  99   Ignore-Hold "false";
 100   Clean-Installed "true";
 101   Immediate-Configure "true";      // DO NOT turn this off, see the man page
 102   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
 103   Cache-Limit "4194304";
 104   Default-Release "";
 105
 106   // consider Recommends, Suggests as important dependencies that should
 107   // be installed by default
 108   Install-Recommends "true";
 109   Install-Suggests "false";
 110
 111   // consider dependencies of packages in this section manual
 112   Never-MarkAuto-Sections {"metapackages"; "universe/metapackages"; };
 113
 114   // Write progress messages on this fd (for stuff like base-config)
 115   Status-Fd "-1";
 116   // Keep the list of FDs open (normally apt closes all fds when it
 117   // does a ExecFork)
 118   Keep-Fds {};
 119 };
 120
 121 // Options for the downloading routines
 122 Acquire
 123 {
 124   Queue-Mode "host";       // host|access
 125   Retries "0";
 126   Source-Symlinks "true";
 127
 128   PDiffs "true";     // try to get the IndexFile diffs
 129
 130   // HTTP method configuration
 131   http
 132   {
 133     Proxy "http://127.0.0.1:3128";
 134     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 135     Timeout "120";
 136     Pipeline-Depth "5";
 137     AllowRedirect  "true";
 138
 139     // Cache Control. Note these do not work with Squid 2.0.2
 140     No-Cache "false";
 141     Max-Age "86400";     // 1 Day age on index files
 142     No-Store "false";    // Prevent the cache from storing archives
 143     Dl-Limit "7";        // 7Kb/sec maximum download rate
 144   };
 145
 146   // HTTPS method configuration:
 147   // - uses the http proxy config
 148   // - uses the http cache-control values
 149   // - uses the http Dl-Limit values
 150   https
 151   {
 152         Verify-Peer "false";
 153         SslCert "/etc/apt/some.pem";
 154         CaPath  "/etc/ssl/certs";
 155         Verify-Host" "true";
 156         AllowRedirect  "true";
 157   };
 158
 159   ftp
 160   {
 161     Proxy "ftp://127.0.0.1/";
 162     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 163
 164     /* Required script to perform proxy login. This example should work
 165        for tisfwtk */
 166     ProxyLogin
 167     {
 168        "USER $(PROXY_USER)";
 169        "PASS $(PROXY_PASS)";
 170        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 171        "PASS $(SITE_PASS)";
 172     };
 173
 174     Timeout "120";
 175
 176     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 177        is preferred if possible */
 178     Passive "true";
 179     Proxy::Passive "true";
 180     Passive::http.us.debian.org "true"; // Specific per-host setting
 181   };
 182
 183   cdrom
 184   {
 185     mount "/cdrom";
 186
 187     // You need the trailing slash!
 188     "/cdrom/"
 189     {
 190        Mount "sleep 1000";
 191        UMount "sleep 500";
 192     }
 193   };
 194
 195   gpgv
 196   {
 197    Options {"--ignore-time-conflict";}  // not very useful on a normal system
 198   };
 199 };
 200
 201 // Directory layout
 202 Dir "/"
 203 {
 204   // Location of the state dir
 205   State "var/lib/apt/"
 206   {
 207      Lists "lists/";
 208      xstatus "xstatus";
 209      userstatus "status.user";
 210      status "/var/lib/dpkg/status";
 211      cdroms "cdroms.list";
 212   };
 213
 214   // Location of the cache dir
 215   Cache "var/cache/apt/" {
 216      Archives "archives/";
 217      srcpkgcache "srcpkgcache.bin";
 218      pkgcache "pkgcache.bin";
 219   };
 220
 221   // Config files
 222   Etc "etc/apt/" {
 223      SourceList "sources.list";
 224      Main "apt.conf";
 225      Preferences "preferences";
 226      Parts "apt.conf.d/";
 227   };
 228
 229   // Locations of binaries
 230   Bin {
 231      methods "/usr/lib/apt/methods/";
 232      gzip "/bin/gzip";
 233      gpg  "/usr/bin/gpgv";
 234      dpkg "/usr/bin/dpkg";
 235      dpkg-source "/usr/bin/dpkg-source";
 236      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 237      apt-get "/usr/bin/apt-get";
 238      apt-cache "/usr/bin/apt-cache";
 239   };
 240
 241   // Location of the logfile
 242   Log "var/log/apt" {
 243         Terminal "term.log";
 244   };
 245 };
 246
 247 // Things that effect the APT dselect method
 248 DSelect
 249 {
 250    Clean "auto";   // always|auto|prompt|never
 251    Options "-f";
 252    UpdateOptions "";
 253    PromptAfterUpdate "no";
 254    CheckDir "no";
 255 }
 256
 257 DPkg
 258 {
 259    // Probably don't want to use force-downgrade..
 260    Options {"--force-overwrite";"--force-downgrade";}
 261
 262    // Auto re-mounting of a readonly /usr
 263    Pre-Invoke {"mount -o remount,rw /usr";};
 264    Post-Invoke {"mount -o remount,ro /usr";};
 265
 266    // Prevents daemons from getting cwd as something mountable (default)
 267    Run-Directory "/";
 268
 269    // Build options for apt-get source --compile
 270    Build-Options "-b -uc";
 271
 272    // Pre-configure all packages before they are installed using debconf.
 273    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 274
 275    // Flush the contents of stdin before forking dpkg.
 276    FlushSTDIN "true";
 277
 278    // Control the size of the command line passed to dpkg.
 279    MaxBytes 1024;
 280    MaxArgs 350;
 281
 282    // controls if apt will apport on the first dpkg error or if it
 283    // tries to install as many packages as possible
 284    StopOnError "true";
 285 }
 286
 287 /* Options you can set to see some debugging text They correspond to names
 288    of classes in the source code */
 289 Debug
 290 {
 291   pkgProblemResolver "false";
 292   pkgProblemResolver::ShowScores "false";
 293   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
 294   pkgDepCache::Marker "false";
 295   pkgAcquire "false";
 296   pkgAcquire::Worker "false";
 297   pkgAcquire::Auth "false";
 298   pkgDPkgPM "false";
 299   pkgDPkgProgressReporting "false";
 300   pkgOrderList "false";
 301   pkgAutoRemove "false";   // show information about automatic removes
 302   BuildDeps "false";
 303   pkgInitialize "false";   // This one will dump the configuration space
 304   NoLocking "false";
 305   Acquire::Ftp "false";    // Show ftp command traffic
 306   Acquire::Http "false";   // Show http command traffic
 307   Acquire::Https "false";   // Show https debug
 308   Acquire::gpgv "false";   // Show the gpgv traffic
 309   aptcdrom "false";        // Show found package files
 310   IdentCdrom "false";
 311
 312 }
 313
 314 /* Whatever you do, do not use this configuration file!! Take out ONLY
 315    the portions you need! */
 316 This Is Not A Valid Config File