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