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 arbitrary
   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      Build-Dep-Automatic "true";
  58   };
  59
  60   Cache
  61   {
  62      Important "false";
  63      AllVersions "false";
  64      GivenOnly "false";
  65      RecurseDepends "false";
  66      ShowFull "false";
  67      Generate "true";
  68      NamesOnly "false";
  69      AllNames "false";
  70      Installed "false";
  71   };
  72
  73   CDROM
  74   {
  75      Rename "false";
  76      NoMount "false";
  77      Fast "false";
  78      NoAct "false";
  79   };
  80
  81   Update
  82   {
  83      Pre-Invoke {"touch /var/lib/apt/pre-update-stamp"; };
  84      Post-Invoke {"touch /var/lib/apt/post-update-stamp"; };
  85   };
  86
  87   Authentication
  88   {
  89      TrustCDROM "false";            // consider the CDROM always trusted
  90   };
  91
  92   GPGV
  93   {
  94      TrustedKeyring "/etc/apt/trusted.gpg";
  95   };
  96
  97   // Some general options
  98   Ignore-Hold "false";
  99   Clean-Installed "true";
 100   Immediate-Configure "true";      // DO NOT turn this off, see the man page
 101   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
 102   Cache-Limit "4194304";
 103   Default-Release "";
 104
 105   // consider Recommends, Suggests as important dependencies that should
 106   // be installed by default
 107   Install-Recommends "false";
 108   Install-Suggests "false";
 109
 110   // install recommends automatically for packages in this section
 111   Install-Recommends-Section { "metapackages"; "universe/metapackages"; };
 112
 113   // consider dependencies of packages in this section manual
 114   Never-MarkAuto-Sections {"metapackages"; "universe/metapackages"; };
 115
 116   // Write progress messages on this fd (for stuff like base-config)
 117   Status-Fd "-1";
 118   // Keep the list of FDs open (normally apt closes all fds when it
 119   // does a ExecFork)
 120   Keep-Fds {};
 121 };
 122
 123 // Options for the downloading routines
 124 Acquire
 125 {
 126   Queue-Mode "host";       // host|access
 127   Retries "0";
 128   Source-Symlinks "true";
 129
 130   PDiffs "true";     // try to get the IndexFile diffs
 131
 132   // HTTP method configuration
 133   http
 134   {
 135     Proxy "http://127.0.0.1:3128";
 136     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 137     Timeout "120";
 138     Pipeline-Depth "5";
 139
 140     // Cache Control. Note these do not work with Squid 2.0.2
 141     No-Cache "false";
 142     Max-Age "86400";     // 1 Day age on index files
 143     No-Store "false";    // Prevent the cache from storing archives
 144     Dl-Limit "7";        // 7Kb/sec maximum download rate
 145   };
 146
 147   // HTTPS method configuration:
 148   // - uses the http proxy config
 149   // - uses the http cache-control values
 150   // - uses the http Dl-Limit values
 151   https
 152   {
 153         Verify-Peer "false";
 154         SslCert "/etc/apt/some.pem";
 155         CaPath  "/etc/ssl/certs";
 156         Verify-Host" "2";
 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   mirror
 201   {
 202    RefreshInterval "360"; // refresh interval in minutes
 203    MaxAge "90";           // max age for a mirror file in days before
 204                           // it gets deleted
 205    // mirror failure reporting script
 206    ProblemReporting "/usr/lib/apt/apt-report-mirror-failure";
 207    // mirror failure reporting url
 208    ReportFailures "http://example.com/mirror-failure";
 209   };
 210
 211   // translations can be set here to "none", "environment" or "$locale"
 212   Translation "none";
 213 };
 214
 215 // Directory layout
 216 Dir "/"
 217 {
 218   // Location of the state dir
 219   State "var/lib/apt/"
 220   {
 221      Lists "lists/";
 222      xstatus "xstatus";
 223      userstatus "status.user";
 224      status "/var/lib/dpkg/status";
 225      cdroms "cdroms.list";
 226      mirrors "mirrors/";
 227   };
 228
 229   // Location of the cache dir
 230   Cache "var/cache/apt/" {
 231      Archives "archives/";
 232      srcpkgcache "srcpkgcache.bin";
 233      pkgcache "pkgcache.bin";
 234   };
 235
 236   // Config files
 237   Etc "etc/apt/" {
 238      SourceList "sources.list";
 239      Main "apt.conf";
 240      Preferences "preferences";
 241      Parts "apt.conf.d/";
 242   };
 243
 244   // Locations of binaries
 245   Bin {
 246      methods "/usr/lib/apt/methods/";
 247      gzip "/bin/gzip";
 248      gpg  "/usr/bin/gpgv";
 249      dpkg "/usr/bin/dpkg";
 250      dpkg-source "/usr/bin/dpkg-source";
 251      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 252      apt-get "/usr/bin/apt-get";
 253      apt-cache "/usr/bin/apt-cache";
 254   };
 255
 256   // Location of the logfile
 257   Log "var/log/apt" {
 258         Terminal "term.log";
 259   };
 260 };
 261
 262 // Things that effect the APT dselect method
 263 DSelect
 264 {
 265    Clean "auto";   // always|auto|prompt|never
 266    Options "-f";
 267    UpdateOptions "";
 268    PromptAfterUpdate "no";
 269    CheckDir "no";
 270 }
 271
 272 DPkg
 273 {
 274    // Probably don't want to use force-downgrade..
 275    Options {"--force-overwrite";"--force-downgrade";}
 276
 277    // Auto re-mounting of a readonly /usr
 278    Pre-Invoke {"mount -o remount,rw /usr";};
 279    Post-Invoke {"mount -o remount,ro /usr";};
 280
 281    // Prevents daemons from getting cwd as something mountable (default)
 282    Run-Directory "/";
 283
 284    // Build options for apt-get source --compile
 285    Build-Options "-b -uc";
 286
 287    // Pre-configure all packages before they are installed using debconf.
 288    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 289
 290    // Flush the contents of stdin before forking dpkg.
 291    FlushSTDIN "true";
 292
 293    // Control the size of the command line passed to dpkg.
 294    MaxBytes 1024;
 295    MaxArgs 350;
 296
 297    // controls if apt will apport on the first dpkg error or if it
 298    // tries to install as many packages as possible
 299    StopOnError "true";
 300 }
 301
 302 /* Options you can set to see some debugging text They correspond to names
 303    of classes in the source code */
 304 Debug
 305 {
 306   pkgProblemResolver "false";
 307   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
 308   pkgAcquire "false";
 309   pkgAcquire::Worker "false";
 310   pkgAcquire::Auth "false";
 311   pkgDPkgPM "false";
 312   pkgDPkgProgressReporting "false";
 313   pkgOrderList "false";
 314   pkgAutoRemove "false";   // show information about automatic removes
 315   BuildDeps "false";
 316   pkgInitialize "false";   // This one will dump the configuration space
 317   NoLocking "false";
 318   Acquire::Ftp "false";    // Show ftp command traffic
 319   Acquire::Http "false";   // Show http command traffic
 320   Acquire::Https "false";   // Show https debug
 321   Acquire::gpgv "false";   // Show the gpgv traffic
 322   Acquire::Mirror "false"; // Show debugging of the mirror method
 323   aptcdrom "false";        // Show found package files
 324   IdentCdrom "false";
 325 }
 326
 327 /* Whatever you do, do not use this configuration file!! Take out ONLY
 328    the portions you need! */
 329 This Is Not A Valid Config File