Fixed typo in the dhelp index

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

diff --git a/doc/apt.conf.5.yo b/doc/apt.conf.5.yo
index 89eb9e61efc8c7dfc36ec393cceb30baf5000df3..4eee5d0ea6dd426d2d47cacea23119ea9d1d309c 100644 (file)
--- a/doc/apt.conf.5.yo
+++ b/doc/apt.conf.5.yo
@@ -30,9 +30,17 @@ verb(APT {
 };
 )
 with newlines placed to make
-it more readable. In general the sample configuration file in
+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) 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
 options for all of the tools.
@@ -105,9 +113,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.
 
+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.
+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()
 
@@ -129,7 +158,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
-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)
@@ -139,8 +169,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.
-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
@@ -165,7 +196,7 @@ 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))
+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.
@@ -173,6 +204,10 @@ 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)
@@ -180,13 +215,14 @@ 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.
 
-mapagesection(FILES)
+manpagesection(FILES)
 /etc/apt/apt.conf
 
 manpageseealso()