Bug fixes

[apt.git] / doc / apt.conf.5.yo

diff --git a/doc/apt.conf.5.yo b/doc/apt.conf.5.yo
index c2807199b69a67c8c926a2ffce4e318c9b92ed77..6b5ba857530a832d6e255ff8e3fc69c94b2cc24f 100644 (file)
--- a/doc/apt.conf.5.yo
+++ b/doc/apt.conf.5.yo
@@ -30,8 +30,18 @@ verb(APT {
 };
 )
 with newlines placed to make
 };
 )
 with newlines placed to make

-it more readable. In general the sample configuration file in
-em(/usr/doc/apt/examples/apt.conf) is a good guide for how it should look.
+it more readable. Lists can be created by opening a scope an including a 
+single word enclosed in quotes followed by a semicolon. 
+In general the sample configuration file in
+em(/usr/doc/apt/examples/apt.conf) and
+em(/usr/doc/apt/examples/configure-index) 
+is a good guide for how it should look.
+
+All of the APT tools take a -o option which allows an arbitary configuration 
+directive to be specified on the command line. The syntax is a full option
+name (APT::Get::Assume-Yes for instance) followed by an equals sign then the
+new value of the option. Lists can be appended too by adding a trailing ::
+to the list name.

 
 manpagesection(The APT Group)
 This group of options controls general APT behavoir as well as holding the
 
 manpagesection(The APT Group)
 This group of options controls general APT behavoir as well as holding the


@@ -47,6 +57,12 @@ dit(bf(Ignore-Hold))
 Ignore Held packages; This global options causes the problem resolver to
 ignore held packages in its decision making. 
 
 Ignore Held packages; This global options causes the problem resolver to
 ignore held packages in its decision making. 
 

+dit(bf(Clean-Installed))
+Defaults to on. When turned on the autoclean feature will remove any pacakge
+which can no longer be downloaded from the cache. If turned off then
+packages that are locally installed are also excluded from cleaning - but
+note that APT provides no direct means to reinstall them.
+

 dit(bf(Immediate-Configure))
 Disable Immedate Configuration; This dangerous option disables some
 of APT's ordering code to cause it to make fewer dpkg calls. Doing
 dit(bf(Immediate-Configure))
 Disable Immedate Configuration; This dangerous option disables some
 of APT's ordering code to cause it to make fewer dpkg calls. Doing


@@ -54,6 +70,18 @@ so may be necessary on some extremely slow single user systems but
 is very dangerous and may cause package install scripts to fail or worse.
 Use at your own risk.
 
 is very dangerous and may cause package install scripts to fail or worse.
 Use at your own risk.
 

+dit(bf(Force-LoopBreak))
+Never Enable this option unless you -really- know what you are doing. It
+permits APT to temporarily remove an essential package to break a
+Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential
+packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option will
+work if the essential packages are not tar, gzip, libc, dpkg, bash or 
+anything that those packages depend on.
+
+dit(bf(Cache-Limit))
+APT uses a fixed size memory mapped cache file to store the 'available'
+information. This sets the size of that cache.
+

 dit(bf(Get))
 The Get subsection controls the bf(apt-get(8)) tool, please see its
 documentation for more information about the options here.
 dit(bf(Get))
 The Get subsection controls the bf(apt-get(8)) tool, please see its
 documentation for more information about the options here.


@@ -83,6 +111,10 @@ dit(bf(Retries))
 Number of retries to perform. If this is non-zero apt will retry failed 
 files the given number of times.
 
 Number of retries to perform. If this is non-zero apt will retry failed 
 files the given number of times.
 

+dit(bf(Source-Symlinks))
+Use symlinks for source archives. If set to true then source archives will
+be symlinked when possible instead of copying. True is the default
+

 dit(bf(http))
 HTTP URIs; http::Proxy is the default http proxy to use. It is in the standard
 form of em(http://[[user][:pass]@]host[:port]/). Per host proxies can also
 dit(bf(http))
 HTTP URIs; http::Proxy is the default http proxy to use. It is in the standard
 form of em(http://[[user][:pass]@]host[:port]/). Per host proxies can also


@@ -105,9 +137,35 @@ remote server is not RFC conforming or buggy (such as Squid 2.0.2)
 Acquire::http::Pipeline-Depth can be a value from 0 to 5 indicating how many
 outstanding requests APT should send.
 
 Acquire::http::Pipeline-Depth can be a value from 0 to 5 indicating how many
 outstanding requests APT should send.
 

+dit(bf(ftp))
+FTP URis; ftp::Proxy is the default proxy server to use. It is in the 
+standard form of em(ftp://[[user][:pass]@]host[:port]/) and is overriden
+by the ftp_proxy environment variable. To use a ftp proxy you will have to
+set the ftp::ProxyLogin script in the configuration file. This entry 
+specifies the commands to send to tell the proxy server what to connect
+to. Please see em(/usr/doc/apt/examples/configure-index) for an example of how 
+to do this. The subsitution variables available are $(PROXY_USER),
+$(PROXY_PASS), $(SITE_USER), $(SITE_PASS), $(SITE), and $(SITE_PORT). 
+Each is taken from it's respective URI component.
+
+Several settings are provided to control passive mode. Generally it is safe
+to leave passive mode on, it works in nearly every environment. However some
+situations require that passive mode be disabled and port mode ftp used
+instead. This can be done globally, for connections that go through a proxy
+or for a specific host (See the sample config file for examples)
+
+It is possible to proxy FTP over HTTP by setting the em(ftp_proxy)
+environment variable to a http url - see the discussion of the http method
+above for syntax. You cannot set this in the configuration file and it is
+not recommended to use FTP over HTTP due to its low efficiency.
+

 dit(bf(cdrom))
 CDROM URIs; the only setting for CDROM URIs is the mount point, cdrom::Mount
 which must be the mount point for the CDROM drive as specified in /etc/fstab.
 dit(bf(cdrom))
 CDROM URIs; the only setting for CDROM URIs is the mount point, cdrom::Mount
 which must be the mount point for the CDROM drive as specified in /etc/fstab.

+It is possible to provide alternate mount and unmount commands if your
+mount point cannot be listed in the fstab (such as an SMB mount). The syntax
+is to put "/cdrom/"::Mount "foo"; within the cdrom block. It is important to
+have the trailing slash. Unmount commands can be specified using UMount.

 
 enddit()
 
 
 enddit()
 


@@ -124,12 +182,13 @@ as the two package caches bf(srcpkgcache) and bf(pkgcache) as well as the
 location to place downloaded archives, bf(Dir::Cache::archives). Like 
 bf(Dir::State) the default directory is contained in bf(Dir::Cache)
 
 location to place downloaded archives, bf(Dir::Cache::archives). Like 
 bf(Dir::State) the default directory is contained in bf(Dir::Cache)
 

-bf(Dir::Etc) contains the location of configuration files, bd(sourcelist)
+bf(Dir::Etc) contains the location of configuration files, bf(sourcelist)

 gives the location of the sourcelist and bf(main) is the default configuration
 file (setting has no effect)
 
 Binary programs are pointed to by bf(Dir::Bin). bf(methods) specifies the
 gives the location of the sourcelist and bf(main) is the default configuration
 file (setting has no effect)
 
 Binary programs are pointed to by bf(Dir::Bin). bf(methods) specifies the

-location of the method handlers and bf(gzip), bf(dpkg), bf(apt-get), and
+location of the method handlers and bf(gzip), bf(dpkg), bf(apt-get), 
+bf(dpkg-source), bf(dpkg-buildpackage) and

 bf(apt-cache) specify the location of the respective programs.
 
 manpagesection(APT in DSelect)
 bf(apt-cache) specify the location of the respective programs.
 
 manpagesection(APT in DSelect)


@@ -139,8 +198,9 @@ control the default behavoir. These are in the bf(DSelect) section.
 startdit()
 dit(bf(Clean))
 Cache Clean mode; this value may be one of always, auto, prompt and never.
 startdit()
 dit(bf(Clean))
 Cache Clean mode; this value may be one of always, auto, prompt and never.

-Currently always and auto are identical but their meanings may diverge in
-future to have auto only clean useless archives and always clean all archives.
+always will remove all archives after they have been downloaded while auto
+will only remove things that are no longer downloadable (replaced with a new
+version for instance)

 
 dit(bf(Options))
 The contents of this variable is passed to bf(apt-get(8)) as command line
 
 dit(bf(Options))
 The contents of this variable is passed to bf(apt-get(8)) as command line


@@ -155,23 +215,56 @@ If true the [U]pdate operation in dselect will always prompt to continue.
 The default is to prompt only on error.
 enddit()
 
 The default is to prompt only on error.
 enddit()
 

+manpagesection(How APT calls DPkg)
+Several configuration directives control how APT invokes dpkg. These are in 
+the bf(DPkg) section.
+
+startdit()
+dit(bf(Options))
+This is a list of options to pass to dpkg. The options must be specified
+using the list notation and each list item is passed as a single arugment
+to dpkg.
+
+dit(bf(Pre-Invoke), bf(Post-Invoke))
+This is a list of shell commands to run before/after invoking dpkg. Like 
+bf(Options) this must be specified in list notation. The commands
+are invoked in order using /bin/sh, should any fail APT will abort.
+
+dit(bf(BPre-Install-Pkgs))
+This is a list of shell commands to run before invoking dpkg. Like
+bf(Options) this must be specified in list notation. The commands
+are invoked in order using /bin/sh, should any fail APT will abort.
+Apt will pass to the commands on standard input the filenames of all
+.deb files it is going to install, one per line.
+
+dit(bf(Run-Directory))
+APT chdirs to this directory before invoking dpkg, the default is /.
+
+dit(bf(Build-Options))
+These options are passed to dpkg-buildpackage when compiling packages,
+the default is to disable signing and produce all binaries.
+
+enddit()
+

 manpagesection(Debug Options)
 Most of the options in the bf(debug) section are not interesting to the
 normal user, however bf(Debug::pkgProblemResolver) shows interesting
 output about the decisions dist-upgrade makes. bf(Debug::NoLocking)
 disables file locking so apt can do some operations as non-root and
 manpagesection(Debug Options)
 Most of the options in the bf(debug) section are not interesting to the
 normal user, however bf(Debug::pkgProblemResolver) shows interesting
 output about the decisions dist-upgrade makes. bf(Debug::NoLocking)
 disables file locking so apt can do some operations as non-root and

-bf(Debug::pkgDPkgPM) will print out the command line for each dpkg invokation.
+bf(Debug::pkgDPkgPM) will print out the command line for each dpkg 
+invokation. bf(Debug::IdentCdrom) will disable the inclusion of statfs 
+data in CDROM IDs.

 
 manpagesection(EXAMPLES)
 
 manpagesection(EXAMPLES)

-bf(/usr/doc/apt/examples/apt.conf) contains a sample configuration file
-showing the default values for all possible options.
+bf(/usr/doc/apt/examples/configure-index.gz) contains a sample configuration 
+file showing the default values for all possible options.

 
 

-mapagesection(FILES)
+manpagesection(FILES)

 /etc/apt/apt.conf
 
 manpageseealso()
 apt-cache (8),
 /etc/apt/apt.conf
 
 manpageseealso()
 apt-cache (8),

-apt.conf (5)
+apt-get (8)

 
 manpagebugs()
 See http://bugs.debian.org/apt.  If you wish to report a
 
 manpagebugs()
 See http://bugs.debian.org/apt.  If you wish to report a