doc/examples/configure-index

   1 // $Id: configure-index,v 1.1 1999/12/06 02:19:39 jgg Exp $
   2 /* This file is an index of all APT configuration directives. It should
   3    NOT actually be used as a real config file, though it is a completely
   4    valid file. Most of the options have sane default values, unless
   5    you have specific needs you should NOT include arbitary items in a custom
   6    configuration.
   7
   8    In some instances involving filenames it is possible to set the default
   9    directory when the path is evaluated. This means you can use relative
  10    paths within the sub scope.
  11
  12    The configuration directives are specified in a tree with {} designating
  13    a subscope relative to the tag before the {}. You can further specify
  14    a subscope using scope notation eg,
  15      APT::Architecture "i386";
  16    This is prefixed with the current scope. Scope notation must be used
  17    if an option is specified on the command line with -o.
  18 */
  19
  20 // Options for APT in general
  21 APT
  22 {
  23   Architecture "i386";
  24
  25   // Options for apt-get
  26   Get
  27   {
  28      Download-Only "false";
  29      Simulate "false";
  30      Assume-Yes "false";
  31      Force-Yes "false";             // I would never set this.
  32      Fix-Broken "false";
  33      Fix-Missing "false";
  34      Show-Upgraded "false";
  35      No-Upgrade "false";
  36      Print-URIs "false";
  37      Compile "false";
  38      No-Download "false";
  39      Purge "false";
  40      List-Cleanup "true";
  41      ReInstall "false";
  42      Trivial-Only "false";
  43      No-Remove "false";
  44   };
  45
  46   Cache
  47   {
  48      Important "false";
  49      AllVersions "false";
  50   };
  51
  52   CDROM
  53   {
  54      Rename "false";
  55      NoMount "false";
  56      Fast "false";
  57      NoAct "false";
  58   };
  59
  60   // Some general options
  61   Ignore-Hold "false";
  62   Clean-Installed "true";
  63   Immediate-Configure "true";      // DO NOT turn this off, see the man page
  64   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
  65   Cache-Limit "4194304";
  66 };
  67
  68 // Options for the downloading routines
  69 Acquire
  70 {
  71   Queue-Mode "host";       // host|access
  72   Retries "0";
  73   Source-Symlinks "true";
  74
  75   // HTTP method configuration
  76   http
  77   {
  78     Proxy "http://127.0.0.1:3128";
  79     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
  80     Timeout "120";
  81     Pipeline-Depth "5";
  82
  83     // Cache Control. Note these do not work with Squid 2.0.2
  84     No-Cache "false";
  85     Max-Age "86400";     // 1 Day age on index files
  86     No-Store "false";    // Prevent the cache from storing archives
  87   };
  88
  89   ftp
  90   {
  91     Proxy "ftp://127.0.0.1/";
  92     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
  93
  94     /* Required script to perform proxy login. This example should work
  95        for tisfwtk */
  96     ProxyLogin
  97     {
  98        "USER $(PROXY_USER)";
  99        "PASS $(PROXY_PASS)";
 100        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 101        "PASS $(SITE_PASS)";
 102     };
 103
 104     Timeout "120";
 105
 106     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 107        is prefered if possible */
 108     Passive "true";
 109     Proxy::Passive "true";
 110     Passive::http.us.debian.org "true"; // Specific per-host setting
 111   };
 112
 113   cdrom
 114   {
 115     Mount "/cdrom";
 116
 117     // You need the trailing slash!
 118     "/cdrom/"
 119     {
 120        Mount "sleep 1000";
 121        UMount "sleep 500";
 122     }
 123   };
 124 };
 125
 126 // Directory layout
 127 Dir
 128 {
 129   // Location of the state dir
 130   State "/var/state/apt/"
 131   {
 132      lists "lists/";
 133      xstatus "xstatus";
 134      userstatus "status.user";
 135      status "/var/lib/dpkg/status";
 136      cdroms "cdroms.list";
 137   };
 138
 139   // Location of the cache dir
 140   Cache "/var/cache/apt/" {
 141      archives "archives/";
 142      srcpkgcache "srcpkgcache.bin";
 143      pkgcache "pkgcache.bin";
 144   };
 145
 146   // Config files
 147   Etc "/etc/apt/" {
 148      sourcelist "sources.list";
 149      main "apt.conf";
 150   };
 151
 152   // Locations of binaries
 153   Bin {
 154      methods "/usr/lib/apt/methods/";
 155      gzip "/bin/gzip";
 156      dpkg "/usr/bin/dpkg";
 157      dpkg-source "/usr/bin/dpkg-source";
 158      dpkg-buildpackage "/usr/bin/dpkg-buildpackage"
 159      apt-get "/usr/bin/apt-get";
 160      apt-cache "/usr/bin/apt-cache";
 161   };
 162 };
 163
 164 // Things that effect the APT dselect method
 165 DSelect
 166 {
 167    Clean "auto";   // always|auto|prompt|never
 168    Options "-f";
 169    UpdateOptions "";
 170    PromptAfterUpdate "no";
 171 }
 172
 173 DPkg
 174 {
 175    // Probably don't want to use force-downgrade..
 176    Options {"--force-overwrite";"--force-downgrade";}
 177
 178    // Auto re-mounting of a readonly /usr
 179    Pre-Invoke {"mount -o remount,rw /usr";};
 180    Post-Invoke {"mount -o remount,ro /usr";};
 181
 182    // Prevents daemons from getting cwd as something mountable (default)
 183    Run-Directory "/";
 184
 185    // Build options for apt-get source --compile
 186    Build-Options "-b -uc";
 187
 188    // Pre-configure all packages before they are installed using debconf.
 189    Pre-Install-Pkgs {"dpkg-preconfig --apt --priority=low --frontend=dialog";};
 190 }
 191
 192 /* Options you can set to see some debugging text They corrispond to names
 193    of classes in the source code */
 194 Debug
 195 {
 196   pkgProblemResolver "false";
 197   pkgAcquire "false";
 198   pkgAcquire::Worker "false";
 199   pkgDPkgPM "false";
 200
 201   pkgInitialize "false";   // This one will dump the configuration space
 202   NoLocking "false";
 203   Acquire::Ftp "false";    // Show ftp command traffic
 204   Acquire::Http "false";   // Show http command traffic
 205   aptcdrom "false";        // Show found package files
 206 }
 207
 208 /* Whatever you do, do not use this configuration file!! Take out ONLY
 209    the portions you need! */
 210 This Is Not A Valid Config File