- Remove man-page's sgml sources and use the *roff sources directly. (Ralf)
authorpmatilai <pmatilai>
Thu, 8 Jun 2006 15:32:28 +0000 (15:32 +0000)
committerpmatilai <pmatilai>
Thu, 8 Jun 2006 15:32:28 +0000 (15:32 +0000)
18 files changed:
doc/Makefile.am
doc/Makefile.in
doc/apt-cache.8
doc/apt-cache.8.sgml [deleted file]
doc/apt-cdrom.8
doc/apt-cdrom.8.sgml [deleted file]
doc/apt-config.8
doc/apt-config.8.sgml [deleted file]
doc/apt-get.8
doc/apt-get.8.sgml [deleted file]
doc/apt.conf.5
doc/apt.conf.5.sgml [deleted file]
doc/apt_preferences.5
doc/apt_preferences.5.sgml [deleted file]
doc/sources.list.5
doc/sources.list.5.sgml [deleted file]
doc/vendors.list.5
doc/vendors.list.5.sgml [deleted file]

index 26dced3..890d2a6 100644 (file)
@@ -1,80 +1,14 @@
 dist_man_MANS = apt.8
-MAINTAINERCLEANFILES =
-EXTRA_DIST =
-
-EXTRA_DIST += apt-cache.8.sgml
 dist_man_MANS += apt-cache.8
-if COMPILE_MANPAGES
-apt-cache.8: apt-cache.8.sgml apt.ent
-       (cd $(srcdir) && $(DOCBOOK2MAN) apt-cache.8.sgml)
-       @rm -f $(srcdir)/manpage.*
-endif
-MAINTAINERCLEANFILES += apt-cache.8
-
-EXTRA_DIST += apt-cdrom.8.sgml
 dist_man_MANS += apt-cdrom.8
-if COMPILE_MANPAGES
-apt-cdrom.8: apt-cdrom.8.sgml apt.ent
-       (cd $(srcdir) && $(DOCBOOK2MAN) apt-cdrom.8.sgml)
-       @rm -f $(srcdir)/manpage.*
-endif
-MAINTAINERCLEANFILES += apt-cdrom.8
-
-EXTRA_DIST += apt.conf.5.sgml
 dist_man_MANS += apt.conf.5
-if COMPILE_MANPAGES
-apt.conf.5: apt.conf.5.sgml apt.ent
-       (cd $(srcdir) && $(DOCBOOK2MAN) apt.conf.5.sgml)
-       @rm -f $(srcdir)/manpage.*
-endif
-MAINTAINERCLEANFILES += apt.conf.5
-
-EXTRA_DIST += apt-config.8.sgml
 dist_man_MANS += apt-config.8
-if COMPILE_MANPAGES
-apt-config.8: apt-config.8.sgml apt.ent
-       (cd $(srcdir) && $(DOCBOOK2MAN) apt-config.8.sgml)
-       @rm -f $(srcdir)/manpage.*
-endif
-MAINTAINERCLEANFILES += apt-config.8
-
-EXTRA_DIST += apt-get.8.sgml
 dist_man_MANS += apt-get.8
-if COMPILE_MANPAGES
-apt-get.8: apt-get.8.sgml apt.ent
-       (cd $(srcdir) && $(DOCBOOK2MAN) apt-get.8.sgml)
-       @rm -f $(srcdir)/manpage.*
-endif
-MAINTAINERCLEANFILES += apt-get.8
-
-EXTRA_DIST += apt_preferences.5.sgml
 dist_man_MANS += apt_preferences.5
-if COMPILE_MANPAGES
-apt_preferences.5: apt_preferences.5.sgml apt.ent
-       (cd $(srcdir) && $(DOCBOOK2MAN) apt_preferences.5.sgml)
-       @rm -f $(srcdir)/manpage.*
-endif
-MAINTAINERCLEANFILES += apt_preferences.5
-
-EXTRA_DIST += sources.list.5.sgml
 dist_man_MANS += sources.list.5
-if COMPILE_MANPAGES
-sources.list.5: sources.list.5.sgml apt.ent
-       (cd $(srcdir) && $(DOCBOOK2MAN) sources.list.5.sgml)
-       @rm -f $(srcdir)/manpage.*
-endif
-MAINTAINERCLEANFILES += sources.list.5
-
-EXTRA_DIST += vendors.list.5.sgml
 dist_man_MANS += vendors.list.5
-if COMPILE_MANPAGES
-vendors.list.5: vendors.list.5.sgml apt.ent
-       (cd $(srcdir) && $(DOCBOOK2MAN) vendors.list.5.sgml)
-       @rm -f $(srcdir)/manpage.*
-endif
-MAINTAINERCLEANFILES += vendors.list.5
 
-EXTRA_DIST += \
+EXTRA_DIST = \
                apt.ent \
                style.txt \
                cache.sgml \
index a62bbe0..6fcce3e 100644 (file)
@@ -194,14 +194,19 @@ sysconfdir = @sysconfdir@
 target_alias = @target_alias@
 dist_man_MANS = apt.8 apt-cache.8 apt-cdrom.8 apt.conf.5 apt-config.8 \
        apt-get.8 apt_preferences.5 sources.list.5 vendors.list.5
-MAINTAINERCLEANFILES = apt-cache.8 apt-cdrom.8 apt.conf.5 apt-config.8 \
-       apt-get.8 apt_preferences.5 sources.list.5 vendors.list.5
-EXTRA_DIST = apt-cache.8.sgml apt-cdrom.8.sgml apt.conf.5.sgml \
-       apt-config.8.sgml apt-get.8.sgml apt_preferences.5.sgml \
-       sources.list.5.sgml vendors.list.5.sgml apt.ent style.txt \
-       cache.sgml files.sgml guide.sgml offline.sgml design.sgml \
-       method.sgml examples/apt.conf examples/configure-index \
-       examples/sources.list
+EXTRA_DIST = \
+               apt.ent \
+               style.txt \
+               cache.sgml \
+               files.sgml \
+               guide.sgml \
+               offline.sgml \
+               design.sgml \
+               method.sgml \
+               examples/apt.conf \
+               examples/configure-index \
+               examples/sources.list
+
 all: all-am
 
 .SUFFIXES:
@@ -400,7 +405,6 @@ distclean-generic:
 maintainer-clean-generic:
        @echo "This command is intended for maintainers to use"
        @echo "it deletes files that may require special tools to rebuild."
-       -test -z "$(MAINTAINERCLEANFILES)" || rm -f $(MAINTAINERCLEANFILES)
 clean: clean-am
 
 clean-am: clean-generic clean-libtool mostlyclean-am
@@ -460,30 +464,6 @@ uninstall-man: uninstall-man5 uninstall-man8
        ps ps-am uninstall uninstall-am uninstall-info-am \
        uninstall-man uninstall-man5 uninstall-man8
 
-@COMPILE_MANPAGES_TRUE@apt-cache.8: apt-cache.8.sgml apt.ent
-@COMPILE_MANPAGES_TRUE@        (cd $(srcdir) && $(DOCBOOK2MAN) apt-cache.8.sgml)
-@COMPILE_MANPAGES_TRUE@        @rm -f $(srcdir)/manpage.*
-@COMPILE_MANPAGES_TRUE@apt-cdrom.8: apt-cdrom.8.sgml apt.ent
-@COMPILE_MANPAGES_TRUE@        (cd $(srcdir) && $(DOCBOOK2MAN) apt-cdrom.8.sgml)
-@COMPILE_MANPAGES_TRUE@        @rm -f $(srcdir)/manpage.*
-@COMPILE_MANPAGES_TRUE@apt.conf.5: apt.conf.5.sgml apt.ent
-@COMPILE_MANPAGES_TRUE@        (cd $(srcdir) && $(DOCBOOK2MAN) apt.conf.5.sgml)
-@COMPILE_MANPAGES_TRUE@        @rm -f $(srcdir)/manpage.*
-@COMPILE_MANPAGES_TRUE@apt-config.8: apt-config.8.sgml apt.ent
-@COMPILE_MANPAGES_TRUE@        (cd $(srcdir) && $(DOCBOOK2MAN) apt-config.8.sgml)
-@COMPILE_MANPAGES_TRUE@        @rm -f $(srcdir)/manpage.*
-@COMPILE_MANPAGES_TRUE@apt-get.8: apt-get.8.sgml apt.ent
-@COMPILE_MANPAGES_TRUE@        (cd $(srcdir) && $(DOCBOOK2MAN) apt-get.8.sgml)
-@COMPILE_MANPAGES_TRUE@        @rm -f $(srcdir)/manpage.*
-@COMPILE_MANPAGES_TRUE@apt_preferences.5: apt_preferences.5.sgml apt.ent
-@COMPILE_MANPAGES_TRUE@        (cd $(srcdir) && $(DOCBOOK2MAN) apt_preferences.5.sgml)
-@COMPILE_MANPAGES_TRUE@        @rm -f $(srcdir)/manpage.*
-@COMPILE_MANPAGES_TRUE@sources.list.5: sources.list.5.sgml apt.ent
-@COMPILE_MANPAGES_TRUE@        (cd $(srcdir) && $(DOCBOOK2MAN) sources.list.5.sgml)
-@COMPILE_MANPAGES_TRUE@        @rm -f $(srcdir)/manpage.*
-@COMPILE_MANPAGES_TRUE@vendors.list.5: vendors.list.5.sgml apt.ent
-@COMPILE_MANPAGES_TRUE@        (cd $(srcdir) && $(DOCBOOK2MAN) vendors.list.5.sgml)
-@COMPILE_MANPAGES_TRUE@        @rm -f $(srcdir)/manpage.*
 # Tell versions [3.59,3.63) of GNU make to not export all variables.
 # Otherwise a system limit (for SysV at least) may be exceeded.
 .NOEXPORT:
index 0240cea..16cfa4b 100644 (file)
@@ -3,7 +3,7 @@
 .\" <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" "29 May 2006" "" ""
+.TH "APT-CACHE" "8" "08 June 2006" "" ""
 
 .SH NAME
 apt-cache \- APT package handling utility -- cache manipulator
