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