Merge remote-tracking branch 'mvo/feature/more-fancy-progress' into debian/sid

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

diff --git a/doc/examples/configure-index b/doc/examples/configure-index
index f5f9964609282e6d75c4ae562b192f0bc52da9b6..2d9f829ba89392aaa95c0dac98817d3a0f70515d 100644 (file)
--- a/doc/examples/configure-index
+++ b/doc/examples/configure-index
@@ -17,11 +17,13 @@
 */
 
 quiet "0";
 */
 
 quiet "0";

+quiet::NoUpdate "true"; // never update progress information - included in -q=1

 
 // Options for APT in general
 APT 
 {
   Architecture "i386";
 
 // Options for APT in general
 APT 
 {
   Architecture "i386";

+  Architectures { "amd64"; "armel"; };

   Build-Essential "build-essential";
 
   NeverAutoRemove  { "linux-image.*";  };  // packages that should never
   Build-Essential "build-essential";
 
   NeverAutoRemove  { "linux-image.*";  };  // packages that should never


@@ -30,6 +32,7 @@ APT
   // Options for apt-get
   Get 
   {
   // Options for apt-get
   Get 
   {

+     Host-Architecture "armel";

      Arch-Only "false";
      AllowUnauthenticated "false";
      AutomaticRemove "false";       
      Arch-Only "false";
      AllowUnauthenticated "false";
      AutomaticRemove "false";       


@@ -87,12 +90,7 @@ APT
 
   Authentication
   {
 
   Authentication
   {

-     TrustCDROM "false";            // consider the CDROM always trusted
-  };
-
-  GPGV
-  {
-     TrustedKeyring "/etc/apt/trusted.gpg";
+     TrustCDROM "false";            // consider the CD-ROM always trusted

   };
 
   // Some general options
   };
 
   // Some general options


@@ -100,7 +98,9 @@ APT
   Clean-Installed "true";
   Immediate-Configure "true";      // DO NOT turn this off, see the man page
   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
   Clean-Installed "true";
   Immediate-Configure "true";      // DO NOT turn this off, see the man page
   Force-LoopBreak "false";         // DO NOT turn this on, see the man page

-  Cache-Limit "4194304";
+  Cache-Start "20971520";
+  Cache-Grow "1048576";
+  Cache-Limit "0";

   Default-Release "";
 
   // consider Recommends, Suggests as important dependencies that should
   Default-Release "";
 
   // consider Recommends, Suggests as important dependencies that should


@@ -117,54 +117,62 @@ APT
   // does a ExecFork)
   Keep-Fds {};
 
   // does a ExecFork)
   Keep-Fds {};
 

+  Changelogs
+  {
+    // server the provides the changelogs, the code will assume
+    // the changlogs are in the pool/ under a srcpkg_ver directory 
+    // with the name "changelog"
+    Server "http://packages.debian.org/changelogs";
+  }:
+

   // control parameters for cron jobs by /etc/cron.daily/apt
   Periodic
   {
   // 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            
+    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). Useful 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 oldest 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            

   };
 };
 
   };
 };
 


@@ -174,9 +182,17 @@ Acquire
   Queue-Mode "host";       // host|access
   Retries "0";
   Source-Symlinks "true";
   Queue-Mode "host";       // host|access
   Retries "0";
   Source-Symlinks "true";

+  ForceHash "sha256"; // hashmethod used for expected hash: sha256, sha1 or md5sum

 
   PDiffs "true";     // try to get the IndexFile diffs
 
   PDiffs "true";     // try to get the IndexFile diffs

-  
+  PDiffs::FileLimit "4"; // don't use diffs if we would need more than 4 diffs
+  PDiffs::SizeLimit "50"; // don't use diffs if size of all patches excess
+                         // 50% of the size of the original file
+
+  Check-Valid-Until "true";
+  Max-ValidTime "864000"; // 10 days
+  Max-ValidTime::Debian-Security "604800"; // 7 days, label specific configuration
+

   // HTTP method configuration
   http 
   {
   // HTTP method configuration
   http 
   {


@@ -191,19 +207,37 @@ Acquire
     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
     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

+    User-Agent "Debian APT-HTTP/1.3";

   };
 
   };
 

-  // HTTPS method configuration:
-  // - uses the http proxy config 
-  // - uses the http cache-control values
-  // - uses the http Dl-Limit values
-  https 
+
+
+  // HTTPS method configuration: uses the http
+  // - proxy config
+  // - cache-control values
+  // - Dl-Limit, Timout, ... values
+  // if not set explicit for https
+  //
+  // see /usr/share/doc/apt/examples/apt-https-method-example.conf.gz
+  // for more examples
+  https

   {
        Verify-Peer "false";
        SslCert "/etc/apt/some.pem";
   {
        Verify-Peer "false";
        SslCert "/etc/apt/some.pem";

-        CaPath  "/etc/ssl/certs";
-        Verify-Host" "true";
-        AllowRedirect  "true";
+       CaPath  "/etc/ssl/certs";
+       Verify-Host "true";
+       AllowRedirect  "true";
+
+       Timeout "120";
+       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
+       No-Store "false";    // Prevent the cache from storing archives
+       Dl-Limit "7";        // 7Kb/sec maximum download rate
+
+       User-Agent "Debian APT-CURL/1.0";

   };
 
   ftp
   };
 
   ftp