diff --git a/doc/apt-cache.8.sgml b/doc/apt-cache.8.sgml
deleted file mode 100644 (file)
index 2fcefb1..0000000
+++ /dev/null
@@ -1,424 +0,0 @@
-<!-- -*- mode: sgml; mode: fold -*- -->
-<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-
-<!ENTITY % aptent SYSTEM "apt.ent">
-%aptent;
-
-]>
-
-<refentry>
- &apt-docinfo;
- <refmeta>
-   <refentrytitle>apt-cache</>
-   <manvolnum>8</>
- </refmeta>
- <!-- Man page title -->
- <refnamediv>
-    <refname>apt-cache</>
-    <refpurpose>APT package handling utility -- cache manipulator</>
- </refnamediv>
-
- <!-- Arguments -->
- <refsynopsisdiv>
-   <cmdsynopsis>
-      <command>apt-cache</>
-      <arg><option>-hvsn</></arg>
-      <arg><option>-o=<replaceable/config string/</></arg>
-      <arg><option>-c=<replaceable/file/</></arg>
-      <group choice=req>
-         <arg>add <arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg></arg>
-         <arg>gencaches</>
-         <arg>showpkg <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>showsrc <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>stats</>
-         <arg>dump</>
-         <arg>dumpavail</>
-         <arg>unmet</>
-         <arg>search <arg choice="plain"><replaceable>regex</replaceable></arg></arg>
-         <arg>show <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>depends <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>whatdepends <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>pkgnames <arg choice="plain"><replaceable>prefix</replaceable></arg></arg>
-         <arg>dotty <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>policy <arg choice="plain" rep="repeat"><replaceable>pkgs</replaceable></arg></arg>
-      </group>   
-   </cmdsynopsis>
- </refsynopsisdiv>
- <RefSect1><Title>Description</>
-   <para>
-   <command/apt-cache/ performs a variety of operations on APT's package 
-   cache. <command/apt-cache/ does not manipulate the state of the system 
-   but does provide operations to search and generate interesting output 
-   from the package metadata.
-   </para>
-
-   <para>
-   Unless the <option/-h/, or <option/--help/ option is given, one of the
-   commands below must be present.
-
-   <VariableList>
-     <VarListEntry><Term>add <replaceable/file(s)/</Term>
-     <ListItem><Para>
-     <literal/add/ adds the named package index files to the package cache.
-     This is for debugging only.</Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>gencaches</Term>
-     <ListItem><Para>
-     <literal/gencaches/ performs the same operation as 
-     <command/apt-get check/. It builds the source and package caches from 
-     the sources in &sources-list; and from <filename>/var/lib/rpm/</filename>.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>showpkg <replaceable/pkg(s)/</Term>
-     <ListItem><Para>
-     <literal/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, <command>apt-cache showpkg libreadline2</> would produce 
-     output similar to the following:</Para>
-     
-<informalexample><programlisting>
-Package: libreadline2
-Versions: 2.1-12(/var/lib/apt/lists/foo_Packages),
-Reverse Depends: 
-  libreadlineg2,libreadline2
-  libreadline2-altdev,libreadline2
-Dependencies:
-2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))
-Provides:
-2.1-12 - 
-Reverse Provides: 
-</programlisting></informalexample>
-                           
-     <para>
-     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
-     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.</para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>stats</Term>
-     <ListItem><Para>
-     <literal/stats/ displays some statistics about the cache.
-     No further arguments are expected. Statistics reported are:
-     <itemizedlist>
-       <listitem><para>
-       <literal/Total package names/ is the number of package names found 
-       in the cache.
-       </para></listitem>
-       
-       <listitem><para>
-       <literal/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.
-       </para></listitem>
-
-       <listitem><para>
-       <literal/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".
-       </para></listitem>
-   
-       <listitem><para>
-       <literal/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".
-       </para></listitem>
-
-       <listitem><para>
-       <literal/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.
-       </para></listitem>
-   
-       <listitem><para>
-       <literal/Missing/ is the number of package names that were referenced in
-       a dependency but were not provided by any package. Missing packages may 
-       be in evidence if a full distribution is not accessed, or if a package
-       (real or virtual) has been dropped from the distribution. Usually they
-       are referenced from Conflicts statements.
-       </para></listitem>
-
-       <listitem><para>
-       <literal/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.
-       </para></listitem>
-
-       <listitem><para>
-       <literal/Total dependencies/ is the number of dependency relationships 
-       claimed by all of the packages in the cache.
-       </para></listitem>
-     </itemizedlist>
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>showsrc <replaceable/pkg(s)/</Term>
-     <ListItem><Para>
-     <literal/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.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>dump</Term>
-     <ListItem><Para>
-     <literal/dump/ shows a short listing of every package in the cache. It is 
-     primarily for debugging.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>dumpavail</Term>
-     <ListItem><Para>
-     <literal/dumpavail/ prints out an available list to stdout.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>unmet</Term>
-     <ListItem><Para>
-     <literal/unmet/ displays a summary of all unmet dependencies in the 
-     package cache.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>show <replaceable/pkg(s)/</Term>
-     <ListItem><Para>
-     Displays the package records for the named packages.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>search <replaceable/regex [ regex ... ]/</Term>
-     <ListItem><Para>
-     <literal/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 <option/--full/ is given
-     then output identical to <literal/show/ is produced for each matched
-     package, and if <option/--names-only/ is given then the long description
-     is not searched, only the package name is.
-     </Para><Para>
-     Separate arguments can be used to specify multiple search patterns that 
-     are and'ed together.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>depends <replaceable/pkg(s)/</Term>
-     <ListItem><Para>
-     <literal/depends/ shows a listing of each dependency a package has 
-     and all the possible other packages that can fulfill that dependency.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>whatdepends <replaceable/pkg(s)/</Term>
-     <ListItem><Para>
-     <literal/whatdepends/ shows a listing of what depends on a package.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>whatprovides <replaceable/pkg(s)/</Term>
-     <ListItem><Para>
-     <literal/whatprovides/ shows a listing of package which provides a
-     dependency.
-     </Para></ListItem>
-     </VarListEntry>
-
-
-     <VarListEntry><Term>pkgnames <replaceable/[ prefix ]/</Term>
-     <ListItem><Para>
-     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 
-     <option/--generate/ option.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>dotty <replaceable/pkg(s)/</Term>
-     <ListItem><Para>
-     <literal/dotty/ takes a list of packages on the command line and 
-     generates output suitable for use by dotty from the 
-     <ulink url="http://www.research.att.com/sw/tools/graphviz/">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 <literal>APT::Cache::GivenOnly</> option.
-     </Para><Para>
-     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.
-     </Para><Para>
-     Caution, dotty cannot graph larger sets of packages.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>policy <replaceable/[ pkg(s) ]/</Term>
-     <ListItem><Para>
-     <literal/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.
-     </Para></ListItem>
-     </VarListEntry>
-   </VariableList>
-   </para>
- </RefSect1>
- <RefSect1><Title>Options</>
-   &apt-cmdblurb;
-   
-   <VariableList>
-     <VarListEntry><term><option/-p/</><term><option/--pkg-cache/</>
-     <ListItem><Para>
-     Select the file to store the package cache. The package cache is the 
-     primary cache used by all operations.
-     Configuration Item: <literal/Dir::Cache::pkgcache/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-s/</><term><option/--src-cache/</>
-     <ListItem><Para>
-     Select the file to store the source cache. The source is used only by
-     <literal/gencaches/ and it stores a parsed version of the package 
-     information from remote sources. When building the package cache the 
-     source cache is used to advoid reparsing all of the package files.
-     Configuration Item: <literal/Dir::Cache::srcpkgcache/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-q/</><term><option/--quiet/</>
-     <ListItem><Para>
-     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
-     <option/-q=#/ to set the quietness level, overriding the configuration file.
-     Configuration Item: <literal/quiet/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-i/</><term><option/--important/</>
-     <ListItem><Para>
-     Print only important dependencies; for use with unmet. Causes only Depends and 
-     Pre-Depends relations to be printed.
-     Configuration Item: <literal/APT::Cache::Important/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-f/</><term><option/--full/</>
-     <ListItem><Para>
-     Print full package records when searching. 
-     Configuration Item: <literal/APT::Cache::ShowFull/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-a/</><term><option/--all-versions/</>
-     <ListItem><Para>
-     Print full records for all available versions. This is the
-     default; to turn it off, use <option/--no-all-versions/.
-     If <option/--no-all-versions/ is specified, only the candidate version
-     will displayed (the one which would be selected for installation).
-     This option is only applicable to  the <literal/show/ command.
-     Configuration Item: <literal/APT::Cache::AllVersions/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-g/</><term><option/--generate/</>
-     <ListItem><Para>
-     Perform automatic package cache regeneration, rather than use the cache 
-     as it is. This is the default; to turn it off, use <option/--no-generate/.
-     Configuration Item: <literal/APT::Cache::Generate/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--names-only/</><term><option/-n/</>
-     <ListItem><Para>
-     Only search on the package names, not the long descriptions. 
-     Configuration Item: <literal/APT::Cache::NamesOnly/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--all-names/</>
-     <ListItem><Para>
-     Make <literal/pkgnames/ print all names, including virtual packages 
-     and missing dependencies. 
-     Configuration Item: <literal/APT::Cache::AllNames/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--recurse/</>
-     <ListItem><Para>
-     Make <literal/depends/ recursive so that all packages mentioned are 
-     printed once.
-     Configuration Item: <literal/APT::Cache::RecurseDepends/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     &apt-commonoptions;
-     
-   </VariableList>
- </RefSect1>
-
- <RefSect1><Title>Files</>
-   <variablelist>
-     <VarListEntry><term><filename>/etc/apt/sources.list</></term>
-     <ListItem><Para>
-     Locations to fetch packages from.
-     Configuration Item: <literal/Dir::Etc::SourceList/.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><filename>&statedir;/lists/</></term>
-     <ListItem><Para>
-     Storage area for state information for each package resource specified in
-     &sources-list;
-     Configuration Item: <literal/Dir::State::Lists/.
-     </Para></ListItem>
-     </VarListEntry>
-  
-     <VarListEntry><term><filename>&statedir;/lists/partial/</></term>
-     <ListItem><Para>
-     Storage area for state information in transit.
-     Configuration Item: <literal/Dir::State::Lists/ (implicit partial).
-     </Para></ListItem>
-     </VarListEntry>     
-   </variablelist>
- </RefSect1>
-
- <RefSect1><Title>See Also</>
-   <para>
-   &apt-conf;, &sources-list;, &apt-get;
-   </para>
- </RefSect1>
-
- <RefSect1><Title>Diagnostics</>
-   <para>
-   <command/apt-cache/ returns zero on normal operation, decimal 100 on error.
-   </para>
- </RefSect1>
-
- &manbugs;
- &manauthor;
-</refentry>
index 8c06880..8d2833c 100644 (file)
@@ -3,7 +3,7 @@
 .\" <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" "29 May 2006" "" ""
