merged from the debian-sid branch

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

diff --git a/doc/examples/configure-index b/doc/examples/configure-index
index 56389b7493e6967e1d8c60875bea060dcb869017..84b1d8829198517697e7a25e8c8e611852671578 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
@@ -25,14 +24,16 @@ APT
   Architecture "i386";
   Build-Essential "build-essential";
 
-  NeverAutoRemove  { "linux-kernel.*";  };  // packages that should never
+  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";
@@ -53,6 +54,7 @@ APT
      Only-Source "";
      Diff-Only "false";
      Tar-Only "false";
+     Build-Dep-Automatic "true";
   };
 
   Cache 
@@ -76,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
@@ -96,14 +104,67 @@ APT
 
   // consider Recommends, Suggests as important dependencies that should
   // be installed by default
-  APT::Install-Recommends "false";
-  APT::Install-Suggests "false";
+  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";
   // Keep the list of FDs open (normally apt closes all fds when it
   // does a ExecFork)
   Keep-Fds {};
+
+  // control parameters for cron jobs by /etc/cron.daily/apt
+  Periodic
+  {
+  BackupArchiveInterval "0";
+  // - Backup after n-days if archive contents changed.(0=disable)
+
+  BackupLevel "3";
+  // - Backup level.(0=disable), 1 is invalid.
+
+  // APT::Archives::MaxAge "0"; (old, deprecated)
+  MaxAge "0"; // (new)
+  // - Set maximum allowed age of a cache package file. If a cache 
+  //   package file is older it is deleted (0=disable)
+
+  // APT::Archives::MinAge "2"; (old, deprecated)
+  MinAge "2"; // (new)
+  // - Set minimum age of a package file. If a file is younger it
+  //   will not be deleted (0=disable). Usefull to prevent races 
+  //   and to keep backups of the packages for emergency.
+
+  // APT::Archives::MaxSize "0"; (old, deprecated)
+  MaxSize "0"; // (new)
+  // - Set maximum size of the cache in MB (0=disable). If the cache
+  //   is bigger, cached package files are deleted until the size
+  //   requirement is met (the biggest packages will be deleted 
+  //   first).
+
+  Update-Package-Lists "0";
+  // - Do "apt-get update" automatically every n-days (0=disable)
+  //   
+  Download-Upgradeable-Packages "0";
+  // - Do "apt-get upgrade --download-only" every n-days (0=disable)
+  //
+  Unattended-Upgrade "0";
+  // - Run the "unattended-upgrade" security upgrade script 
+  //   every n-days (0=disabled)
+  //   Requires the package "unattended-upgrades" and will write
+  //   a log in /var/log/unattended-upgrades
+  //
+  AutocleanInterval "0";
+  // - Do "apt-get autoclean" every n-days (0=disable)
+
+  Verbose "0";
+  // - Send report mail to root
+  //   0:  no report             (or null string)
+  //   1:  progress report       (actually any string)
+  //   2:  + command outputs     (remove -qq, remove 2>/dev/null, add -d)
+  //   3:  + trace on            
+  };
 };
 
 // Options for the downloading routines
@@ -160,7 +221,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
@@ -180,7 +241,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
   };
 };
 
@@ -200,6 +261,8 @@ Dir "/"
   // Location of the cache dir
   Cache "var/cache/apt/" {
      Archives "archives/";
+     // backup directory created by /etc/cron.daily/apt
+     Backup "backup/"; 
      srcpkgcache "srcpkgcache.bin";
      pkgcache "pkgcache.bin";     
   };
@@ -223,6 +286,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