- big manpage overhaul (Vincent Danen)
authorpmatilai <pmatilai>
Thu, 15 Jun 2006 16:43:09 +0000 (16:43 +0000)
committerpmatilai <pmatilai>
Thu, 15 Jun 2006 16:43:09 +0000 (16:43 +0000)
doc/apt-cache.8
doc/apt-cdrom.8
doc/apt-config.8
doc/apt-get.8
doc/apt.8
doc/apt.conf.5
doc/apt_preferences.5
doc/sources.list.5
doc/vendors.list.5

index 16cfa4b..f29ed08 100644 (file)
@@ -1,48 +1,47 @@
-.\" This manpage has been automatically generated by docbook2man 
-.\" from a DocBook document.  This tool can be found at:
-.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
-.\" Please send any bug reports, improvements, comments, patches, 
-.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "APT-CACHE" "8" "08 June 2006" "" ""
-
+.TH "APT-CACHE" 8 "14 Jun 2006" "APT-RPM" "apt-cache"
 .SH NAME
-apt-cache \- APT package handling utility -- cache manipulator
-.SH SYNOPSIS
+apt-cache - APT package handling utility -- cache manipulator
 
-\fBapt-cache\fR [ \fB-hvsn\fR ] [ \fB-o=\fIconfig string\fB\fR ] [ \fB-c=\fIfile\fB\fR ] { \fBadd  \fIfile\fB\fI ...\fB\fR | \fBgencaches\fR | \fBshowpkg  \fIpkg\fB\fI ...\fB\fR | \fBshowsrc  \fIpkg\fB\fI ...\fB\fR | \fBstats\fR | \fBdump\fR | \fBdumpavail\fR | \fBunmet\fR | \fBsearch  \fIregex\fB\fR | \fBshow  \fIpkg\fB\fI ...\fB\fR | \fBdepends  \fIpkg\fB\fI ...\fB\fR | \fBwhatdepends  \fIpkg\fB\fI ...\fB\fR | \fBpkgnames  \fIprefix\fB\fR | \fBdotty  \fIpkg\fB\fI ...\fB\fR | \fBpolicy  \fIpkgs\fB\fI ...\fB\fR }
+.SH SYNOPSIS
+.nf
+\fBapt-cache\fR [\fBoptions\fR] [\fB-o\fR \fIconfig\fR=\fIstring\fR] [\fB-c\fR=\fIcfgfile\fR] \fBcommand\fR [\fBpkg|file(s)|regex\fR]
+.fi
 
 .SH "DESCRIPTION"
-.PP
-\fBapt-cache\fR performs a variety of operations on APT's package 
-cache. \fBapt-cache\fR does not manipulate the state of the system 
-but does provide operations to search and generate interesting output 
-from the package metadata.
-.PP
-Unless the \fB-h\fR, or \fB--help\fR option is given, one of the
-commands below must be present.
-.TP
-\fBadd \fIfile(s)\fB\fR
-add adds the named package index files to the package cache.
-This is for debugging only.
+.LP
+\fBapt-cache\fR performs a variety of operations on APT's package cache.
+\fBapt-cache\fR does not manipulate the state of the system but does provide
+operations to search and generate interesting output from the package
+metadata.
+
+.SH "COMMANDS"
+.LP
+Unless the \fB-h\fR, or \fB--help\fR option is given, one of the commands
+below must be present.
+
 .TP
-\fBgencaches\fR
-gencaches performs the same operation as 
-\fBapt-get check\fR\&. It builds the source and package caches from 
-the sources in \fB\fIsources.list\fB\fR(5) and from \fI/var/lib/rpm/\fR\&.
-.TP
-\fBshowpkg \fIpkg(s)\fB\fR
-showpkg displays information about the packages listed on the 
-command line. Remaining arguments are package names. The available 
-versions and reverse dependencies of each package listed are listed, as 
-well as forward dependencies for each version. Forward (normal) 
-dependencies are those packages upon which the package in question 
-depends; reverse dependencies are those packages that depend upon the 
-package in question. Thus, forward dependencies must be satisfied for a 
-package, but reverse dependencies need not be.
-For instance, \fBapt-cache showpkg libreadline2\fR would produce 
-output similar to the following:
+\fBadd\fR file(s)
+Adds the named package index file(s) to the package cache. This is for
+debugging only.
 
+.TP
+\fBgencaches\fR
+Performs the same operation as \fBapt-get check\fR. It builds the source and
+package caches from the sources in \fIsources.list\fR(5) and from
+\fI/var/lib/rpm/\fR.
 
+.TP
+\fBshowpkg\fR pkg(s)
+Displays information about the packages listed on the command-line.
+Remaining arguments are package names. The available versions and reverse
+dependencies of each package specified are listed, as well as forward
+dependencies for each version. Forward (normal) dependencies are those
+packages upon which the package in question depends; reverse dependencies
+are those packages that depend upon the package in question. Thus, forward
+dependencies must be satisfied for a package, but reverse dependencies need
+not be. For instance, \fBapt-cache showpkg libreadline2\fR would produce
+output similar to the following:
+.IP
 .nf
 Package: libreadline2
 Versions: 2.1-12(/var/lib/apt/lists/foo_Packages),
@@ -55,265 +54,278 @@ Provides:
 2.1-12 - 
 Reverse Provides: 
 .fi
-
+.IP
 Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and
-ncurses3.0 which must be installed for libreadline2 to work. 
-In turn, libreadlineg2 and libreadline2-altdev depend on libreadline2. If
+ncurses3.0 which must be installed for libreadline2 to work. In turn,
+libreadlineg2 and libreadline2-altdev depend on libreadline2. If
 libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be
 installed; libreadlineg2 and libreadline2-altdev do not have to be
-installed. For the specific meaning of the remainder of the output it
-is best to consult the apt source code.
+installed. For the specific meaning of the remainder of the output it is
+best to consult the apt source code.
+
 .TP
 \fBstats\fR