+.TH "APT-CDROM" "8" "08 June 2006" "" ""
 
 .SH NAME
 apt-cdrom \- APT CDROM management utility
diff --git a/doc/apt-cdrom.8.sgml b/doc/apt-cdrom.8.sgml
deleted file mode 100644 (file)
index 2805b04..0000000
+++ /dev/null
@@ -1,156 +0,0 @@
-<!-- -*- mode: sgml; mode: fold -*- -->
-<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-
-<!ENTITY % aptent SYSTEM "apt.ent">
-%aptent;
-
-]>
-
-<refentry>
- &apt-docinfo;
- <refmeta>
-   <refentrytitle>apt-cdrom</>
-   <manvolnum>8</>
- </refmeta>
- <!-- Man page title -->
- <refnamediv>
-    <refname>apt-cdrom</>
-    <refpurpose>APT CDROM management utility</>
- </refnamediv>
-
- <!-- Arguments -->
- <refsynopsisdiv>
-   <cmdsynopsis>
-      <command>apt-cdrom</>
-      <arg><option>-hvrmfan</></arg>
-      <arg><option>-d=<replaceable/cdrom mount point/</></arg>
-      <arg><option>-o=<replaceable/config string/</></arg>
-      <arg><option>-c=<replaceable/file/</></arg>
-      <group choice=req>
-         <arg>add</>
-         <arg>ident</>
-      </group>   
-   </cmdsynopsis>
- </refsynopsisdiv>
-
- <RefSect1><Title>Description</>
-   <para>
-   <command/apt-cdrom/ is used to add a new CDROM to APTs list of available 
-   sources. <command/apt-cdrom/ takes care of determining the structure of 
-   the disc as well as correcting for several possible mis-burns and 
-   verifying the index files.   
-   </para><para>
-   It is necessary to use <command/apt-cdrom/ 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.
-   </para><para>
-   Unless the <option/-h/, or <option/--help/ option is given one of the
-   commands below must be present.
-   
-   <VariableList>
-     <VarListEntry><Term>add</Term>
-     <ListItem><Para>
-     <literal/add/ is used to add a new disc to the source list. It will unmount the
-     CDROM device, prompt for a disk to be inserted and then procceed to 
-     scan it and copy the index files. If the disc does not have a proper
-     <filename>.disk/</> directory you will be prompted for a descriptive 
-     title.
-     </Para><Para>
-     APT uses a CDROM ID to track which disc is currently in the drive and
-     maintains a database of these IDs in 
-     <filename>&statedir;/cdroms.list</>
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>ident</Term>
-     <ListItem><Para>
-     A debugging tool to report the identity of the current disc as well
-     as the stored file name
-     </Para></ListItem>
-     </VarListEntry>
-   </VariableList>
-   </para>
- </RefSect1>
-
- <RefSect1><Title>Options</>
-   &apt-cmdblurb;
-   
-   <VariableList>
-     <VarListEntry><term><option/-d/</><term><option/--cdrom/</>
-     <ListItem><Para>
-     Mount point; specify the location to mount the cdrom. This mount 
-     point must be listed in <filename>/etc/fstab</> and properly configured.
-     Configuration Item: <literal/Acquire::cdrom::mount/.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><option/-r/</><term><option/--rename/</>
-     <ListItem><Para>
-     Rename a disc; change the label of a disk or override the disks 
-     given label. This option will cause <command/apt-cdrom/ to prompt for 
-     a new label.
-     Configuration Item: <literal/APT::CDROM::Rename/.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><option/-m/</><term><option/--no-mount/</>
-     <ListItem><Para>
-     No mounting; prevent <command/apt-cdrom/ from mounting and unmounting 
-     the mount point.
-     Configuration Item: <literal/APT::CDROM::NoMount/.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><option/-f/</><term><option/--fast/</>
-     <ListItem><Para>
-     Fast Copy; Assume the package files are valid and do not check 
-     every package. This option should be used only if
-     <command/apt-cdrom/ has been run on this disc before and did not detect 
-     any errors.
-     Configuration Item: <literal/APT::CDROM::Fast/.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><option/-a/</><term><option/--thorough/</>
-     <ListItem><Para>
-     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.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><option/-n/</>
-                   <term><option/--just-print/</>
-                   <term><option/--recon/</>
-                   <term><option/--no-act/</>
-     <ListItem><Para>
-     No Changes; Do not change the &sources-list; file and do not 
-     write index files. Everything is still checked however.
-     Configuration Item: <literal/APT::CDROM::NoAct/.
-     </Para></ListItem>
-     </VarListEntry> 
-     &apt-commonoptions;
-     
-   </VariableList>
- </RefSect1>
-
- <RefSect1><Title>See Also</>
-   <para>
-   &apt-conf;, &apt-get;, &sources-list;
-   </para>
- </RefSect1>
-
- <RefSect1><Title>Diagnostics</>
-   <para>
-   <command/apt-cdrom/ returns zero on normal operation, decimal 100 on error.
-   </para>
- </RefSect1>
-
- &manbugs;
- &manauthor;
-
-</refentry>
-
index 4df4668..ce502e2 100644 (file)
@@ -3,7 +3,7 @@
 .\" <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" "29 May 2006" "" ""
+.TH "APT-CONFIG" "8" "08 June 2006" "" ""
 
 .SH NAME
 apt-config \- APT Configuration Query program
diff --git a/doc/apt-config.8.sgml b/doc/apt-config.8.sgml
deleted file mode 100644 (file)
index 5fed0cb..0000000
+++ /dev/null
@@ -1,108 +0,0 @@
-<!-- -*- mode: sgml; mode: fold -*- -->
-<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-
-<!ENTITY % aptent SYSTEM "apt.ent">
-%aptent;
-
-]>
-
-<refentry>
- &apt-docinfo;
- <refmeta>
-   <refentrytitle>apt-config</>
-   <manvolnum>8</>
- </refmeta>
- <!-- Man page title -->
- <refnamediv>
-    <refname>apt-config</>
-    <refpurpose>APT Configuration Query program</>
- </refnamediv>
-
- <!-- Arguments -->
- <refsynopsisdiv>
-   <cmdsynopsis>
-      <command>apt-config</>
-      <arg><option>-hv</></arg>
-      <arg><option>-o=<replaceable/config string/</></arg>
-      <arg><option>-c=<replaceable/file/</></arg>
-      <group choice=req>
-         <arg>shell</>
-         <arg>dump</>
-      </group>   
-   </cmdsynopsis>
- </refsynopsisdiv>
- <RefSect1><Title>Description</>
-   <para>
-   <command/apt-config/ is an internal program used by various portions of
-   the APT suite to provide consistent configurability. It accesses the main 
-   configuration file <filename>/etc/apt/apt.conf</> in a manner that is 
-   easy to use by scripted applications.
-   </para><para>
-   Unless the <option/-h/, or <option/--help/ option is given one of the
-   commands below must be present.
-   </para>
-   
-   <VariableList>
-     <VarListEntry><Term>shell</Term>
-     <ListItem><Para>
-     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:
-     </para>
-     
-<informalexample><programlisting>
-OPTS="-f"
-RES=`apt-config shell OPTS MyApp::Options`
-eval $RES
-</programlisting></informalexample>
-
-     <para>
-     This will set the shell environment variable $OPTS to the value of
-     MyApp::Options with a default of <option/-f/.
-     </para><para>
-     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.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>dump</Term>
-     <ListItem><Para>
-     Just show the contents of the configuration space.
-     </Para></ListItem>
-     </VarListEntry>
-
-   </VariableList>
- </RefSect1>
-
- <RefSect1><Title>Options</>
-   &apt-cmdblurb;
-   
-   <VariableList>
-   
-     &apt-commonoptions;
-     
-   </VariableList>
- </RefSect1>
-
- <RefSect1><Title>See Also</>
-   <para>
-   &apt-conf;
-   </para>
- </RefSect1>
-
- <RefSect1><Title>Diagnostics</>
-   <para>
-   <command/apt-config/ returns zero on normal operation, decimal 100 on error.
-   </para>
- </RefSect1>
-
- &manbugs;
- &manauthor;
-</refentry>
index 085dc3f..80bbea9 100644 (file)
@@ -3,7 +3,7 @@
 .\" <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" "29 May 2006" "" ""
+.TH "APT-GET" "8" "08 June 2006" "" ""
 
 .SH NAME
 apt-get \- APT package handling utility -- command-line interface
@@ -340,6 +340,11 @@ APT::Get::Tar-Only
 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
 .TP
 \fB--help\fR
