Two bugs..

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

diff --git a/doc/apt.conf.5.yo b/doc/apt.conf.5.yo
index 9e04069a6b0d7b5f649feb499a7d9b8d12d6981e..9e14b861cebd6c483aa818c023ce1090ba3ad554 100644 (file)
--- a/doc/apt.conf.5.yo
+++ b/doc/apt.conf.5.yo
@@ -47,17 +47,24 @@ 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(Immediate-Configure))
+Disable Immedate Configuration; This dangerous option disables some
+of APT's ordering code to cause it to make fewer dpkg calls. Doing
+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.
+

 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(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(Cache))

-The Cache subsection controls the bf(apt-cache(8)) tool, please see it
-sdocumentation for more information about the options here.
+The Cache subsection controls the bf(apt-cache(8)) tool, please see its
+documentation for more information about the options here.

 
 dit(bf(CDROM))
 
 dit(bf(CDROM))

-The CDROM subsection controls the bf(apt-cdrom(8)) tool, please see it
-sdocumentation for more information about the options here.
+The CDROM subsection controls the bf(apt-cdrom(8)) tool, please see its
+documentation for more information about the options here.

 
 enddit()
 
 
 enddit()
 


@@ -68,10 +75,14 @@ URI handlers.
 startdit()
 dit(bf(Queue-Mode))
 Queuing mode; bf(Queue-Mode) can be one of bf(host) or bf(access) which 
 startdit()
 dit(bf(Queue-Mode))
 Queuing mode; bf(Queue-Mode) can be one of bf(host) or bf(access) which 

-determins how APT parallelizesoutgoing connections. bf(host) means that
+determins how APT parallelizes outgoing connections. bf(host) means that

 one connection per target host will be opened, bf(access) means that one
 connection per URI type will be opened.
 
 one connection per target host will be opened, bf(access) means that one
 connection per URI type will be opened.
 

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

 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


@@ -82,8 +93,8 @@ will override all settings.
 Three settings are provided for cache control with HTTP/1.1 complient proxy
 caches. bf(No-Cache) tells the proxy to not used its cached response under
 any circumstances, bf(Max-Age) is sent only for index files and tells the
 Three settings are provided for cache control with HTTP/1.1 complient proxy
 caches. bf(No-Cache) tells the proxy to not used its cached response under
 any circumstances, bf(Max-Age) is sent only for index files and tells the

-cache to refresh its object if it is older than the given value. Debian
-updates its index files daily so the default is 1 day. bd(No-Store) 
+cache to refresh its object if it is older than the given number of seconds. 
+Debian updates its index files daily so the default is 1 day. bf(No-Store) 

 specifies that the cache should never store this request, it is only
 set for archive files. This may be usefull to prevent polluting a proxy cache
 with very large .deb files. Note: Squid 2.0.2 does not support any of
 specifies that the cache should never store this request, it is only
 set for archive files. This may be usefull to prevent polluting a proxy cache
 with very large .deb files. Note: Squid 2.0.2 does not support any of


@@ -94,9 +105,30 @@ 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(http://[[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/apt.conf) 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)
+

 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()
 


@@ -118,7 +150,8 @@ 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
 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)


@@ -144,23 +177,51 @@ 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(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.

 
 manpagesection(EXAMPLES)
 bf(/usr/doc/apt/examples/apt.conf) contains a sample configuration file
 showing the default values for all possible options.
 
 
 manpagesection(EXAMPLES)
 bf(/usr/doc/apt/examples/apt.conf) contains a sample configuration file
 showing the default values for all possible options.
 

+manpagesection(FILES)
+/etc/apt/apt.conf
+

 manpageseealso()
 apt-cache (8),
 apt.conf (5)
 
 manpagebugs()
 manpageseealso()
 apt-cache (8),
 apt.conf (5)
 
 manpagebugs()

-See http://www.debian.org/Bugs/db/pa/lapt.html.  If you wish to report a
+See http://bugs.debian.org/apt.  If you wish to report a

 bug in bf(apt-get), please see bf(/usr/doc/debian/bug-reporting.txt)
 or the bf(bug(1)) command.
 
 bug in bf(apt-get), please see bf(/usr/doc/debian/bug-reporting.txt)
 or the bf(bug(1)) command.