@@ -232,6 +266,13 @@ Acquire
   
   cdrom
   {
   
   cdrom
   {

+    // do auto detection of the cdrom mountpoint
+    AutoDetect "true";   
+    // when auto-detecting, only look for cdrom/dvd. when this is false
+    // it will support any removable device as a "cdrom" source
+    CdromOnly "true";
+    
+    // cdrom mountpoint (needs to be defined in fstab if AutoDetect is not used)

     mount "/cdrom";
 
     // You need the trailing slash!
     mount "/cdrom";
 
     // You need the trailing slash!


@@ -253,7 +294,16 @@ Acquire
     lzma "lzma";
     gz "gzip";
 
     lzma "lzma";
     gz "gzip";
 

-    Order { "gz"; "lzma"; "bz2"; };
+    Order { "uncompressed"; "gz"; "lzma"; "bz2"; };
+  };
+
+  Languages
+  {
+     "environment";
+     "de";
+     "en";
+     "none";
+     "fr";

   };
 };
 
   };
 };
 


@@ -264,9 +314,8 @@ Dir "/"
   State "var/lib/apt/" 
   {
      Lists "lists/";
   State "var/lib/apt/" 
   {
      Lists "lists/";

-     xstatus "xstatus";
-     userstatus "status.user";

      status "/var/lib/dpkg/status";
      status "/var/lib/dpkg/status";

+     extended_states "extended_states";

      cdroms "cdroms.list";
   };
   
      cdroms "cdroms.list";
   };
   


@@ -290,6 +339,8 @@ Dir "/"
      SourceParts "sources.list.d";
      VendorList "vendors.list";
      VendorParts "vendors.list.d";
      SourceParts "sources.list.d";
      VendorList "vendors.list";
      VendorParts "vendors.list.d";

+     Trusted "trusted.gpg";
+     TrustedParts "trusted.gpg.d";

   };
   
   // Locations of binaries
   };
   
   // Locations of binaries


@@ -307,6 +358,21 @@ Dir "/"
   // Location of the logfile
   Log "var/log/apt" {
        Terminal "term.log";
   // Location of the logfile
   Log "var/log/apt" {
        Terminal "term.log";

+       History "history.log";
+  };
+
+  // Media 
+  Media 
+  {
+       // Media AutoDetect mount path
+       MountPath "/media/apt";
+  };
+
+  // Media 
+  Media 
+  {
+       // Media AutoDetect mount path
+       MountPath "/media/apt";

   };
 };
 
   };
 };
 


@@ -324,7 +390,6 @@ DPkg
 {
    // let apt aggressivly use dpkg triggers
    NoTriggers "true";
 {
    // let apt aggressivly use dpkg triggers
    NoTriggers "true";

-   NoConfigure "true";

    ConfigurePending "true";
 
    // Probably don't want to use force-downgrade..
    ConfigurePending "true";
 
    // Probably don't want to use force-downgrade..


@@ -365,12 +430,14 @@ Debug
   pkgProblemResolver::ShowScores "false";
   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
   pkgDepCache::Marker "false"; 
   pkgProblemResolver::ShowScores "false";
   pkgDepCache::AutoInstall "false"; // what packages apt install to satify dependencies
   pkgDepCache::Marker "false"; 

+  pkgCacheGen "false";

   pkgAcquire "false";
   pkgAcquire::Worker "false";
   pkgAcquire::Auth "false";
   pkgDPkgPM "false";
   pkgDPkgProgressReporting "false";
   pkgOrderList "false";
   pkgAcquire "false";
   pkgAcquire::Worker "false";
   pkgAcquire::Auth "false";
   pkgDPkgPM "false";
   pkgDPkgProgressReporting "false";
   pkgOrderList "false";

+  pkgPackageManager "false"; // OrderList/Configure debugging

   pkgAutoRemove "false";   // show information about automatic removes
   BuildDeps "false";
   pkgInitialize "false";   // This one will dump the configuration space
   pkgAutoRemove "false";   // show information about automatic removes
   BuildDeps "false";
   pkgInitialize "false";   // This one will dump the configuration space


@@ -379,12 +446,15 @@ Debug
   Acquire::Http "false";   // Show http command traffic
   Acquire::Https "false";   // Show https debug
   Acquire::gpgv "false";   // Show the gpgv traffic
   Acquire::Http "false";   // Show http command traffic
   Acquire::Https "false";   // Show https debug
   Acquire::gpgv "false";   // Show the gpgv traffic

+  Acquire::cdrom "false";   // Show cdrom debug output

   aptcdrom "false";        // Show found package files
   IdentCdrom "false";
   acquire::netrc "false";  // netrc parser
   aptcdrom "false";        // Show found package files
   IdentCdrom "false";
   acquire::netrc "false";  // netrc parser

-  
+  RunScripts "false";      // debug invocation of external scripts  

 }
 
 }
 

+pkgCacheGen::Essential "native"; // other modes: all, none, installed
+

 /* Whatever you do, do not use this configuration file!! Take out ONLY
    the portions you need! */
 This Is Not A Valid Config File
 /* Whatever you do, do not use this configuration file!! Take out ONLY
    the portions you need! */
 This Is Not A Valid Config File