New configuration example

Author: jgg
Date: 1999-12-06 02:19:38 GMT
New configuration example

2 files changed, 218 insertions, 186 deletions

diff --git a/doc/examples/apt.conf b/doc/examples/apt.conf
index 6bd04c5e5..7201d1920 100644
--- a/doc/examples/apt.conf
+++ b/doc/examples/apt.conf
@@ -1,210 +1,32 @@
-// $Id: apt.conf,v 1.42 1999/10/31 06:32:28 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. Most of the options have sane default values, unless
-   you have specific needs you should NOT include arbitary items in a custom
-   configuration.
-   
-   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.
+// $Id: apt.conf,v 1.43 1999/12/06 02:19:38 jgg Exp $
+/* This file is a sample configuration file with a few harmless sample 
+   options.   
 */
 
-// Options for APT in general
 APT 
 {
-  Architecture "i386";
-  
   // 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";
-     Compile "false";
-     No-Download "false";
-     Purge "false";
-     List-Cleanup "true";
-     ReInstall "false";
-     Trivial-Only "false";
-     No-Remove "false";
-  };
-
-  Cache 
-  {
-     Important "false";
-     AllVersions "false";
-  };
-
-  CDROM 
-  {
-     Rename "false";
-     NoMount "false";
-     Fast "false";
-     NoAct "false";
   };
-
-  // Some general options
-  Ignore-Hold "false";
-  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";
+  
 };
 
 // Options for the downloading routines
 Acquire
 {
-  Queue-Mode "host";       // host|access
   Retries "0";
-  Source-Symlinks "true";
-  
-  // HTTP method configuration
-  http 
-  {
-    Proxy "http://127.0.0.1:3128";
-    Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
-    Timeout "120";
-    Pipeline-Depth "5";
-    
-    // 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";
-
-    // You need the trailing slash!
-    "/cdrom/"
-    {
-       Mount "sleep 1000";
-       UMount "sleep 500";
-    }
-  };
-};
-
-// Directory layout
-Dir 
-{
-  // Location of the state dir
-  State "/var/state/apt/" 
-  {
-     lists "lists/";
-     xstatus "xstatus";
-     userstatus "status.user";
-     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";
-     dpkg-source "/usr/bin/dpkg-source";
-     dpkg-buildpackage "/usr/bin/dpkg-buildpackage"
-     apt-get "/usr/bin/apt-get";
-     apt-cache "/usr/bin/apt-cache";
-  };
 };
 
 // Things that effect the APT dselect method
 DSelect 
 {
-   Clean "auto";   // always|auto|prompt|never
-   Options "-f";
-   UpdateOptions "";
-   PromptAfterUpdate "no";
-}
+  Clean "auto";   // always|auto|prompt|never
+};
 
 DPkg 
 {
-   // Probably don't want to use force-downgrade..
-   Options {"--force-overwrite";"--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 "/";
-   
-   // Build options for apt-get source --compile
-   Build-Options "-b -uc";
-
-   // Pre-configure all packages before they are installed using debconf.
-   Pre-Install-Pkgs {"dpkg-preconfig --apt --priority=low --frontend=dialog";};
+  // Probably don't want to use force-downgrade..
+  Options {"--force-overwrite";}
 }
-
-/* 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
-  Acquire::Http "false";   // Show http command traffic
-  aptcdrom "false";        // Show found package files
-}
-
-/* Whatever you do, do not use this configuration file!! Take out ONLY
-   the portions you need */
-This Is Not A Valid Config File
diff --git a/doc/examples/configure-index b/doc/examples/configure-index
new file mode 100644
index 000000000..58492cd57
--- /dev/null
+++ b/doc/examples/configure-index
@@ -0,0 +1,210 @@
+// $Id: configure-index,v 1.1 1999/12/06 02:19:39 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. Most of the options have sane default values, unless
+   you have specific needs you should NOT include arbitary items in a custom
+   configuration.
+   
+   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.
+*/
+
+// Options for APT in general
+APT 
+{
+  Architecture "i386";
+  
+  // 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";
+     Compile "false";
+     No-Download "false";
+     Purge "false";
+     List-Cleanup "true";
+     ReInstall "false";
+     Trivial-Only "false";
+     No-Remove "false";
+  };
+
+  Cache 
+  {
+     Important "false";
+     AllVersions "false";
+  };
+
+  CDROM 
+  {
+     Rename "false";
+     NoMount "false";
+     Fast "false";
+     NoAct "false";
+  };
+
+  // Some general options
+  Ignore-Hold "false";
+  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";
+};
+
+// Options for the downloading routines
+Acquire
+{
+  Queue-Mode "host";       // host|access
+  Retries "0";
+  Source-Symlinks "true";
+  
+  // HTTP method configuration
+  http 
+  {
+    Proxy "http://127.0.0.1:3128";
+    Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
+    Timeout "120";
+    Pipeline-Depth "5";
+    
+    // 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";
+
+    // You need the trailing slash!
+    "/cdrom/"
+    {
+       Mount "sleep 1000";
+       UMount "sleep 500";
+    }
+  };
+};
+
+// Directory layout
+Dir 
+{
+  // Location of the state dir
+  State "/var/state/apt/" 
+  {
+     lists "lists/";
+     xstatus "xstatus";
+     userstatus "status.user";
+     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";
+     dpkg-source "/usr/bin/dpkg-source";
+     dpkg-buildpackage "/usr/bin/dpkg-buildpackage"
+     apt-get "/usr/bin/apt-get";
+     apt-cache "/usr/bin/apt-cache";
+  };
+};
+
+// 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 use force-downgrade..
+   Options {"--force-overwrite";"--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 "/";
+   
+   // Build options for apt-get source --compile
+   Build-Options "-b -uc";
+
+   // Pre-configure all packages before they are installed using debconf.
+   Pre-Install-Pkgs {"dpkg-preconfig --apt --priority=low --frontend=dialog";};
+}
+
+/* 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
+  Acquire::Http "false";   // Show http command traffic
+  aptcdrom "false";        // Show found package files
+}
+
+/* Whatever you do, do not use this configuration file!! Take out ONLY
+   the portions you need! */
+This Is Not A Valid Config File