doc/examples/configure-index

   1 // $Id: configure-index,v 1.10 2004/07/17 19:37:16 mdz 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 (except for the
   4    last line) a completely valid file. Most of the options have sane default
   5    values, unless you have specific needs you should NOT include arbitary
   6    items in a custom 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 quiet "0";
  21
  22 // Options for APT in general
  23 APT
  24 {
  25   Architecture "i386";
  26   Build-Essential "build-essential";
  27
  28   // Options for apt-get
  29   Get
  30   {
  31      Arch-Only "false";
  32      Download-Only "false";
  33      Simulate "false";
  34      Assume-Yes "false";
  35      Force-Yes "false";             // I would never set this.
  36      Fix-Broken "false";
  37      Fix-Missing "false";
  38      Show-Upgraded "false";
  39      Show-Versions "false";
  40      Upgrade "true";
  41      Print-URIs "false";
  42      Compile "false";
  43      Download "true";
  44      Purge "false";
  45      List-Cleanup "true";
  46      ReInstall "false";
  47      Trivial-Only "false";
  48      Remove "true";
  49      Only-Source "";
  50      Diff-Only "false";
  51      Tar-Only "false";
  52   };
  53
  54   Cache
  55   {
  56      Important "false";
  57      AllVersions "false";
  58      GivenOnly "false";
  59      RecurseDepends "false";
  60      ShowFull "false";
  61      Generate "true";
  62      NamesOnly "false";
  63      AllNames "false";
  64      Installed "false";
  65   };
  66
  67   CDROM
  68   {
  69      Rename "false";
  70      NoMount "false";
  71      Fast "false";
  72      NoAct "false";
  73   };
  74
  75   // Some general options
  76   Ignore-Hold "false";
  77   Clean-Installed "true";
  78   Immediate-Configure "true";      // DO NOT turn this off, see the man page
  79   Force-LoopBreak "false";         // DO NOT turn this on, see the man page
  80   Cache-Limit "4194304";
  81   Default-Release "";
  82 };
  83
  84 // Options for the downloading routines
  85 Acquire
  86 {
  87   Queue-Mode "host";       // host|access
  88   Retries "0";
  89   Source-Symlinks "true";
  90
  91   // HTTP method configuration
  92   http
  93   {
  94     Proxy "http://127.0.0.1:3128";
  95     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
  96     Timeout "120";
  97     Pipeline-Depth "5";
  98
  99     // Cache Control. Note these do not work with Squid 2.0.2
 100     No-Cache "false";
 101     Max-Age "86400";     // 1 Day age on index files
 102     No-Store "false";    // Prevent the cache from storing archives
 103   };
 104
 105   ftp
 106   {
 107     Proxy "ftp://127.0.0.1/";
 108     Proxy::http.us.debian.org "DIRECT"; // Specific per-host setting
 109
 110     /* Required script to perform proxy login. This example should work
 111        for tisfwtk */
 112     ProxyLogin
 113     {
 114        "USER $(PROXY_USER)";
 115        "PASS $(PROXY_PASS)";
 116        "USER $(SITE_USER)@$(SITE):$(SITE_PORT)";
 117        "PASS $(SITE_PASS)";
 118     };
 119
 120     Timeout "120";
 121
 122     /* Passive mode control, proxy, non-proxy and per-host. Pasv mode
 123        is prefered if possible */
 124     Passive "true";
 125     Proxy::Passive "true";
 126     Passive::http.us.debian.org "true"; // Specific per-host setting
 127   };
 128
 129   cdrom
 130   {
 131     mount "/cdrom";
 132
 133     // You need the trailing slash!
 134     "/cdrom/"
 135     {
 136        Mount "sleep 1000";
 137        UMount "sleep 500";
 138     }
 139   };
 140 };
 141
 142 // Directory layout
 143 Dir "/"
 144 {
 145   // Location of the state dir
 146   State "var/lib/apt/"
 147   {
 148      Lists "lists/";
 149      xstatus "xstatus";
 150      userstatus "status.user";
 151      status "/var/lib/dpkg/status";
 152      cdroms "cdroms.list";
 153   };
 154
 155   // Location of the cache dir
 156   Cache "var/cache/apt/" {
 157      Archives "archives/";
 158      srcpkgcache "srcpkgcache.bin";
 159      pkgcache "pkgcache.bin";
 160   };
 161
 162   // Config files
 163   Etc "etc/apt/" {
 164      SourceList "sources.list";
 165      Main "apt.conf";
 166      Preferences "preferences";
 167      Parts "apt.conf.d/";
 168   };
 169
 170   // Locations of binaries
 171   Bin {
 172      methods "/usr/lib/apt/methods/";
 173      gzip "/bin/gzip";
 174      dpkg "/usr/bin/dpkg";
 175      dpkg-source "/usr/bin/dpkg-source";
 176      dpkg-buildpackage "/usr/bin/dpkg-buildpackage"
 177      apt-get "/usr/bin/apt-get";
 178      apt-cache "/usr/bin/apt-cache";
 179   };
 180 };
 181
 182 // Things that effect the APT dselect method
 183 DSelect
 184 {
 185    Clean "auto";   // always|auto|prompt|never
 186    Options "-f";
 187    UpdateOptions "";
 188    PromptAfterUpdate "no";
 189    CheckDir "no";
 190 }
 191
 192 DPkg
 193 {
 194    // Probably don't want to use force-downgrade..
 195    Options {"--force-overwrite";"--force-downgrade";}
 196
 197    // Auto re-mounting of a readonly /usr
 198    Pre-Invoke {"mount -o remount,rw /usr";};
 199    Post-Invoke {"mount -o remount,ro /usr";};
 200
 201    // Prevents daemons from getting cwd as something mountable (default)
 202    Run-Directory "/";
 203
 204    // Build options for apt-get source --compile
 205    Build-Options "-b -uc";
 206
 207    // Pre-configure all packages before they are installed using debconf.
 208    Pre-Install-Pkgs {"dpkg-preconfigure --apt --priority=low --frontend=dialog";};
 209
 210    // Flush the contents of stdin before forking dpkg.
 211    FlushSTDIN "true";
 212
 213    // Control the size of the command line passed to dpkg.
 214    MaxBytes 1024;
 215    MaxArgs 350;
 216 }
 217
 218 /* Options you can set to see some debugging text They correspond to names
 219    of classes in the source code */
 220 Debug
 221 {
 222   pkgProblemResolver "false";
 223   pkgAcquire "false";
 224   pkgAcquire::Worker "false";
 225   pkgDPkgPM "false";
 226   pkgOrderList "false";
 227
 228   pkgInitialize "false";   // This one will dump the configuration space
 229   NoLocking "false";
 230   Acquire::Ftp "false";    // Show ftp command traffic
 231   Acquire::Http "false";   // Show http command traffic
 232   aptcdrom "false";        // Show found package files
 233   IdentCdrom "false";
 234 }
 235
 236 /* Whatever you do, do not use this configuration file!! Take out ONLY
 237    the portions you need! */
 238 This Is Not A Valid Config File