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