-stats displays some statistics about the cache.
-No further arguments are expected. Statistics reported are:
+Displays some statistics about the cache. No further arguments are expected.
+Statistics reported are:
 .RS
 .TP 0.2i
 \(bu
-Total package names is the number of package names found 
-in the cache.
+Total package names is the number of package names found in the cache.
 .TP 0.2i
 \(bu
-Normal packages is the number of regular, ordinary package 
-names; these are packages that bear a one-to-one correspondence between 
-their names and the names used by other packages for them in 
-dependencies. The majority of packages fall into this category.
+Normal packages is the number of regular, ordinary package names; these are
+packages that bear a one-to-one correspondence between their names and the
+names used by other packages for them in dependencies. The majority of
+packages fall into this category.
 .TP 0.2i
 \(bu
-Pure virtual packages is the number of packages that exist 
-only as a virtual package name; that is, packages only "provide" the 
-virtual package name, and no package actually uses the name. For 
-instance, "mail-transport-agent" in the Debian GNU/Linux system is a 
-pure virtual package; several packages provide "mail-transport-agent", 
-but there is no package named "mail-transport-agent".
+Pure virtual packages is the number of packages that exist only as a virtual
+package name; that is, packages only "provide" the virtual package name, and
+no package actually uses the name. For instance, "mail-transport-agent" in
+the Debian GNU/Linux system is a pure virtual package; several packages
+provide "mail-transport-agent", but there is no package named
+"mail-transport-agent".
 .TP 0.2i
 \(bu
-Single virtual packages is the number of packages with only 
-one package providing a particular virtual package. For example, in the
-Debian GNU/Linux system, "X11-text-viewer" is a virtual package, but 
-only one package, xless, provides "X11-text-viewer".
+Single virtual packages is the number of packages with only one package
+providing a particular virtual package. For example, in the Debian GNU/Linux
+system, "X11-text-viewer" is a virtual package, but only one package, xless,
+provides "X11-text-viewer".
 .TP 0.2i
 \(bu
-Mixed virtual packages is the number of packages that either 
-provide a particular virtual package or have the virtual package name 
-as the package name. For instance, in the Debian GNU/Linux system, 
-"debconf" is both an actual package, and provided by the debconf-tiny
-package.
+Mixed virtual packages is the number of packages that either provide a
+particular virtual package or have the virtual package name as the package
+name. For instance, in the Debian GNU/Linux system, "debconf" is both an
+actual package, and provided by the debconf-tiny package.
 .TP 0.2i
 \(bu
-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 accessed, or if a package
-(real or virtual) has been dropped from the distribution. Usually they
-are referenced from Conflicts statements.
+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 accessed, or if a package (real or virtual) has
+been dropped from the distribution. Usually they are referenced from
+Conflicts statements.
 .TP 0.2i
 \(bu
-Total distinct versions is the number of package versions 
-found in the cache; this value is therefore at least equal to the 
-number of total package names. If more than one distribution (both 
-"stable" and "unstable", for instance), is being accessed, this value 
-can be considerably larger than the number of total package names.
+Total distinct versions is the number of package versions found in the
+cache; this value is therefore at least equal to the number of total package
+names. If more than one distribution (both "stable" and "unstable", for
+instance), is being accessed, this value can be considerably larger than the
+number of total package names.
 .TP 0.2i
 \(bu
-Total dependencies is the number of dependency relationships 
-claimed by all of the packages in the cache.
+Total dependencies is the number of dependency relationships claimed by all
+of the packages in the cache.
 .RE
+
 .TP
-\fBshowsrc \fIpkg(s)\fB\fR
-showsrc displays all the source package records that match
-the given package names. All versions are shown, as well as all 
-records that declare the name to be a Binary.
+\fBshowsrc\fR pkg(s)
+Displays all the source package records that match the given package names.
+All versions are shown, as well as all records that declare the name to be a
+Binary.
+
 .TP
 \fBdump\fR
-dump shows a short listing of every package in the cache. It is 
-primarily for debugging.
+Shows a short listing of every package in the cache. It is primarily for
+debugging.
+
 .TP
 \fBdumpavail\fR
-dumpavail prints out an available list to stdout.
+Prints out an available list to stdout.
+
 .TP
 \fBunmet\fR
-unmet displays a summary of all unmet dependencies in the 
-package cache.
+Displays a summary of all unmet dependencies in the package cache.
+
 .TP
-\fBshow \fIpkg(s)\fB\fR
+\fBshow\fR pkg(s)
 Displays the package records for the named packages.
-.TP
-\fBsearch \fIregex [ regex ... ]\fB\fR
-search performs a full text search on all available package
-lists for the regex pattern given. It searches the package names and the
-descriptions for an occurrence of the regular expression and prints out
-the package name and the short description. If \fB--full\fR is given
-then output identical to show is produced for each matched
-package, and if \fB--names-only\fR is given then the long description
-is not searched, only the package name is.
-
-Separate arguments can be used to specify multiple search patterns that 
-are and'ed together.
-.TP
-\fBdepends \fIpkg(s)\fB\fR
-depends shows a listing of each dependency a package has 
-and all the possible other packages that can fulfill that dependency.
-.TP
-\fBwhatdepends \fIpkg(s)\fB\fR
-whatdepends shows a listing of what depends on a package.
-.TP
-\fBwhatprovides \fIpkg(s)\fB\fR
-whatprovides shows a listing of package which provides a
-dependency.
-.TP
-\fBpkgnames \fI[ prefix ]\fB\fR
-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 
-extremely quickly. This command is best used with the 
-\fB--generate\fR option.
-.TP
-\fBdotty \fIpkg(s)\fB\fR
-dotty takes a list of packages on the command line and 
-generates output suitable for use by dotty from the 
-GraphViz <URL:http://www.research.att.com/sw/tools/graphviz/>
-package. The result will be a set of nodes and edges representing the 
-relationships between the packages. By default the given packages will 
-trace out all dependent packages; this can produce a very large graph. 
-To limit the output to only the packages listed on the command line,
-set the APT::Cache::GivenOnly option.
 
-The resulting nodes will have several shapes; normal packages are boxes,
-pure provides are triangles, mixed provides are diamonds, 
-missing packages are hexagons. Orange boxes mean recursion was stopped 
-[leaf packages], blue lines are pre-depends, green lines are conflicts.
+.TP
+\fBsearch\fR regex [regex ...]
+Performs a full text search on all available package lists for the regex
+pattern given. It searches the package names and the descriptions for an
+occurrence of the regular expression and prints out the package name and the
+short description. If \fB--full\fR is given then output identical to
+\fBshow\fR is produced for each matched package, and if \fB--names-only\fR
+is given then the long description is not searched, only the package name is.
+.IP
+Separate arguments can be used to specify multiple search patterns that are
+and'ed together.
 
-Caution, dotty cannot graph larger sets of packages.
 .TP
-\fBpolicy \fI[ pkg(s) ]\fB\fR
-policy is ment to help debug issues relating to the 
-preferences file. With no arguments it will print out the 
-priorities of each source. Otherwise it prints out detailed information
-about the priority selection of the named package.
-.SH "OPTIONS"
-.PP
-All command line options may be set using the configuration file, the
-descriptions indicate the configuration option to set. For boolean
-options you can override the config file by using something like 
-\fB-f-\fR,\fB--no-f\fR, \fB-f=no\fR or several other variations.
+\fBdepends\fR pkg(s)
+Shows a listing of each dependency a package has and all the possible other
+packages that can fulfill that dependency.
+
 .TP
-\fB-p\fR
+\fBwhatdepends\fR pkg(s)
+Shows a listing of what depends on a package.
+
 .TP
-\fB--pkg-cache\fR
-Select the file to store the package cache. The package cache is the 
-primary cache used by all operations.
-Configuration Item: Dir::Cache::pkgcache\&.
+\fBwhatprovides\fR pkg(s)
+Shows a listing of package which provides a dependency.
+
 .TP
-\fB-s\fR
+\fBpkgnames\fR prefix
+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 extremely quickly.
+This command is best used with the \fB--generate\fR option.
+
 .TP
-\fB--src-cache\fR
-Select the file to store the source cache. The source is used only by
-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.
-Configuration Item: Dir::Cache::srcpkgcache\&.
+\fBdotty\fR pkg(s)
+Takes a list of packages on the command line and generates output suitable
+for use by dotty from the GraphViz
+(http://www.research.att.com/sw/tools/graphviz/) package. The result will be
+a set of nodes and edges representing the relationships between the
+packages. By default the given packages will trace out all dependent
+packages; this can produce a very large graph. To limit the output to only
+the packages listed on the command line, set the \fIAPT::Cache::GivenOnly\fR
+option.
+.IP
+The resulting nodes will have several shapes; normal packages are boxes,
+pure provides are triangles, mixed provides are diamonds, missing packages
+are hexagons. Orange boxes mean recursion was stopped [leaf packages], blue
+lines are pre-depends, green lines are conflicts.
+.IP
+Caution, dotty cannot graph larger sets of packages.
+
 .TP
-\fB-q\fR
+\fBpolicy\fR [pkg(s)]
+This is meant to help debug issues relating to the preferences file. With no
+arguments it will print out the priorities of each source. Otherwise it
+prints out detailed information about the priority selection of the named
+package.
+
+.SH "OPTIONS"
+All command-line options may be set using the configuration file, the
+descriptions indicate the configuration option to set. For boolean options
+you can override the config file by using something like
+\fB-f-\fR,\fB--no-f\fR, \fB-f=no\fR or several other variations.
+
 .TP
-\fB--quiet\fR
-Quiet; produces output suitable for logging, omitting progress indicators.
-More q's will produce more quietness up to a maximum of 2. You can also use
-\fB-q=#\fR to set the quietness level, overriding the configuration file.
-Configuration Item: quiet\&.
+\fB-p\fR, \fB--pkg-cache\fR
+Select the file to store the package cache. The package cache is the primary
+cache used by all operations.
+.IP
+Configuration Item: \fIDir::Cache::pkgcache\fR.
+
 .TP
-\fB-i\fR
+\fB-s\fR, \fB--src-cache\fR
+Select the file to store the source cache. The source is used only by
+\fBgencaches\fR 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.
+.IP
+Configuration Item: \fIDir::Cache::srcpkgcache\fR.
+
 .TP
-\fB--important\fR
-Print only important dependencies; for use with unmet. Causes only Depends and 
-Pre-Depends relations to be printed.
-Configuration Item: APT::Cache::Important\&.
+\fB-q\fR, \fB--quiet\fR
+Quiet.  Produces output suitable for logging, omitting progress indicators.
+More \fBq\fR's will produce more quietness up to a maximum of two. You can
+also use \fB-q=#\fR to set the quietness level, overriding the configuration
+file.
+.IP
+Configuration Item: \fIquiet\fR.
+
 .TP
-\fB-f\fR
+\fB-i\fR, \fB--important\fR
+Print only important dependencies; for use with \fBunmet\fR. Causes only
+Depends and Pre-Depends relations to be printed.
+.IP
+Configuration Item: \fIAPT::Cache::Important\fR.
+
 .TP
-\fB--full\fR
+\fB-f\fR, \fB--full\fR
 Print full package records when searching. 
-Configuration Item: APT::Cache::ShowFull\&.
-.TP
-\fB-a\fR
-.TP
-\fB--all-versions\fR
-Print full records for all available versions. This is the
-default; to turn it off, use \fB--no-all-versions\fR\&.
-If \fB--no-all-versions\fR is specified, only the candidate version
-will displayed (the one which would be selected for installation).
-This option is only applicable to  the show command.
-Configuration Item: APT::Cache::AllVersions\&.
-.TP
-\fB-g\fR
+.IP
+Configuration Item: \fIAPT::Cache::ShowFull\fR.
+
 .TP
-\fB--generate\fR
-Perform automatic package cache regeneration, rather than use the cache 
-as it is. This is the default; to turn it off, use \fB--no-generate\fR\&.
-Configuration Item: APT::Cache::Generate\&.
+\fB-a\fR, \fB--all-versions\fR
+Print full records for all available versions. This is the default; to turn
+it off, use \fB--no-all-versions\fR. If \fB--no-all-versions\fR is
+specified, only the candidate version will be displayed (the one which would
+be selected for installation). This option is only applicable to the
+\fBshow\fR command.
+.IP
+Configuration Item: \fIAPT::Cache::AllVersions\fR.
+
 .TP
-\fB--names-only\fR
+\fB-g\fR, \fB--generate\fR
+Perform automatic package cache regeneration, rather than use the cache as
+it is. This is the default; to turn it off, use \fB--no-generate\fR.
+.IP
+Configuration Item: \fIAPT::Cache::Generate\fR.
+
 .TP
-\fB-n\fR
+\fB-n\fR, \fB--names-only\fR
 Only search on the package names, not the long descriptions. 
-Configuration Item: APT::Cache::NamesOnly\&.
+.IP
+Configuration Item: \fIAPT::Cache::NamesOnly\fR.
+
 .TP
 \fB--all-names\fR
-Make pkgnames print all names, including virtual packages 
-and missing dependencies. 
-Configuration Item: APT::Cache::AllNames\&.
+Make \fBpkgnames\fR print all names, including virtual packages and missing
+dependencies.
+.IP
+Configuration Item: \fIAPT::Cache::AllNames\fR.
+
 .TP
 \fB--recurse\fR
-Make depends recursive so that all packages mentioned are 
-printed once.
-Configuration Item: APT::Cache::RecurseDepends\&.
-.TP
-\fB-h\fR
+Make \fBdepends\fR recursive so that all packages mentioned are printed once.
+.IP
+Configuration Item: \fIAPT::Cache::RecurseDepends\fR.
+
 .TP
-\fB--help\fR
+\fB-h\fR, \fB--help\fR
 Show a short usage summary.
+
 .TP
-\fB-v\fR
-.TP
-\fB--version\fR
+\fB-v\fR, \fB--version\fR
 Show the program version.
+
 .TP
-\fB-c\fR
-.TP
-\fB--config-file\fR
-Configuration File; Specify a configuration file to use. 
-The program will read the default configuration file and then this 
-configuration file. See \fB\fIapt.conf\fB\fR(5) for syntax information.     
-.TP
-\fB-o\fR
+\fB-c\fR, \fB--config-file\fR
+Configuration File. Specify a configuration file to use. The program will
+read the default configuration file and then this configuration file. See
+\fIapt.conf\fR(5) for syntax information.
+
 .TP
-\fB--option\fR
-Set a Configuration Option; This will set an arbitrary configuration 
-option. The syntax is \fB-o Foo::Bar=bar\fR\&.
+\fB-o\fR, \fB--option\fR
+Set a Configuration Option. This will set an arbitrary configuration option.
+The syntax is \fB-o Foo::Bar=bar\fR\.
+
 .SH "FILES"
 .TP
-\fB\fI/etc/apt/sources.list\fB\fR
+\fI/etc/apt/sources.list\fR
 Locations to fetch packages from.
-Configuration Item: Dir::Etc::SourceList\&.
+.IP
+Configuration Item: \fIDir::Etc::SourceList\fR.
+
 .TP
-\fB\fI/var/lib/apt/lists/\fB\fR
+\fI/var/lib/apt/lists/\fR
 Storage area for state information for each package resource specified in
-\fB\fIsources.list\fB\fR(5)
-Configuration Item: Dir::State::Lists\&.
+\fIsources.list\fR(5).
+.IP
+Configuration Item: \fIDir::State::Lists\fR.
+
 .TP
-\fB\fI/var/lib/apt/lists/partial/\fB\fR
+\fI/var/lib/apt/lists/partial/\fR
 Storage area for state information in transit.
-Configuration Item: Dir::State::Lists (implicit partial).
+.IP
+Configuration Item: \fIDir::State::Lists\fR (implicit partial).
+
 .SH "SEE ALSO"
-.PP
-\fB\fIapt.conf\fB\fR(5), \fB\fIsources.list\fB\fR(5), \fBapt-get\fR(8)
+\fIapt.conf\fR(5), \fIsources.list\fR(5), \fBapt-get\fR(8)
+
 .SH "DIAGNOSTICS"
-.PP
 \fBapt-cache\fR returns zero on normal operation, decimal 100 on error.
+
 .SH "BUGS"
-.PP
-Reporting bugs in APT-RPM is best done in the 
-APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>\&.
+Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist at
+http://apt-rpm.org/mailinglist.shtml.
+
 .SH "AUTHOR"
-.PP
-Maintainer and contributor information can be found in the
-credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.
+Maintainer and contributor information can be found in the credits page
+http://apt-rpm.org/about.shtml of APT-RPM.
index 8d2833c..99e6792 100644 (file)
-.\" This manpage has been automatically generated by docbook2man 
-.\" from a DocBook document.  This tool can be found at:
-.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
-.\" Please send any bug reports, improvements, comments, patches, 
-.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "APT-CDROM" "8" "08 June 2006" "" ""
-
+.TH "APT-CDROM" 8 "14 Jun 2006" "APT-RPM" "apt-cdrom"
 .SH NAME
-apt-cdrom \- APT CDROM management utility
-.SH SYNOPSIS
+apt-cdrom - APT CDROM management utility
 
-\fBapt-cdrom\fR [ \fB-hvrmfan\fR ] [ \fB-d=\fIcdrom mount point\fB\fR ] [ \fB-o=\fIconfig string\fB\fR ] [ \fB-c=\fIfile\fB\fR ] { \fBadd\fR | \fBident\fR }
+.SH SYNOPSIS
+\fBapt-cdrom\fR [\fBoptions\fR] [\fB-d\fR=\fImount_point\fR] [\fB-o\fR \fIconfig\fR=\fIstring\fR] [\fB-c\fR=\fIfile\fR] \fBcommand\fR
 
 .SH "DESCRIPTION"
-.PP
-\fBapt-cdrom\fR is used to add a new CDROM to APTs list of available 
-sources. \fBapt-cdrom\fR takes care of determining the structure of 
-the disc as well as correcting for several possible mis-burns and 
-verifying the index files.   
-.PP
-It is necessary to use \fBapt-cdrom\fR to add CDs to the APT system, 
-it cannot be done by hand. Furthermore each disk in a multi-cd set must be
+\fBapt-cdrom\fR is used to add a new CDROM to APT's list of available
+sources.  \fBapt-cdrom\fR takes care of determining the structure of the
+disc as well as correcting for several possible mis-burns and verifying the
+index files.
+.LP
+It is necessary to use \fBapt-cdrom\fR to add CDs to the APT system; it
+cannot be done by hand.  Furthermore each disk in a multi-CD set must be
 inserted and scanned separately to account for possible mis-burns.
-.PP
-Unless the \fB-h\fR, or \fB--help\fR option is given one of the
-commands below must be present.
+
+.SH "COMMANDS"
+Unless the \fB-h\fR, or \fB--help\fR option is given one of the commands
+below must be present.
+
 .TP
 \fBadd\fR
-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 
-scan it and copy the index files. If the disc does not have a proper
-\fI\&.disk/\fR directory you will be prompted for a descriptive 
-title.
-
+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 proceed to scan it and
+copy the index files.  If the disc does not have a proper \fI.disk/\fR
+directory you will be prompted for a descriptive title.
+.IP
 APT uses a CDROM ID to track which disc is currently in the drive and
-maintains a database of these IDs in 
-\fI/var/lib/apt/cdroms.list\fR
+maintains a database of these IDs in \fI/var/lib/apt/cdroms.list\fR.
+
 .TP
 \fBident\fR
-A debugging tool to report the identity of the current disc as well
-as the stored file name
+A debugging tool to report the identity of the current disc as well as the
+stored file name.
+
 .SH "OPTIONS"
-.PP
-All command line options may be set using the configuration file, the
-descriptions indicate the configuration option to set. For boolean
-options you can override the config file by using something like 
+All command-line options may be set using the configuration file, the
+descriptions indicate the configuration option to set.  For boolean options
+you can override the config file by using something like
 \fB-f-\fR,\fB--no-f\fR, \fB-f=no\fR or several other variations.
+
 .TP
-\fB-d\fR
-.TP
-\fB--cdrom\fR
-Mount point; specify the location to mount the cdrom. This mount 
-point must be listed in \fI/etc/fstab\fR and properly configured.
-Configuration Item: Acquire::cdrom::mount\&.
-.TP
-\fB-r\fR
-.TP
-\fB--rename\fR
-Rename a disc; change the label of a disk or override the disks 
-given label. This option will cause \fBapt-cdrom\fR to prompt for 
-a new label.
-Configuration Item: APT::CDROM::Rename\&.
-.TP
-\fB-m\fR
-.TP
-\fB--no-mount\fR
-No mounting; prevent \fBapt-cdrom\fR from mounting and unmounting 
-the mount point.
-Configuration Item: APT::CDROM::NoMount\&.
-.TP
-\fB-f\fR
-.TP
-\fB--fast\fR
-Fast Copy; Assume the package files are valid and do not check 
-every package. This option should be used only if
-\fBapt-cdrom\fR has been run on this disc before and did not detect 
-any errors.
-Configuration Item: APT::CDROM::Fast\&.
-.TP
-\fB-a\fR
-.TP
-\fB--thorough\fR
-Thorough Package Scan; This option may be needed with some old 
-Debian 1.1/1.2 discs that have Package files in strange places. It 
-takes much longer to scan the CD but will pick them all up.
+\fB-d\fR, \fB--cdrom\fR
+Mount point.  Specify the location to mount the cdrom.  This mount point
+must be listed in \fI/etc/fstab\fR and properly configured.
+.IP
+Configuration Item: \fIAcquire::cdrom::mount\fR.
+
 .TP
-\fB-n\fR
+\fB-r\fR, \fB--rename\fR
+Rename a disc.  Change the label of a disk or override the disk's given
+label.  This option will cause \fBapt-cdrom\fR to prompt for a new label.
+.IP
+Configuration Item: \fIAPT::CDROM::Rename\fR.
+
 .TP
-\fB--just-print\fR
+\fB-m\fR, \fB--no-mount\fR
+No mounting.  Prevent \fBapt-cdrom\fR from mounting and unmounting the mount
+point.
+.IP
+Configuration Item: \fIAPT::CDROM::NoMount\fR.
+
 .TP
-\fB--recon\fR
+\fB-f\fR, \fB--fast\fR
+Fast Copy.  Assume the package files are valid and do not check every
+package.  This option should be used only if \fBapt-cdrom\fR has been run on
+this disc before and did not detect any errors.
+.IP
+Configuration Item: \fIAPT::CDROM::Fast\fR.
+
 .TP
-\fB--no-act\fR
-No Changes; Do not change the \fB\fIsources.list\fB\fR(5) file and do not 
-write index files. Everything is still checked however.
-Configuration Item: APT::CDROM::NoAct\&.
+\fB-a\fR, \fB--thorough\fR
+Thorough Package Scan.  This option may be needed with some old discs that
+have Package files in strange places.  It takes much longer to scan the CD
+but will pick them all up.
+
 .TP
-\fB-h\fR
+\fB-n\fR, \fB--just-print\fR, \fB--recon\fR, \fB--no-act\fR
+No Changes.  Do not change the \fIsources.list\fR(5) file and do not write
+index files.  Everything is still checked however.
+.IP
+Configuration Item: \fIAPT::CDROM::NoAct\fR.
+
 .TP
-\fB--help\fR
+\fB-h\fR, \fB--help\fR
 Show a short usage summary.
+
 .TP
-\fB-v\fR
-.TP
-\fB--version\fR
+\fB-v\fR, \fB--version\fR
 Show the program version.
+
 .TP
-\fB-c\fR
-.TP
-\fB--config-file\fR
-Configuration File; Specify a configuration file to use. 
-The program will read the default configuration file and then this 
-configuration file. See \fB\fIapt.conf\fB\fR(5) for syntax information.     
-.TP
-\fB-o\fR
+\fB-c\fR, \fB--config-file\fR
+Configuration File.  Specify a configuration file to use. The program will
+read the default configuration file and then this configuration file.  See
+\fIapt.conf\fR(5) for syntax information.      
+
 .TP
-\fB--option\fR
-Set a Configuration Option; This will set an arbitrary configuration 
-option. The syntax is \fB-o Foo::Bar=bar\fR\&.
+\fB-o\fR, \fB--option\fR
+Set a Configuration Option.  This will set an arbitrary configuration
+option.  The syntax is \fB-o Foo::Bar=bar\fR\.
+
 .SH "SEE ALSO"
-.PP
-\fB\fIapt.conf\fB\fR(5), \fBapt-get\fR(8), \fB\fIsources.list\fB\fR(5)
+\fIapt.conf\fR(5), \fBapt-get\fR(8), \fIsources.list\fR(5)
+
 .SH "DIAGNOSTICS"
-.PP
 \fBapt-cdrom\fR returns zero on normal operation, decimal 100 on error.
+
 .SH "BUGS"
-.PP
-Reporting bugs in APT-RPM is best done in the 
-APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>\&.
+Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist at
+http://apt-rpm.org/mailinglist.shtml.
+
 .SH "AUTHOR"
-.PP
-Maintainer and contributor information can be found in the
-credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.
+Maintainer and contributor information can be found in the credits page
+http://apt-rpm.org/about.shtml of APT-RPM.
index ce502e2..1f26452 100644 (file)
@@ -1,89 +1,78 @@
-.\" This manpage has been automatically generated by docbook2man 
-.\" from a DocBook document.  This tool can be found at:
-.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
-.\" Please send any bug reports, improvements, comments, patches, 
-.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "APT-CONFIG" "8" "08 June 2006" "" ""
-
+.TH "APT-CONFIG" 8 "14 Jun 2006" "APT-RPM" "apt-config"
 .SH NAME
-apt-config \- APT Configuration Query program
-.SH SYNOPSIS
+apt-config - APT Configuration Query program
 
-\fBapt-config\fR [ \fB-hv\fR ] [ \fB-o=\fIconfig string\fB\fR ] [ \fB-c=\fIfile\fB\fR ] { \fBshell\fR | \fBdump\fR }
+.SH SYNOPSIS
+\fBapt-config\fR [\fBoptions\fR] [\fB-o\fR \fIconfig\fR=\fIstring\fR] [\fB-c\fR=\fIfile\fR] \fBcommand\fR
 
 .SH "DESCRIPTION"
-.PP
-\fBapt-config\fR is an internal program used by various portions of
-the APT suite to provide consistent configurability. It accesses the main 
-configuration file \fI/etc/apt/apt.conf\fR in a manner that is 
-easy to use by scripted applications.
-.PP
-Unless the \fB-h\fR, or \fB--help\fR option is given one of the
-commands below must be present.
+\fBapt-config\fR is an internal program used by various portions of the APT
+suite to provide consistent configurability.  It accesses the main
+configuration file \fI/etc/apt/apt.conf\fR(5) in a manner that is easy to use
+by scripted applications.
+
+.SH "COMMANDS"
+Unless the \fB-h\fR, or \fB--help\fR option is given, one of the commands
+below must be present.
 .TP
 \fBshell\fR
-shell is used to access the configuration information from a shell 
-script. It is given pairs of arguments, the first being a shell 
-variable and the second the configuration value to query. As output 
-it lists a series of shell assignments commands for each present value. 
-In a shell script it should be used like:
-
-
+Used to access the configuration information from a shell script.  It is
+given pairs of arguments, the first being a shell variable and the second
+the configuration value to query.  As output it lists a series of shell
+assignments commands for each present value. In a shell script it should be
+used like:
+.IP
 .nf
 OPTS="-f"
 RES=`apt-config shell OPTS MyApp::Options`
 eval $RES
 .fi
-
+.IP
 This will set the shell environment variable $OPTS to the value of
-MyApp::Options with a default of \fB-f\fR\&.
+\fIMyApp::Options\fR with a default of \fB-f\fR. .IP The configuration item
+may be postfixed with a /[fdbi].  \fBf\fR returns file names, \fBd\fR
+returns directories, \fBb\fR returns true or false and \fBi\fR returns an
+integer.  Each of the returns is normalized and verified internally.
 
-The configuration item may be postfixed with a /[fdbi]. f returns file
-names, d returns directories, b returns true or false and i returns an 
-integer. Each of the returns is normalized and verified internally.
 .TP
 \fBdump\fR
-Just show the contents of the configuration space.
+Shows the contents of the configuration space.
+
 .SH "OPTIONS"
-.PP
-All command line options may be set using the configuration file, the
-descriptions indicate the configuration option to set. For boolean
+All command-line options may be set using the configuration file, the
+descriptions indicate the configuration option to set.  For boolean
 options you can override the config file by using something like 
 \fB-f-\fR,\fB--no-f\fR, \fB-f=no\fR or several other variations.
+
 .TP
-\fB-h\fR
-.TP
-\fB--help\fR
+\fB-h\fR, \fB--help\fR
 Show a short usage summary.
+
 .TP
-\fB-v\fR
-.TP
-\fB--version\fR
+\fB-v\fR, \fB--version\fR
 Show the program version.
+
 .TP
-\fB-c\fR
-.TP
-\fB--config-file\fR
-Configuration File; Specify a configuration file to use. 
+\fB-c\fR, \fB--config-file\fR
+Configuration File.  Specify a configuration file to use.  
 The program will read the default configuration file and then this 
-configuration file. See \fB\fIapt.conf\fB\fR(5) for syntax information.     
-.TP
-\fB-o\fR
+configuration file.  See \fIapt.conf\fR(5) for syntax information.      
+
 .TP
-\fB--option\fR
-Set a Configuration Option; This will set an arbitrary configuration 
-option. The syntax is \fB-o Foo::Bar=bar\fR\&.
+\fB-o\fR, \fB--option\fR
+Set a Configuration Option.  This will set an arbitrary configuration 
+option.  The syntax is \fB-o Foo::Bar=bar\fR.
+
 .SH "SEE ALSO"
-.PP
-\fB\fIapt.conf\fB\fR(5)
+\fIapt.conf\fR(5)
+
 .SH "DIAGNOSTICS"
-.PP
 \fBapt-config\fR returns zero on normal operation, decimal 100 on error.
+
 .SH "BUGS"
-.PP
-Reporting bugs in APT-RPM is best done in the 
-APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>\&.
+Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist at
+http://apt-rpm.org/mailinglist.shtml.
+
 .SH "AUTHOR"
-.PP
-Maintainer and contributor information can be found in the
-credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.
+Maintainer and contributor information can be found in the credits page
+http://apt-rpm.org/about.shtml of APT-RPM.
index 80bbea9..71ba86e 100644 (file)
-.\" This manpage has been automatically generated by docbook2man 
-.\" from a DocBook document.  This tool can be found at:
-.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
-.\" Please send any bug reports, improvements, comments, patches, 
-.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "APT-GET" "8" "08 June 2006" "" ""
-
+.TH "APT-GET" 8 "14 Jun 2006" "APT-RPM" "apt-get"
 .SH NAME
-apt-get \- APT package handling utility -- command-line interface
-.SH SYNOPSIS
-
-\fBapt-get\fR [ \fB-hvs\fR ] [ \fB-o=\fIconfig string\fB\fR ] [ \fB-c=\fIfile\fB\fR ] { \fBupdate\fR | \fBupgrade\fR | \fBinstall  \fIpkg\fB\fI ...\fB\fR | \fBremove  \fIpkg\fB\fI ...\fB\fR | \fBsource  \fIpkg\fB\fI ...\fB\fR | \fBbuild-dep  \fIpkg\fB\fI ...\fB\fR | \fBcheck\fR | \fBclean\fR | \fBautoclean\fR }
+.LP
+apt-get - APT package handling utility - command-line interface
+.SH "SYNOPSIS"
+.nf
+\fBapt-get\fR [\fBoptions\fR] [\fB-o\fR \fIconfig\fR=\fIstring\fR] [\fB-c\fR=\fIcfgfile\fR] \fBcommand\fR [\fBpkg\fR]
+.fi
 
 .SH "DESCRIPTION"
-.PP
-\fBapt-get\fR is the command-line tool for handling packages, and may be 
-considered the user's "back-end" to other tools using the APT
-library.  Several "front-end" interfaces exist, such as synaptic and
-aptitude.
-.PP
-Unless the \fB-h\fR, or \fB--help\fR option is given, one of the
-commands below must be present.
+\fBapt-get\fR is the command-line tool for handling packages, and may be
+considered the user's "back-end" to other tools using the APT library.
+Several "front-end" interfaces exist, such as synaptic and aptitude.
+
+.SH "COMMANDS"
+Unless the \fB-h\fR, or \fB--help\fR option is given, one of the commands
+below must be present.
+
 .TP
 \fBupdate\fR
-update is used to resynchronize the package index files from
-their sources. The indexes of available packages are fetched from the
-location(s) specified in \fI/etc/apt/sources.list\fR\&.
-An update should always be 
-performed before an upgrade or dist-upgrade\&.
+Used to re-synchronize the package index files from their sources.  The
+indexes of available packages are fetched from the location(s) specified in
+\fI/etc/apt/sources.list\fR(5).  An update should always be performed before
+an upgrade or dist-upgrade.
+
 .TP
 \fBupgrade\fR
-upgrade is used to install the newest versions of all packages 
-currently installed on the system from the sources enumerated in
-\fI/etc/apt/sources.list\fR\&. Packages currently installed with 
-new versions available are retrieved and upgraded; under no circumstances 
-are currently installed packages removed, or packages not already installed 
-retrieved and installed. New versions of currently installed packages that 
-cannot be upgraded without changing the install status of another package 
-will be left at their current version. An update must be 
-performed first so that \fBapt-get\fR knows that new versions of packages are 
-available.
+Used to install the newest versions of all packages currently installed on
+the system from the sources enumerated in \fI/etc/apt/sources.list\fR(5). 
+Packages currently installed with new versions available are retrieved and
+upgraded; under no circumstances are currently installed packages removed,
+nor are packages that are not already installed retrieved and installed. 
+New versions of currently installed packages that cannot be upgraded without
+changing the install status of another package will be left at their current
+version.  An update must be performed first so that \fBapt-get\fR knows that
+new versions of packages are available.
+
 .TP
 \fBdist-upgrade\fR
-dist-upgrade, in addition to performing the function of 
-upgrade, also intelligently handles changing dependencies 
-with new versions of packages; \fBapt-get\fR has a "smart" conflict 
-resolution system, and it will attempt to upgrade the most important 
-packages at the expense of less important ones if necessary. 
-The \fI/etc/apt/sources.list\fR file contains a list of locations 
-from which to retrieve desired package files.
-See also \fBapt_preferences\fR(5) for a mechanism for
-overriding the general settings for individual packages.
-.TP
-\fBinstall\fR
-install is followed by one or more packages desired for 
-installation. Each package is a package name, not a fully qualified 
-filename (for instance, in a Fedora Core system, glibc would be the 
-argument provided, not glibc-2.4.8.i686.rpm). 
-All packages required 
-by the package(s) specified for installation will also be retrieved and 
-installed. The \fI/etc/apt/sources.list\fR file is used to locate 
-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 
-install. These latter features may be used to override decisions made by 
-apt-get's conflict resolution system.
-
-A specific version of a package can be selected for installation by 
-following the package name with an equals and the version of the package 
-to select. This will cause that version to be located and selected for
-install. Alternatively a specific distribution can be selected by 
-following the package name with a slash and the version of the 
-distribution or the Archive name (stable, testing, unstable).
-
-Both of the version selection mechanisms can downgrade packages and must
-be used with care.
-
-Finally, the \fBapt_preferences\fR(5) mechanism allows you to
-create an alternative installation policy for
-individual packages.
+In addition to performing the function of \fBupgrade\fR, this option also
+intelligently handles changing dependencies with new versions of packages;
+\fBapt-get\fR has a "smart" conflict resolution system, and it will attempt
+to upgrade the most important packages at the expense of less important
+ones, if necessary.
+.IP
+The \fI/etc/apt/sources.list\fR(5) file contains a list of locations from
+which to retrieve desired package files.  See also \fIapt_preferences\fR(5)
+for a mechanism for over-riding the general settings for individual packages.
 
+.TP
+\fBinstall\fR pkg(s)
+This option is followed by one or more packages desired for installation. 
+Each package is a package name, not a fully qualified filename (for
+instance, in a Fedora Core system, glibc would be the argument provided, not
+glibc-2.4.8.i686.rpm).
+.IP
+All packages required by the package(s) specified for installation will also
+be retrieved and installed.  The \fI/etc/apt/sources.list\fR(5) file is used
+to locate the repositories for the desired packages.  If a hyphen (\fB-\fR)
+is appended to the package name (with no intervening space), the identified
+package will be removed if it is currently installed.  Similarly a plus sign
+(\fB+\fR) can be used to designate a package to install.  These latter
+features may be used to override decisions made by \fBapt-get\fR's conflict
+resolution system.
+.IP
+A specific version of a package can be selected for installation by
+following the package name with an equals (\fB=\fR) and the version of the
+package to select.  This will cause that version to be located and selected
+for install.  Alternatively, a specific distribution can be selected by
+following the package name with a slash (\fB/\fR) and the version of the
+distribution or the Archive name (i.e.  stable, testing, unstable).
+.IP
+Both of the version selection mechanisms can downgrade packages and must be
+used with care.
+.IP
+Finally, the \fIapt_preferences\fR(5) mechanism allows you to create an
+alternative installation policy for individual packages.
+.IP
 If no package matches the given expression and the expression contains one
-of '.', '?' or '*' then it is assumed to be a POSIX regular expression,
-and it is applied
-to all package names in the database. Any matches are then installed (or
-removed). Note that matching is done by substring so 'lo.*' matches 'how-lo'
-and 'lowest'. If this is undesired, anchor the regular expression
-with a '^' or '$' character, or create a more specific regular expression.
-.TP
-\fBremove\fR
-remove is identical to install except that packages are 
-removed instead of installed. If a plus sign is appended to the package 
-name (with no intervening space), the identified package will be 
-installed instead of removed.
-.TP
-\fBsource\fR
-source causes \fBapt-get\fR to fetch source packages. APT 
-will examine the available packages to decide which source package to 
-fetch. It will then find and download into the current directory the 
-newest available version of that source package. Source packages are 
-tracked separately from binary packages via rpm-src type lines 
-in the \fB\fIsources.list\fB\fR(5) file. This probably will mean that you will not 
-get the same source as the package you have installed or as you could 
-install. If the --compile options is specified then the package will be 
-compiled to a binary using rpmbuild, if --download-only is 
-specified then the source package will not be unpacked.
-
-A specific source version can be retrieved by postfixing the source name
-with an equals and then the version to fetch, similar to the mechanism
-used for the package files. This enables exact matching of the source 
-package name and version, implicitly enabling the 
-APT::Get::Only-Source option.
-
-Note that source packages are not tracked like binary packages, they 
-exist only in the current directory and are similar to downloading source
-tar balls.
-.TP
-\fBbuild-dep\fR
-build-dep causes apt-get to install/remove packages in an 
-attempt to satisfy the build dependencies for a source package.
+of ".", "?" or "*" then it is assumed to be a POSIX regular expression, and
+it is applied to all package names in the database.  Any matches are then
+installed (or removed).  Note that matching is done by substring so "lo.*"
+matches "how-lo" and "lowest".  If this is undesired, anchor the regular
+expression with a "^" or "$" character, or create a more specific regular
+expression.
+
+.TP
+\fBremove\fR pkg(s)
+Identical to \fBinstall\fR except that packages are removed instead of
+installed. If a plus sign (\fB+\fR) is appended to the package name (with no
+intervening space), the identified package will be installed instead of
+removed.
+
+.TP
+\fBsource\fR source_pkg
+Causes \fBapt-get\fR to fetch source packages.  APT will examine the
+available packages to decide which source package to fetch.  It will then
+find and download into the current directory the newest available version of
+that source package.  Source packages are tracked separately from binary
+packages via \fIrpm-src\fR type lines in the \fIsources.list\fR(5) file. 
+This probably will mean that you will not get the same source as the package
+you have installed, or could install.  If the \fB--compile\fR options is
+specified then the package will be compiled to a binary using
+\fBrpmbuild\fR, if \fB--download-only\fR is specified then the source
+package will not be unpacked.
+.IP
+A specific source version can be retrieved by following the source name with
+an equals (\fB=\fR) and then the version to fetch, similar to the mechanism
+used for the package files.  This enables exact matching of the source
+package name and version, implicitly enabling the
+\fIAPT::Get::Only-Source\fR option.
+.IP
+Note that source packages are not tracked like binary packages, they exist
+only in the current directory and are similar to downloading source tar
+balls.
+
+.TP
+\fBbuild-dep\fR source_pkg
+Causes \fBapt-get\fR to install/remove packages in an attempt to satisfy the
+build dependencies for a source package.
+
 .TP
 \fBcheck\fR
-check is a diagnostic tool; it updates the package cache and checks 
-for broken dependencies.
+Diagnostic tool; it updates the package cache and checks for broken
+dependencies.
+
 .TP
 \fBclean\fR
-clean clears out the local repository of retrieved package 
-files. It removes everything but the lock file from 
-\fI/var/cache/apt/archives/\fR and 
-\fI/var/cache/apt/archives/partial/\fR\&. 
+Clears out the local repository of retrieved package files.  It removes
+everything but the lock file from \fI/var/cache/apt/archives/\fR and
+\fI/var/cache/apt/archives/partial/\fR.
+
 .TP
 \fBautoclean\fR
-Like clean, autoclean clears out the local 
-repository of retrieved package files. The difference is that it only 
-removes package files that can no longer be downloaded, and are largely 
-useless. This allows a cache to be maintained over a long period without 
-it growing out of control. The configuration option 
-APT::Clean-Installed will prevent installed packages from being
-erased if it is set to off.
+Like \fBclean\fR, \fBautoclean\fR clears out the local repository of
+retrieved package files.  The difference is that it only removes package
+files that can no longer be downloaded, and are largely useless.  This
+allows a cache to be maintained over a long period of time without it
+growing out of control.  The configuration option \fIAPT::Clean-Installed\fR
+will prevent installed packages from being erased if it is set to off.
+
 .SH "OPTIONS"
-.PP
-All command line options may be set using the configuration file, the
-descriptions indicate the configuration option to set. For boolean
-options you can override the config file by using something like 
-\fB-f-\fR,\fB--no-f\fR, \fB-f=no\fR or several other variations.
-.TP
-\fB-d\fR
+.LP
+All command-line options may be set using the configuration file, the
+descriptions indicate the configuration option to set.  For boolean options
+you can override the config file by using something like \fB-f-\fR,
+\fB--no-f\fR, \fB-f=no\fR or several other variations.
+
 .TP
-\fB--download-only\fR
+\fB-d\fR, \fB--download-only\fR
 Download only; package files are only retrieved, not unpacked or installed.
-Configuration Item: APT::Get::Download-Only\&.
-.TP
-\fB-f\fR
-.TP
-\fB--fix-broken\fR
-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 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 
-Use of this option together with \fB-m\fR may produce an
-error in some situations. 
-Configuration Item: APT::Get::Fix-Broken\&.
-.TP
-\fB-m\fR
-.TP
-\fB--ignore-missing\fR
-.TP
-\fB--fix-missing\fR
-Ignore missing packages; If packages cannot be retrieved or fail the    
-integrity check after retrieval (corrupted package files), hold back    
-those packages and handle the result. Use of this option together with  
-\fB-f\fR may produce an error in some situations. If a package is 
-selected for installation (particularly if it is mentioned on the 
-command line) and it could not be downloaded then it will be silently 
-held back.
-Configuration Item: APT::Get::Fix-Missing\&.
-.TP
-\fB--no-download\fR
-Disables downloading of packages. This is best used with 
-\fB--ignore-missing\fR to force APT to use only the .rpms it has 
-already downloaded.
-Configuration Item: APT::Get::Download\&.
-.TP
-\fB-q\fR
-.TP
-\fB--quiet\fR
-Quiet; produces output suitable for logging, omitting progress indicators.
-More q's will produce more quiet up to a maximum of 2. You can also use
-\fB-q=#\fR to set the quiet level, overriding the configuration file. 
-Note that quiet level 2 implies \fB-y\fR, you should never use -qq 
-without a no-action modifier such as -d, --print-uris or -s as APT may 
-decided to do something you did not expect.
-Configuration Item: quiet\&.
-.TP
-\fB-s\fR
-.TP
-\fB--simulate\fR
-.TP
-\fB--just-print\fR
-.TP
-\fB--dry-run\fR
-.TP
-\fB--recon\fR
+.IP
+Configuration Item: \fIAPT::Get::Download-Only\fR.
+
 .TP
-\fB--no-act\fR
-No action; perform a simulation of events that would occur but do not
-actually change the system. 
-Configuration Item: APT::Get::Simulate\&.
+\fB-f\fR, \fB--fix-broken\fR
+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 solution.  Any package(s) that are specified must
+completely correct the problem.  This 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. 
+Use of this option together with \fB-m\fR may produce an error in some
+situations.
+.IP
+Configuration Item: \fIAPT::Get::Fix-Broken\fR.
 
-Simulate prints out
-a series of lines each one representing an rpm operation, Configure (Conf),
-Remove (Remv), Unpack (Inst). Square brackets indicate broken packages with
-and empty set of square brackets meaning breaks that are of no consequence
-(rare).
 .TP
-\fB-y\fR
+\fB-m\fR, \fB--ignore-missing\fR, \fB--fix-missing\fR
+Ignore missing packages.  If packages cannot be retrieved or fail the
+integrity check after retrieval (corrupted package files), hold back those
+packages and handle the result.  Use of this option together with \fB-f\fR
+may produce an error in some situations.  If a package is selected for
+installation (particularly if it is mentioned on the command-line) and it
+could not be downloaded then it will be silently held back.
+.IP
+Configuration Item: \fIAPT::Get::Fix-Missing\fR.
+
 .TP
-\fB--yes\fR
+\fB--no-download\fR
+Disables downloading of packages.  This is best used with
+\fB--ignore-missing\fR to force APT to use only the rpms it has already
+downloaded.
+.IP
+Configuration Item: \fIAPT::Get::Download\fR.
+
 .TP
-\fB--assume-yes\fR
-Automatic yes to prompts; assume "yes" as answer to all prompts and run
-non-interactively. If an undesirable situation, such as changing a held
-package or removing an essential package occurs then apt-get 
-will abort. 
-Configuration Item: APT::Get::Assume-Yes\&.
+\fB-q\fR, \fB--quiet\fR
+Quiet.  Produces output suitable for logging, omitting progress indicators. 
+More \fBq\fR's will produce more quiet up to a maximum of two.  You can also
+use \fB-q=#\fR to set the quiet level, overriding the configuration file. 
+Note that quiet level 2 implies \fB-y\fR, you should never use \fB-qq\fR
+without a no-action modifier such as \fB-d\fR, \fB--print-uris\fR or
+\fB-s\fR as APT may decided to do something you did not expect.
+.IP
+Configuration Item: \fIquiet\fR.
+
 .TP
-\fB-u\fR
+\fB-s\fR, \fB--simulate\fR, \fB--just-print\fR, \fB--dry-run\fR, \fB--recon\fR, \fB--no-act\fR
+No action.  Perform a simulation of events that would occur but do not
+actually change the system.
+.IP
+Configuration Item: \fIAPT::Get::Simulate\fR.
+.IP
+Simulate prints out a series of lines, each one representing an rpm
+operation: Configure (Conf), Remove (Remv), Unpack (Inst).   Square
+brackets indicate broken packages with an empty set of square
+brackets meaning breaks that are of no consequence (rare).
+
 .TP
-\fB--show-upgraded\fR
-Show upgraded packages; Print out a list of all packages that are to be
-upgraded. 
-Configuration Item: APT::Get::Show-Upgraded\&.
+\fB-y\fR, \fB--yes\fR, \fB--assume-yes\fR
+Automatic yes to prompts.  Assume "yes" as answer to all prompts and run
+non-interactively.  If an undesirable situation, such as changing a held
+package or removing an essential package, occurs then \fBapt-get\fR will
+abort.
+.IP
+Configuration Item: \fIAPT::Get::Assume-Yes\fR.
+
 .TP
-\fB-V\fR
+\fB-u\fR, \fB--show-upgraded\fR
+Show upgraded packages.  Print out a list of all packages that are to be
+upgraded.
+.IP
+Configuration Item: \fIAPT::Get::Show-Upgraded\fR.
+
 .TP
-\fB--verbose-versions\fR
+\fB-V\fR, \fB--verbose-versions\fR
 Show full versions for upgraded and installed packages.
-Configuration Item: APT::Get::Show-Versions\&.
-.TP
-\fB-b\fR
-.TP
-\fB--compile\fR
+.IP
+Configuration Item: \fIAPT::Get::Show-Versions\fR.
+
 .TP
-\fB--build\fR
+\fB-b\fR, \fB--compile\fR, \fB--build\fR
 Compile source packages after downloading them.
-Configuration Item: APT::Get::Compile\&.
+.IP
+Configuration Item: \fIAPT::Get::Compile\fR.
+
 .TP
 \fB--ignore-hold\fR
-Ignore package Holds; This causes \fBapt-get\fR to ignore a hold 
-placed on a package. This may be useful in conjunction with 
-dist-upgrade to override a large number of undesired holds. 
-Configuration Item: APT::Ignore-Hold\&.
+Ignore package Holds.  This causes \fBapt-get\fR to ignore a hold placed on
+a package.  This may be useful in conjunction with dist-upgrade to override
+a large number of undesired holds.
+.IP
+Configuration Item: \fIAPT::Ignore-Hold\fR.
+
 .TP
 \fB--no-upgrade\fR
-Do not upgrade packages; When used in conjunction with install
-no-upgrade will prevent packages listed from being upgraded
-if they are already installed. 
-Configuration Item: APT::Get::Upgrade\&.
+Do not upgrade packages.  When used in conjunction with install, no-upgrade
+will prevent packages listed from being upgraded if they are already
+installed.
+.IP
+Configuration Item: \fIAPT::Get::Upgrade\fR.
+
 .TP
 \fB--force-yes\fR
-Force yes; This is a dangerous option that will cause apt to continue 
-without prompting if it is doing something potentially harmful. It 
-should not be used except in very special situations. Using 
-force-yes can potentially destroy your system! 
-Configuration Item: APT::Get::force-yes\&.
+Force yes.  This is a dangerous option that will cause \fBapt-get\fR to
+continue without prompting if it is doing something potentially harmful.  It
+should not be used except in very special situations.  Using
+\fB--force-yes\fR can potentially destroy your system!
+.IP
+Configuration Item: \fIAPT::Get::force-yes\fR.
+
 .TP
 \fB--print-uris\fR
-Instead of fetching the files to install their URIs are printed. Each
-URI will have the path, the destination file name, the size and the expected
-md5 hash. Note that the file name to write to will not always match
-the file name on the remote site! This also works with the 
-source and update commands. When used with the
-update command the MD5 and size are not included, and it is
-up to the user to decompress any compressed files.
-Configuration Item: APT::Get::Print-URIs\&.
-.TP
-\fB--purge\fR
-Use purge instead of remove for anything that would be removed.
-An asterisk ("*") will be displayed next to packages which are
-scheduled to be purged.
-Configuration Item: APT::Get::Purge\&.
+Instead of fetching the files to install, their URIs are printed.  Each URI
+will have the path, the destination file name, the size and the expected md5
+hash.  Note that the file name to write to will not always match the file
+name on the remote site! This also works with the source and update
+commands.  When used with the update command, the MD5 and size are not
+included, and it is up to the user to decompress any compressed files.
+.IP
+Configuration Item: \fIAPT::Get::Print-URIs\fR.
+
 .TP
 \fB--reinstall\fR
 Re-Install packages that are already installed and at the newest version.
-Configuration Item: APT::Get::ReInstall\&.
+.IP
+Configuration Item: \fIAPT::Get::ReInstall\fR.
+
 .TP
 \fB--list-cleanup\fR
-This option defaults to on, use --no-list-cleanup to turn it 
-off. When on \fBapt-get\fR will automatically manage the contents of 
-\fI/var/lib/apt/lists\fR to ensure that obsolete files are erased. 
-The only  reason to turn it off is if you frequently change your source 
-list. 
-Configuration Item: APT::Get::List-Cleanup\&.
-.TP
-\fB-t\fR
-.TP
-\fB--target-release\fR
+This option defaults to on, use \fB--no-list-cleanup\fR to turn it off. 
+When on, \fBapt-get\fR will automatically manage the contents of
+\fI/var/lib/apt/lists\fR to ensure that obsolete files are erased.  The only
+reason to turn it off is if you frequently change your source list.
+.IP
+Configuration Item: \fIAPT::Get::List-Cleanup\fR.
+
 .TP
-\fB--default-release\fR
-This option controls the default input to the policy engine, it creates
-a default pin at priority 990 using the specified release string. The
-preferences file may further override this setting. In short, this option
+\fB-t\fR, \fB--target-release\fR, \fB--default-release\fR
+This option controls the default input to the policy engine.  It creates a
+default pin at priority 990 using the specified release string.  The
+preferences file may further override this setting.  In short, this option
 lets you have simple control over which distribution packages will be
-retrieved from. Some common examples might be 
-\fB-t '2.1*'\fR or \fB-t unstable\fR\&.
-Configuration Item: APT::Default-Release;
-see also the \fBapt_preferences\fR(5) manual page.
+retrieved from.  Some common examples might be \fB-t '2.1*'\fR or \fB-t
+unstable\fR.
+.IP
+Configuration Item: \fIAPT::Default-Release\fR; see also the
+\fIapt_preferences\fR(5) manual page.
+
 .TP
 \fB--trivial-only\fR
-Only perform operations that are 'trivial'. Logically this can be considered
-related to \fB--assume-yes\fR, where \fB--assume-yes\fR will answer 
-yes to any prompt, \fB--trivial-only\fR will answer no. 
-Configuration Item: APT::Get::Trivial-Only\&.
+Only perform operations that are "trivial".  Logically this can be
+considered related to \fB--assume-yes\fR.  Where \fB--assume-yes\fR will
+answer yes to any prompt, \fB--trivial-only\fR will answer no.
+.IP
+Configuration Item: fIAPT::Get::Trivial-Only\fR.
+
 .TP
 \fB--no-remove\fR
-If any packages are to be removed apt-get immediately aborts without
-prompting. 
-Configuration Item: APT::Get::Remove
+If any packages are to be removed \fBapt-get\fR immediately aborts without
+prompting.
+.IP
+Configuration Item: \fIAPT::Get::Remove\fR.
+
 .TP
 \fB--only-source\fR
-Only has meaning for the source command.  Indicates that the
-given source names are not to be mapped through the binary
-table.  This means that if this option is specified, the
-source command will only accept source package names as
-arguments, rather than accepting binary package names and looking
+Only has meaning for the source command.  Indicates that the given source
+names are not to be mapped through the binary table.  This means that if
+this option is specified, the source command will only accept source package
+names as arguments, rather than accepting binary package names and looking
 up the corresponding source package.
-Configuration Item: APT::Get::Only-Source
-.TP
-\fB--diff-only\fR
-.TP
-\fB--tar-only\fR
-Download only the diff or tar file of a source archive. 
-Configuration Item: APT::Get::Diff-Only and 
-APT::Get::Tar-Only
-.TP
-\fB--arch-only\fR
-Only process architecture-dependent build-dependencies.
-Configuration Item: APT::Get::Arch-Only 
-.TP
-\fB--root\fR
-Install to alternate root directory. For example
-\fB--root /mnt/buildsys-fc4\fR\&.
-Configuration Item: RPM::RootDir;
-.TP
-\fB-h\fR
+.IP
+Configuration Item: \fIAPT::Get::Only-Source\fR.
+
 .TP
-\fB--help\fR
+\fB-h\fR, \fB--help\fR
 Show a short usage summary.
+
 .TP
-\fB-v\fR
-.TP
-\fB--version\fR
+\fB-v\fR, \fB--version\fR
 Show the program version.
+
 .TP
-\fB-c\fR
-.TP
-\fB--config-file\fR
-Configuration File; Specify a configuration file to use. 
-The program will read the default configuration file and then this 
-configuration file. See \fB\fIapt.conf\fB\fR(5) for syntax information.     
-.TP
-\fB-o\fR
+\fB-c\fR, \fB--config-file\fR
+Configuration File.  Specify a configuration file to use.  The program will
+read the default configuration file and then this configuration file.  See
+\fBapt.conf\fR(5) for syntax information.
+
 .TP
-\fB--option\fR
-Set a Configuration Option; This will set an arbitrary configuration 
-option. The syntax is \fB-o Foo::Bar=bar\fR\&.
+\fB-o\fR, \fB--option\fR
+Set a Configuration Option.  This will set an arbitrary configuration
+option.  The syntax is \fI-o Foo::Bar=bar\fR.
+
 .SH "FILES"
+
 .TP
-\fB\fI/etc/apt/sources.list\fB\fR
+\fI/etc/apt/sources.list\fR
 Locations to fetch packages from.
-Configuration Item: Dir::Etc::SourceList\&.
+.IP
+Configuration Item: \fIDir::Etc::SourceList\fR.
+
 .TP
-\fB\fI/etc/apt/apt.conf\fB\fR
+\fI/etc/apt/apt.conf\fR
 APT configuration file.
-Configuration Item: Dir::Etc::Main\&.
+.IP
+Configuration Item: \fIDir::Etc::Main\fR.
+
 .TP
-\fB\fI/etc/apt/apt.conf.d/\fB\fR
-APT configuration file fragments
-Configuration Item: Dir::Etc::Parts\&.
+\fI/etc/apt/apt.conf.d/\fR
+APT configuration file fragments.
+.IP
+Configuration Item: \fIDir::Etc::Parts\fR.
+
 .TP
-\fB\fI/etc/apt/preferences\fB\fR
-Version preferences file.
-This is where you would specify "pinning",
-i.e. a preference to get certain packages
-from a separate source
-or from a different version of a distribution.
-Configuration Item: Dir::Etc::Preferences\&.
+\fI/etc/apt/preferences\fR
+Version preferences file.  This is where you would specify "pinning", i.e. 
+a preference to get certain packages from a separate source or from a
+different version of a distribution.
+.IP
+Configuration Item: \fIDir::Etc::Preferences\fR.
+
 .TP
-\fB\fI/var/cache/apt/archives/\fB\fR
+\fI/var/cache/apt/archives/\fR
 Storage area for retrieved package files.
-Configuration Item: Dir::Cache::Archives\&.
+.IP
+Configuration Item: \fIDir::Cache::Archives\fR.
+
 .TP
-\fB\fI/var/cache/apt/archives/partial/\fB\fR
+\fI/var/cache/apt/archives/partial/\fR
 Storage area for package files in transit.
-Configuration Item: Dir::Cache::Archives (implicit partial). 
+.IP
+Configuration Item: \fIDir::Cache::Archives\fR (implicit partial).
+
 .TP
-\fB\fI/var/lib/apt/lists/\fB\fR
+\fI/var/lib/apt/lists/\fR
 Storage area for state information for each package resource specified in
-\fB\fIsources.list\fB\fR(5)
-Configuration Item: Dir::State::Lists\&.
+\fIsources.list\fR(5).
+.IP
+Configuration Item: \fIDir::State::Lists\fR.
+
 .TP
-\fB\fI/var/lib/apt/lists/partial/\fB\fR
+\fI/var/lib/apt/lists/partial/\fR
 Storage area for state information in transit.
-Configuration Item: Dir::State::Lists (implicit partial).
+.IP
+Configuration Item: \fIDir::State::Lists\fR (implicit partial).
+
 .SH "SEE ALSO"
-.PP
-\fBapt-cache\fR(8), \fBapt-cdrom\fR(8), \fB\fIsources.list\fB\fR(5),
-\fB\fIapt.conf\fB\fR(5), \fBapt-config\fR(8),
-The APT User's guide in /usr/share/doc/apt/, \fBapt_preferences\fR(5), the APT Howto.
+\fBapt-cache\fR(8), \fBapt-cdrom\fR(8), \fIsources.list\fR(5),
+\fIapt.conf\fR(5),
+.br
+\fBapt-config\fR(8), \fIapt_preferences\fR(5)
+
 .SH "DIAGNOSTICS"
-.PP
 \fBapt-get\fR returns zero on normal operation, decimal 100 on error.
+
 .SH "BUGS"
-.PP
-Reporting bugs in APT-RPM is best done in the 
-APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>\&.
+Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist at
+http://apt-rpm.org/mailinglist.shtml.
+
 .SH "AUTHOR"
-.PP
-Maintainer and contributor information can be found in the
-credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.
+Maintainer and contributor information can be found in the credits page
+http://apt-rpm.org/about.shtml of APT-RPM.
index f628460..1c230e7 100644 (file)
--- a/doc/apt.8
+++ b/doc/apt.8
@@ -1,50 +1,21 @@
-.\" This manpage is copyright (C) 1998 Branden Robinson <branden@debian.org>.
-.\" 
-.\" This is free software; you may redistribute it and/or modify
-.\" it under the terms of the GNU General Public License as
-.\" published by the Free Software Foundation; either version 2,
-.\" or (at your option) any later version.
-.\"
-.\" This is distributed in the hope that it will be useful, but
-.\" WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-.\" GNU General Public License for more details.
-.\"
-.\" You should have received a copy of the GNU General Public
-.\" License along with APT; if not, write to the Free Software
-.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
-.\" 02111-1307 USA
-.TH apt 8 "16 June 1998" "Debian GNU/Linux"
+.TH "APT" 8 "14 Jun 2006" "APT-RPM" "apt"
 .SH NAME
-apt \- Advanced Package Tool
-.SH SYNOPSIS
-.B apt
+apt - Advanced Package Tool
+
 .SH DESCRIPTION
-APT is a management system for software packages.  It is still
-under development; the snazzy front ends are not yet available.  In the
-meantime, please see
-.BR apt-get (8).
-.SH OPTIONS
-None.
-.SH FILES
-None.
+APT is a management system for software packages.  Originally written for Debian and the deb package format, APT was ported and became APT-RPM to manage the \fBrpm\fR(8) package format.  APT-RPM can be used by any RPM-based distribution, such as Conectiva, Red Hat, SUSE, ALT-Linux, etc.
+.LP
+For further information on how to use APT, refer to \fBapt-get\fR(8) or visit http://apt-rpm.org/.
+
 .SH SEE ALSO
-.BR apt-cache (8),
-.BR apt-get (8),
-.BR apt.conf (5),
-.BR sources.list (5)
-.SH DIAGNOSTICS
-apt returns zero on normal operation, decimal 100 on error.
-.SH BUGS
-This manpage isn't even started.
-.PP
-See <http://bugs.debian.org/apt>.  If you wish to report a
-bug in
-.BR apt ,
-please see
-.I /usr/share/doc/debian/bug-reporting.txt
-or the
-.BR bug (1)
-command.
-.SH AUTHOR
-apt was written by the APT team <apt@packages.debian.org>.
+\fBapt-cache\fR(8), \fBapt-get\fR(8), \fBapt-cdrom\fR(8),
+\fIsources.list\fR(5), \fIapt.conf\fR(5), \fBapt-config\fR(8),
+\fIapt_preferences\fR(5)
+
+.SH "BUGS"
+Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist at
+http://apt-rpm.org/mailinglist.shtml.
+
+.SH "AUTHOR"
+Maintainer and contributor information can be found in the credits page
+http://apt-rpm.org/about.shtml of APT-RPM.
index 5e0e42b..b2f873c 100644 (file)
@@ -1,44 +1,35 @@
-.\" This manpage has been automatically generated by docbook2man 
-.\" from a DocBook document.  This tool can be found at:
-.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
-.\" Please send any bug reports, improvements, comments, patches, 
-.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "APT.CONF" "5" "08 June 2006" "" ""
-
+.TH "APT.CONF" 5 "14 Jun 2006" "APT-RPM" "apt.conf"
 .SH NAME
-apt.conf \- Configuration file for APT
+apt.conf - Configuration file for APT
+
 .SH "DESCRIPTION"
-.PP
-\fIapt.conf\fR is the main configuration file for the APT suite of
-tools, all tools make use of the configuration file and a common command line
+\fIapt.conf\fR 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
-read the configuration specified by the \fBAPT_CONFIG\fR environment 
-variable (if any) and then read the files in Dir::Etc::Parts 
-then read the main configuration file specified by 
-Dir::Etc::main then finally apply the
-command line options to override the configuration directives, possibly 
-loading even more config files.
-.PP
+read the configuration specified by the \fBAPT_CONFIG\fR environment
+variable (if any) and then read the files in \fIDir::Etc::Parts\fR then read
+the main configuration file specified by \fIDir::Etc::main\fR then finally
+apply the command-line options to override the configuration directives,
+possibly loading even more config files.
+.LP
 The configuration file is organized in a tree with options organized into
 functional groups. Option specification is given with a double colon
-notation, for instance APT::Get::Assume-Yes is an option within 
-the APT tool group, for the Get tool. Options do not inherit from their 
-parent groups.
-.PP
-Syntacticly the configuration language is modeled after what the ISC tools
-such as bind and dhcp use.  Lines starting with
-// are treated as comments (ignored).  Each line is of the form
-
+notation, for instance \fIAPT::Get::Assume-Yes\fR is an option within the
+\fIAPT\fR tool group, for the \fIGet\fR tool. Options do not inherit from
+their parent groups.
+.LP
+Syntacticly, the configuration language is modeled after what the ISC tools
+such as bind and dhcp use.  Lines starting with \fB//\fR are treated as
+comments (ignored).  Each line is of the form:
+.IP
 .nf
 APT::Get::Assume-Yes "true";
 .fi
-The trailing 
-semicolon is required and the quotes are optional. A new scope can be
-opened with curly braces, like:
-.PP
-
+.LP
+The trailing semicolon is required and the quotes are optional. A new scope
+can be opened with curly braces, like:
+.IP
 .nf
-   
 APT {
   Get {
     Assume-Yes "true";
@@ -46,281 +37,285 @@ APT {
   };
 };
 .fi
-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 separated by a semicolon.
-.PP
-
+.LP
+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 separated by a semicolon:
+.IP
 .nf
-   
 RPM::Allow-Duplicated {"kernel"; "kernel-smp";};
 .fi
-.PP
-In general the sample configuration file in 
-\fI/usr/share/doc/apt/examples/apt.conf\fR \fI/usr/share/doc/apt/examples/configure-index.gz\fR
-is a good guide for how it should look.
-.PP
-Two specials are allowed, #include and #clear\&. 
-#include will include the given file, unless the filename
-ends in a slash, then the whole directory is included.  
-#clear is used to erase a list of names.
-.PP
-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 (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.   
+.LP
+In general the sample configuration file in
+\fI/usr/share/doc/apt/examples/apt.conf\fR and
+\fI/usr/share/doc/apt/examples/configure-index.gz\fR are good guides for how
+it should look.
+.LP
+Two specials are allowed, #include and #clear. #include will include the
+given file, unless the filename ends in a slash, then the whole directory is
+included. #clear is used to erase a list of names.
+.LP
+All of the APT tools take a \fB-o\fR option which allows an arbitrary
+configuration directive to be specified on the command line. The syntax is a
+full option name (\fIAPT::Get::Assume-Yes\fR for instance) followed by an
+equals sign (\fB=\fR) then the new value of the option. Lists can be
+appended too by adding a trailing :: to the list name.
+
 .SH "THE APT GROUP"
-.PP
 This group of options controls general APT behavior as well as holding the
 options for all of the tools.
+
 .TP
 \fBArchitecture\fR
-System Architecture; sets the architecture to use when fetching files and
-parsing package lists. The internal default is the architecture apt was 
+System Architecture.  Sets the architecture to use when fetching files and
+parsing package lists. The internal default is the architecture apt was
 compiled for.
+
 .TP
 \fBIgnore-Hold\fR
-Ignore Held packages; This global option causes the problem resolver to
+Ignore Held packages This global option causes the problem resolver to
 ignore held packages in its decision making. 
+
 .TP
 \fBClean-Installed\fR
-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.
+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.
+
 .TP
 \fBForce-LoopBreak\fR
-Never Enable this option unless you -really- know what you are doing. It
+Never Enable this option unless you \fBreally\fR 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 
+packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option
 will work if the essential packages are not gzip, libc, rpm, bash or
 anything that those packages depend on.
+
 .TP
 \fBCache-Limit\fR
 APT uses a fixed size memory mapped cache file to store the 'available'
 information. This sets the size of that cache.
+
 .TP
 \fBBuild-Essential\fR
 Defines which package(s) are considered essential build dependencies.
+
 .TP
 \fBGet\fR
 The Get subsection controls the \fBapt-get\fR(8) tool, please see its
 documentation for more information about the options here.
+
 .TP
 \fBCache\fR
 The Cache subsection controls the \fBapt-cache\fR(8) tool, please see its
 documentation for more information about the options here.
+
 .TP
 \fBCDROM\fR
 The CDROM subsection controls the \fBapt-cdrom\fR(8) tool, please see its
 documentation for more information about the options here.
+
 .SH "THE ACQUIRE GROUP"
-.PP
-The Acquire group of options controls the download of packages 
-and the URI handlers. 
+The Acquire group of options controls the download of packages and the URI
+handlers. 
+
 .TP
 \fBQueue-Mode\fR
-Queuing mode; Queue-Mode can be one of host or 
-access which determines how  APT parallelizes outgoing 
-connections. host means that one connection per target host 
-will be opened, access means that one connection per URI type 
-will be opened.
+Queuing mode.  Queue-Mode can be one of \fIhost\fR or \fIaccess\fR which
+determines how APT parallelizes outgoing connections. host means that one
+connection per target host will be opened, access means that one connection
+per URI type will be opened.
+
 .TP
 \fBRetries\fR
-Number of retries to perform. If this is non-zero APT will retry failed 
+Number of retries to perform. If this is non-zero APT will retry failed
 files the given number of times.
+
 .TP
 \fBSource-Symlinks\fR
 Use symlinks for source archives. If set to true then source archives will
 be symlinked when possible instead of copying. True is the default
+
 .TP
 \fBhttp\fR
-HTTP URIs; http::Proxy is the default http proxy to use. It is in the 
-standard form of http://[[user][:pass]@]host[:port]/\&. Per 
-host proxies can also be specified by using the form 
-http::Proxy::<host> with the special keyword DIRECT 
-meaning to use no proxies. The \fBhttp_proxy\fR environment variable
-will override all settings.
-
-Three settings are provided for cache control with HTTP/1.1 compliant 
-proxy caches. No-Cache tells the proxy to not use its cached 
-response under any circumstances, 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 
-default is 1 day. No-Store specifies that the cache should never 
-store this request, it is only set for archive files. This may be useful 
-to prevent polluting a proxy cache with very large .deb files. Note: 
-Squid 2.0.2 does not support any of these options.
-
-The option timeout sets the timeout timer used by the method, 
-this applies to all things including connection timeout and data timeout.
-
+HTTP URIs.  \fIhttp::Proxy\fR is the default http proxy to use. It is in the
+standard form of http://[[user][:pass]@]host[:port]/. Per-host proxies can
+also be specified by using the form \fIhttp::Proxy::<host>\fR with the
+special keyword DIRECT meaning to use no proxies. The "http_proxy"
+environment variable will override all settings.
+.IP
+Three settings are provided for cache control with HTTP/1.1 compliant proxy
+caches. \fINo-Cache\fR tells the proxy to not use its cached response under
+any circumstances, \fIMax-Age\fR is sent only for index files and tells the
+cache to refresh its object if it is older than the given number of seconds;
+the default is 1 day.  \fINo-Store\fR specifies that the cache should never
+store this request, it is only set for archive files. This may be useful to
+prevent polluting a proxy cache with very large .rpm files. Note: Squid
+2.0.2 does not support any of these options.
+.IP
+The option timeout sets the timeout timer used by the method, this applies
+to all things including connection timeout and data timeout.
+.IP
 One setting is provided to control the pipeline depth in cases where the
 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. A value of
-zero MUST be specified if the remote host does not properly linger
-on TCP connections - otherwise data corruption will occur. Hosts which
-require this are in violation of RFC 2068.     
+\fIAcquire::http::Pipeline-Depth\fR 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 occur. Hosts which require this are in
+violation of RFC 2068.
+
 .TP
 \fBftp\fR
-FTP URIs; ftp::Proxy is the default proxy server to use. It is in the 
-standard form of ftp://[[user][:pass]@]host[:port]/ and is 
-overridden by the \fBftp_proxy\fR 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 
-\fI/usr/share/doc/apt/examples/configure-index.gz\fR 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.
-
-The option timeout sets the timeout timer used by the method, 
-this applies to all things including connection timeout and data timeout.
-
-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 \fBftp_proxy\fR
-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.
-
-The setting ForceExtended controls the use of RFC2428 
-EPSV and EPRT commands. The defaut 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.
+FTP URIs.  \fIftp::Proxy\fR is the default proxy server to use. It is in the
+standard form of ftp://[[user][:pass]@]host[:port]/ and is overridden by the
+"ftp_proxy" environment variable. To use a ftp proxy you will have to set
+the \fIftp::ProxyLogin\fR script in the configuration file. This entry
+specifies the commands to send to tell the proxy server what to connect to.
+Please see \fI/usr/share/doc/apt/examples/configure-index.gz\fR 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.
+.IP
+The option timeout sets the timeout timer used by the method, this applies
+to all things including connection timeout and data timeout.
+.IP
+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).
+.IP
+It is possible to proxy FTP over HTTP by setting the "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.
+.IP
+The setting \fIForceExtended\fR controls the use of RFC2428 EPSV and EPRT
+commands. The defaut 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.
+
 .TP
 \fBcdrom\fR
-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 \fI/etc/fstab\fR\&. 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 and old mount packages). The syntax 
-is to put 
-
+CDROM URIs.  The only setting for CDROM URIs is the mount point,
+\fIcdrom::Mount\fR which must be the mount point for the CDROM drive as
+specified in \fI/etc/fstab\fR. 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 and old mount packages). The syntax is to put:
+.IP
 .nf
 "/cdrom/"::Mount "foo";
 .fi
-within 
-the cdrom block. It is important to have the trailing slash. Unmount 
-commands can be specified using UMount.
+.IP
+within the cdrom block. It is important to have the trailing slash. Unmount
+commands can be specified using \fIUMount\fR.
+
 .SH "DIRECTORIES"
-.PP
-The Dir::State section has directories that pertain to local 
-state information. lists is the directory to place downloaded 
-package lists in.
-preferences is the name of the APT preferences file.
-Dir::State contains the default directory to prefix on all sub 
-items if they do not start with \fI/\fR or \fI\&./\fR\&. 
-.PP
-Dir::Cache contains locations pertaining to local cache 
-information, such as the two package caches srcpkgcache and 
-pkgcache as well as the location to place downloaded archives, 
-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
-than the srcpkgcache. Like Dir::State the default
-directory is contained in Dir::Cache
-.PP
-Dir::Etc contains the location of configuration files, 
-sourcelist gives the location of the sourcelist and 
-main is the default configuration file (setting has no effect,
-unless it is done from the config file specified by 
-\fBAPT_CONFIG\fR).
-.PP
-The Dir::Parts setting reads in all the config fragments in 
+The \fIDir::State\fR section has directories that pertain to local state
+information.  \fIlists\fR is the directory to place downloaded package lists
+in. \fIpreferences\fR is the name of the APT preferences file.
+\fIDir::State\fR contains the default directory to prefix on all sub items
+if they do not start with \fI/\fR or \fI./\fR. 
+.LP
+\fIDir::Cache\fR contains locations pertaining to local cache information,
+such as the two package caches srcpkgcache and pkgcache as well as the
+location to place downloaded archives, \fIDir::Cache::archives\fR.
+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 than the srcpkgcache. Like \fIDir::State\fR the
+default directory is contained in \fIDir::Cache\fR.
+.LP
+\fIDir::Etc\fR contains the location of configuration files, sourcelist
+gives the location of the sourcelist and main is the default configuration
+file (setting has no effect, unless it is done from the config file
+specified by the "APT_CONFIG" environment variable).
+.LP
+The \fIDir::Parts\fR setting reads in all the config fragments in 
 lexical order from the directory specified. After this is done then the
 main config file is loaded.
-.PP
-Binary programs are pointed to by Dir::Bin\&. Dir::Bin::Methods 
-specifies the location of the method handlers and gzip, 
-rpm, apt-get, rpmbuild
-and apt-cache specify the location
-of the respective programs.
+.LP
+Binary programs are pointed to by \fIDir::Bin\fR. \fIDir::Bin::Methods\fR
+specifies the location of the method handlers while \fIgzip\fR, \fIrpm\fR,
+\fIapt-get\fR, \fIrpmbuild\fR and \fIapt-cache\fR specify the location of
+their respective programs.
+
 .SH "HOW APT CALLS RPM"
-.PP
-Several configuration directives control how APT invokes \fBrpm\fR(8)\&. These are 
-in the RPM section.
+Several configuration directives control how APT invokes \fBrpm\fR(8). These
+are in the \fIRPM\fR section.
+
 .TP
 \fBOptions\fR
-This is a list of options to pass to rpm for all install, upgrade and
-remove operations. The options must be specified
-using the list notation and each list item is passed as a single argument
-to \fBrpm\fR(8)\&.
+This is a list of options to pass to \fBrpm\fR(8) for all install, upgrade
+and remove operations. The options must be specified using the list notation
+and each list item is passed as a single argument.
+
 .TP
 \fBInstall-Options\fR
-This is a list of options to pass to rpm during install and upgrade
-operations. The options must be specified
-using the list notation and each list item is passed as a single argument
-to \fBrpm\fR(8)\&.
+This is a list of options to pass to \fBrpm\fR(8) during install and upgrade
+operations. The options must be specified using the list notation and each
+list item is passed as a single argument.
+
 .TP
 \fBErase-Options\fR
-This is a list of options to pass to rpm during remove operations. 
-The options must be specified
-using the list notation and each list item is passed as a single argument
-to \fBrpm\fR(8)\&.
-.TP
-\fBPre-Invoke\fR
+This is a list of options to pass to \fBrpm\fR(8) during remove operations.
+The options must be specified using the list notation and each list item is
+passed as a single argument.
+
 .TP
-\fBPost-Invoke\fR
-This is a list of shell commands to run before/after invoking \fBrpm\fR(8)\&. 
-Like Options this must be specified in list notation. The 
-commands are invoked in order using \fI/bin/sh\fR, should any 
-fail APT will abort.
+\fBPre-Invoke\fR, \fBPost-Invoke\fR
+This is a list of shell commands to run before/after invoking \fBrpm\fR(8).
+Like \fIOptions\fR this must be specified in list notation. The commands are
+invoked in order using \fB/bin/sh\fR; should any fail APT will abort.
+
 .TP
 \fBPre-Install-Pkgs\fR
-This is a list of shell commands to run before invoking rpm. Like
-Options this must be specified in list notation. The commands
-are invoked in order using \fI/bin/sh\fR, should any fail APT 
-will abort. APT will pass to the commands on standard input the 
-filenames of all .rpm files it is going to install, one per line.
-
-Version 2 of this protocol dumps more information, including the 
-protocol version, the APT configuration space and the packages, files
-and versions being changed. Version 2 is enabled by setting 
-DPkg::Tools::Options::cmd::Version to 2. cmd is a
-command given to Pre-Install-Pkgs\&.
+This is a list of shell commands to run before invoking \fBrpm\fR(8). Like
+\fIOptions\fR this must be specified in list notation. The commands are
+invoked in order using \fB/bin/sh\fR; should any fail APT will abort. APT
+will pass to the commands on standard input the filenames of all .rpm files
+it is going to install, one per line.
+.IP
+.\" debianism... is this even valid here? (vdanen)
+Version 2 of this protocol dumps more information, including the protocol
+version, the APT configuration space and the packages, files and versions
+being changed. Version 2 is enabled by setting
+\fIDPkg::Tools::Options::cmd::Version\fR to 2. \fIcmd\fR is a command given
+to \fIPre-Install-Pkgs\fR.
+
 .TP
 \fBRun-Directory\fR
-APT chdirs to this directory before invoking rpm, the default is 
-\fI/\fR\&.
+APT chdirs to this directory before invoking \fBrpm\fR(8), the default is 
+\fI/\fR.
+
 .TP
 \fBBuild-Options\fR
-These options are passed to \fBrpmbuild\fR(1) when compiling packages.
+These options are passed to \fBrpmbuild\fR(8) when compiling packages.
+
 .SH "DEBUG OPTIONS"
-.PP
-Most of the options in the debug section are not interesting to 
-the normal user, however Debug::pkgProblemResolver shows 
-interesting output about the decisions dist-upgrade makes. 
-Debug::NoLocking disables file locking so APT can do some 
-operations as non-root and Debug::pkgRPMPM will print out the 
-command line for each rpm invokation. Debug::IdentCdrom will 
-disable the inclusion of statfs data in CDROM IDs.
+Most of the options in the debug section are not interesting to the normal
+user, however \fIDebug::pkgProblemResolver\fR shows interesting output about
+the decisions \fBapt-get dist-upgrade\fR makes. \fIDebug::NoLocking\fR
+disables file locking so APT can do some operations as non-root and
+\fIDebug::pkgRPMPM\fR will print out the command-line for each \fBrpm\fR(8)
+invocation. \fIDebug::IdentCdrom\fR will disable the inclusion of statfs
+data in CDROM IDs.
+
 .SH "EXAMPLES"
-.PP
 \fI/usr/share/doc/apt/examples/configure-index.gz\fR contains a 
 sample configuration file showing the default values for all possible 
 options.
+
 .SH "FILES"
-.PP
 \fI/etc/apt/apt.conf\fR
+
 .SH "SEE ALSO"
-.PP
-\fBapt-cache\fR(8), \fBapt-config\fR(8), \fBapt_preferences\fR(5)\&.
+\fBapt-cache\fR(8), \fBapt-config\fR(8), \fIapt_preferences\fR(5).
+
 .SH "BUGS"
-.PP
-Reporting bugs in APT-RPM is best done in the 
-APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>\&.
+Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist at
+http://apt-rpm.org/mailinglist.shtml.
+
 .SH "AUTHOR"
-.PP
-Maintainer and contributor information can be found in the
-credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.
+Maintainer and contributor information can be found in the credits page
+http://apt-rpm.org/about.shtml of APT-RPM.
index 7238807..c64c745 100644 (file)
@@ -1,53 +1,46 @@
-.\" This manpage has been automatically generated by docbook2man 
-.\" from a DocBook document.  This tool can be found at:
-.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
-.\" Please send any bug reports, improvements, comments, patches, 
-.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "APT_PREFERENCES" "5" "08 June 2006" "" ""
+.\" There are a lot of Debianisms in this file that should probably
+.\" be removed, but I'm not sure what to use as the "default" RPM-based
+.\" reference distro (Fedora?  RH?  A distro that uses apt-rpm by
+.\" default? (vdanen)
 
+.TH "APT_PREFERENCES" 5 "14 Jun 2006" "APT-RPM" "apt_preferences"
 .SH NAME
-apt_preferences \- Preference control file for APT
+apt_preferences - Preference control file for APT
+
 .SH "DESCRIPTION"
-.PP
-The APT preferences file \fI/etc/apt/preferences\fR
-can be used to control which versions of packages will be selected
+The APT preferences file \fI/etc/apt/preferences\fR can be used to control
+which versions of packages will be selected for installation.
+.LP
+Several versions of a package may be available for installation when the
+\fIsources.list\fR(5) file contains references to more than one distribution
+(for example, stable and testing). APT assigns a priority to each version
+that is available. Subject to dependency constraints, \fBapt-get\fR(8)
+selects the version with the highest priority for installation. The APT
+preferences file overrides the priorities that APT assigns to package
+versions by default, thus giving the user control over which one is selected
 for installation.
-.PP
-Several versions of a package may be available for installation when
-the \fB\fIsources.list\fB\fR(5) file contains references to more than one distribution
-(for example, stable and testing).
-APT assigns a priority to each version that is available.
-Subject to dependency constraints, \fBapt-get\fR selects the
-version with the highest priority for installation.
-The APT preferences file overrides the priorities that APT assigns to
-package versions by default, thus giving the user control over which
-one is selected for installation.
-.PP
-Several instances of the same version of a package may be available when
-the \fB\fIsources.list\fB\fR(5) file contains references to more than one source.
-In this case \fBapt-get\fR downloads the instance listed
-earliest in the \fB\fIsources.list\fB\fR(5) file.
-The APT preferences file does not affect the choice of instance, only
-the choice of version.
-.SS "APT'S DEFAULT PRIORITY ASSIGNMENTS"
-.PP
-If there is no preferences file or if there is no entry in the file
-that applies to a particular version then the priority assigned to that
-version is the priority of the distribution to which that version
-belongs.  It is possible to single out a distribution, "the target release",
-which receives a higher priority than other distributions do by default.
-The target release can be set on the \fBapt-get\fR command
-line or in the APT configuration file \fI/etc/apt/apt.conf\fR\&.
-For example,
+.LP
+Several instances of the same version of a package may be available when the
+\fIsources.list\fR(5) file contains references to more than one source. In
+this case \fBapt-get\fR(8) downloads the instance listed earliest in the
+\fIsources.list\fR(5) file. The APT preferences file does not affect the
+choice of instance, only the choice of version.
 
-.nf
-\fBapt-get install -t testing \fIsome-package\fB\fR
-.fi
-
-.nf
-APT::Default-Release "stable";
-.fi
-.PP
+.SH "APT'S DEFAULT PRIORITY ASSIGNMENTS"
+If there is no preferences file or if there is no entry in the file that
+applies to a particular version then the priority assigned to that version
+is the priority of the distribution to which that version belongs.  It is
+possible to single out a distribution, "the target release", which receives
+a higher priority than other distributions do by default. The target release
+can be set on the \fBapt-get\fR(8) command line or in the APT configuration
+file \fI/etc/apt/apt.conf\fR(5). For example,
+.IP
+\fBapt-get install -t testing some-package\fR
+.LP
+To configure the default release in the configuration file, use:
+.IP
+\fIAPT::Default-Release\fR "stable";
+.LP
 If the target release has been specified then APT uses the following
 algorithm to set the priorities of the versions of a package.  Assign:
 .TP
@@ -55,70 +48,67 @@ algorithm to set the priorities of the versions of a package.  Assign:
 to the version that is already installed (if any).
 .TP
 \fBpriority 500\fR
-to the versions that are not installed and do not belong to the target release.
+to the versions that are not installed and do not belong to the target
+release.
 .TP
 \fBpriority 990\fR
 to the versions that are not installed and belong to the target release.
-.PP
+.LP
 If the target release has not been specified then APT simply assigns
 priority 100 to all installed package versions and priority 500 to all
 uninstalled package versions.
-.PP
-APT then applies the following rules, listed in order of precedence,
-to determine which version of a package to install.
+.LP
+APT then applies the following rules, listed in order of precedence, to
+determine which version of a package to install:
 .TP 0.2i
 \(bu
-Never downgrade unless the priority of an available
-version exceeds 1000.  ("Downgrading" is installing a less recent version
-of a package in place of a more recent version.  Note that none of APT's
-default priorities exceeds 1000; such high priorities can only be set in
-the preferences file.  Note also that downgrading a package
-can be risky.)
+Never downgrade unless the priority of an available version exceeds 1000. 
+("Downgrading" is installing a less recent version of a package in place of
+a more recent version.  Note that none of APT's default priorities exceeds
+1000; such high priorities can only be set in the preferences file.  Note
+also that downgrading a package can be risky.)
 .TP 0.2i
 \(bu
 Install the highest priority version.
 .TP 0.2i
 \(bu
-If two or more versions have the same priority,
-install the most recent one (that is, the one with the higher version
-number).
+If two or more versions have the same priority, install the most recent one
+(that is, the one with the higher version number).
 .TP 0.2i
 \(bu
-If two or more versions have the same priority and
-version number but either the packages differ in some of their metadata or the
---reinstall option is given, install the uninstalled one.
-.PP
-In a typical situation, the installed version of a package (priority 100)
-is not as recent as one of the versions available from the sources listed in
-the \fB\fIsources.list\fB\fR(5) file (priority 500 or 990).  Then the package will be upgraded
-when \fBapt-get install \fIsome-package\fB\fR
-or \fBapt-get upgrade\fR is executed.
-.PP
-More rarely, the installed version of a package is \fBmore\fR recent
-than any of the other available versions.  The package will not be downgraded
-when \fBapt-get install \fIsome-package\fB\fR
-or \fBapt-get upgrade\fR is executed.
-.PP
-Sometimes the installed version of a package is more recent than the
-version belonging to the target release, but not as recent as a version
-belonging to some other distribution.  Such a package will indeed be upgraded
-when \fBapt-get install \fIsome-package\fB\fR
-or \fBapt-get upgrade\fR is executed,
-because at least \fBone\fR of the available versions has a higher
-priority than the installed version.
-.SS "THE EFFECT OF APT PREFERENCES"
-.PP
+If two or more versions have the same priority and version number but either
+the packages differ in some of their metadata or the \fB--reinstall\fR
+option is given, install the uninstalled one.
+.LP
+In a typical situation, the installed version of a package (priority 100) is
+not as recent as one of the versions available from the sources listed in
+the \fIsources.list\fR(5) file (priority 500 or 990).  Then the package will
+be upgraded when \fBapt-get install some-package\fR or \fBapt-get upgrade\fR
+is executed.
+.LP
+More rarely, the installed version of a package is \fBmore\fR recent than
+any of the other available versions.  The package will not be downgraded
+when \fBapt-get install some-package\fR or \fBapt-get upgrade\fR is executed.
+.LP
+Sometimes the installed version of a package is more recent than the version
+belonging to the target release, but not as recent as a version belonging to
+some other distribution.  Such a package will indeed be upgraded when
+\fBapt-get install some-package\fR or \fBapt-get upgrade\fR is executed,
+because at least \fBone\fR of the available versions has a higher priority
+than the installed version.
+
+.SH "THE EFFECT OF APT PREFERENCES"
 The APT preferences file allows the system administrator to control the
-assignment of priorities.  The file consists of one or more multi-line records
-separated by blank lines.  Records can have one of two forms, a specific form
-and a general form.
+assignment of priorities.  The file consists of one or more multi-line
+records separated by blank lines.  Records can have one of two forms, a
+specific form and a general form.
 .TP 0.2i
 \(bu
-The specific form assigns a priority (a "Pin-Priority") to a
-specified package and specified version or version range.  For example,
-the following record assigns a high priority to all versions of
-the \fIperl\fR package whose version number begins with "5.8".
-
+The specific form assigns a priority (a "Pin-Priority") to a specified
+package and specified version or version range.  For example, the following
+record assigns a high priority to all versions of the \fIperl\fR package
+whose version number begins with "5.8".
+.IP
 .nf
 Package: perl
 Pin: version 5.8*
@@ -127,85 +117,81 @@ Pin-Priority: 1001
 .TP 0.2i
 \(bu
 The general form assigns a priority to all of the package versions in a
-given distribution (that is, to all the versions of packages that are
-listed in a certain \fIRelease\fR file) or to all of the package
-versions coming from a particular Internet site, as identified by the
-site's fully qualified domain name.
-
-This general-form entry in the APT preferences file applies only
-to groups of packages.  For example, the following record assigns a high
-priority to all package versions available from the local site.
-
+given distribution (that is, to all the versions of packages that are listed
+in a certain \fIRelease\fR file) or to all of the package versions coming
+from a particular Internet site, as identified by the site's fully qualified
+domain name.
+.IP
+This general-form entry in the APT preferences file applies only to groups
+of packages.  For example, the following record assigns a high priority to
+all package versions available from the local site.
+.IP
 .nf
 Package: *
 Pin: origin ""
 Pin-Priority: 999
 .fi
-
-A note of caution: the keyword used here is "origin".
-This should not be confused with the Origin of a distribution as
-specified in a \fIRelease\fR file.  What follows the "Origin:" tag
-in a \fIRelease\fR file is not an Internet address
-but an author or vendor name, such as "Debian" or "Ximian".
-
+.IP
+A note of caution: the keyword used here is "origin". This should not be
+confused with the Origin of a distribution as specified in a \fIRelease\fR
+file.  What follows the "Origin:" tag in a \fIRelease\fR file is not an
+Internet address but an author or vendor name, such as "Debian" or "Ximian".
+.IP
 The following record assigns a low priority to all package versions
 belonging to any distribution whose Archive name is "unstable".
-
+.IP
 .nf
 Package: *
 Pin: release a=unstable
 Pin-Priority: 50
 .fi
-
+.IP
 The following record assigns a high priority to all package versions
-belonging to any release whose Archive name is "stable"
-and whose release Version number is "3.0".
-
+belonging to any release whose Archive name is "stable" and whose release
+Version number is "3.0".
+.IP
 .nf
 Package: *
 Pin: release a=unstable, v=3.0
 Pin-Priority: 50
 .fi
-.SS "HOW APT INTERPRETS PRIORITIES"
+
+.SH "HOW APT INTERPRETS PRIORITIES"
 .PP
-Priorities (P) assigned in the APT preferences file must be positive
-or negative integers.  They are interpreted as follows (roughly speaking):
+Priorities (P) assigned in the APT preferences file must be positive or
+negative integers.  They are interpreted as follows (roughly speaking):
 .TP
 \fBP > 1000\fR
-causes a version to be installed even if this
-constitutes a downgrade of the package
+causes a version to be installed even if this constitutes a downgrade of the
+package.
 .TP
 \fB990 < P <=1000\fR
-causes a version to be installed
-even if it does not come from the target release,
-unless the installed version is more recent
+causes a version to be installed even if it does not come from the target
+release, unless the installed version is more recent.
 .TP
 \fB500 < P <=990\fR
-causes a version to be installed
-unless there is a version available belonging to the target release
-or the installed version is more recent
+causes a version to be installed unless there is a version available
+belonging to the target release or the installed version is more recent.
 .TP
 \fB100 < P <=500\fR
-causes a version to be installed
-unless there is a version available belonging to some other
-distribution or the installed version is more recent
+causes a version to be installed unless there is a version available
+belonging to some other distribution or the installed version is more recent.
 .TP
 \fB0 < P <=100\fR
-causes a version to be installed
-only if there is no installed version of the package
+causes a version to be installed only if there is no installed version of
+the package.
 .TP
 \fBP < 0\fR
-prevents the version from being installed
-.PP
+prevents the version from being installed.
+.LP
 If any specific-form records match an available package version then the
-first such record determines the priority of the package version.  
-Failing that,
-if any general-form records match an available package version then the
-first such record determines the priority of the package version.  
-.PP
-For example, suppose the APT preferences file contains the three
-records presented earlier:
-
+first such record determines the priority of the package version. Failing
+that, if any general-form records match an available package version then
+the first such record determines the priority of the package version.  
+.LP
+For example, suppose the APT preferences file contains the three records
+presented earlier:
+.IP
 .nf
 Package: perl
 Pin: version 5.8*
@@ -219,140 +205,138 @@ Package: *
 Pin: release unstable
 Pin-Priority: 50
 .fi
+.LP
 Then:
 .TP 0.2i
 \(bu
-The most recent available version of the perl
-package will be installed, so long as that version's version number begins
-with "5.8".  If \fBany\fR 5.8* version of perl is
-available and the installed version is 5.9*, then perl will be
-downgraded.
+The most recent available version of the perl package will be installed, so
+long as that version's version number begins with "5.8".  If \fBany\fR 5.8*
+version of perl is available and the installed version is 5.9*, then perl
+will be downgraded.
 .TP 0.2i
 \(bu
-A version of any package other than perl
-that is available from the local system has priority over other versions,
-even versions belonging to the target release.
+A version of any package other than perl that is available from the local
+system has priority over other versions, even versions belonging to the
+target release.
 .TP 0.2i
 \(bu
-A version of a package whose origin is not the local
-system but some other site listed in \fB\fIsources.list\fB\fR(5) and which belongs to
-an unstable distribution is only installed if it is selected
-for installation and no version of the package is already installed.
-.SS "DETERMINATION OF PACKAGE VERSION AND DISTRIBUTION PROPERTIES"
-.PP
-The locations listed in the \fB\fIsources.list\fB\fR(5) file should provide
-\fIPackages\fR and \fIRelease\fR files
-to describe the packages available at that location.
-.PP
+A version of a package whose origin is not the local system but some other
+site listed in \fIsources.list\fR(5) and which belongs to an unstable
+distribution is only installed if it is selected for installation and no
+version of the package is already installed.
+
+.SH "DETERMINATION OF PACKAGE VERSION AND DISTRIBUTION PROPERTIES"
+The locations listed in the \fIsources.list\fR(5) file should provide
+\fIPackages\fR and \fIRelease\fR files to describe the packages available at
+that location.
+.LP
+\fBThe\fR \fIPackages\fR \fbFile\fR
+.LP
 The \fIPackages\fR file is normally found in the directory
-\fI\&.../dists/dist-name/component/arch\fR:
-for example, \fI\&.../dists/stable/main/binary-i386/Packages\fR\&.
-It consists of a series of multi-line records, one for each package available
-in that directory.  Only two lines in each record are relevant for setting
-APT priorities:
+\fI.../dists/dist-name/component/arch\fR.  For example:
+\fI.../dists/stable/main/binary-i386/Packages\fR. It consists of a series of
+multi-line records, one for each package available in that directory.  Only
+two lines in each record are relevant for setting APT priorities:
 .TP
-\fBthe Package: line\fR
-gives the package name
+\fBPackage:\fR
+this line gives the package name.
 .TP
-\fBthe Version: line\fR
-gives the version number for the named package
-.PP
+\fBVersion:\fR
+this line gives the version number for the named package.
+.LP
+\fBThe\fR \fIRelease\fR \fBFile\fR
+.LP
 The \fIRelease\fR file is normally found in the directory
-\fI\&.../dists/dist-name\fR:
-for example, \fI\&.../dists/stable/Release\fR,
-or \fI\&.../dists/woody/Release\fR\&.
-It consists of a single multi-line record which applies to \fBall\fR of
-the packages in the directory tree below its parent.  Unlike the
-\fIPackages\fR file, nearly all of the lines in a \fIRelease\fR
-file are relevant for setting APT priorities:
+\fI.../dists/dist-name\fR.  For example: \fI.../dists/stable/Release\fR, or
+\fI.../dists/woody/Release\fR. It consists of a single multi-line record
+which applies to \fBall\fR of the packages in the directory tree below its
+parent.  Unlike the \fIPackages\fR file, nearly all of the lines in a
+\fIRelease\fR file are relevant for setting APT priorities:
 .TP
-\fBthe Archive: line\fR
-names the archive to which all the packages
-in the directory tree belong.  For example, the line
-"Archive: stable"
-specifies that all of the packages in the directory
-tree below the parent of the \fIRelease\fR file are in a
-stable archive.  Specifying this value in the APT preferences file
+\fBArchive:\fR
+this line names the archive to which all the packages in the directory tree
+belong. For example, the line "Archive: stable" specifies that all of the
+packages in the directory tree below the parent of the \fIRelease\fR file
+are in a stable archive.  Specifying this value in the APT preferences file
 would require the line:
-
+.IP
 .nf
 Pin: release a=stable
 .fi
 .TP
-\fBthe Version: line\fR
-names the release version.  For example, the
-packages in the tree might belong to Debian GNU/Linux release
-version 3.0.  Note that there is normally no version number for the
-testing and unstable distributions because they
-have not been released yet.  Specifying this in the APT preferences
-file would require one of the following lines.
-
+\fBVersion:\fR
+this line names the release version.  For example, the packages in the tree
+might belong to Debian GNU/Linux release version 3.0.  Note that there is
+normally no version number for the testing and unstable distributions
+because they have not been released yet.  Specifying this in the APT
+preferences file would require one of the following lines.
+.IP
 .nf
 Pin: release v=3.0
 Pin: release a=stable, v=3.0
 Pin: release 3.0
 .fi
 .TP
-\fBthe Component: line\fR
-names the licensing component associated with the
-packages in the directory tree of the \fIRelease\fR file.
-For example, the line "Component: main" specifies that
-all the packages in the directory tree are from the main
-component, which entails that they are licensed under terms listed
-in the Debian Free Software Guidelines.  Specifying this component
-in the APT preferences file would require the line:
-
+\fBComponent:\fR
+this line names the licensing component associated with the packages in the
+directory tree of the \fIRelease\fR file. For example, the line "Component:
+main" specifies that all the packages in the directory tree are from the
+main component, which entails that they are licensed under terms listed in
+the Debian Free Software Guidelines.  Specifying this component in the APT
+preferences file would require the line:
+.IP
 .nf
 Pin: release c=main
 .fi
 .TP
-\fBthe Origin: line\fR
-names the originator of the packages in the
-directory tree of the \fIRelease\fR file.  Most commonly, this is
-Debian\&.  Specifying this origin in the APT preferences file
-would require the line:
-
+\fBOrigin:\fR
+this line names the originator of the packages in the directory tree of the
+\fIRelease\fR file.  Most commonly, this is Debian.  Specifying this origin
+in the APT preferences file would require the line:
+.IP
 .nf
 Pin: release o=Debian
 .fi
 .TP
-\fBthe Label: line\fR
-names the label of the packages in the directory tree
-of the \fIRelease\fR file.  Most commonly, this is
-Debian\&.  Specifying this label in the APT preferences file
-would require the line:
-
+\fBLabel:\fR
+this line names the label of the packages in the directory tree of the
+\fIRelease\fR file.  Most commonly, this is Debian.  Specifying this label
+in the APT preferences file would require the line:
+.IP
 .nf
 Pin: release l=Debian
 .fi
-.PP
-All of the \fIPackages\fR and \fIRelease\fR
-files retrieved from locations listed in the \fB\fIsources.list\fB\fR(5) file are stored
-in the directory \fI/var/lib/apt/lists\fR, or in the file named
-by the variable Dir::State::Lists in the \fIapt.conf\fR file.
-For example, the file
+.LP
+All of the \fIPackages\fR and \fIRelease\fR files retrieved from locations
+listed in the \fIsources.list\fR(5) file are stored in the directory
+\fI/var/lib/apt/lists\fR, or in the file named by the variable
+\fIDir::State::Lists\fR in the \fIapt.conf\fR(5) file. For example, the file
 \fIdebian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release\fR
-contains the \fIRelease\fR file retrieved from the site
-debian.lcs.mit.edu for binary-i386 architecture
-files from the contrib component of the unstable
-distribution.
-.SS "OPTIONAL LINES IN AN APT PREFERENCES RECORD"
-.PP
-Each record in the APT preferences file can optionally begin with
-one or more lines beginning with the word Explanation:\&.
-This provides a place for comments.
-.PP
-The Pin-Priority: line in each APT preferences record is
-optional.  If omitted, APT assigs a priority of 1 less than the last value
-specified on a line beginning with Pin-Priority: release ...\&.
-.SH "EXAMPLES"
-.SS "TRACKING STABLE"
-.PP
-The following APT preferences file will cause APT to assign a
-priority higher than the default (500) to all package versions belonging
-to a stable distribution and a prohibitively low priority to
-package versions belonging to other Debian distributions.
+contains the \fIRelease\fR file retrieved from the site debian.lcs.mit.edu
+for binary-i386 architecture files from the contrib component of the
+unstable distribution.
 
+.SH "OPTIONAL LINES IN AN APT PREFERENCES RECORD"
+Each record in the APT preferences file can optionally begin with one or
+more lines beginning with the word Explanation:. This provides a place for
+comments.
+.LP
+The Pin-Priority: line in each APT preferences record is optional.  If
+omitted, APT assigs a priority of 1 less than the last value specified on a
+previous line beginning with Pin-Priority: release ....
+
+.SH "EXAMPLES"
+The following examples make use of the component names "stable", "testing",
+and "unstable", but these are obviously defined by the vendor and are
+determined by the repository layout.
+.LP
+\fBTracking a "STABLE" distribution\fR
+.LP
+The following APT preferences file will cause APT to assign a priority
+higher than the default (500) to all package versions belonging to a
+"stable" distribution and a prohibitively low priority to package versions
+belonging to other distributions.
+.IP
 .nf
 Explanation: Uninstall or do not install any Debian-originated
 Explanation: package versions other than those in the stable distro
@@ -364,33 +348,32 @@ Package: *
 Pin: release o=Debian
 Pin-Priority: -10
 .fi
-.PP
-With a suitable \fB\fIsources.list\fB\fR(5) file and the above preferences file,
-any of the following commands will cause APT to upgrade to the
-latest stable version(s).
-
+.LP
+With a suitable \fIsources.list\fR(5) file and the above preferences file,
+any of the following commands will cause APT to upgrade to the latest stable
+version(s):
+.IP
 .nf
-apt-get install \fIpackage-name\fR
-apt-get upgrade
-apt-get dist-upgrade
+\fBapt-get install package-name\fR
+\fBapt-get upgrade\fR
+\fBapt-get dist-upgrade\fR
 .fi
-.PP
-The following command will cause APT to upgrade the specified
-package to the latest version from the testing distribution;
-the package will not be upgraded again unless this command is given
-again.
-
+.LP
+The following command will cause APT to upgrade the specified package
+("package") to the latest version from the "testing" distribution; the
+package will not be upgraded again unless this command is given again.
+.IP
 .nf
-apt-get install \fIpackage\fR/testing
+\fBapt-get install package/testing\fR
 .fi
-.SS "TRACKING TESTING OR UNSTABLE"
-.PP
-The following APT preferences file will cause APT to assign
-a high priority to package versions from the testing
-distribution, a lower priority to package versions from the
-unstable distribution, and a prohibitively low priority
-to package versions from other Debian distributions.
-
+.LP
+\fBTracking a "TESTING" or "UNSTABLE" distribution\fR
+.LP
+The following APT preferences file will cause APT to assign a high priority
+to package versions from the testing distribution, a lower priority to
+package versions from the unstable distribution, and a prohibitively low
+priority to package versions from other Debian distributions.
+.IP
 .nf
 Package: *
 Pin: release a=testing
@@ -404,36 +387,35 @@ Package: *
 Pin: release o=Debian
 Pin-Priority: -10
 .fi
-.PP
-With a suitable \fB\fIsources.list\fB\fR(5) file and the above preferences file,
+.LP
+With a suitable \fIsources.list\fR(5) file and the above preferences file,
 any of the following commands will cause APT to upgrade to the latest
-testing version(s).
-
+testing version(s):
+.IP
 .nf
-apt-get install \fIpackage-name\fR
-apt-get upgrade
-apt-get dist-upgrade
+\fBapt-get install package-name\fR
+\fBapt-get upgrade\fR
+\fBapt-get dist-upgrade\fR
 .fi
-.PP
-The following command will cause APT to upgrade the specified
-package to the latest version from the unstable distribution.
-Thereafter, \fBapt-get upgrade\fR will upgrade
-the package to the most recent testing version if that is
-more recent than the installed version, otherwise, to the most recent
-unstable version if that is more recent than the installed
-version.
-
+.LP
+The following command will cause APT to upgrade the specified package to the
+latest version from the "unstable" distribution. Thereafter, \fBapt-get
+upgrade\fR will upgrade the package to the most recent "testing" version if
+that is more recent than the installed version, otherwise to the most recent
+"unstable" version if that is more recent than the installed version.
+.IP
 .nf
-apt-get install \fIpackage\fR/unstable
+\fBapt-get install package/unstable\fR
 .fi
+
 .SH "SEE ALSO"
-.PP
-\fBapt-get\fR(8) \fBapt-cache\fR(8) \fB\fIapt.conf\fB\fR(5) \fB\fIsources.list\fB\fR(5)
+.LP
+\fBapt-get\fR(8) \fBapt-cache\fR(8) \fIapt.conf\fR(5) \fIsources.list\fR(5)
+
 .SH "BUGS"
-.PP
-Reporting bugs in APT-RPM is best done in the 
-APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>\&.
+Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist at
+http://apt-rpm.org/mailinglist.shtml.
+
 .SH "AUTHOR"
-.PP
-Maintainer and contributor information can be found in the
-credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.
+Maintainer and contributor information can be found in the credits page
+http://apt-rpm.org/about.shtml of APT-RPM.
index a5dbb97..66ab53a 100644 (file)
-.\" This manpage has been automatically generated by docbook2man 
-.\" from a DocBook document.  This tool can be found at:
-.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
-.\" Please send any bug reports, improvements, comments, patches, 
-.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "SOURCES.LIST" "5" "08 June 2006" "" ""
-
+.TH "SOURCES.LIST" 5 "14 Jun 2006" "APT-RPM" "sources.list"
 .SH NAME
-sources.list \- Package resource list for APT
+sources.list - Package resource list for APT
+
 .SH "DESCRIPTION"
-.PP
+.LP
 The package resource list is used to locate archives of the package
-distribution system in use on the system. 
-This control file is located in \fI/etc/apt/sources.list\fR
-and additionally any files ending in .list in 
-\fI/etc/apt/sources.list.d\fR are included.
-.PP
+distribution system in use on the system. This control file is located in
+\fI/etc/apt/sources.list\fR and additionally any files ending with ".list"
+in \fI/etc/apt/sources.list.d\fR are included.
+.LP
 The source list is designed to support any number of active sources and a
-variety of source media. The file lists one source per line, with the
-most preferred source listed first. The format of each line is:
-type uri args\&. The first item, type, determines the 
-format for args\&. uri is a Universal Resource Identifier 
-(URI), which is a superset of the more specific and well-known Universal
-Resource Locator, or URL. The rest of the line can be marked as a comment 
-by using a #.
-.PP
-The generic format of sources.list entry is:
-
-.nf
-type baseuri distribution [component comp2 ...]
-.fi
-.PP
-Type is one of the types explained below. Baseuri is the URI to the root
-of given distribution, distribution part points to a given distribution
-name, version and architecture. The splitting of URI into baseuri and
+variety of source media.  The file lists one source per line, with the most
+preferred source listed first.  The format of each line is: \fItype uri
+args\fR.  The first item, \fItype\fR, determines the format for \fIargs\fR. 
+\fIuri\fR is a Universal Resource Identifier (URI), which is a superset of
+the more specific and well-known Universal Resource Locator, or URL.  The
+rest of the line can be marked as a comment by using a #.
+.LP
+The generic format of \fIsources.list\fR entry is:
+.IP
+\fBtype baseuri distribution [component comp2 ...]\fR
+.LP
+Type is one of the types explained below.  Baseuri is the URI to the root of
+the given distribution.  Distribution points to a given distribution name,
+version and architecture.  The splitting of URI into baseuri and
 distribution parts should be done in a way that allows pointing the baseuri
-to another mirror without touching distribution.
-Some types additionally support a component-entry.
-.PP
-The following variable substitutions are done on sources.list entries:
-$(ARCH) is substituted with the base archecture of the system.
-.PP
-$(VERSION) is substituted with the distribution version if
-configured automatically via Apt::DistroVerPkg or manually via 
-Apt::DistroVersion configuration option.
-.SH "THE REPOMD AND REPOMD-SRC TYPES"
-.PP
-The format of repomd and repomd-src sources.list entries is:
+to another mirror without touching distribution. Some types additionally
+support a component-entry.
+.LP
+The following variable substitutions are done on \fIsources.list\fR entries:
+$(ARCH) is substituted with the base architecture of the system.
+.LP
+$(VERSION) is substituted with the distribution version if configured
+automatically via \fIApt::DistroVerPkg\fR or manually via the
+\fIApt::DistroVersion\fR configuration option.
 
-.nf
-repomd baseuri distribution
-.fi
-
-.nf
-repomd-src baseuri distribution
-.fi
+.SH "THE REPOMD AND REPOMD-SRC TYPES"
+The format of \fBrepomd\fR and \fBrepomd-src\fR \fIsources.list\fR entries
+is:
+.IP
+\fBrepomd baseuri distribution\fR
+.IP
+\fBrepomd-src baseuri distribution\fR
+.LP
 Repomd repositories do not support a concept of "components"!
-.SH "THE RPM AND RPM-SRC TYPES"
-.PP
-The format of rpm and rpm-src sources.list entries is:
-
-.nf
-rpm baseuri distribution component [comp2 ...]
-.fi
 
-.nf
-rpm-src baseuri distribution component [comp2 ...]
-.fi
-At least one component must be specified for rpm and rpm-src 
+.SH "THE RPM AND RPM-SRC TYPES"
+The format of \fBrpm\fR and \fBrpm-src\fR \fIsources.list\fR entries is:
+.IP
+\fBrpm baseuri distribution component [comp2 ...]\fR
+.IP
+\fBrpm-src baseuri distribution component [comp2 ...]\fR
+.LP
+At least one component must be specified for \fBrpm\fR and \fBrpm-src\fR
 repositories.
-.SH "THE RPM-DIR AND RPM-SRC-DIR TYPES"
-.PP
-The format of rpm-dir and rpm-src-dir sources.list entries is:
 
-.nf
-rpm-dir baseuri distribution component [comp2 ...]
-.fi
+.SH "THE RPM-DIR AND RPM-SRC-DIR TYPES"
+The format of \fBrpm-dir\fR and \fBrpm-src-dir\fR \fIsources.list\fR entries
+is:
+.IP
+\fBrpm-dir baseuri distribution component [comp2 ...]\fR
+.IP
+\fBrpm-src-dir baseuri distribution component [comp2 ...]\fR
+.LP
+At least one component must be specified for \fBrpm\fR and \fBrpm-src\fR
+repositories.  \fBrpm-dir\fR and \fBrpm-src-dir\fR only accept file:// uri's!
 
-.nf
-rpm-src-dir baseuri distribution component [comp2 ...]
-.fi
-At least one component must be specified for rpm and rpm-src 
-repositories. Rpm-dir and rpm-src-dir only accept file:// uri's!
 .SH "URI SPECIFICATION"
-.PP
-The currently recognized URI types are cdrom, file, http, and ftp.
+The currently recognized URI types are \fBcdrom\fR, \fBfile\fR, \fBhttp\fR,
+and \fBftp\fR.
+
 .TP
 \fBfile\fR
-The file scheme allows an arbitrary directory in the file system to be
-considered an archive. This is useful for NFS mounts and local mirrors or
+The \fBfile\fR scheme allows an arbitrary directory in the file system to be
+considered an archive.  This is useful for NFS mounts and local mirrors or
 archives.
+
 .TP
 \fBcdrom\fR
-The cdrom scheme allows APT to use a local CDROM drive with media
-swapping. Use the \fBapt-cdrom\fR(8) program to create cdrom entries in the
+The \fBcdrom\fR scheme allows APT to use a local CDROM drive with media
+swapping.  Use the \fBapt-cdrom\fR(8) program to create cdrom entries in the
 source list.
+
 .TP
 \fBhttp\fR
-The http scheme specifies an HTTP server for the archive. If an environment
-variable \fBhttp_proxy\fR is set with the format 
-http://server:port/, the proxy server specified in
-\fBhttp_proxy\fR will be used. Users of authenticated HTTP/1.1 proxies 
-may use a string of the format http://user:pass@server:port/
-Note that this is an insecure method of authentication.
+The \fBhttp\fR scheme specifies an HTTP server for the archive.  If the
+"http_proxy" environment variable is set with the format
+"http://server:port/", the proxy server specified in "http_proxy" will be
+used.  Users of authenticated HTTP/1.1 proxies may use a string of the
+format "http://user:pass@server:port/".  Note that this is an insecure
+method of authentication.
+
 .TP
 \fBftp\fR
-The ftp scheme specifies an FTP server for the archive. APT's FTP behavior
-is highly configurable; for more information see the
-\fB\fIapt.conf\fB\fR(5) manual page. Please note that a ftp proxy can be specified
-by using the \fBftp_proxy\fR environment variable. It is possible to 
-specify a http proxy (http proxy servers often understand ftp urls) using 
-this method and ONLY this method. ftp proxies using http specified in the 
+The \fBftp\fR scheme specifies an FTP server for the archive.  APT's FTP
+behavior is highly configurable; for more information see the
+\fIapt.conf\fR(5) manual page.  Please note that a ftp proxy can be
+specified by using the "ftp_proxy" environment variable.  It is possible to
+specify a http proxy (http proxy servers often understand ftp urls) using
+this method and ONLY this method.  ftp proxies using http specified in the
 configuration file will be ignored.
+
 .TP
 \fBcopy\fR
-The copy scheme is identical to the file scheme except that packages are
-copied into the cache directory instead of used directly at their location.
-This is useful for people using a zip disk to copy files around with APT.
+The \fBcopy\fR scheme is identical to the \fBfile\fR scheme except that
+packages are copied into the cache directory instead of used directly at
+their location. This is useful for people using a zip disk to copy files
+around with APT.
+
 .TP
 \fBrsh\fR
+See below.
+
 .TP
 \fBssh\fR
-The rsh/ssh method invokes rsh/ssh to connect to a remote host
-as a given user and access the files. No password authentication is 
+The \fBrsh\fR/\fBssh\fR method invokes rsh/ssh to connect to a remote host
+as a given user and access the files.  No password authentication is 
 possible, prior arrangements with RSA keys or rhosts must have been made.
-Access to files on the remote uses standard \fBfind\fR and \fBdd\fR 
+Access to files on the remote uses standard \fBfind\fR(1) and \fBdd\fR(P) 
 commands to perform the file transfers from the remote.
+
 .SH "EXAMPLES"
-.PP
 Repomd entries for Fedora Core, Extras and Updates using variable
-substitution, assumes Apt::DistroVerPkg is set to "fedora-release":
-
+substitution, assumes \fIApt::DistroVerPkg\fR is set to "fedora-release":
+.IP
 .nf
-   repomd http://download.fedora.redhat.com/pub/ fedora/linux/core/$(VERSION)/$(ARCH)/os/
-   repomd http://download.fedora.redhat.com/pub/ fedora/linux/extras/$(VERSION)/$(ARCH)/
-   repomd http://download.fedora.redhat.com/pub/ fedora/linux/core/updates/$(VERSION)/$(ARCH)/
-   
+repomd http://download.fedora.redhat.com/pub/ fedora/linux/core/$(VERSION)/$(ARCH)/os/
+repomd http://download.fedora.redhat.com/pub/ fedora/linux/extras/$(VERSION)/$(ARCH)/
+repomd http://download.fedora.redhat.com/pub/ fedora/linux/core/updates/$(VERSION)/$(ARCH)/
 .fi
-.PP
-Local mirror (local disk, NFS mounted etc) of Fedora Core at 
-/var/www/html/fedora/
 
+.LP
+Local mirror (local disk, NFS mounted etc) of Fedora Core at 
+\fI/var/www/html/fedora/\fR
+.IP
 .nf
-   repomd file:/var/www/html fedora/linux/core/$(VERSION)/$(ARCH)/
-   
+repomd file:/var/www/html fedora/linux/core/$(VERSION)/$(ARCH)/
 .fi
+
 .SH "SEE ALSO"
-.PP
-\fBapt-cache\fR(8) \fB\fIapt.conf\fB\fR(5)
+.LP
+\fBapt-cache\fR(8) \fIapt.conf\fR(5)
+
 .SH "BUGS"
-.PP
-Reporting bugs in APT-RPM is best done in the 
-APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>\&.
+Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist at
+http://apt-rpm.org/mailinglist.shtml.
+
 .SH "AUTHOR"
-.PP
-Maintainer and contributor information can be found in the
-credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.
+Maintainer and contributor information can be found in the credits page
+http://apt-rpm.org/about.shtml of APT-RPM.
index a99a9fc..49f8c2f 100644 (file)
@@ -1,80 +1,69 @@
-.\" This manpage has been automatically generated by docbook2man 
-.\" from a DocBook document.  This tool can be found at:
-.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
-.\" Please send any bug reports, improvements, comments, patches, 
-.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "VENDORS.LIST" "5" "08 June 2006" "" ""
-
+.TH "VENDORS.LIST" 5 "14 Jun 2006" "APT-RPM" "vendors.list"
 .SH NAME
-vendors.list \- Security key configuration for APT
+vendors.list - Security key configuration for APT
+
 .SH "DESCRIPTION"
-.PP
-The package vendor list contains a list of all vendors
-from whom you wish to  authenticate  downloaded  packages.
-For each vendor listed, it must contain the corresponding
-PGP key fingerprint, so that  APT  can  perform  signature
-verification  of the release file and subsequent checking
-of the checksums of each  downloaded  package.
-To have authentication enabled, you must add the 
-vendor identification string  (see  below) enclosed in
-square braces to the sources.list line for all sites that mirror
-the repository provided by that vendor.
-.PP
-The format of this file is similar  to  the  one  used  by
-apt.conf.  It consists of an arbitrary number of blocks of
-vendors, where each block starts with a string telling the
-\fIkey_type\fR and the \fIvendor_id\fR\&.
-.PP
-Some vendors may have multiple blocks that define different
-security policies for their distributions. Debian for instance
-uses a different signing methodology for stable and unstable releases.
-.PP
-\fIkey_type\fR is the type of the check required.
-Currently, there is only one type available which is 
-simple-key\&.
-.PP
-\fIvendor_id\fR is the vendor identification string. It is an
-arbitrary string you must supply to uniquely identifify a
-vendor that's listed in this file.
+The package vendor list contains a list of all vendors from whom you wish to
+ authenticate  downloaded  packages.  For each vendor listed, it must contain
+the corresponding PGP key fingerprint, so that  APT  can  perform  signature
+verification  of the release file and subsequent checking of the checksums
+of each  downloaded  package.  To have authentication enabled, you must add
+the vendor identification string  (see  below) enclosed in square braces to
+the \fIsources.list\fR(5) line for all sites that mirror the repository
+provided by that vendor.
+.LP
+The format of this file is similar  to  the  one  used  by \fIapt.conf\fR(5).  
+It consists of an arbitrary number of blocks of vendors, where each block
+starts with a string telling the \fBkey_type\fR and the \fBvendor_id\fR.
+.LP
+Some vendors may have multiple blocks that define different security
+policies for their distributions.  Debian for instance uses a different
+signing methodology for stable and unstable releases.
+.LP
+\fBkey_type\fR is the type of the check required.  Currently, there is only
+one type available which is \fIsimple-key\fR.
+.LP
+\fBvendor_id\fR is the vendor identification string.  It is an arbitrary
+string you must supply to uniquely identify a vendor that's listed in this
+file.
+.LP
 Example:
-.PP
-
+.IP
 .nf
-   
 simple-key "joe"
 {
    Fingerprint "0987AB4378FSD872343298787ACC";
    Name "Joe Shmoe <joe@shmoe.com>";
 }                                                  
 .fi
+
 .SH "THE SIMPLE-KEY TYPE"
-.PP
-This type of verification is used when the vendor has a single
-secured key that must be used to sign the Release file. The
-following items should be present
+This type of verification is used when the vendor has a single secured key
+that must be used to sign the Release file.  The following items should be
+present
+
 .TP
 \fBFingerprint\fR
-The PGP fingerprint for the key. The fingerprint should be
-expressed in the standard notion with or without spaces.
-The \fB--fingerprint\fR option for 
-\fBgpg\fR(1)
-will show the fingerprint for the selected keys(s).
+The PGP fingerprint for the key.  The fingerprint should be expressed in the
+standard notion with or without spaces.  The \fB--fingerprint\fR option for
+\fBgpg\fR(1) will show the fingerprint for the selected keys(s).
+
 .TP
 \fBName\fR
-A string containing a description of the owner of
-the  key  or vendor.  You may put the vendor name and it's
-email. The string must be quoted with ".
+A string containing a description of the owner of the  key  or vendor.   You
+may put the vendor name and email.  The string must be entirely within
+double-quotes (\fB"\fR).
+
 .SH "FILES"
-.PP
 \fI/etc/apt/vendors.list\fR
+
 .SH "SEE ALSO"
-.PP
-\fB\fIsources.list\fB\fR(5)
+\fIsources.list\fR(5)
+
 .SH "BUGS"
-.PP
-Reporting bugs in APT-RPM is best done in the 
-APT-RPM mailinglist <URL:http://apt-rpm.org/mailinglist.shtml>\&.
+Reporting bugs in APT-RPM is best done in the APT-RPM mailinglist at
+http://apt-rpm.org/mailinglist.shtml.
+
 .SH "AUTHOR"
-.PP
-Maintainer and contributor information can be found in the
-credits page <URL:http://apt-rpm.org/about.shtml> of APT-RPM.
+Maintainer and contributor information can be found in the credits page
+http://apt-rpm.org/about.shtml of APT-RPM.