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 ac2f2997d9a75aa555ee8363bfa203808adeda7f..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
 /* 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
    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";
 {
   Architecture "i386";
   Build-Essential "build-essential";

-  
+
+  NeverAutoRemove  { "linux-image.*";  };  // packages that should never
+                                            // considered for autoRemove
+

   // Options for apt-get
   Get 
   {
      Arch-Only "false";
   // Options for apt-get
   Get 
   {
      Arch-Only "false";

+     AllowUnauthenticated "false";
+     AutomaticRemove "false";       
+     HideAutoRemove "false";

      Download-Only "false";
      Simulate "false";
      Assume-Yes "false";
      Download-Only "false";
      Simulate "false";
      Assume-Yes "false";


@@ -49,6 +54,7 @@ APT
      Only-Source "";
      Diff-Only "false";
      Tar-Only "false";
      Only-Source "";
      Diff-Only "false";
      Tar-Only "false";

+     Build-Dep-Automatic "true";

   };
 
   Cache 
   };
 
   Cache 


@@ -72,6 +78,12 @@ APT
      NoAct "false";
   };
 
      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
   Authentication
   {
      TrustCDROM "false";            // consider the CDROM always trusted


@@ -90,12 +102,69 @@ APT
   Cache-Limit "4194304";
   Default-Release "";
 
   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";
   // Keep the list of FDs open (normally apt closes all fds when it
   // does a ExecFork)
   Keep-Fds {};
 
   // 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
 };
 
 // Options for the downloading routines


@@ -122,6 +191,18 @@ Acquire
     Dl-Limit "7";        // 7Kb/sec maximum download rate
   };
 
     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
   {
     Proxy "ftp://127.0.0.1/";
   ftp
   {
     Proxy "ftp://127.0.0.1/";


@@ -140,7 +221,7 @@ Acquire
     Timeout "120";
     
     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
     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
     Passive "true";
     Proxy::Passive "true";
     Passive::http.us.debian.org "true"; // Specific per-host setting


@@ -160,7 +241,7 @@ Acquire
 
   gpgv
   {
 
   gpgv
   {

-   Options {"--ignore-time-conflict";} // not very usefull on a normal system
+   Options {"--ignore-time-conflict";} // not very useful on a normal system

   };
 };
 
   };
 };
 


@@ -180,6 +261,8 @@ Dir "/"
   // Location of the cache dir
   Cache "var/cache/apt/" {
      Archives "archives/";
   // 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";     
   };
      srcpkgcache "srcpkgcache.bin";
      pkgcache "pkgcache.bin";     
   };


@@ -203,6 +286,11 @@ Dir "/"
      apt-get "/usr/bin/apt-get";
      apt-cache "/usr/bin/apt-cache";
   };
      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
 };
 
 // Things that effect the APT dselect method


@@ -239,6 +327,10 @@ DPkg
    // Control the size of the command line passed to dpkg.
    MaxBytes 1024;
    MaxArgs 350;
    // 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
 }
 
 /* Options you can set to see some debugging text They correspond to names


@@ -253,12 +345,13 @@ Debug
   pkgDPkgPM "false";
   pkgDPkgProgressReporting "false";
   pkgOrderList "false";
   pkgDPkgPM "false";
   pkgDPkgProgressReporting "false";
   pkgOrderList "false";

+  pkgAutoRemove "false";   // show information about automatic removes

   BuildDeps "false";
   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
   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";
   Acquire::gpgv "false";   // Show the gpgv traffic
   aptcdrom "false";        // Show found package files
   IdentCdrom "false";