diff --git a/doc/apt-get.8.sgml b/doc/apt-get.8.sgml
deleted file mode 100644 (file)
index 1e92d10..0000000
+++ /dev/null
@@ -1,541 +0,0 @@
-<!-- -*- mode: sgml; mode: fold -*- -->
-<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-
-<!ENTITY % aptent SYSTEM "apt.ent">
-%aptent;
-
-]>
-
-<refentry>
- &apt-docinfo;
- <refmeta>
-   <refentrytitle>apt-get</>
-   <manvolnum>8</>
- </refmeta>
- <!-- Man page title -->
- <refnamediv>
-    <refname>apt-get</>
-    <refpurpose>APT package handling utility -- command-line interface</>
- </refnamediv>
-
- <!-- Arguments -->
- <refsynopsisdiv>
-   <cmdsynopsis>
-      <command>apt-get</>
-      <arg><option>-hvs</></arg>
-      <arg><option>-o=<replaceable/config string/</></arg>
-      <arg><option>-c=<replaceable/file/</></arg>
-      <group choice=req>
-         <arg>update</>
-         <arg>upgrade</>
-         <arg>install <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>remove <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>source <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>build-dep <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
-         <arg>check</>
-         <arg>clean</>
-         <arg>autoclean</>
-      </group>   
-   </cmdsynopsis>
- </refsynopsisdiv>
- <RefSect1><Title>Description</>
-   <para>
-   <command/apt-get/ 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.
-   </para><para>
-   Unless the <option/-h/, or <option/--help/ option is given, one of the
-   commands below must be present.
-   
-   <VariableList>
-     <VarListEntry><Term>update</Term>
-     <ListItem><Para>
-     <literal/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 <filename>/etc/apt/sources.list</>.
-     An <literal/update/ should always be 
-     performed before an <literal/upgrade/ or <literal/dist-upgrade/.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>upgrade</Term>
-     <ListItem><Para>   
-     <literal/upgrade/ is used to install the newest versions of all packages 
-     currently installed on the system from the sources enumerated in
-     <filename>/etc/apt/sources.list</>. 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 <literal/update/ must be 
-     performed first so that <command/apt-get/ knows that new versions of packages are 
-     available.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>dist-upgrade</Term>
-     <ListItem><Para>   
-     <literal/dist-upgrade/, in addition to performing the function of 
-     <literal/upgrade/, also intelligently handles changing dependencies 
-     with new versions of packages; <command/apt-get/ 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 <filename>/etc/apt/sources.list</> file contains a list of locations 
-     from which to retrieve desired package files.
-     See also &apt-preferences; for a mechanism for
-     overriding the general settings for individual packages.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>install</Term>
-     <ListItem><Para>   
-     <literal/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 <literal/glibc-2.4.8.i686.rpm/). 
-     All packages required 
-     by the package(s) specified for installation will also be retrieved and 
-     installed. The <filename>/etc/apt/sources.list</> 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.
-     </para><para>
-     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).
-     </para><para>
-     Both of the version selection mechanisms can downgrade packages and must
-     be used with care.
-     </para><para>
-     Finally, the &apt-preferences; mechanism allows you to
-     create an alternative installation policy for
-     individual packages.
-     </para><para>
-     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.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>remove</Term>
-     <ListItem><Para>   
-     <literal/remove/ is identical to <literal/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.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>source</Term>
-     <ListItem><Para>
-     <literal/source/ causes <command/apt-get/ 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 <literal/rpm-src/ type lines 
-     in the &sources-list; 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.
-     </para><para>
-     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 
-     <literal/APT::Get::Only-Source/ option.
-     </para><para>
-     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.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>build-dep</Term>
-     <ListItem><Para>   
-     <literal/build-dep/ causes apt-get to install/remove packages in an 
-     attempt to satisfy the build dependencies for a source package.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>check</Term>
-     <ListItem><Para>   
-     <literal/check/ is a diagnostic tool; it updates the package cache and checks 
-     for broken dependencies.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>clean</Term>
-     <ListItem><Para>   
-     <literal/clean/ clears out the local repository of retrieved package 
-     files. It removes everything but the lock file from 
-     <filename>&cachedir;/archives/</> and 
-     <filename>&cachedir;/archives/partial/</>. 
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>autoclean</Term>
-     <ListItem><Para>   
-     Like <literal/clean/, <literal/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 
-     <literal/APT::Clean-Installed/ will prevent installed packages from being
-     erased if it is set to off.
-     </Para></ListItem>
-     </VarListEntry>
-   </VariableList>
-   </para>
- </RefSect1>
- <RefSect1><Title>Options</>
-   &apt-cmdblurb;
-
-   <VariableList>
-     <VarListEntry><term><option/-d/</><term><option/--download-only/</>
-     <ListItem><Para>
-     Download only; package files are only retrieved, not unpacked or installed.
-     Configuration Item: <literal/APT::Get::Download-Only/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-f/</><term><option/--fix-broken/</>
-     <ListItem><Para>
-     Fix; attempt to correct a system with broken dependencies in            
-     place. This option, when used with install/remove, can omit any packages
-     to permit APT to deduce a likely 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 <option/-m/ may produce an
-     error in some situations. 
-     Configuration Item: <literal/APT::Get::Fix-Broken/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-m/</><term><option/--ignore-missing/</>
-                   <term><option/--fix-missing/</>
-     <ListItem><Para>
-     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  
-     <option/-f/ 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: <literal/APT::Get::Fix-Missing/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--no-download/</>
-     <ListItem><Para>
-     Disables downloading of packages. This is best used with 
-     <option/--ignore-missing/ to force APT to use only the .rpms it has 
-     already downloaded.
-     Configuration Item: <literal/APT::Get::Download/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-q/</><term><option/--quiet/</>
-     <ListItem><Para>
-     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
-     <option/-q=#/ to set the quiet level, overriding the configuration file. 
-     Note that quiet level 2 implies <option/-y/, 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: <literal/quiet/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-s/</>
-                   <term><option/--simulate/</>
-                  <term><option/--just-print/</>
-                  <term><option/--dry-run/</>
-                  <term><option/--recon/</>
-                  <term><option/--no-act/</>
-     <ListItem><Para>
-     No action; perform a simulation of events that would occur but do not
-     actually change the system. 
-     Configuration Item: <literal/APT::Get::Simulate/.
-     </para><para>
-     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).
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-y/</><term><option/--yes/</>
-                   <term><option/--assume-yes/</>
-     <ListItem><Para>
-     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 <literal/apt-get/ 
-     will abort. 
-     Configuration Item: <literal/APT::Get::Assume-Yes/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-u/</><term><option/--show-upgraded/</>
-     <ListItem><Para>
-     Show upgraded packages; Print out a list of all packages that are to be
-     upgraded. 
-     Configuration Item: <literal/APT::Get::Show-Upgraded/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-V/</><term><option/--verbose-versions/</>
-     <ListItem><Para>
-     Show full versions for upgraded and installed packages.
-     Configuration Item: <literal/APT::Get::Show-Versions/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-b/</><term><option/--compile/</>
-                   <term><option/--build/</>
-     <ListItem><Para>
-     Compile source packages after downloading them.
-     Configuration Item: <literal/APT::Get::Compile/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--ignore-hold/</>
-     <ListItem><Para>
-     Ignore package Holds; This causes <command/apt-get/ to ignore a hold 
-     placed on a package. This may be useful in conjunction with 
-     <literal/dist-upgrade/ to override a large number of undesired holds. 
-     Configuration Item: <literal/APT::Ignore-Hold/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--no-upgrade/</>
-     <ListItem><Para>
-     Do not upgrade packages; When used in conjunction with <literal/install/
-     <literal/no-upgrade/ will prevent packages listed from being upgraded
-     if they are already installed. 
-     Configuration Item: <literal/APT::Get::Upgrade/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--force-yes/</>
-     <ListItem><Para>
-     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 
-     <literal/force-yes/ can potentially destroy your system! 
-     Configuration Item: <literal/APT::Get::force-yes/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--print-uris/</>
-     <ListItem><Para>
-     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 
-     <literal/source/ and <literal/update/ commands. When used with the
-     <literal/update/ command the MD5 and size are not included, and it is
-     up to the user to decompress any compressed files.
-     Configuration Item: <literal/APT::Get::Print-URIs/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--purge/</>
-     <ListItem><Para>
-     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: <literal/APT::Get::Purge/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--reinstall/</>
-     <ListItem><Para>
-     Re-Install packages that are already installed and at the newest version.
-     Configuration Item: <literal/APT::Get::ReInstall/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--list-cleanup/</>
-     <ListItem><Para>
-     This option defaults to on, use <literal/--no-list-cleanup/ to turn it 
-     off. When on <command/apt-get/ will automatically manage the contents of 
-     <filename>&statedir;/lists</> to ensure that obsolete files are erased. 
-     The only  reason to turn it off is if you frequently change your source 
-     list. 
-     Configuration Item: <literal/APT::Get::List-Cleanup/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/-t/</>
-                   <term><option/--target-release/</>
-                   <term><option/--default-release/</>
-     <ListItem><Para>
-     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 
-     <option>-t '2.1*'</> or <option>-t unstable</>.
-     Configuration Item: <literal/APT::Default-Release/;
-     see also the &apt-preferences; manual page.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--trivial-only/</>
-     <ListItem><Para>
-     Only perform operations that are 'trivial'. Logically this can be considered
-     related to <option/--assume-yes/, where <option/--assume-yes/ will answer 
-     yes to any prompt, <option/--trivial-only/ will answer no. 
-     Configuration Item: <literal/APT::Get::Trivial-Only/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--no-remove/</>
-     <ListItem><Para>
-     If any packages are to be removed apt-get immediately aborts without
-     prompting. 
-     Configuration Item: <literal/APT::Get::Remove/
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--only-source/</>
-     <ListItem><Para>
-     Only has meaning for the <literal/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
-     <literal/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: <literal/APT::Get::Only-Source/
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><term><option/--diff-only/</><term><option/--tar-only/</>
-     <ListItem><Para>
-     Download only the diff or tar file of a source archive. 
-     Configuration Item: <literal/APT::Get::Diff-Only/ and 
-     <literal/APT::Get::Tar-Only/
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><option/--arch-only/</>
-     <ListItem><Para>
-     Only process architecture-dependent build-dependencies.
-     Configuration Item: <literal/APT::Get::Arch-Only/ 
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><option/--root/</>
-     <ListItem><Para>
-     Install to alternate root directory. For example
-     <option>--root /mnt/buildsys-fc4</>.
-     Configuration Item: <literal/RPM::RootDir/;
-     </Para></ListItem>
-     </VarListEntry>
-
-     &apt-commonoptions;
-     
-   </VariableList>
- </RefSect1>
-
- <RefSect1><Title>Files</>
-   <variablelist>
-     <VarListEntry><term><filename>/etc/apt/sources.list</></term>
-     <ListItem><Para>
-     Locations to fetch packages from.
-     Configuration Item: <literal/Dir::Etc::SourceList/.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><filename>/etc/apt/apt.conf</></term>
-     <ListItem><Para>
-     APT configuration file.
-     Configuration Item: <literal/Dir::Etc::Main/.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><filename>/etc/apt/apt.conf.d/</></term>
-     <ListItem><Para>
-     APT configuration file fragments
-     Configuration Item: <literal/Dir::Etc::Parts/.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><filename>/etc/apt/preferences</></term>
-     <ListItem><Para>
-     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: <literal/Dir::Etc::Preferences/.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><filename>&cachedir;/archives/</></term>
-     <ListItem><Para>
-     Storage area for retrieved package files.
-     Configuration Item: <literal/Dir::Cache::Archives/.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><filename>&cachedir;/archives/partial/</></term>
-     <ListItem><Para>
-     Storage area for package files in transit.
-     Configuration Item: <literal/Dir::Cache::Archives/ (implicit partial). 
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><term><filename>&statedir;/lists/</></term>
-     <ListItem><Para>
-     Storage area for state information for each package resource specified in
-     &sources-list;
-     Configuration Item: <literal/Dir::State::Lists/.
-     </Para></ListItem>
-     </VarListEntry>
-  
-     <VarListEntry><term><filename>&statedir;/lists/partial/</></term>
-     <ListItem><Para>
-     Storage area for state information in transit.
-     Configuration Item: <literal/Dir::State::Lists/ (implicit partial).
-     </Para></ListItem>
-     </VarListEntry>     
-   </variablelist>
- </RefSect1>
-
- <RefSect1><Title>See Also</>
-   <para>
-   &apt-cache;, &apt-cdrom;, &sources-list;,
-   &apt-conf;, &apt-config;,
-   The APT User's guide in &docdir;, &apt-preferences;, the APT Howto.
-   </para>
- </RefSect1>
-
- <RefSect1><Title>Diagnostics</>
-   <para>
-   <command/apt-get/ returns zero on normal operation, decimal 100 on error.
-   </para>
- </RefSect1>
-
- &manbugs;
- &manauthor;
-</refentry>
index 6e39dc1..5e0e42b 100644 (file)
@@ -3,7 +3,7 @@
 .\" <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" "29 May 2006" "" ""
