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   Install-Recommends "false";
 100   Install-Suggests "false";
 101
 102   // install recommends automatically for packages in this section
 103   Install-Recommends-Section "metapackages";
 104
 105   // consider dependencies of packages in this section manual
 106   Never-MarkAuto-Section "metapackages";
 107
 108   // Write progress messages on this fd (for stuff like base-config)
 109   Status-Fd "-1";
 110   // Keep the list of FDs open (normally apt closes all fds when it
 111   // does a ExecFork)
 112   Keep-Fds {};
 113 };
 114
 115 // Options for the downloading routines
 116 Acquire
 117 {
 118   Queue-Mode "host";       // host|access
 119   Retries "0";
 120   Source-Symlinks "true";
 121
 122   // HTTP method configuration
 123   http
 124   {
 125     Proxy "http://127.0.0.1:3128";
 126     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
 127     Timeout "120";
 128     Pipeline-Depth "5";
 129
 130     // Cache Control. Note these do not work with Squid 2.0.2
 131     No-Cache "false";
 132     Max-Age "86400";     // 1 Day age on index files
 133     No-Store "false";    // Prevent the cache from storing archives
 134     Dl-Limit "7";        // 7Kb/sec maximum download rate
 135   };
 136
 137   // HTTPS method configuration:
 138   // - uses the http proxy config
 139   // - uses the http cache-control values
 140   // - uses the http Dl-Limit values
 141   https
 142   {
 143         Verify-Peer "false";
 144         SslCert "/etc/apt/some.pem";
 145         CaPath  "/etc/ssl/certs";
 146         Verify-Host" "2";
 147   };
 148
 149   ftp
 150   {
 151     Proxy "ftp://127.0.0.1/";
 152     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 153
 154     /* Required script to perform proxy login. This example should work
 155        for tisfwtk */
 156     ProxyLogin
 157     {
 158        "USER $(PROXY_USER)";
 159        "PASS $(PROXY_PASS)";
 160        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 161        "PASS $(SITE_PASS)";
 162     };
 163
 164     Timeout "120";
 165
 166     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 167        is prefered if possible */
 168     Passive "true";
 169     Proxy::Passive "true";
 170     Passive::http.us.debian.org "true"; // Specific per-host setting
 171   };
 172
 173   cdrom
 174   {
 175     mount "/cdrom";
 176
 177     // You need the trailing slash!
 178     "/cdrom/"
 179     {
 180        Mount "sleep 1000";
 181        UMount "sleep 500";
 182     }
 183   };
 184
 185   gpgv
 186   {
 187    Options {"--ignore-time-conflict";}  // not very usefull on a normal system
 188   };
 189
 190   mirror
 191   {
 192    RefreshInterval "360"; // refresh interval in minutes
 193    MaxAge "90";           // max age for a mirror file in days before
 194                           // it gets deleted
 195    // mirror failure reporting script
 196    ProblemReporting "/usr/lib/apt/apt-report-mirror-failure";
 197    // mirror failure reporting url
 198    ReportFailures "http://example.com/mirror-failure";
 199   };
 200
 201   // translations can be set here to "none", "environment" or "$locale"
 202   Translation "none";
 203 };
 204
 205 // Directory layout
 206 Dir "/"
 207 {
 208   // Location of the state dir
 209   State "var/lib/apt/"
 210   {
 211      Lists "lists/";
 212      xstatus "xstatus";
 213      userstatus "status.user";
 214      status "/var/lib/dpkg/status";
 215      cdroms "cdroms.list";
 216      mirrors "mirrors/";
 217   };
 218
 219   // Location of the cache dir
 220   Cache "var/cache/apt/" {
 221      Archives "archives/";
 222      srcpkgcache "srcpkgcache.bin";
 223      pkgcache "pkgcache.bin";
 224   };
 225
 226   // Config files
 227   Etc "etc/apt/" {
 228      SourceList "sources.list";
 229      Main "apt.conf";
 230      Preferences "preferences";
 231      Parts "apt.conf.d/";
 232   };
 233
 234   // Locations of binaries
 235   Bin {
 236      methods "/usr/lib/apt/methods/";
 237      gzip "/bin/gzip";
 238      gpg  "/usr/bin/gpgv";
 239      dpkg "/usr/bin/dpkg";
 240      dpkg-source "/usr/bin/dpkg-source";
 241      dpkg-buildpackage "/usr/bin/dpkg-buildpackage";
 242      apt-get "/usr/bin/apt-get";
 243      apt-cache "/usr/bin/apt-cache";
 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   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
 293   pkgAcquire "false";
 294   pkgAcquire::Worker "false";
 295   pkgAcquire::Auth "false";
 296   pkgDPkgPM "false";
 297   pkgDPkgProgressReporting "false";
 298   pkgOrderList "false";
 299   pkgAutoRemove "false";   // show information about automatic removes
 300   BuildDeps "false";
 301   pkgInitialize "false";   // This one will dump the configuration space
 302   NoLocking "false";
 303   Acquire::Ftp "false";    // Show ftp command traffic
 304   Acquire::Http "false";   // Show http command traffic
 305   Acquire::Https "false";   // Show https debug
 306   Acquire::gpgv "false";   // Show the gpgv traffic
 307   Acquire::Mirror "false"; // Show debugging of the mirror method
 308   aptcdrom "false";        // Show found package files
 309   IdentCdrom "false";
 310 }
 311
 312 /* Whatever you do, do not use this configuration file!! Take out ONLY
 313    the portions you need! */
 314 This Is Not A Valid Config File