X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/36803406d195dba90a418bb858ebf65033867aba..7c4d986bb672313cd3c7e6dee8f071ba24d42f8c:/doc/apt.conf.5.sgml
diff --git a/doc/apt.conf.5.sgml b/doc/apt.conf.5.sgml
index 4c79e4cc0..eb64bed5f 100644
--- a/doc/apt.conf.5.sgml
+++ b/doc/apt.conf.5.sgml
@@ -17,11 +17,11 @@
apt.conf
- Configuratoin file for APT
+ Configuration file for APT
Description</>
- <para>
+ <para>
<filename/apt.conf/ is the main configuration file for the APT suite of
tools, all tools make use of the configuration file and a common command line
parser to provide a uniform environment. When an APT tool starts up it will
@@ -53,13 +53,13 @@ APT {
</programlisting></informalexample>
with newlines placed to make it more readable. Lists can be created by
opening a scope and including a single word enclosed in quotes followed by a
- semicolon. Multiple entries can be included, each seperated by a semicolon.
+ semicolon. Multiple entries can be included, each separated by a semicolon.
<informalexample><programlisting>
DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
</programlisting></informalexample>
<para>
In general the sample configuration file in
- <filename>&docdir;/examples/apt.conf</> &configureindex;
+ <filename>&docdir;examples/apt.conf</> &configureindex;
is a good guide for how it should look.
<para>
Two specials are allowed, <literal/#include/ and <literal/#clear/.
@@ -67,7 +67,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
ends in a slash, then the whole directory is included.
<literal/#clear/ is used to erase a list of names.
<para>
- All of the APT tools take a -o option which allows an arbitary configuration
+ All of the APT tools take a -o option which allows an arbitrary configuration
directive to be specified on the command line. The syntax is a full option
name (<literal/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
@@ -76,7 +76,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
<RefSect1><Title>The APT Group</>
<para>
- This group of options controls general APT behavoir as well as holding the
+ This group of options controls general APT behavior as well as holding the
options for all of the tools.
<VariableList>
@@ -89,13 +89,13 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
<VarListEntry><Term>Ignore-Hold</Term>
<ListItem><Para>
- Ignore Held packages; This global options causes the problem resolver to
+ Ignore Held packages; This global option causes the problem resolver to
ignore held packages in its decision making.
</VarListEntry>
<VarListEntry><Term>Clean-Installed</Term>
<ListItem><Para>
- Defaults to on. When turned on the autoclean feature will remove any pacakge
+ Defaults to on. When turned on the autoclean feature will remove any packages
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.
@@ -103,7 +103,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
<VarListEntry><Term>Immediate-Configure</Term>
<ListItem><Para>
- Disable Immedate Configuration; This dangerous option disables some
+ Disable Immediate 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.
@@ -126,6 +126,11 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
information. This sets the size of that cache.
</VarListEntry>
+ <VarListEntry><Term>Build-Essential</Term>
+ <ListItem><Para>
+ Defines which package(s) are considered essential build dependencies.
+ </VarListEntry>
+
<VarListEntry><Term>Get</Term>
<ListItem><Para>
The Get subsection controls the &apt-get; tool, please see its
@@ -155,7 +160,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
<VarListEntry><Term>Queue-Mode</Term>
<ListItem><Para>
Queuing mode; <literal/Queue-Mode/ can be one of <literal/host/ or
- <literal/access/ which determins how APT parallelizes outgoing
+ <literal/access/ which determines how APT parallelizes outgoing
connections. <literal/host/ means that one connection per target host
will be opened, <literal/access/ means that one connection per URI type
will be opened.
@@ -182,8 +187,8 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
meaning to use no proxies. The <envar/http_proxy/ environment variable
will override all settings.
<para>
- Three settings are provided for cache control with HTTP/1.1 complient
- proxy caches. <literal/No-Cache/ tells the proxy to not used its cached
+ Three settings are provided for cache control with HTTP/1.1 compliant
+ proxy caches. <literal/No-Cache/ tells the proxy to not use its cached
response under any circumstances, <literal/Max-Age/ is sent only for
index files and tells the cache to refresh its object if it is older than
the given number of seconds. Debian updates its index files daily so the
@@ -200,15 +205,15 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
<literal/Acquire::http::Pipeline-Depth/ can be a value from 0 to 5
indicating how many outstanding requests APT should send. A value of
zero MUST be specified if the remote host does not properly linger
- on TCP connections - otherwise data corruption will occure. Hosts which
+ on TCP connections - otherwise data corruption will occur. Hosts which
require this are in violation of RFC 2068.
</VarListEntry>
<VarListEntry><Term>ftp</Term>
<ListItem><Para>
- FTP URis; ftp::Proxy is the default proxy server to use. It is in the
+ FTP URIs; ftp::Proxy is the default proxy server to use. It is in the
standard form of <literal>ftp://[[user][:pass]@]host[:port]/</> and is
- overriden by the <envar/ftp_proxy/ environment variable. To use a ftp
+ overridden by the <envar/ftp_proxy/ environment variable. To use a ftp
proxy you will have to set the <literal/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
@@ -259,7 +264,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
The <literal/Dir::State/ section has directories that pertain to local
state information. <literal/lists/ is the directory to place downloaded
package lists in and <literal/status/ is the name of the dpkg status file.
- <literal/preferences/ is the name of the APT preferencse file.
+ <literal/preferences/ is the name of the APT preferences file.
<literal/Dir::State/ contains the default directory to prefix on all sub
items if they do not start with <filename>/</> or <filename>./</>.
<para>
@@ -292,7 +297,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
<RefSect1><Title>APT in DSelect</>
<para>
When APT is used as a &dselect; method several configuration directives
- control the default behavoir. These are in the <literal/DSelect/ section.
+ control the default behaviour. These are in the <literal/DSelect/ section.
<VariableList>
<VarListEntry><Term>Clean</Term>
@@ -334,7 +339,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
<VarListEntry><Term>Options</Term>
<ListItem><Para>
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
+ using the list notation and each list item is passed as a single argument
to &dpkg;.
</VarListEntry>
@@ -400,7 +405,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
<RefSect1><Title>See Also</>
<para>
- &apt-cache;, &apt-conf;, &apt-preferences;.
+ &apt-cache;, &apt-config;<!-- ? reading apt.conf -->, &apt-preferences;.
</RefSect1>
&manbugs;