configure-index: document Dir::Etc::SourceParts and some other options

[apt.git] / doc / examples / configure-index

diff --git a/doc/examples/configure-index b/doc/examples/configure-index
index ac2f2997d9a75aa555ee8363bfa203808adeda7f..b2bc95e692db2f2c3eb834bf19e3d3b42bbb53d7 100644 (file)
--- a/doc/examples/configure-index
+++ b/doc/examples/configure-index
@@ -1,8 +1,7 @@
-// $Id: configure-index,v 1.10 2004/07/17 19:37:16 mdz Exp $
 /* This file is an index of all APT configuration directives. It should
    NOT actually be used as a real config file, though it is (except for the
    last line) a completely valid file. Most of the options have sane default
-   values, unless you have specific needs you should NOT include arbitary
+   values, unless you have specific needs you should NOT include arbitrary
    items in a custom configuration.
    
    In some instances involving filenames it is possible to set the default
@@ -24,11 +23,17 @@ APT
 {
   Architecture "i386";
   Build-Essential "build-essential";
-  
+
+  NeverAutoRemove  { "linux-image.*";  };  // packages that should never
+                                            // considered for autoRemove
+
   // Options for apt-get
   Get 
   {
      Arch-Only "false";
+     AllowUnauthenticated "false";
+     AutomaticRemove "false";       
+     HideAutoRemove "false";
      Download-Only "false";
      Simulate "false";
      Assume-Yes "false";
@@ -49,6 +54,7 @@ APT
      Only-Source "";
      Diff-Only "false";
      Tar-Only "false";
+     Build-Dep-Automatic "true";
   };
 
   Cache 
@@ -72,6 +78,12 @@ APT
      NoAct "false";
   };
 
+  Update
+  {
+     Pre-Invoke {"touch /var/lib/apt/pre-update-stamp"; };
+     Post-Invoke {"touch /var/lib/apt/post-update-stamp"; };
+  };
+
   Authentication
   {
      TrustCDROM "false";            // consider the CDROM always trusted
@@ -90,6 +102,13 @@ APT
   Cache-Limit "4194304";
   Default-Release "";
 
+  // consider Recommends, Suggests as important dependencies that should
+  // be installed by default
+  Install-Recommends "true";
+  Install-Suggests "false";
+
+  // consider dependencies of packages in this section manual
+  Never-MarkAuto-Sections {"metapackages"; "universe/metapackages"; };
 
   // Write progress messages on this fd (for stuff like base-config)
   Status-Fd "-1";
@@ -114,7 +133,8 @@ Acquire
     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
     Timeout "120";
     Pipeline-Depth "5";
-    
+    AllowRedirect  "true";
+
     // Cache Control. Note these do not work with Squid 2.0.2
     No-Cache "false";
     Max-Age "86400";     // 1 Day age on index files
@@ -122,6 +142,19 @@ Acquire
     Dl-Limit "7";        // 7Kb/sec maximum download rate
   };
 
+  // HTTPS method configuration:
+  // - uses the http proxy config 
+  // - uses the http cache-control values
+  // - uses the http Dl-Limit values
+  https 
+  {
+       Verify-Peer "false";
+       SslCert "/etc/apt/some.pem";
+        CaPath  "/etc/ssl/certs";
+        Verify-Host" "true";
+        AllowRedirect  "true";
+  };
+
   ftp
   {
     Proxy "ftp://127.0.0.1/";
@@ -140,7 +173,7 @@ Acquire
     Timeout "120";
     
     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
-       is prefered if possible */
+       is preferred if possible */
     Passive "true";
     Proxy::Passive "true";
     Passive::http.us.debian.org "true"; // Specific per-host setting
@@ -160,7 +193,7 @@ Acquire
 
   gpgv
   {
-   Options {"--ignore-time-conflict";} // not very usefull on a normal system
+   Options {"--ignore-time-conflict";} // not very useful on a normal system
   };
 };
 
@@ -186,10 +219,13 @@ Dir "/"
   
   // Config files
   Etc "etc/apt/" {
-     SourceList "sources.list";
      Main "apt.conf";
-     Preferences "preferences";     
      Parts "apt.conf.d/";
+     Preferences "preferences";     
+     SourceList "sources.list";
+     SourceParts "sources.list.d";
+     VendorList "vendors.list";
+     VendorParts "vendors.list.d";
   };
   
   // Locations of binaries
@@ -203,6 +239,11 @@ Dir "/"
      apt-get "/usr/bin/apt-get";
      apt-cache "/usr/bin/apt-cache";
   };
+
+  // Location of the logfile
+  Log "var/log/apt" {
+       Terminal "term.log";
+  };
 };
 
 // Things that effect the APT dselect method
@@ -239,6 +280,10 @@ DPkg
    // Control the size of the command line passed to dpkg.
    MaxBytes 1024;
    MaxArgs 350;
+
+   // controls if apt will apport on the first dpkg error or if it 
+   // tries to install as many packages as possible
+   StopOnError "true";
 }
 
 /* Options you can set to see some debugging text They correspond to names
@@ -246,19 +291,22 @@ DPkg
 Debug 
 {
   pkgProblemResolver "false";
+  pkgProblemResolver::ShowScores "false";
   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
+  pkgDepCache::Marker "false"; 
   pkgAcquire "false";
   pkgAcquire::Worker "false";
   pkgAcquire::Auth "false";
   pkgDPkgPM "false";
   pkgDPkgProgressReporting "false";
   pkgOrderList "false";
+  pkgAutoRemove "false";   // show information about automatic removes
   BuildDeps "false";
-  
   pkgInitialize "false";   // This one will dump the configuration space
   NoLocking "false";
   Acquire::Ftp "false";    // Show ftp command traffic
   Acquire::Http "false";   // Show http command traffic
+  Acquire::Https "false";   // Show https debug
   Acquire::gpgv "false";   // Show the gpgv traffic
   aptcdrom "false";        // Show found package files
   IdentCdrom "false";