+.TH "APT.CONF" "5" "08 June 2006" "" ""
 
 .SH NAME
 apt.conf \- Configuration file for APT
diff --git a/doc/apt.conf.5.sgml b/doc/apt.conf.5.sgml
deleted file mode 100644 (file)
index 9a94767..0000000
+++ /dev/null
@@ -1,417 +0,0 @@
-<!-- -*- mode: sgml; mode: fold -*- -->
-<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-
-<!ENTITY % aptent SYSTEM "apt.ent">
-%aptent;
-
-]>
-
-<refentry>
- &apt-docinfo;
- <refmeta>
-   <refentrytitle>apt.conf</>
-   <manvolnum>5</>
- </refmeta>
- <!-- Man page title -->
- <refnamediv>
-    <refname>apt.conf</>
-    <refpurpose>Configuration file for APT</>
- </refnamediv>
- <RefSect1><Title>Description</>
-   <para>
-   <filename/apt.conf/ is the main configuration file for the APT suite of
-   tools, all tools make use of the configuration file and a common command line
-   parser to provide a uniform environment. When an APT tool starts up it will
-   read the configuration specified by the <envar/APT_CONFIG/ environment 
-   variable (if any) and then read the files in <literal/Dir::Etc::Parts/ 
-   then read the main configuration file specified by 
-   <literal/Dir::Etc::main/ then finally apply the
-   command line options to override the configuration directives, possibly 
-   loading even more config files.
-   </para><para>
-   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 <literal/APT::Get::Assume-Yes/ is an option within 
-   the APT tool group, for the Get tool. Options do not inherit from their 
-   parent groups.
-   </para><para>
-   Syntacticly the configuration language is modeled after what the ISC tools
-   such as bind and dhcp use.  Lines starting with
-   <literal>//</literal> are treated as comments (ignored).  Each line is of the form
-   <literallayout>APT::Get::Assume-Yes "true";</literallayout> The trailing 
-   semicolon is required and the quotes are optional. A new scope can be
-   opened with curly braces, like:
-<informalexample><programlisting>   
-APT {
-  Get {
-    Assume-Yes "true";
-    Fix-Broken "true";
-  };
-};
-</programlisting></informalexample>
-   with newlines placed to make it more readable. Lists can be created by 
-   opening a scope and including a single word enclosed in quotes followed by a 
-   semicolon. Multiple entries can be included, each separated by a semicolon.
-<informalexample><programlisting>   
-RPM::Allow-Duplicated {"kernel"; "kernel-smp";};
-</programlisting></informalexample>
-   </para><para>
-   In general the sample configuration file in 
-   <filename>&docdir;examples/apt.conf</> &configureindex;
-   is a good guide for how it should look.
-   </para><para>
-   Two specials are allowed, <literal/#include/ and <literal/#clear/. 
-   <literal/#include/ will include the given file, unless the filename
-   ends in a slash, then the whole directory is included.  
-   <literal/#clear/ is used to erase a list of names.
-   </para><para>
-   All of the APT tools take a -o option which allows an arbitrary configuration 
-   directive to be specified on the command line. The syntax is a full option
-   name (<literal/APT::Get::Assume-Yes/ for instance) followed by an equals
-   sign then the new value of the option. Lists can be appended too by adding 
-   a trailing :: to the list name.   
-   </para>
- </RefSect1>
-
- <RefSect1><Title>The APT Group</>
-   <para>   
-   This group of options controls general APT behavior as well as holding the
-   options for all of the tools.
-
-   <VariableList>
-     <VarListEntry><Term>Architecture</Term>
-     <ListItem><Para>
-     System Architecture; sets the architecture to use when fetching files and
-     parsing package lists. The internal default is the architecture apt was 
-     compiled for.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>Ignore-Hold</Term>
-     <ListItem><Para>
-     Ignore Held packages; This global option causes the problem resolver to
-     ignore held packages in its decision making. 
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>Clean-Installed</Term>
-     <ListItem><Para>
-     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.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>Force-LoopBreak</Term>
-     <ListItem><Para>
-     Never Enable this option unless you -really- 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 
-     will work if the essential packages are not gzip, libc, rpm, bash or
-     anything that those packages depend on.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>Cache-Limit</Term>
-     <ListItem><Para>
-     APT uses a fixed size memory mapped cache file to store the 'available'
-     information. This sets the size of that cache.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>Build-Essential</Term>
-     <ListItem><Para>
-     Defines which package(s) are considered essential build dependencies.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>Get</Term>
-     <ListItem><Para>
-     The Get subsection controls the &apt-get; tool, please see its
-     documentation for more information about the options here.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>Cache</Term>
-     <ListItem><Para>
-     The Cache subsection controls the &apt-cache; tool, please see its
-     documentation for more information about the options here.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>CDROM</Term>
-     <ListItem><Para>
-     The CDROM subsection controls the &apt-cdrom; tool, please see its
-     documentation for more information about the options here.
-     </Para></ListItem>
-     </VarListEntry>
-   </VariableList>
-   </para>
- </RefSect1>
-
- <RefSect1><Title>The Acquire Group</>
-   <para>   
-   The <literal/Acquire/ group of options controls the download of packages 
-   and the URI handlers. 
-
-   <VariableList>
-     <VarListEntry><Term>Queue-Mode</Term>
-     <ListItem><Para>
-     Queuing mode; <literal/Queue-Mode/ can be one of <literal/host/ or 
-     <literal/access/ which determines how  APT parallelizes outgoing 
-     connections. <literal/host/ means that one connection per target host 
-     will be opened, <literal/access/ means that one connection per URI type 
-     will be opened.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>Retries</Term>
-     <ListItem><Para>
-     Number of retries to perform. If this is non-zero APT will retry failed 
-     files the given number of times.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>Source-Symlinks</Term>
-     <ListItem><Para>
-     Use symlinks for source archives. If set to true then source archives will
-     be symlinked when possible instead of copying. True is the default
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>http</Term>
-     <ListItem><Para>
-     HTTP URIs; http::Proxy is the default http proxy to use. It is in the 
-     standard form of <literal>http://[[user][:pass]@]host[:port]/</>. Per 
-     host proxies can also be specified by using the form 
-     <literal/http::Proxy::&lt;host&gt;/ with the special keyword <literal/DIRECT/ 
-     meaning to use no proxies. The <envar/http_proxy/ environment variable
-     will override all settings.
-     </Para><Para>
-     Three settings are provided for cache control with HTTP/1.1 compliant 
-     proxy caches. <literal/No-Cache/ tells the proxy to not use its cached 
-     response under any circumstances, <literal/Max-Age/ is sent only for 
-     index files and tells the cache to refresh its object if it is older than 
-     the given number of seconds. Debian updates its index files daily so the 
-     default is 1 day. <literal/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.
-     </Para><Para>
-     The option <literal/timeout/ sets the timeout timer used by the method, 
-     this applies to all things including connection timeout and data timeout.
-     </Para><Para>
-     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)
-     <literal/Acquire::http::Pipeline-Depth/ can be a value from 0 to 5 
-     indicating how many outstanding requests APT should send. A value of
-     zero MUST be specified if the remote host does not properly linger
-     on TCP connections - otherwise data corruption will occur. Hosts which
-     require this are in violation of RFC 2068.     
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>ftp</Term>
-     <ListItem><Para>
-     FTP URIs; ftp::Proxy is the default proxy server to use. It is in the 
-     standard form of <literal>ftp://[[user][:pass]@]host[:port]/</> and is 
-     overridden by the <envar/ftp_proxy/ environment variable. To use a ftp 
-     proxy you will have to set the <literal/ftp::ProxyLogin/ script in the 
-     configuration file. This entry specifies the commands to send to tell 
-     the proxy server what to connect to. Please see 
-     &configureindex; for an example of 
-     how to do this. The subsitution variables available are 
-     <literal/$(PROXY_USER)/, <literal/$(PROXY_PASS)/, <literal/$(SITE_USER)/,
-     <literal/$(SITE_PASS)/, <literal/$(SITE)/, and <literal/$(SITE_PORT)/.
-     Each is taken from it's respective URI component.
-     </Para><Para>
-     The option <literal/timeout/ sets the timeout timer used by the method, 
-     this applies to all things including connection timeout and data timeout.
-     </Para><Para>
-     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)
-     </Para><Para>
-     It is possible to proxy FTP over HTTP by setting the <envar/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.
-     </Para><Para>
-     The setting <literal/ForceExtended/ controls the use of RFC2428 
-     <literal/EPSV/ and <literal/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.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>cdrom</Term>
-     <ListItem><Para>
-     CDROM URIs; the only setting for CDROM URIs is the mount point, 
-     <literal/cdrom::Mount/ which must be the mount point for the CDROM drive 
-     as specified in <filename>/etc/fstab</>. It is possible to provide 
-     alternate mount and unmount commands if your mount point cannot be listed 
-     in the fstab (such as an SMB mount and old mount packages). The syntax 
-     is to put <literallayout>"/cdrom/"::Mount "foo";</literallayout> within 
-     the cdrom block. It is important to have the trailing slash. Unmount 
-     commands can be specified using UMount.
-     </Para></ListItem>
-     </VarListEntry>
-   </VariableList>
-   </para>
- </RefSect1>
-
- <RefSect1><Title>Directories</>
-   <para>   
-   The <literal/Dir::State/ section has directories that pertain to local 
-   state information. <literal/lists/ is the directory to place downloaded 
-   package lists in.
-   <literal/preferences/ is the name of the APT preferences file.
-   <literal/Dir::State/ contains the default directory to prefix on all sub 
-   items if they do not start with <filename>/</> or <filename>./</>. 
-   </para><para>
-   <literal/Dir::Cache/ contains locations pertaining to local cache 
-   information, such as the two package caches <literal/srcpkgcache/ and 
-   <literal/pkgcache/ as well as the location to place downloaded archives, 
-   <literal/Dir::Cache::archives/. Generation of caches can be turned off
-   by setting their names to be blank. This will slow down startup but
-   save disk space. It is probably prefered to turn off the pkgcache rather
-   than the srcpkgcache. Like <literal/Dir::State/ the default
-   directory is contained in <literal/Dir::Cache/
-   </para><para>
-   <literal/Dir::Etc/ contains the location of configuration files, 
-   <literal/sourcelist/ gives the location of the sourcelist and 
-   <literal/main/ is the default configuration file (setting has no effect,
-   unless it is done from the config file specified by 
-   <envar/APT_CONFIG/).
-   </para><para>
-   The <literal/Dir::Parts/ 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.
-   </para><para>
-   Binary programs are pointed to by <literal/Dir::Bin/. <literal/Dir::Bin::Methods/ 
-   specifies the location of the method handlers and <literal/gzip/, 
-   <literal/rpm/, <literal/apt-get/, <literal/rpmbuild/
-   and <literal/apt-cache/ specify the location
-   of the respective programs.
-   </para>
- </RefSect1>
- <RefSect1><Title>How APT calls rpm</>
-   <para>   
-   Several configuration directives control how APT invokes &rpm;. These are 
-   in the <literal/RPM/ section.
-
-   <VariableList>
-     <VarListEntry><Term>Options</Term>
-     <ListItem><Para>
-     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 &rpm;.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>Install-Options</Term>
-     <ListItem><Para>
-     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 &rpm;.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>Erase-Options</Term>
-     <ListItem><Para>
-     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 &rpm;.
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>Pre-Invoke</Term><Term>Post-Invoke</Term>
-     <ListItem><Para>
-     This is a list of shell commands to run before/after invoking &rpm;. 
-     Like <literal/Options/ this must be specified in list notation. The 
-     commands are invoked in order using <filename>/bin/sh</>, should any 
-     fail APT will abort.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>Pre-Install-Pkgs</Term>
-     <ListItem><Para>
-     This is a list of shell commands to run before invoking rpm. Like
-     <literal/Options/ this must be specified in list notation. The commands
-     are invoked in order using <filename>/bin/sh</>, 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.
-     </para><para>
-     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 
-     <literal/DPkg::Tools::Options::cmd::Version/ to 2. <literal/cmd/ is a
-     command given to <literal/Pre-Install-Pkgs/.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>Run-Directory</Term>
-     <ListItem><Para>
-     APT chdirs to this directory before invoking rpm, the default is 
-     <filename>/</>.
-     </Para></ListItem>
-     </VarListEntry>
-
-     <VarListEntry><Term>Build-Options</Term>
-     <ListItem><Para>
-     These options are passed to &rpmbuild; when compiling packages.
-     </Para></ListItem>
-     </VarListEntry>
-   </VariableList>
-   </para>
- </RefSect1>
-
- <RefSect1><Title>Debug Options</>
-   <para>   
-   Most of the options in the <literal/debug/ section are not interesting to 
-   the normal user, however <literal/Debug::pkgProblemResolver/ shows 
-   interesting output about the decisions dist-upgrade makes. 
-   <literal/Debug::NoLocking/ disables file locking so APT can do some 
-   operations as non-root and <literal/Debug::pkgRPMPM/ will print out the 
-   command line for each rpm invokation. <literal/Debug::IdentCdrom/ will 
-   disable the inclusion of statfs data in CDROM IDs.
-   </para>
- </RefSect1>
- <RefSect1><Title>Examples</>
-   <para>
-   &configureindex; contains a 
-   sample configuration file showing the default values for all possible 
-   options.
-   </para>
- </RefSect1>
- <RefSect1><Title>Files</>
-   <para>
-   <filename>/etc/apt/apt.conf</>
-   </para>
- </RefSect1>
- <RefSect1><Title>See Also</>
-   <para>
-   &apt-cache;, &apt-config;<!-- ? reading apt.conf -->, &apt-preferences;.
-   </para>
- </RefSect1>
-
- &manbugs;
- &manauthor;
-</refentry>
index 7a53f0f..7238807 100644 (file)
@@ -3,7 +3,7 @@
 .\" <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" "29 May 2006" "" ""
