Man pages cleanup
I ran apt/doc/*.[0-9].sgml (from 0.5.3) through aspell, and here are
the results. I also made one minor grammatical change (, => :) at one
point before I switched to aspell.
-- --
John R. Daily jdaily@progeny.com
Systems Programmer Progeny Linux Systems
Master of the ephemeral epiphany
--- apt-cache.8.sgml.orig Mon Jun 18 12:55:58 2001
+++ apt-cache.8.sgml Mon Jun 18 12:57:45 2001
@@ -64,7 +64,7 @@
<VarListEntry><Term>gencaches</Term>
<ListItem><Para>
- <literal/gencaches/ performs the same opration as
+ <literal/gencaches/ performs the same operation as
<command/apt-get check/. It builds the source and package caches from
the sources in &sources-list; and from <filename>/var/lib/dpkg/status</>.
</VarListEntry>
@@ -149,7 +149,7 @@
<listitem><para>
<literal/Missing/ is the number of package names that were referenced in
a dependency but were not provided by any package. Missing packages may
- be in evidence if a full distribution is not accesssed, or if a package
+ be in evidence if a full distribution is not accessed, or if a package
(real or virtual) has been dropped from the distribution. Usually they
are referenced from Conflicts statements.
</listitem>
@@ -197,21 +197,21 @@
<VarListEntry><Term>search</Term>
<ListItem><Para>
<literal/search/ performs a full text search on all available package
- files for the regex pattern given. It searchs the package names and the
- descriptions for an occurance of the string and prints out the package
+ files for the regex pattern given. It searches the package names and the
+ descriptions for an occurrence of the string and prints out the package
name and the short description. If <option/--full/ is given then output
identical to <literal/show/ is produced for each matched package and
if <option/--names-only/ is given then the long description is not
searched, only the package name is.
<para>
- Seperate arguments can be used to specified multiple search patterns that
+ Separate arguments can be used to specified multiple search patterns that
are and'd together.
</VarListEntry>
<VarListEntry><Term>depends</Term>
<ListItem><Para>
<literal/depends/ shows a listing of each dependency a package has
- and all the possible other packages that can fullfill that dependency.
+ and all the possible other packages that can fulfill that dependency.
</VarListEntry>
<VarListEntry><Term>pkgnames</Term>
@@ -219,14 +219,14 @@
This command prints the name of each package in the system. The optional
argument is a prefix match to filter the name list. The output is suitable
for use in a shell tab complete function and the output is generated
- extremly quickly. This command is best used with the
+ extremely quickly. This command is best used with the
<option/--generate/ option.
</VarListEntry>
<VarListEntry><Term>dotty</Term>
<ListItem><Para>
<literal/dotty/ takes a list of packages on the command line and
- gernerates output suitable for use by dotty from the
+ generates output suitable for use by dotty from the
<ulink url="http://www.research.att.com/sw/tools/graphviz/";>GraphVis</>
package. The result will be a set of nodes and edges representing the
relationships between the packages. By default the given packages will
@@ -235,10 +235,10 @@
<literal>APT::Cache::GivenOnly</> option.
<para>
- The resulting nodes will have several shapse, normal packages are boxes,
+ The resulting nodes will have several shapes, normal packages are boxes,
pure provides are triangles, mixed provides are diamonds,
hexagons are missing packages. Orange boxes mean recursion was stopped
- [leaf packages], blue lines are prre-depends, green lines are conflicts.
+ [leaf packages], blue lines are pre-depends, green lines are conflicts.
<para>
Caution, dotty cannot graph larger sets of packages.
@@ -262,7 +262,7 @@
Select the file to store the source cache. The source is used only by
<literal/gencaches/ and it stores a parsed version of the package
information from remote sources. When building the package cache the
- source cache is used to advoid reparsing all of the package files.
+ source cache is used to avoid reparsing all of the package files.
Configuration Item: <literal/Dir::Cache::srcpkgcache/.
</VarListEntry>
--- apt-cdrom.8.sgml.orig Mon Jun 18 13:02:47 2001
+++ apt-cdrom.8.sgml Mon Jun 18 13:03:26 2001
@@ -17,7 +17,7 @@
<!-- Man page title -->
<refnamediv>
<refname>apt-cdrom</>
- <refpurpose>APT CDROM managment utility</>
+ <refpurpose>APT CDROM management utility</>
</refnamediv>
<!-- Arguments -->
@@ -54,7 +54,7 @@
<VarListEntry><Term>add</Term>
<ListItem><Para>
<literal/add/ is used to add a new disc to the source list. It will unmount the
- CDROM device, prompt for a disk to be inserted and then procceed to
+ CDROM device, prompt for a disk to be inserted and then proceed to
scan it and copy the index files. If the disc does not have a proper
<filename>.disk/</> directory you will be prompted for a descriptive
title.
@@ -80,7 +80,7 @@
<VarListEntry><term><option/-d/</><term><option/--cdrom/</>
<ListItem><Para>
Mount point; specify the location to mount the cdrom. This mount
- point must be listed in <filename>/etc/fstab</> and propely configured.
+ point must be listed in <filename>/etc/fstab</> and properly configured.
Configuration Item: <literal/Acquire::cdrom::mount/.
</VarListEntry>
--- apt-config.8.sgml.orig Mon Jun 18 13:09:32 2001
+++ apt-config.8.sgml Mon Jun 18 13:10:07 2001
@@ -38,7 +38,7 @@
<para>
<command/apt-config/ is an internal program used by various portions of
the APT suite to provide consistent configurability. It accesses the main
- configuarion file <filename>/etc/apt/apt.conf</> in a manner that is
+ configuration file <filename>/etc/apt/apt.conf</> in a manner that is
easy to use by scripted applications.
<para>
Unless the <option/-h/, or <option/--help/ option is given one of the
--- apt-extracttemplates.1.sgml.orig Mon Jun 18 13:03:38 2001
+++ apt-extracttemplates.1.sgml Mon Jun 18 13:04:23 2001
@@ -23,7 +23,7 @@
<!-- Arguments -->
<refsynopsisdiv>
<cmdsynopsis>
- <command>apt-extracttemplate</>
+ <command>apt-extracttemplates</>
<arg><option>-hv</></arg>
<arg><option>-t=<replaceable/temporary directory/</></arg>
<arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg>
--- apt-ftparchive.1.sgml.orig Mon Jun 18 13:04:48 2001
+++ apt-ftparchive.1.sgml Mon Jun 18 13:08:00 2001
@@ -122,12 +122,12 @@
The <literal/generate/ command uses a configuration file to describe the
archives that are going to be generated. It follows the typical ISC
configuration format as seen in ISC tools like bind 8 and dhcpd.
- &apt-conf; contains a decsription of the syntax. Note that the generate
+ &apt-conf; contains a description of the syntax. Note that the generate
configuration is parsed in sectional manner, but &apt-conf; is parsed in a
tree manner. This only effects how the scope tag is handled.
<para>
- The generate configuration has 4 separate sections, each decribed below.
+ The generate configuration has 4 separate sections, each described below.
<refsect2><title>Dir Section</>
<Para>
@@ -235,7 +235,7 @@
to be checked without changing. If this limit is passed the mtime of the
contents file is updated. This case can occur if the package file is
changed in such a way that does not result in a new contents file
- [overried edit for instance]. A hold off is allowed in hopes that new
+ [overridden edit for instance]. A hold off is allowed in hopes that new
.debs will be installed, requiring a new file anyhow. The default is 10,
the units are in days.
</VarListEntry>
@@ -297,7 +297,7 @@
Specifies that instead of walking the directory tree
that <command/apt-ftparchive/ should read the list of files from the given
file. Relative files names are prefixed with the archive directory.
- This is used when processing source indexs.
+ This is used when processing source indexes.
</VarListEntry>
</VariableList>
</refsect2>
@@ -336,7 +336,7 @@
<VarListEntry><term>Architectures</term>
<ListItem><Para>
This is a space separated list of all the
- architectures that appear under seach section. The special architecture
+ architectures that appear under each section. The special architecture
'source' is used to indicate that this tree has a source archive.
</VarListEntry>
@@ -409,7 +409,7 @@
<RefSect1><Title>The Binary Override File</>
<para>
The binary override file is fully compatible with &dpkg-scanpackages;. It
- contains 4 fields sperated by spaces. The first field is the package name,
+ contains 4 fields separated by spaces. The first field is the package name,
the second is the priority to force that package to, the third is the
the section to force that package to and the final field is the maintainer
permutation field.
--- apt-get.8.sgml.orig Mon Jun 18 12:59:20 2001
+++ apt-get.8.sgml Mon Jun 18 13:00:23 2001
@@ -110,7 +110,7 @@
the desired packages. If a hyphen is appended to the package name (with
no intervening space), the identified package will be removed if it is
installed. Similarly a plus sign can be used to designate a package to
- isntall. These latter feature may be used to override decisions made by
+ install. These latter feature may be used to override decisions made by
apt-get's conflict resolution system.
<para>
A specific version of a package can be selected for installation by
@@ -120,7 +120,7 @@
following the package name with a slash and the version of the
distribution or the Archive name (stable, frozen, unstable).
<para>
- Both of the version selection mechansims can downgrade packages and must
+ Both of the version selection mechanisms can downgrade packages and must
be used with care.
<para>
If no package matches the given expression and the expression contains one
@@ -214,8 +214,8 @@
<ListItem><Para>
Fix; attempt to correct a system with broken dependencies in
place. This option, when used with install/remove, can omit any packages
- to permit APT to deduce a likely soltion. Any Package that are specified
- must completly correct the problem. The option is sometimes necessary when
+ to permit APT to deduce a likely solution. Any Package that are specified
+ must completely correct the problem. The option is sometimes necessary when
running APT for the first time; APT itself does not allow broken package
dependencies to exist on a system. It is possible that a system's
dependency structure can be so corrupt as to require manual intervention
--- apt.conf.5.sgml.orig Mon Jun 18 12:50:46 2001
+++ apt.conf.5.sgml Mon Jun 18 12:54:44 2001
@@ -17,7 +17,7 @@
<!-- Man page title -->
<refnamediv>
<refname>apt.conf</>
- <refpurpose>Configuratoin file for APT</>
+ <refpurpose>Configuration file for APT</>
</refnamediv>
<RefSect1><Title>Description</>
@@ -53,7 +53,7 @@
</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>
@@ -67,7 +67,7 @@
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 @@
<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>
@@ -95,7 +95,7 @@
<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 package
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 @@
<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.
@@ -155,7 +155,7 @@
<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,7 +182,7 @@
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
+ Three settings are provided for cache control with HTTP/1.1 compliant
proxy caches. <literal/No-Cache/ tells the proxy to not used 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
@@ -200,20 +200,20 @@
<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
&configureindex; for an example of
- how to do this. The subsitution variables available are
+ how to do this. The substitution variables available are
<literal/$(PROXY_USER)/, <literal/$(PROXY_PASS)/, <literal/$(SITE_USER)/,
<literal/$(SITE_PASS)/, <literal/$(SITE)/, and <literal/$(SITE_PORT)/.
Each is taken from it's respective URI component.
@@ -234,7 +234,7 @@
not recommended to use FTP over HTTP due to its low efficiency.
<para>
The setting <literal/ForceExtended/ controls the use of RFC2428
- <literal/EPSV/ and <literal/EPRT/ commands. The defaut is false, which means
+ <literal/EPSV/ and <literal/EPRT/ commands. The default is false, which means
these commands are only used if the control connection is IPv6. Setting this
to true forces their use even on IPv4 connections. Note that most FTP servers
do not support RFC2428.
@@ -259,7 +259,7 @@
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>
@@ -268,7 +268,7 @@
<literal/pkgcache/ as well as the location to place downloaded archives,
<literal/Dir::Cache::archives/. Generation of caches can be turned off
by setting their names to be blank. This will slow down startup but
- save disk space. It is probably prefered to turn off the pkgcache rather
+ save disk space. It is probably preferred to turn off the pkgcache rather
than the srcpkgcache. Like <literal/Dir::State/ the default
directory is contained in <literal/Dir::Cache/
<para>
@@ -292,7 +292,7 @@
<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 behavior. These are in the <literal/DSelect/ section.
<VariableList>
<VarListEntry><Term>Clean</Term>
@@ -332,7 +332,7 @@
<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>
@@ -380,7 +380,7 @@
interesting output about the decisions dist-upgrade makes.
<literal/Debug::NoLocking/ disables file locking so APT can do some
operations as non-root and <literal/Debug::pkgDPkgPM/ will print out the
- command line for each dpkg invokation. <literal/Debug::IdentCdrom/ will
+ command line for each dpkg invocation. <literal/Debug::IdentCdrom/ will
disable the inclusion of statfs data in CDROM IDs.
</RefSect1>
--- apt_preferences.5.sgml.orig Mon Jun 18 12:41:28 2001
+++ apt_preferences.5.sgml Mon Jun 18 12:47:45 2001
@@ -23,9 +23,9 @@
<RefSect1><Title>Description</>
<para>
The APT preferences file controls various aspects of the APT system.
- It is ment to be user editable and manipulatable from software. The file
+ It is meant to be user editable and manipulatable from software. The file
consists of a number of records formed like the dpkg status file, space
- seperated sections of text with at the start of each line tags seperated
+ separated sections of text with at the start of each line tags separated
by a colon. It is stored in <filename>/etc/apt/preferences</>.
</RefSect1>
@@ -44,11 +44,11 @@
<para>
Selection by release is more complicated and has three forms. The primary
purpose of release selections is to identify a set of packages that match
- a specific vendor, or release (ie Debian 2.1). The first two forms are
+ a specific vendor, or release (i.e. Debian 2.1). The first two forms are
shortcuts intended for quick command line use. If the first character of the
specification is a digit then it is considered to be a release version match,
otherwise a release label match. Specifications which contain equals are
- full release data matches and are a comma seperated list of one letter keys
+ full release data matches and are a comma separated list of one letter keys
followed by an equals then by the string. Examples:
<informalexample><programlisting>
v=2.1*,o=Debian,c=main
@@ -68,7 +68,7 @@
<VarListEntry><term>c= Component</term>
<ListItem><Para>
- Referes to the sub-component of the archive, <literal/main/,
+ Refers to the sub-component of the archive, <literal/main/,
<literal/contrib/ etc. Component may be omitted if there are no
components for this archive.
</VarListEntry>
@@ -105,7 +105,7 @@
<RefSect1><Title>Candidate Version Policy</>
<para>
- Interaly APT maintains a list of all available versions for all packages.
+ Internally APT maintains a list of all available versions for all packages.
If you place multiple releases or vendors in your &sources-list; file then
these features are available. By default APT selects the highest version
from all automatic sources. Some sources, such as
@@ -113,13 +113,13 @@
to the bottom of the selection pile.
<para>
When deciding what version to use APT assigns a priority to each available
- version of the package. It then does two things, first it selects
- the highest priorty version that is newer than the installed version of the
+ version of the package. It then does two things: first it selects
+ the highest priority version that is newer than the installed version of the
package, then it selects the highest priority version that is older than
the installed version. Next, if the older versions have a priority greater
than 1000 they are compared with the priority of the upgrade set, the larger
becomes the selected result. Otherwise the downgrade versions are ignored
- and the highest priority of the ugprade set is selected.
+ and the highest priority of the upgrade set is selected.
<para>
It is possible to think of the priorities in strata:
<VariableList>
@@ -173,7 +173,7 @@
The first line specifies the package, the second gives the Pin specification
and the last gives the priority of this pin. The first word of the pin
specification may be version, release or origin, the remainder of the field
- is described in the Versioning sectin above.
+ is described in the Versioning section above.
<para>
A default pin is how the priorities of package files are set. Any number
of default pins may be specified, the first matching default will select
@@ -185,17 +185,17 @@
Pin-Priority: 998
</programlisting></informalexample>
<para>
- If the Pin-Priorty field is omitted then the priority defaults to 989 for
+ If the Pin-Priority field is omitted then the priority defaults to 989 for
both cases.
<RefSect2><title>Interesting Effects</>
<para>
Due to the downgrade prevention barrier at priority 1000 it is possible
that a lower priority version will be selected if the higher priority
- would casue a downgrade. For instance, if package foo has versions
+ would cause a downgrade. For instance, if package foo has versions
<literal/1.2/, <literal/1.1/ and <literal/1.0/ installed, with
<literal/1.1/ being the currently installed version and the priorities of
- each version being 900, 100 and 950 repectively the winning version will be
+ each version being 900, 100 and 950 respectively the winning version will be
<literal/1.2/.
<para>
In practice this is often desired. A user may use a default pin to
--- sources.list.5.sgml.orig Mon Jun 18 13:01:32 2001
+++ sources.list.5.sgml Mon Jun 18 13:02:16 2001
@@ -50,7 +50,7 @@
<para>
The format for a <filename/sources.list/ entry using the <literal/deb/
and <literal/deb-src/ types are:
- <literallayout>deb uri distribution [component1] [componenent2] [...]</literallayout>
+ <literallayout>deb uri distribution [component1] [component2] [...]</literallayout>
<para>
The URI for the <literal/deb/ type must specify the base of the Debian
distribution, from which APT will find the information it needs.
@@ -62,7 +62,7 @@
<para>
<literal/distribution/ may also contain a variable, <literal/$(ARCH)/,
which expands to the Debian architecture (i386, m68k, powerpc, ...)
- used on the system. This permits archiecture-independent
+ used on the system. This permits architecture-independent
<filename/sources.list/ files to be used. In general this is only of
interest when specifying an exact path, <literal/APT/ will automatically
generate a URI with the current architecture otherwise.
@@ -76,7 +76,7 @@
inefficiently establish an FTP connection, close it, do something else,
and then re-establish a connection to that same host. This feature is
useful for accessing busy FTP sites with limits on the number of
- simultaneous anonymous users. bf(APT) also parallizes connections to
+ simultaneous anonymous users. bf(APT) also parallelizes connections to
different hosts to more effectively deal with sites with low bandwidth.
<para>
It is important to list sources in order of preference, with the most
Reply to: