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