+.TH "APT_PREFERENCES" "5" "08 June 2006" "" ""
 
 .SH NAME
 apt_preferences \- Preference control file for APT
diff --git a/doc/apt_preferences.5.sgml b/doc/apt_preferences.5.sgml
deleted file mode 100644 (file)
index bd7a998..0000000
+++ /dev/null
@@ -1,572 +0,0 @@
-<!-- -*- mode: sgml; mode: fold -*- -->
-<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-
-<!ENTITY % aptent SYSTEM "apt.ent">
-%aptent;
-
-]>
-
-<refentry>
- &apt-docinfo;
-
- <refmeta>
-   <refentrytitle>apt_preferences</>
-   <manvolnum>5</>
- </refmeta>
-
- <!-- Man page title -->
- <refnamediv>
-    <refname>apt_preferences</>
-    <refpurpose>Preference control file for APT</>
- </refnamediv>
-
-<RefSect1>
-<Title>Description</Title>
-<para>
-The APT preferences file <filename>/etc/apt/preferences</>
-can be used to control which versions of packages will be selected
-for installation.
-</para>
-
-<para>
-Several versions of a package may be available for installation when
-the &sources-list; file contains references to more than one distribution
-(for example, <literal>stable</literal> and <literal>testing</literal>).
-APT assigns a priority to each version that is available.
-Subject to dependency constraints, <command>apt-get</command> 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.
-</para>
-<para>
-Several instances of the same version of a package may be available when
-the &sources-list; file contains references to more than one source.
-In this case <command>apt-get</command> downloads the instance listed
-earliest in the &sources-list; file.
-The APT preferences file does not affect the choice of instance, only
-the choice of version.
-</para>
-
-<RefSect2><Title>APT's Default Priority Assignments</>
-
-<para>
-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 <command>apt-get</command> command
-line or in the APT configuration file <filename>/etc/apt/apt.conf</filename>.
-For example,
-<programlisting>
-<command>apt-get install -t testing <replaceable>some-package</replaceable></command>
-</programlisting>
-<programlisting>
-APT::Default-Release "stable";
-</programlisting>
-</para>
-
-<para>
-If the target release has been specified then APT uses the following
-algorithm to set the priorities of the versions of a package.  Assign:
-<variablelist>
-<varlistentry>
-<term>priority 100</term>
-<listitem><simpara>to the version that is already installed (if any).</simpara></listitem>
-</varlistentry>
-<varlistentry>
-<term>priority 500</term>
-<listitem><simpara>to the versions that are not installed and do not belong to the target release.</simpara></listitem>
-</varlistentry>
-<varlistentry>
-<term>priority 990</term>
-<listitem><simpara>to the versions that are not installed and belong to the target release.</simpara></listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<para>
-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.
-</para>
-
-<para>
-APT then applies the following rules, listed in order of precedence,
-to determine which version of a package to install.
-<itemizedlist>
-<listitem><simpara>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.)</simpara></listitem>
-<listitem><simpara>Install the highest priority version.</simpara></listitem>
-<listitem><simpara>If two or more versions have the same priority,
-install the most recent one (that is, the one with the higher version
-number).</simpara></listitem>
-<listitem><simpara>If two or more versions have the same priority and
-version number but either the packages differ in some of their metadata or the
-<literal/--reinstall/ option is given, install the uninstalled one.</simpara></listitem>
-</itemizedlist>
-</para>
-
-<para>
-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 &sources-list; file (priority 500 or 990).  Then the package will be upgraded
-when <command>apt-get install <replaceable>some-package</replaceable></command>
-or <command>apt-get upgrade</command> is executed.
-</para>
-
-<para>
-More rarely, the installed version of a package is <emphasis/more/ recent
-than any of the other available versions.  The package will not be downgraded
-when <command>apt-get install <replaceable>some-package</replaceable></command>
-or <command>apt-get upgrade</command> is executed.
-</para>
-
-<para>
-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 <command>apt-get install <replaceable>some-package</replaceable></command>
-or <command>apt-get upgrade</command> is executed,
-because at least <emphasis/one/ of the available versions has a higher
-priority than the installed version.
-</para>
-
-</RefSect2>
-
-<RefSect2><Title>The Effect of APT Preferences</>
-
-<para>
-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.
-<itemizedlist>
-<listitem>
-<simpara>
-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 <filename/perl/ package whose version number begins with "<literal/5.8/".
-</simpara>
-
-<programlisting>
-Package: perl
-Pin: version 5.8*
-Pin-Priority: 1001
-</programlisting>
-</listitem>
-
-<listitem><simpara>
-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 <filename/Release/ file) or to all of the package
-versions coming from a particular Internet site, as identified by the
-site's fully qualified domain name.
-</simpara>
-
-<simpara>
-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.
-</simpara>
-
-<programlisting>
-Package: *
-Pin: origin ""
-Pin-Priority: 999
-</programlisting>
-
-<simpara>
-A note of caution: the keyword used here is "<literal/origin/".
-This should not be confused with the Origin of a distribution as
-specified in a <filename/Release/ file.  What follows the "Origin:" tag
-in a <filename/Release/ file is not an Internet address
-but an author or vendor name, such as "Debian" or "Ximian".
-</simpara>
-
-<simpara>
-The following record assigns a low priority to all package versions
-belonging to any distribution whose Archive name is "<literal/unstable/".
-</simpara>
-
-<programlisting>
-Package: *
-Pin: release a=unstable
-Pin-Priority: 50
-</programlisting>
-
-<simpara>
-The following record assigns a high priority to all package versions
-belonging to any release whose Archive name is "<literal/stable/"
-and whose release Version number is "<literal/3.0/".
-</simpara>
-
-<programlisting>
-Package: *
-Pin: release a=unstable, v=3.0
-Pin-Priority: 50
-</programlisting>
-</listitem>
-</itemizedlist>
-</para>
-
-</RefSect2>
-
-<RefSect2>
-<Title>How APT Interprets Priorities</Title>
-
-<para>
-Priorities (P) assigned in the APT preferences file must be positive
-or negative integers.  They are interpreted as follows (roughly speaking):
-
-<variablelist>
-<varlistentry>
-<term>P &gt; 1000</term>
-<listitem><simpara>causes a version to be installed even if this
-constitutes a downgrade of the package</simpara></listitem>
-</varlistentry>
-<varlistentry>
-<term>990 &lt; P &lt;=1000</term>
-<listitem><simpara>causes a version to be installed
-even if it does not come from the target release,
-unless the installed version is more recent</simpara></listitem>
-</varlistentry>
-<varlistentry>
-<term>500 &lt; P &lt;=990</term>
-<listitem><simpara>causes a version to be installed
-unless there is a version available belonging to the target release
-or the installed version is more recent</simpara></listitem>
-</varlistentry>
-<varlistentry>
-<term>100 &lt; P &lt;=500</term>
-<listitem><simpara>causes a version to be installed
-unless there is a version available belonging to some other
-distribution or the installed version is more recent</simpara></listitem>
-</varlistentry>
-<varlistentry>
-<term>0 &lt; P &lt;=100</term>
-<listitem><simpara>causes a version to be installed
-only if there is no installed version of the package</simpara></listitem>
-</varlistentry>
-<varlistentry>
-<term>P &lt; 0</term>
-<listitem><simpara>prevents the version from being installed</simpara></listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<para>
-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.  
-</para>
-
-<para>
-For example, suppose the APT preferences file contains the three
-records presented earlier:
-
-<programlisting>
-Package: perl
-Pin: version 5.8*
-Pin-Priority: 1001
-
-Package: *
-Pin: origin ""
-Pin-Priority: 999
-
-Package: *
-Pin: release unstable
-Pin-Priority: 50
-</programlisting>
-
-Then:
-
-<itemizedlist>
-<listitem><simpara>The most recent available version of the <literal/perl/
-package will be installed, so long as that version's version number begins
-with "<literal/5.8/".  If <emphasis/any/ 5.8* version of <literal/perl/ is
-available and the installed version is 5.9*, then <literal/perl/ will be
-downgraded.</simpara></listitem>
-<listitem><simpara>A version of any package other than <literal/perl/
-that is available from the local system has priority over other versions,
-even versions belonging to the target release.
-</simpara></listitem>
-<listitem><simpara>A version of a package whose origin is not the local
-system but some other site listed in &sources-list; and which belongs to
-an <literal/unstable/ distribution is only installed if it is selected
-for installation and no version of the package is already installed.
-</simpara></listitem>
-</itemizedlist>
-</para>
-</RefSect2>
-
-<RefSect2>
-<Title>Determination of Package Version and Distribution Properties</Title>
-
-<para>
-The locations listed in the &sources-list; file should provide
-<filename>Packages</filename> and <filename>Release</filename> files
-to describe the packages available at that location.
-</para>
-
-<para>
-The <filename>Packages</filename> file is normally found in the directory
-<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>:
-for example, <filename>.../dists/stable/main/binary-i386/Packages</filename>.
-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:
-<variablelist>
-<varlistentry>
-<term>the <literal/Package:/ line</term>
-<listitem><simpara>gives the package name</simpara></listitem>
-</varlistentry>
-<varlistentry>
-<term>the <literal/Version:/ line</term>
-<listitem><simpara>gives the version number for the named package</simpara></listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<para>
-The <filename>Release</filename> file is normally found in the directory
-<filename>.../dists/<replaceable>dist-name</replaceable></filename>:
-for example, <filename>.../dists/stable/Release</filename>,
-or <filename>.../dists/woody/Release</filename>.
-It consists of a single multi-line record which applies to <emphasis/all/ of
-the packages in the directory tree below its parent.  Unlike the
-<filename/Packages/ file, nearly all of the lines in a <filename/Release/
-file are relevant for setting APT priorities:
-
-<variablelist>
-<varlistentry>
-<term>the <literal/Archive:/ line</term>
-<listitem><simpara>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 <filename/Release/ file are in a
-<literal/stable/ archive.  Specifying this value in the APT preferences file
-would require the line:
-</simpara>
-<programlisting>
-Pin: release a=stable
-</programlisting>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>the <literal/Version:/ line</term>
-<listitem><simpara>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
-<literal/testing/ and <literal/unstable/ distributions because they
-have not been released yet.  Specifying this in the APT preferences
-file would require one of the following lines.
-</simpara>
-
-<programlisting>
-Pin: release v=3.0
-Pin: release a=stable, v=3.0
-Pin: release 3.0
-</programlisting>
-
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>the <literal/Component:/ line</term>
-<listitem><simpara>names the licensing component associated with the
-packages in the directory tree of the <filename/Release/ file.
-For example, the line "Component: main" specifies that
-all the packages in the directory tree are from the <literal/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:
-</simpara>
-<programlisting>
-Pin: release c=main
-</programlisting>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>the <literal/Origin:/ line</term>
-<listitem><simpara>names the originator of the packages in the
-directory tree of the <filename/Release/ file.  Most commonly, this is
-<literal/Debian/.  Specifying this origin in the APT preferences file
-would require the line:
-</simpara>
-<programlisting>
-Pin: release o=Debian
-</programlisting>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term>the <literal/Label:/ line</term>
-<listitem><simpara>names the label of the packages in the directory tree
-of the <filename/Release/ file.  Most commonly, this is
-<literal/Debian/.  Specifying this label in the APT preferences file
-would require the line:
-</simpara>
-<programlisting>
-Pin: release l=Debian
-</programlisting>
-</listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-<para>
-All of the <filename>Packages</filename> and <filename>Release</filename>
-files retrieved from locations listed in the &sources-list; file are stored
-in the directory <filename>/var/lib/apt/lists</filename>, or in the file named
-by the variable <literal/Dir::State::Lists/ in the <filename/apt.conf/ file.
-For example, the file
-<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename>
-contains the <filename>Release</filename> file retrieved from the site
-<literal/debian.lcs.mit.edu/ for <literal/binary-i386/ architecture
-files from the <literal/contrib/ component of the <literal/unstable/
-distribution.
-</para>
-
-</RefSect2>
-
-<RefSect2>
-<Title>Optional Lines in an APT Preferences Record</Title>
-
-<para>
-Each record in the APT preferences file can optionally begin with
-one or more lines beginning with the word <literal/Explanation:/.
-This provides a place for comments.
-</para>
-
-<para>
-The <literal/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 <literal/Pin-Priority: release .../.
-</para>
-</RefSect2>
-</RefSect1>
-
-<RefSect1>
-<Title>Examples</Title>
-<RefSect2>
-<Title>Tracking Stable</Title>
-
-<para>
-The following APT preferences file will cause APT to assign a
-priority higher than the default (500) to all package versions belonging
-to a <literal/stable/ distribution and a prohibitively low priority to
-package versions belonging to other <literal/Debian/ distributions.
-
-<programlisting>
-Explanation: Uninstall or do not install any Debian-originated
-Explanation: package versions other than those in the stable distro
-Package: *
-Pin: release a=stable
-Pin-Priority: 900
-
-Package: *
-Pin: release o=Debian
-Pin-Priority: -10
-</programlisting>
-</para>
-
-<para>
-With a suitable &sources-list; file and the above preferences file,
-any of the following commands will cause APT to upgrade to the
-latest <literal/stable/ version(s).
-
-<programlisting>
-apt-get install <replaceable>package-name</replaceable>
-apt-get upgrade
-apt-get dist-upgrade
-</programlisting>
-</para>
-
-<para>
-The following command will cause APT to upgrade the specified
-package to the latest version from the <literal/testing/ distribution;
-the package will not be upgraded again unless this command is given
-again.
-
-<programlisting>
-apt-get install <replaceable>package</replaceable>/testing
-</programlisting>
-</para>
-</RefSect2>
-
- <RefSect2>
- <Title>Tracking Testing or Unstable</Title>
-
-<para>
-The following APT preferences file will cause APT to assign
-a high priority to package versions from the <literal/testing/
-distribution, a lower priority to package versions from the
-<literal/unstable/ distribution, and a prohibitively low priority
-to package versions from other <literal/Debian/ distributions.
-
-<programlisting>
-Package: *
-Pin: release a=testing
-Pin-Priority: 900
-
-Package: *
-Pin: release a=unstable
-Pin-Priority: 800
-
-Package: *
-Pin: release o=Debian
-Pin-Priority: -10
-</programlisting>
-</para>
-
-<para>
-With a suitable &sources-list; file and the above preferences file,
-any of the following commands will cause APT to upgrade to the latest
-<literal/testing/ version(s).
-
-<programlisting>
-apt-get install <replaceable>package-name</replaceable>
-apt-get upgrade
-apt-get dist-upgrade
-</programlisting>
-</para>
-
-<para>The following command will cause APT to upgrade the specified
-package to the latest version from the <literal/unstable/ distribution.
-Thereafter, <command>apt-get upgrade</command> will upgrade
-the package to the most recent <literal/testing/ version if that is
-more recent than the installed version, otherwise, to the most recent
-<literal/unstable/ version if that is more recent than the installed
-version.
-
-<programlisting>
-apt-get install <replaceable>package</replaceable>/unstable
-</programlisting>
-</para>
-
-</RefSect2>
-</RefSect1>
-
-<RefSect1>
-<Title>See Also</Title>
-<para>
-&apt-get; &apt-cache; &apt-conf; &sources-list;
-</para>
-</RefSect1>
-
- &manbugs;
- &manauthor;
-
-</refentry>
index 5e8b6a4..a5dbb97 100644 (file)
@@ -3,7 +3,7 @@
 .\" <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" "29 May 2006" "" ""
