FTP man page updates

[apt.git] / doc / examples / apt.conf

diff --git a/doc/examples/apt.conf b/doc/examples/apt.conf
index 0a6477c6e0c5fed3719ccbe48de4566726f1a9b7..3895a57b55158d94030c62743ae15f9e9665f209 100644 (file)
--- a/doc/examples/apt.conf
+++ b/doc/examples/apt.conf
@@ -1,47 +1,174 @@
-// $Id: apt.conf,v 1.1 1998/10/02 04:39:59 jgg Exp $
+// $Id: apt.conf,v 1.28 1999/03/15 23:05:49 jgg 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 a completely
    valid file.
+   
+   In some instances involving filenames it is possible to set the default
+   directory when the path is evaluated. This means you can use relative
+   paths within the sub scope.
+   
+   The configuration directives are specified in a tree with {} designating
+   a subscope relative to the tag before the {}. You can further specify
+   a subscope using scope notation eg,
+     APT::Architecture "i386";
+   This is prefixed with the current scope. Scope notation must be used
+   if an option is specified on the command line with -o.
 */
 
-APT {
+// Options for APT in general
+APT 
+{
   Architecture "i386";
   
-  Get {
+  // Options for apt-get
+  Get 
+  {
      Download-Only "false";
      Simulate "false";
      Assume-Yes "false";
+     Force-Yes "false";             // I would never set this.
      Fix-Broken "false";  
+     Fix-Missing "false";     
      Show-Upgraded "false";
+     No-Upgrade "false";
+     Print-URIs "false";
+  };
+
+  Cache 
+  {
+     Important "false";
+  };
+
+  CDROM 
+  {
+     Rename "false";
+     NoMount "false";
+     Fast "false";
+     NoAct "false";
   };
+
+  // Some general options
+  Ingore-Hold "false";
+  Immediate-Configure "true";      // DO NOT turn this off, see the man page
 };
 
+// Options for the downloading routines
+Acquire
+{
+  Queue-Mode "host";       // host|access
+  Retries "0";
+  
+  // HTTP method configuration
+  http 
+  {
+    Proxy "http://127.0.0.1:3128";
+    Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
+    Timeout "120";
+    
+    // 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    
+  };
+
+  ftp
+  {
+    Proxy "ftp://127.0.0.1/";
+    Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
+
+    /* Required script to perform proxy login. This example should work
+       for tisfwtk */
+    ProxyLogin
+    {
+       "USER $(PROXY_USER)";
+       "PASS $(PROXY_PASS)";
+       "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
+       "PASS $(SITE_PASS)";
+    };
+    
+    Timeout "120";
+    
+    /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
+       is prefered if possible */
+    Passive "true";
+    Proxy::Passive "true";
+    Passive::http.us.debian.org "true"; // Specific per-host setting
+  };
+  
+  cdrom
+  {
+    Mount "/cdrom";    
+  };
+};
+
+// Directory layout
 Dir 
 {
+  // Location of the state dir
   State "/var/state/apt/" 
   {
      lists "lists/";
      xstatus "xstatus";
      userstatus "status.user";
-     status "/var/lib/dpkg/status";     
+     status "/var/lib/dpkg/status";
+     cdroms "cdroms.list";
   };
   
+  // Location of the cache dir
   Cache "/var/cache/apt/" {
      archives "archives/";
      srcpkgcache "srcpkgcache.bin";
      pkgcache "pkgcache.bin";     
   };
   
+  // Config files
   Etc "/etc/apt/" {
      sourcelist "sources.list";
      main "apt.conf";
   };
+  
+  // Locations of binaries
+  Bin {
+     methods "/usr/lib/apt/methods/";
+     gzip "/bin/gzip";
+     dpkg "/usr/bin/dpkg";
+     apt-get "/usr/bin/apt-get";
+     apt-cache "/usr/bin/apt-get";
+  };
 };
 
-DSelect {
+// Things that effect the APT dselect method
+DSelect 
+{
+   Clean "auto";   // always|auto|prompt|never
+   Options "-f";
+   UpdateOptions "";
+   PromptAfterUpdate "no";
+}
 
+DPkg 
+{
+   // Probably don't want to set this one..
+   Options {"--force-downgrade";}
+   
+   // Auto re-mounting of a readonly /usr
+   Pre-Invoke {"mount -o remount,rw /usr";};
+   Post-Invoke {"mount -o remount,ro /usr";};
+   
+   // Prevents daemons from getting cwd as something mountable (default)
+   Run-Directory "/";
 }
 
-Debug {
-  pkgProblemResolver "true";
+/* Options you can set to see some debugging text They corrispond to names
+   of classes in the source code */
+Debug 
+{
+  pkgProblemResolver "false";
+  pkgAcquire "false";
+  pkgAcquire::Worker "false";
+  pkgDPkgPM "false";
+  
+  pkgInitialize "false";   // This one will dump the configuration space
+  NoLocking "false";
+  Acquire::Ftp "false";    // Show ftp command traffic
 }