merged from debian

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

diff --git a/doc/examples/configure-index b/doc/examples/configure-index
index dee0c06ffeee1ed3b1003bb5daa7a358dbd89b44..a6ad56067986a83c9f5b5abc6ff4de059d74095d 100644 (file)
--- a/doc/examples/configure-index
+++ b/doc/examples/configure-index
@@ -2,7 +2,7 @@
 /* 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 +24,16 @@ APT
 {
   Architecture "i386";
   Build-Essential "build-essential";
-  
+
+  NeverAutoRemove  { "linux-kernel.*";  };  // packages that should never
+                                            // considered for autoRemove
+
   // Options for apt-get
   Get 
   {
      Arch-Only "false";
+     AutomaticRemove "false";       
+     HideAutoRemove "false";
      Download-Only "false";
      Simulate "false";
      Assume-Yes "false";
@@ -72,6 +77,17 @@ 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
+  };
+
   GPGV
   {
      TrustedKeyring "/etc/apt/trusted.gpg";
@@ -85,6 +101,16 @@ APT
   Cache-Limit "4194304";
   Default-Release "";
 
+  // consider Recommends, Suggests as important dependencies that should
+  // be installed by default
+  Install-Recommends "false";
+  Install-Suggests "false";
+
+  // install recommends automatically for packages in this section
+  Install-Recommends-Section { "metapackages"; "universe/metapackages"; };
+  
+  // 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";
@@ -99,6 +125,8 @@ Acquire
   Queue-Mode "host";       // host|access
   Retries "0";
   Source-Symlinks "true";
+
+  PDiffs "true";     // try to get the IndexFile diffs
   
   // HTTP method configuration
   http 
@@ -112,6 +140,19 @@ Acquire
     No-Cache "false";
     Max-Age "86400";     // 1 Day age on index files
     No-Store "false";    // Prevent the cache from storing archives    
+    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" "2";
   };
 
   ftp
@@ -132,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
@@ -152,8 +193,22 @@ Acquire
 
   gpgv
   {
-   Options {"--ignore-time-conflict";} // not very usefull on a normal system
+   Options {"--ignore-time-conflict";} // not very useful on a normal system
+  };
+
+  mirror
+  {
+   RefreshInterval "360"; // refresh interval in minutes
+   MaxAge "90";           // max age for a mirror file in days before 
+                          // it gets deleted
+   // mirror failure reporting script
+   ProblemReporting "/usr/lib/apt/apt-report-mirror-failure"; 
+   // mirror failure reporting url
+   ReportFailures "http://example.com/mirror-failure"; 
   };
+
+  // translations can be set here to "none", "environment" or "$locale"
+  Translation "none";
 };
 
 // Directory layout
@@ -167,6 +222,7 @@ Dir "/"
      userstatus "status.user";
      status "/var/lib/dpkg/status";
      cdroms "cdroms.list";
+     mirrors "mirrors/";
   };
   
   // Location of the cache dir
@@ -195,6 +251,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
@@ -231,6 +292,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
@@ -238,20 +303,24 @@ DPkg
 Debug 
 {
   pkgProblemResolver "false";
+  pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
   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
+  Acquire::Mirror "false"; // Show debugging of the mirror method
   aptcdrom "false";        // Show found package files
   IdentCdrom "false";
-  
 }
 
 /* Whatever you do, do not use this configuration file!! Take out ONLY