+.TH "SOURCES.LIST" "5" "08 June 2006" "" ""
 
 .SH NAME
 sources.list \- Package resource list for APT
diff --git a/doc/sources.list.5.sgml b/doc/sources.list.5.sgml
deleted file mode 100644 (file)
index c2bd6d5..0000000
+++ /dev/null
@@ -1,186 +0,0 @@
-<!-- -*- mode: sgml; mode: fold -*- -->
-<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-
-<!ENTITY % aptent SYSTEM "apt.ent">
-%aptent;
-
-]>
-
-<refentry>
- &apt-docinfo;
- <refmeta>
-   <refentrytitle>sources.list</>
-   <manvolnum>5</>
- </refmeta>
- <!-- Man page title -->
- <refnamediv>
-    <refname>sources.list</>
-    <refpurpose>Package resource list for APT</>
- </refnamediv>
- <RefSect1><Title>Description</>
-   <para>   
-   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 <filename>/etc/apt/sources.list</>
-   and additionally any files ending in .list in 
-   <filename>/etc/apt/sources.list.d</> are included.
-   </>
-   <para>
-   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:
-   <literal/type uri args/. The first item, <literal/type/, determines the 
-   format for <literal/args/. <literal/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 #.
-   </>
-   <para>
-   The generic format of sources.list entry is:
-   <literallayout>type baseuri distribution [component comp2 ...]</literallayout>
-   </para>
-
-   <para>
-   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
-   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.
-   </para>
-
-   <para>
-   The following variable substitutions are done on sources.list entries:
-
-   <literal/$(ARCH)/ is substituted with the base archecture of the system.
-   </para><para>
-   <literal/$(VERSION)/ is substituted with the distribution version if
-   configured automatically via Apt::DistroVerPkg or manually via 
-   Apt::DistroVersion configuration option.
-   </para>
- </RefSect1>
- <RefSect1><Title>The repomd and repomd-src types</>
-   <para>
-   The format of repomd and repomd-src sources.list entries is:
-   <literallayout>repomd baseuri distribution</literallayout>
-   <literallayout>repomd-src baseuri distribution</literallayout>
-   Repomd repositories do not support a concept of "components"!
-   </para>
-    
- </RefSect1>
-
- <RefSect1><Title>The rpm and rpm-src types</>
-   <para>
-   The format of rpm and rpm-src sources.list entries is:
-   <literallayout>rpm baseuri distribution component [comp2 ...]</literallayout>
-   <literallayout>rpm-src baseuri distribution component [comp2 ...]</literallayout>
-   At least one component must be specified for rpm and rpm-src 
-   repositories.
-   </para>
- </RefSect1>
-
- <RefSect1><Title>The rpm-dir and rpm-src-dir types</>
-   <para>
-   The format of rpm-dir and rpm-src-dir sources.list entries is:
-   <literallayout>rpm-dir baseuri distribution component [comp2 ...]</literallayout>
-   <literallayout>rpm-src-dir baseuri distribution component [comp2 ...]</literallayout>
-   At least one component must be specified for rpm and rpm-src 
-   repositories. Rpm-dir and rpm-src-dir only accept file:// uri's!
-   </para>
- </RefSect1>
-
- <RefSect1><title>URI specification</title>
-   <para>
-   The currently recognized URI types are cdrom, file, http, and ftp.
-   <VariableList>
-    <VarListEntry><term>file</term>
-    <ListItem><Para>
-    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
-    archives.</para></listitem>
-    </VarListEntry>
-    
-    <VarListEntry><term>cdrom</term>
-    <ListItem><Para>
-    The cdrom scheme allows APT to use a local CDROM drive with media
-    swapping. Use the &apt-cdrom; program to create cdrom entries in the
-    source list.</para></listitem>
-    </VarListEntry>
-
-    <VarListEntry><term>http</term>
-    <ListItem><Para>
-    The http scheme specifies an HTTP server for the archive. If an environment
-    variable <EnVar/http_proxy/ is set with the format 
-    http://server:port/, the proxy server specified in
-    <EnVar/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.</para></listitem>
-    </VarListEntry>
-
-    <VarListEntry><term>ftp</term>
-    <ListItem><Para>
-    The ftp scheme specifies an FTP server for the archive. APT's FTP behavior
-    is highly configurable; for more information see the
-    &apt-conf; manual page. Please note that a ftp proxy can be specified
-    by using the <EnVar/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.</para></listitem>
-    </VarListEntry>
-
-    <VarListEntry><term>copy</term>
-    <ListItem><Para>
-    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.</para></listitem>
-    </VarListEntry>
-    
-    <VarListEntry><term>rsh</term><term>ssh</term>
-    <ListItem><Para>
-    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 
-    possible, prior arrangements with RSA keys or rhosts must have been made.
-    Access to files on the remote uses standard <command/find/ and <command/dd/ 
-    commands to perform the file transfers from the remote.</para></listitem>
-    </VarListEntry>
-  </VariableList>
- </para>
- </RefSect1>
- <RefSect1><title>Examples</title>
-   <para>
-   Repomd entries for Fedora Core, Extras and Updates using variable
-   substitution, assumes Apt::DistroVerPkg is set to "fedora-release":
-   <literallayout>
-   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)/
-   </literallayout>
-   </para>
-   
-   <para>
-   Local mirror (local disk, NFS mounted etc) of Fedora Core at 
-   /var/www/html/fedora/
-   <literallayout>
-   repomd file:/var/www/html fedora/linux/core/$(VERSION)/$(ARCH)/
-   </literallayout>
-   </para>
-
- </RefSect1>
- <RefSect1><Title>See Also</>
-   <para>
-   &apt-cache; &apt-conf;
-   </para>
- </RefSect1>
-
- &manbugs;
- &manauthor;
-</refentry>
-
index 0e8df41..a99a9fc 100644 (file)
@@ -3,7 +3,7 @@
 .\" <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" "29 May 2006" "" ""
