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