doc/examples/configure-index

   1 // $Id: configure-index,v 1.2 2000/05/13 01:52:59 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      GivenOnly "false";
  51   };
  52
  53   CDROM
  54   {
  55      Rename "false";
  56      NoMount "false";
  57      Fast "false";
  58      NoAct "false";
  59   };
  60
  61   // Some general options
  62   Ignore-Hold "false";
  63   Clean-Installed "true";
  64   Immediate-Configure "true";      // DO NOT turn this off, see the man page
  65   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
  66   Cache-Limit "4194304";
  67 };
  68
  69 // Options for the downloading routines
  70 Acquire
  71 {
  72   Queue-Mode "host";       // host|access
  73   Retries "0";
  74   Source-Symlinks "true";
  75
  76   // HTTP method configuration
  77   http
  78   {
  79     Proxy "http://127.0.0.1:3128";
  80     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
  81     Timeout "120";
  82     Pipeline-Depth "5";
  83
  84     // Cache Control. Note these do not work with Squid 2.0.2
  85     No-Cache "false";
  86     Max-Age "86400";     // 1 Day age on index files
  87     No-Store "false";    // Prevent the cache from storing archives
  88   };
  89
  90   ftp
  91   {
  92     Proxy "ftp://127.0.0.1/";
  93     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
  94
  95     /* Required script to perform proxy login. This example should work
  96        for tisfwtk */
  97     ProxyLogin
  98     {
  99        "USER $(PROXY_USER)";
 100        "PASS $(PROXY_PASS)";
 101        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 102        "PASS $(SITE_PASS)";
 103     };
 104
 105     Timeout "120";
 106
 107     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 108        is prefered if possible */
 109     Passive "true";
 110     Proxy::Passive "true";
 111     Passive::http.us.debian.org "true"; // Specific per-host setting
 112   };
 113
 114   cdrom
 115   {
 116     Mount "/cdrom";
 117
 118     // You need the trailing slash!
 119     "/cdrom/"
 120     {
 121        Mount "sleep 1000";
 122        UMount "sleep 500";
 123     }
 124   };
 125 };
 126
 127 // Directory layout
 128 Dir
 129 {
 130   // Location of the state dir
 131   State "/var/state/apt/"
 132   {
 133      lists "lists/";
 134      xstatus "xstatus";
 135      userstatus "status.user";
 136      status "/var/lib/dpkg/status";
 137      cdroms "cdroms.list";
 138   };
 139
 140   // Location of the cache dir
 141   Cache "/var/cache/apt/" {
 142      archives "archives/";
 143      srcpkgcache "srcpkgcache.bin";
 144      pkgcache "pkgcache.bin";
 145   };
 146
 147   // Config files
 148   Etc "/etc/apt/" {
 149      sourcelist "sources.list";
 150      main "apt.conf";
 151   };
 152
 153   // Locations of binaries
 154   Bin {
 155      methods "/usr/lib/apt/methods/";
 156      gzip "/bin/gzip";
 157      dpkg "/usr/bin/dpkg";
 158      dpkg-source "/usr/bin/dpkg-source";
 159      dpkg-buildpackage "/usr/bin/dpkg-buildpackage"
 160      apt-get "/usr/bin/apt-get";
 161      apt-cache "/usr/bin/apt-cache";
 162   };
 163 };
 164
 165 // Things that effect the APT dselect method
 166 DSelect
 167 {
 168    Clean "auto";   // always|auto|prompt|never
 169    Options "-f";
 170    UpdateOptions "";
 171    PromptAfterUpdate "no";
 172 }
 173
 174 DPkg
 175 {
 176    // Probably don't want to use force-downgrade..
 177    Options {"--force-overwrite";"--force-downgrade";}
 178
 179    // Auto re-mounting of a readonly /usr
 180    Pre-Invoke {"mount -o remount,rw /usr";};
 181    Post-Invoke {"mount -o remount,ro /usr";};
 182
 183    // Prevents daemons from getting cwd as something mountable (default)
 184    Run-Directory "/";
 185
 186    // Build options for apt-get source --compile
 187    Build-Options "-b -uc";
 188
 189    // Pre-configure all packages before they are installed using debconf.
 190    Pre-Install-Pkgs {"dpkg-preconfig --apt --priority=low --frontend=dialog";};
 191
 192    // Flush the contents of stdin before forking dpkg.
 193    FlushSTDIN "true";
 194 }
 195
 196 /* Options you can set to see some debugging text They corrispond to names
 197    of classes in the source code */
 198 Debug
 199 {
 200   pkgProblemResolver "false";
 201   pkgAcquire "false";
 202   pkgAcquire::Worker "false";
 203   pkgDPkgPM "false";
 204
 205   pkgInitialize "false";   // This one will dump the configuration space
 206   NoLocking "false";
 207   Acquire::Ftp "false";    // Show ftp command traffic
 208   Acquire::Http "false";   // Show http command traffic
 209   aptcdrom "false";        // Show found package files
 210 }
 211
 212 /* Whatever you do, do not use this configuration file!! Take out ONLY
 213    the portions you need! */
 214 This Is Not A Valid Config File