+.TH "VENDORS.LIST" "5" "08 June 2006" "" ""
 
 .SH NAME
 vendors.list \- Security key configuration for APT
diff --git a/doc/vendors.list.5.sgml b/doc/vendors.list.5.sgml
deleted file mode 100644 (file)
index 1931913..0000000
+++ /dev/null
@@ -1,109 +0,0 @@
-<!-- -*- mode: sgml; mode: fold -*- -->
-<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-
-<!ENTITY % aptent SYSTEM "apt.ent">
-%aptent;
-
-]>
-
-<refentry>
- &apt-docinfo;
- <refmeta>
-   <refentrytitle>vendors.list</>
-   <manvolnum>5</>
- </refmeta>
- <!-- Man page title -->
- <refnamediv>
-    <refname>vendors.list</>
-    <refpurpose>Security key configuration for APT</>
- </refnamediv>
- <RefSect1><Title>Description</>
-   <para>   
-   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.
-   </para><para>
-   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
-   <replaceable/key_type/ and the <replaceable/vendor_id/.
-   </para><para>
-   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.
-   </para><para>
-   <replaceable/key_type/ is the type of the check required.
-   Currently, there is only one type available which is 
-   <literal/simple-key/.
-   </para><para>
-   <replaceable/vendor_id/ is the vendor identification string. It is an
-   arbitrary string you must supply to uniquely identifify a
-   vendor that's listed in this file.
-   
-   Example:
-<informalexample><programlisting>   
-simple-key "joe"
-{
-   Fingerprint "0987AB4378FSD872343298787ACC";
-   Name "Joe Shmoe &lt;joe@shmoe.com&gt;";
-}                                                  
-</programlisting></informalexample>
-   </para>
- </RefSect1>
-
- <RefSect1><Title>The simple-key type</>
-   <para>   
-   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
-   
-   <VariableList>
-     <VarListEntry><Term>Fingerprint</Term>
-     <ListItem><Para>
-     The PGP fingerprint for the key. The fingerprint should be
-     expressed in the standard notion with or without spaces.
-     The <option/--fingerprint/ option for 
-     <CiteRefEntry><RefEntryTitle><command/gpg/</RefEntryTitle><ManVolNum/1/</CiteRefEntry>
-     will show the fingerprint for the selected keys(s).
-     </Para></ListItem>
-     </VarListEntry>
-     
-     <VarListEntry><Term>Name</Term>
-     <ListItem><Para>
-     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 ".
-     </Para></ListItem>
-     </VarListEntry>
-     
-   </VariableList>
-   </para>
- </RefSect1>
-
- <RefSect1><Title>Files</>
-   <para>
-   <filename>/etc/apt/vendors.list</>
-   </para>
- </RefSect1>
- <RefSect1><Title>See Also</>
-   <para>
-   &sources-list;
-   </para>
- </RefSect1>
-
- &manbugs;
- &manauthor;
-</refentry>
-