Browse Source

* Replace SGML manpages with XML man pages from richard...

Author: mdz
Date: 2004-02-07 21:48:14 GMT
* Replace SGML manpages with XML man pages from richard.bos@xs4all.nl
(Closes: #230687)
tags/devuan/2.0.1+devuan1
Arch Librarian 16 years ago
parent
commit
24f6490f4b
27 changed files with 2824 additions and 2907 deletions
  1. +1
    -0
      buildlib/defaults.mak
  2. +3
    -0
      buildlib/environment.mak.in
  3. +3
    -0
      configure.in
  4. +2
    -0
      debian/changelog
  5. +0
    -412
      doc/apt-cache.8.sgml
  6. +371
    -0
      doc/apt-cache.8.xml
  7. +0
    -147
      doc/apt-cdrom.8.sgml
  8. +162
    -0
      doc/apt-cdrom.8.xml
  9. +0
    -105
      doc/apt-config.8.sgml
  10. +109
    -0
      doc/apt-config.8.xml
  11. +0
    -80
      doc/apt-extracttemplates.1.sgml
  12. +77
    -0
      doc/apt-extracttemplates.1.xml
  13. +0
    -571
      doc/apt-ftparchive.1.sgml
  14. +565
    -0
      doc/apt-ftparchive.1.xml
  15. +0
    -512
      doc/apt-get.8.sgml
  16. +466
    -0
      doc/apt-get.8.xml
  17. +0
    -73
      doc/apt-sortpkgs.1.sgml
  18. +71
    -0
      doc/apt-sortpkgs.1.xml
  19. +0
    -415
      doc/apt.conf.5.sgml
  20. +389
    -0
      doc/apt.conf.5.xml
  21. +145
    -107
      doc/apt.ent
  22. +136
    -178
      doc/apt_preferences.5.xml
  23. +4
    -4
      doc/makefile
  24. +0
    -199
      doc/sources.list.5.sgml
  25. +211
    -0
      doc/sources.list.5.xml
  26. +0
    -104
      doc/vendors.list.5.sgml
  27. +109
    -0
      doc/vendors.list.5.xml

+ 1
- 0
buildlib/defaults.mak View File

@@ -83,6 +83,7 @@ PYTHON_H = $(BASE)/buildlib/python.mak
COPY_H = $(BASE)/buildlib/copy.mak
YODL_MANPAGE_H = $(BASE)/buildlib/yodl_manpage.mak
SGML_MANPAGE_H = $(BASE)/buildlib/sgml_manpage.mak
XML_MANPAGE_H = $(BASE)/buildlib/xml_manpage.mak
FAIL_H = $(BASE)/buildlib/fail.mak
PODOMAIN_H = $(BASE)/buildlib/podomain.mak



+ 3
- 0
buildlib/environment.mak.in View File

@@ -31,6 +31,9 @@ DEBIANDOC_TEXT = @DEBIANDOC_TEXT@
# SGML for the man pages
DOCBOOK2MAN := @DOCBOOK2MAN@

# XML for the man pages
XMLTO := @XMLTO@

# Gettext settings
GMSGFMT = @GMSGFMT@
XGETTEXT = @XGETTEXT@


+ 3
- 0
configure.in View File

@@ -160,6 +160,9 @@ AC_PATH_PROG(DEBIANDOC_TEXT,debiandoc2text)
dnl Check for the SGML tools needed to build man pages
AC_PATH_PROG(DOCBOOK2MAN,docbook2man)

dnl Check for the XML tools needed to build man pages
AC_PATH_PROG(XMLTO,xmlto)

dnl Check for YODL
dnl AC_CHECK_PROG(YODL_MAN,yodl2man,"yes","")



+ 2
- 0
debian/changelog View File

@@ -14,6 +14,8 @@ apt (0.5.22) unstable; urgency=low
(Closes: #230102)
* Simplified Chinese translation of message catalog from "Carlos
Z.F. Liu" <carlos_liu@yahoo.com> (Closes: #230960)
* Replace SGML manpages with XML man pages from richard.bos@xs4all.nl
(Closes: #230687)

--



+ 0
- 412
doc/apt-cache.8.sgml View File

@@ -1,412 +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>rdepends <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>
<arg>madison <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>
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.
</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/dpkg/status</>.
</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:
<informalexample><programlisting>
Package: libreadline2
Versions: 2.1-12(/var/state/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.
</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.
</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.
</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".
</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".
</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.
</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.
</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.
</listitem>

<listitem><para>
<literal/Total dependencies/ is the number of dependency relationships
claimed by all of the packages in the cache.
</listitem>
</itemizedlist>
</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.
</VarListEntry>
<VarListEntry><Term>dump</Term>
<ListItem><Para>
<literal/dump/ shows a short listing of every package in the cache. It is
primarily for debugging.
</VarListEntry>

<VarListEntry><Term>dumpavail</Term>
<ListItem><Para>
<literal/dumpavail/ prints out an available list to stdout. This is
suitable for use with &dpkg; and is used by the &dselect; method.
</VarListEntry>

<VarListEntry><Term>unmet</Term>
<ListItem><Para>
<literal/unmet/ displays a summary of all unmet dependencies in the
package cache.
</VarListEntry>

<VarListEntry><Term>show <replaceable/pkg(s)/</Term>
<ListItem><Para>
<literal/show/ performs a function similar to
<command>dpkg --print-avail</>i; it displays the package records for the
named packages.
</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>
Separate arguments can be used to specify multiple search patterns that
are and'ed together.
</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.
</VarListEntry>

<VarListEntry><Term>rdepends <replaceable/pkg(s)/</Term>
<ListItem><Para>
<literal/rdepends/ shows a listing of each reverse dependency a package
has.
</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.
</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>
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>
Caution, dotty cannot graph larger sets of packages.
<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.
</VarListEntry>

<VarListEntry><Term>madison <replaceable/[ pkg(s) ]/</Term>
<ListItem><Para>

<literal/apt-cache/'s <literal/madison/ command attempts to mimic
the output format and a subset of the functionality of the Debian
archive management tool, <literal/madison/. It displays
available versions of a package in a tabular format. Unlike the
original <literal/madison/, it can only display information for
the architecture for which APT has retrieved package lists
(<literal/APT::Architecture/).

</VarListEntry>
</VariableList>
</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/.
</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/.
</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/.
</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/.
</VarListEntry>

<VarListEntry><term><option/-f/</><term><option/--full/</>
<ListItem><Para>
Print full package records when searching.
Configuration Item: <literal/APT::Cache::ShowFull/.
</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/.
</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/.
</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/.
</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/.
</VarListEntry>

<VarListEntry><term><option/--recurse/</>
<ListItem><Para>
Make <literal/depends/ and <literal/rdepends/ recursive so that
all packages mentioned are printed once.
Configuration Item: <literal/APT::Cache::RecurseDepends/.
</VarListEntry>

<VarListEntry><term><option/--installed/</>
<ListItem><Para>
Limit the output of <literal/depends/ and <literal/rdepends/ to
packages which are currently installed.
Configuration Item: <literal/APT::Cache::Installed/.
</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/.
</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/.
</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).
</VarListEntry>
</variablelist>
</RefSect1>

<RefSect1><Title>See Also</>
<para>
&apt-conf;, &sources-list;, &apt-get;
</RefSect1>

<RefSect1><Title>Diagnostics</>
<para>
<command/apt-cache/ returns zero on normal operation, decimal 100 on error.
</RefSect1>

&manbugs;
&manauthor;
</refentry>

+ 371
- 0
doc/apt-cache.8.xml View File

@@ -0,0 +1,371 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

]>

<refentry>
&apt-docinfo;
<refmeta>
<refentrytitle>apt-cache</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<!-- Man page title -->
<refnamediv>
<refname>apt-cache</refname>
<refpurpose>APT package handling utility -- cache manipulator</refpurpose>
</refnamediv>

<!-- Arguments -->
<refsynopsisdiv>
<cmdsynopsis>
<command>apt-cache</command>
<arg><option>-hvsn</option></arg>
<arg><option>-o=<replaceable>config string</replaceable></option></arg>
<arg><option>-c=<replaceable>file</replaceable></option></arg>
<group choice="req">
<arg>add <arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg></arg>
<arg>gencaches</arg>
<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>
<arg>dump</arg>
<arg>dumpavail</arg>
<arg>unmet</arg>
<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>rdepends <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>
<arg>madison <arg choice="plain" rep="repeat"><replaceable>pkgs</replaceable></arg></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para><command>apt-cache</command> performs a variety of operations on APT's package
cache. <command>apt-cache</command> 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</option>, or <option>--help</option> option is given, one of the
commands below must be present.</para>

<variablelist>
<varlistentry><term>add <replaceable>file(s)</replaceable></term>
<listitem><para><literal>add</literal> 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</literal> performs the same operation as
<command>apt-get check</command>. It builds the source and package caches from
the sources in &sources-list; and from
<filename>/var/lib/dpkg/status</filename>.</para></listitem>
</varlistentry>

<varlistentry><term>showpkg <replaceable>pkg(s)</replaceable></term>
<listitem><para><literal>showpkg</literal> 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</command> would produce
output similar to the following:</para>
<informalexample><programlisting>
Package: libreadline2
Versions: 2.1-12(/var/state/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</literal> displays some statistics about the cache.
No further arguments are expected. Statistics reported are:
<itemizedlist>
<listitem><para><literal>Total package names</literal> is the number of package names found
in the cache.</para>
</listitem>
<listitem><para><literal>Normal packages</literal> 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</literal> 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</literal> 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</literal> 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</literal> 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</literal> 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</literal> 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)</replaceable></term>
<listitem><para><literal>showsrc</literal> 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</literal> 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</literal> prints out an available list to stdout. This is
suitable for use with &dpkg; and is used by the &dselect; method.</para></listitem>
</varlistentry>

<varlistentry><term>unmet</term>
<listitem><para><literal>unmet</literal> displays a summary of all unmet dependencies in the
package cache.</para></listitem>
</varlistentry>

<varlistentry><term>show <replaceable>pkg(s)</replaceable></term>
<listitem><para><literal>show</literal> performs a function similar to
<command>dpkg --print-avail</command>i; it displays the package records for the
named packages.</para></listitem>
</varlistentry>

<varlistentry><term>search <replaceable>regex [ regex ... ]</replaceable></term>
<listitem><para><literal>search</literal> 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</option> is given
then output identical to <literal>show</literal> is produced for each matched
package, and if <option>--names-only</option> 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)</replaceable></term>
<listitem><para><literal>depends</literal> 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>rdepends <replaceable>pkg(s)</replaceable></term>
<listitem><para><literal>rdepends</literal>shows a listing of each reverse dependency a
package has.</para></listitem>
</varlistentry>

<varlistentry><term>pkgnames <replaceable>[ prefix ]</replaceable></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> option.</para></listitem>
</varlistentry>
<varlistentry><term>dotty <replaceable>pkg(s)</replaceable></term>
<listitem><para><literal>dotty</literal> 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</ulink>
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</literal> 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) ]</replaceable></term>
<listitem><para><literal>policy</literal> 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>

<varlistentry><term>madison <replaceable>/[ pkg(s) ]</replaceable></term>
<listitem><para><literal>apt-cache</literal>'s <literal>madison</literal> command attempts to mimic
the output format and a subset of the functionality of the Debian
archive management tool, <literal>madison</literal>. It displays
available versions of a package in a tabular format. Unlike the
original <literal>madison</literal>, it can only display information for
the architecture for which APT has retrieved package lists
(<literal>APT::Architecture</literal>).</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>options</title>
&apt-cmdblurb;
<variablelist>
<varlistentry><term><option>-p</option></term><term><option>--pkg-cache</option></term>
<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</literal>.</para></listitem>
</varlistentry>

<varlistentry><term><option>-s</option></term><term><option>--src-cache</option></term>
<listitem><para>Select the file to store the source cache. The source is used only by
<literal>gencaches</literal> 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</literal>.</para></listitem>
</varlistentry>

<varlistentry><term><option>-q</option></term><term><option>--quiet</option></term>
<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=#</option> to set the quietness level, overriding the configuration file.
Configuration Item: <literal>quiet</literal>.</para></listitem>
</varlistentry>

<varlistentry><term><option>-i</option></term><term><option>--important</option></term>
<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</literal>.</para></listitem>
</varlistentry>

<varlistentry><term><option>-f</option></term><term><option>--full</option></term>
<listitem><para>Print full package records when searching.
Configuration Item: <literal>APT::Cache::ShowFull</literal>.</para></listitem>
</varlistentry>

<varlistentry><term><option>-a</option></term><term><option>--all-versions</option></term>
<listitem><para>Print full records for all available versions. This is the
default; to turn it off, use <option>--no-all-versions</option>.
If <option>--no-all-versions</option> 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</literal> command.
Configuration Item: <literal>APT::Cache::AllVersions</literal>.</para></listitem>
</varlistentry>

<varlistentry><term><option>-g</option></term><term><option>--generate</option></term>
<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</option>.
Configuration Item: <literal>APT::Cache::Generate</literal>.</para></listitem>
</varlistentry>

<varlistentry><term><option>--names-only</option></term><term><option>-n</option></term>
<listitem><para>Only search on the package names, not the long descriptions.
Configuration Item: <literal>APT::Cache::NamesOnly</literal>.</para></listitem>
</varlistentry>

<varlistentry><term><option>--all-names</option></term>
<listitem><para>Make <literal>pkgnames</literal> print all names, including virtual packages
and missing dependencies.
Configuration Item: <literal>APT::Cache::AllNames</literal>.</para></listitem>
</varlistentry>

<varlistentry><term><option>--recurse</option></term>
<listitem><para>Make <literal>depends</literal> and <literal>rdepends</literal> recursive so
that all packages mentioned are printed once.
Configuration Item: <literal>APT::Cache::RecurseDepends</literal>.</para></listitem>
</varlistentry>

<varlistentry><term><option>--installed</option></term>
<listitem><para>
Limit the output of <literal>depends</literal> and <literal>rdepends</literal> to
packages which are currently installed.
Configuration Item: <literal>APT::Cache::Installed</literal>.</para></listitem>
</varlistentry>

&apt-commonoptions;
</variablelist>
</refsect1>

<refsect1><title>Files</title>
<variablelist>
<varlistentry><term><filename>/etc/apt/sources.list</filename></term>
<listitem><para>Locations to fetch packages from.
Configuration Item: <literal>Dir::Etc::SourceList</literal>.</para></listitem>
</varlistentry>
<varlistentry><term><filename>&statedir;/lists/</filename></term>
<listitem><para>Storage area for state information for each package resource specified in
&sources-list;
Configuration Item: <literal>Dir::State::Lists</literal>.</para></listitem>
</varlistentry>
<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>
<listitem><para>Storage area for state information in transit.
Configuration Item: <literal>Dir::State::Lists</literal> (implicit partial).</para></listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1><title>See Also</title>
<para>&apt-conf;, &sources-list;, &apt-get;
</para>
</refsect1>

<refsect1><title>Diagnostics</title>
<para><command>apt-cache</command> returns zero on normal operation, decimal 100 on error.
</para>
</refsect1>

&manbugs;
&manauthor;
</refentry>

+ 0
- 147
doc/apt-cdrom.8.sgml View File

@@ -1,147 +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>
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>
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>
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</>
</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
</VarListEntry>
</VariableList>
</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/.
</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/.
</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/.
</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/.
</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.
</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/.
</VarListEntry>
&apt-commonoptions;
</VariableList>
</RefSect1>

<RefSect1><Title>See Also</>
<para>
&apt-conf;, &apt-get;, &sources-list;
</RefSect1>

<RefSect1><Title>Diagnostics</>
<para>
<command/apt-cdrom/ returns zero on normal operation, decimal 100 on error.
</RefSect1>

&manbugs;
&manauthor;

</refentry>


+ 162
- 0
doc/apt-cdrom.8.xml View File

@@ -0,0 +1,162 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

]>

<refentry>

&apt-docinfo;

<refmeta>
<refentrytitle>apt-cdrom</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<!-- Man page title -->
<refnamediv>
<refname>apt-cdrom</refname>
<refpurpose>APT CDROM management utility</refpurpose>
</refnamediv>

<!-- Arguments -->
<refsynopsisdiv>
<cmdsynopsis>
<command>apt-cdrom</command>
<arg><option>-hvrmfan</option></arg>
<arg><option>-d=<replaceable>cdrom mount point</replaceable></option></arg>
<arg><option>-o=<replaceable>config string</replaceable></option></arg>
<arg><option>-c=<replaceable>file</replaceable></option></arg>
<group>
<arg>add</arg>
<arg>ident</arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1><title>Description</title>
<para><command>apt-cdrom</command> is used to add a new CDROM to APTs list
of available sources. <command>apt-cdrom</command> 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</command> 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</option>, or <option>--help</option> option is
given one of the commands below must be present.
<variablelist>
<varlistentry><term>add</term>
<listitem><para><literal>add</literal> 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</filename> 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</filename>
</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</title>
&apt-cmdblurb;
<variablelist>
<varlistentry><term><option>-d</option></term><term><option>--cdrom</option></term>
<listitem><para>Mount point; specify the location to mount the cdrom. This
mount point must be listed in <filename>/etc/fstab</filename> and
properly configured.
Configuration Item: <literal>Acquire::cdrom::mount</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><option>-r</option></term><term><option>--rename</option></term>
<listitem><para>Rename a disc; change the label of a disk or override the
disks given label. This option will cause <command>apt-cdrom</command> to
prompt for a new label.
Configuration Item: <literal>APT::CDROM::Rename</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><option>-m</option></term><term><option>--no-mount</option></term>
<listitem><para>No mounting; prevent <command>apt-cdrom</command> from
mounting and unmounting the mount point.
Configuration Item: <literal>APT::CDROM::NoMount</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><option>-f</option></term><term><option>--fast</option></term>
<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</command> has been run on this disc before and did not
detect any errors.
Configuration Item: <literal>APT::CDROM::Fast</literal>.
</para>
</listitem>
</varlistentry>

<varlistentry><term><option>-a</option></term><term><option>--thorough</option></term>
<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</option></term>
<term><option>--just-print</option></term>
<term><option>--recon</option></term>
<term><option>--no-act</option></term>
<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</literal>.
</para>
</listitem>
</varlistentry>

&apt-commonoptions;

</variablelist>
</refsect1>

<refsect1><title>See Also</title>
<para>&apt-conf;, &apt-get;, &sources-list;
</para>
</refsect1>

<refsect1><title>Diagnostics</title>
<para><command>apt-cdrom</command> returns zero on normal operation, decimal 100 on error.
</para>
</refsect1>

&manbugs;
&manauthor;

</refentry>


+ 0
- 105
doc/apt-config.8.sgml View File

@@ -1,105 +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>
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>
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.
</VarListEntry>

<VarListEntry><Term>dump</Term>
<ListItem><Para>
Just show the contents of the configuration space.
</VarListEntry>

</VariableList>
</RefSect1>

<RefSect1><Title>Options</>
&apt-cmdblurb;
<VariableList>
&apt-commonoptions;
</VariableList>
</RefSect1>

<RefSect1><Title>See Also</>
<para>
&apt-conf;
</RefSect1>

<RefSect1><Title>Diagnostics</>
<para>
<command/apt-config/ returns zero on normal operation, decimal 100 on error.
</RefSect1>

&manbugs;
&manauthor;
</refentry>

+ 109
- 0
doc/apt-config.8.xml View File

@@ -0,0 +1,109 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

]>

<refentry>
&apt-docinfo;
<refmeta>
<refentrytitle>apt-config</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<!-- Man page title -->
<refnamediv>
<refname>apt-config</refname>
<refpurpose>APT Configuration Query program</refpurpose>
</refnamediv>

<!-- Arguments -->
<refsynopsisdiv>
<cmdsynopsis>
<command>apt-config</command>
<arg><option>-hv</option></arg>
<arg><option>-o=<replaceable>config string</replaceable></option></arg>
<arg><option>-c=<replaceable>file</replaceable></option></arg>
<group choice="req">
<arg>shell</arg>
<arg>dump</arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para><command>apt-config</command> 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</filename> in a
manner that is easy to use by scripted applications.</para>

<para>Unless the <option>-h</option>, or <option>--help</option> 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</option>.</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</title>
&apt-cmdblurb;
<variablelist>
&apt-commonoptions;
</variablelist>
</refsect1>

<refsect1><title>See Also</title>
<para>
&apt-conf;
</para>
</refsect1>

<refsect1><title>Diagnostics</title>
<para><command>apt-config</command> returns zero on normal operation, decimal 100 on error.
</para>
</refsect1>

&manbugs;
&manauthor;
</refentry>


+ 0
- 80
doc/apt-extracttemplates.1.sgml View File

@@ -1,80 +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-extracttemplates</>
<manvolnum>1</>
</refmeta>
<!-- Man page title -->
<refnamediv>
<refname>apt-extracttemplates</>
<refpurpose>Utility to extract DebConf config and templates from Debian packages</>
</refnamediv>

<!-- Arguments -->
<refsynopsisdiv>
<cmdsynopsis>
<command>apt-extracttemplates</>
<arg><option>-hv</></arg>
<arg><option>-t=<replaceable/temporary directory/</></arg>
<arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<RefSect1><Title>Description</>
<para>
<command/apt-extracttemplates/ will take one or more Debian package files
as input and write out (to a temporary directory) all associated config
scripts and template files. For each passed in package that contains
config scripts and templates, one line of output will be generated
in the format:
<para>
package version template-file config-script
<para>
template-file and config-script are written to the temporary directory
specified by the -t or --tempdir (<literal>APT::ExtractTemplates::TempDir</>)
directory, with filenames of the form <filename>package.template.XXXX</> and
<filename>package.config.XXXX</>
</RefSect1>
<RefSect1><Title>Options</>
&apt-cmdblurb;

<VariableList>
<VarListEntry><term><option/-t/</><term><option/--tempdir/</>
<ListItem><Para>
Temporary directory in which to write extracted debconf template files
and config scripts
Configuration Item: <literal/APT::ExtractTemplates::TempDir/.
</VarListEntry>

&apt-commonoptions;
</VariableList>
</RefSect1>

<RefSect1><Title>See Also</>
<para>
&apt-conf;
</RefSect1>

<RefSect1><Title>Diagnostics</>
<para>
<command/apt-extracttemplates/ returns zero on normal operation, decimal 100 on error.
</RefSect1>

&manbugs;
&manauthor;
</refentry>

+ 77
- 0
doc/apt-extracttemplates.1.xml View File

@@ -0,0 +1,77 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

]>

<refentry>
&apt-docinfo;
<refmeta>
<refentrytitle>apt-extracttemplates</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<!-- Man page title -->
<refnamediv>
<refname>apt-extracttemplates</refname>
<refpurpose>Utility to extract DebConf config and templates from Debian packages</refpurpose>
</refnamediv>

<!-- Arguments -->
<refsynopsisdiv>
<cmdsynopsis>
<command>apt-extracttemplates</command>
<arg><option>-hv</option></arg>
<arg><option>-t=<replaceable>temporary directory</replaceable></option></arg>
<arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para><command>apt-extracttemplates</command> will take one or more Debian package files
as input and write out (to a temporary directory) all associated config
scripts and template files. For each passed in package that contains
config scripts and templates, one line of output will be generated
in the format:</para>
<para>package version template-file config-script</para>
<para>template-file and config-script are written to the temporary directory
specified by the -t or --tempdir (<literal>APT::ExtractTemplates::TempDir</literal>)
directory, with filenames of the form <filename>package.template.XXXX</filename> and
<filename>package.config.XXXX</filename></para>
</refsect1>
<refsect1><title>options</title>
&apt-cmdblurb;

<variablelist>
<varlistentry><term><option>-t</option></term><term><option>--tempdir</option></term>
<listitem><para>
Temporary directory in which to write extracted debconf template files
and config scripts
Configuration Item: <literal>APT::ExtractTemplates::TempDir</literal></para></listitem>
</varlistentry>

&apt-commonoptions;
</variablelist>
</refsect1>

<refsect1><title>See Also</title>
<para>&apt-conf;</para>
</refsect1>

<refsect1><title>Diagnostics</title>
<para>
<command>apt-extracttemplates</command> returns zero on normal operation, decimal 100 on error.</para>
</refsect1>

&manbugs;
&manauthor;
</refentry>

+ 0
- 571
doc/apt-ftparchive.1.sgml View File

@@ -1,571 +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-ftparchive</>
<manvolnum>1</>
</refmeta>
<!-- Man page title -->
<refnamediv>
<refname>apt-ftparchive</>
<refpurpose>Utility to generate index files</>
</refnamediv>

<!-- Arguments -->
<refsynopsisdiv>
<cmdsynopsis>
<command>apt-ftparchive</>
<arg><option>-hvdsq</></arg>
<arg><option>--md5</></arg>
<arg><option>--delink</></arg>
<arg><option>--readonly</></arg>
<arg><option>--contents</></arg>
<arg><option>-o=<replaceable/config string/</></arg>
<arg><option>-c=<replaceable/file/</></arg>
<group choice=req>
<arg>packages<arg choice="plain" rep="repeat"><replaceable>path</replaceable></arg><arg><replaceable>override</replaceable><arg><replaceable>pathprefix</replaceable></arg></arg></arg>
<arg>sources<arg choice="plain" rep="repeat"><replaceable>path</replaceable></arg><arg><replaceable>override</replaceable><arg><replaceable>pathprefix</replaceable></arg></arg></arg>
<arg>contents <arg choice="plain"><replaceable>path</replaceable></arg></arg>
<arg>release <arg choice="plain"><replaceable>path</replaceable></arg></arg>
<arg>generate <arg choice="plain"><replaceable>config-file</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>section</replaceable></arg></arg>
<arg>clean <arg choice="plain"><replaceable>config-file</replaceable></arg></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
<RefSect1><Title>Description</>
<para>
<command/apt-ftparchive/ is the command line tool that generates the index
files that APT uses to access a distribution source. The index files should
be generated on the origin site based on the content of that site.

<para>
<command/apt-ftparchive/ is a superset of the &dpkg-scanpackages; program,
incorporating its entire functionality via the <literal/packages/ command.
It also contains a contents file generator, <literal/contents/, and an
elaborate means to 'script' the generation process for a complete
archive.

<para>
Internally <command/apt-ftparchive/ can make use of binary databases to
cache the contents of a .deb file and it does not rely on any external
programs aside from &gzip;. When doing a full generate it automatically
performs file-change checks and builds the desired compressed output files.
<para>
Unless the <option/-h/, or <option/--help/ option is given one of the
commands below must be present.
<VariableList>
<VarListEntry><term>packages</term>
<ListItem><Para>
The packages command generates a package file from a directory tree. It
takes the given directory and recursively searches it for .deb files,
emitting a package record to stdout for each. This command is
approximately equivalent to &dpkg-scanpackages;.
<para>
The option <option/--db/ can be used to specify a binary caching DB.
</VarListEntry>
<VarListEntry><term>sources</term>
<ListItem><Para>
The <literal/sources/ command generates a source index file from a directory tree.
It takes the given directory and recursively searches it for .dsc files,
emitting a source record to stdout for each. This command is approximately
equivalent to &dpkg-scansources;.
<para>
If an override file is specified then a source override file will be
looked for with an extension of .src. The --source-override option can be
used to change the source override file that will be used.
</VarListEntry>

<VarListEntry><term>contents</term>
<ListItem><Para>
The <literal/contents/ command generates a contents file from a directory tree. It
takes the given directory and recursively searches it for .deb files,
and reads the file list from each file. It then sorts and writes to stdout
the list of files matched to packages. Directories are not written to
the output. If multiple packages own the same file then each package is
separated by a comma in the output.
<para>
The option <option/--db/ can be used to specify a binary caching DB.
</VarListEntry>

<VarListEntry><term>release</term>
<ListItem><Para>
The <literal/release/ command generates a Release file from a
directory tree. It recursively searches the given directory for
Packages, Packages.gz, Packages.bz2, Sources, Sources.gz,
Sources.bz2, Release and md5sum.txt files. It then writes to
stdout a Release file containing an MD5 digest and SHA1 digest
for each file.
<para>
Values for the additional metadata fields in the Release file are
taken from the corresponding variables under
<literal/APT::FTPArchive::Release/,
e.g. <literal/APT::FTPArchive::Release::Origin/. The supported fields
are: <literal/Origin/, <literal/Label/, <literal/Suite/,
<literal/Version/, <literal/Codename/, <literal/Date/,
<literal/Architectures/, <literal/Components/, <literal/Description/.

</VarListEntry>

<VarListEntry><term>generate</term>
<ListItem><Para>
The <literal/generate/ command is designed to be runnable from a cron script and
builds indexes according to the given config file. The config language
provides a flexible means of specifying which index files are built from
which directories, as well as providing a simple means of maintaining the
required settings.
</VarListEntry>

<VarListEntry><term>clean</term>
<ListItem><Para>
The <literal/clean/ command tidies the databases used by the given
configuration file by removing any records that are no longer necessary.
</VarListEntry>
</VariableList>
</RefSect1>

<RefSect1><Title>The Generate Configuration</>
<para>
The <literal/generate/ command uses a configuration file to describe the
archives that are going to be generated. It follows the typical ISC
configuration format as seen in ISC tools like bind 8 and dhcpd.
&apt-conf; contains a description of the syntax. Note that the generate
configuration is parsed in sectional manner, but &apt-conf; is parsed in a
tree manner. This only effects how the scope tag is handled.

<para>
The generate configuration has 4 separate sections, each described below.

<refsect2><title>Dir Section</>
<Para>
The <literal/Dir/ section defines the standard directories needed to
locate the files required during the generation process. These
directories are prepended to certain relative paths defined in later
sections to produce a complete an absolute path.
<VariableList>
<VarListEntry><term>ArchiveDir</term>
<ListItem><Para>
Specifies the root of the FTP archive, in a standard
Debian configuration this is the directory that contains the
<filename/ls-LR/, and dist nodes.
</VarListEntry>

<VarListEntry><term>OverrideDir</term>
<ListItem><Para>
Specifies the location of the override files.
</VarListEntry>
<VarListEntry><term>CacheDir</term>
<ListItem><Para>
Specifies the location of the cache files
</VarListEntry>
<VarListEntry><term>FileListDir</term>
<ListItem><Para>
Specifies the location of the file list files,
if the <literal/FileList/ setting is used below.
</VarListEntry>
</VariableList>
</refsect2>
<refsect2><title>Default Section</>
<para>
The <literal/Default/ section specifies default values, and settings
that control the operation of the generator. Other sections may override
these defaults with a per-section setting.
<VariableList>
<VarListEntry><term>Packages::Compress</term>
<ListItem><Para>
Sets the default compression schemes to use
for the Package index files. It is a string that contains a space
separated list of at least one of: '.' (no compression), 'gzip' and
'bzip2'. The default for all compression schemes is '. gzip'.
</VarListEntry>

<VarListEntry><term>Packages::Extensions</term>
<ListItem><Para>
Sets the default list of file extensions that are package files.
This defaults to '.deb'.
</VarListEntry>
<VarListEntry><term>Sources::Compress</term>
<ListItem><Para>
This is similar to <literal/Packages::Compress/
except that it controls the compression for the Sources files.
</VarListEntry>
<VarListEntry><term>Sources::Extensions</term>
<ListItem><Para>
Sets the default list of file extensions that are source files.
This defaults to '.dsc'.
</VarListEntry>
<VarListEntry><term>Contents::Compress</term>
<ListItem><Para>
This is similar to <literal/Packages::Compress/
except that it controls the compression for the Contents files.
</VarListEntry>
<VarListEntry><term>DeLinkLimit</term>
<ListItem><Para>
Specifies the number of kilobytes to delink (and
replace with hard links) per run. This is used in conjunction with the
per-section <literal/External-Links/ setting.
</VarListEntry>
<VarListEntry><term>FileMode</term>
<ListItem><Para>
Specifies the mode of all created index files. It
defaults to 0644. All index files are set to this mode with no regard
to the umask.
</VarListEntry>
</VariableList>
</refsect2>
<refsect2><title>TreeDefault Section</>
<para>
Sets defaults specific to <literal/Tree/ sections. All of these
variables are substitution variables and have the strings $(DIST),
$(SECTION) and $(ARCH) replaced with their respective values.
<VariableList>
<VarListEntry><term>MaxContentsChange</term>
<ListItem><Para>
Sets the number of kilobytes of contents
files that are generated each day. The contents files are round-robined
so that over several days they will all be rebuilt.
</VarListEntry>
<VarListEntry><term>ContentsAge</term>
<ListItem><Para>
Controls the number of days a contents file is allowed
to be checked without changing. If this limit is passed the mtime of the
contents file is updated. This case can occur if the package file is
changed in such a way that does not result in a new contents file
[override edit for instance]. A hold off is allowed in hopes that new
.debs will be installed, requiring a new file anyhow. The default is 10,
the units are in days.
</VarListEntry>
<VarListEntry><term>Directory</term>
<ListItem><Para>
Sets the top of the .deb directory tree. Defaults to
<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</>
</VarListEntry>
<VarListEntry><term>SrcDirectory</term>
<ListItem><Para>
Sets the top of the source package directory tree. Defaults to
<filename>$(DIST)/$(SECTION)/source/</>
</VarListEntry>
<VarListEntry><term>Packages</term>
<ListItem><Para>
Sets the output Packages file. Defaults to
<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</>
</VarListEntry>
<VarListEntry><term>Sources</term>
<ListItem><Para>
Sets the output Packages file. Defaults to
<filename>$(DIST)/$(SECTION)/source/Sources</>
</VarListEntry>
<VarListEntry><term>InternalPrefix</term>
<ListItem><Para>
Sets the path prefix that causes a symlink to be
considered an internal link instead of an external link. Defaults to
<filename>$(DIST)/$(SECTION)/</>
</VarListEntry>
<VarListEntry><term>Contents</term>
<ListItem><Para>
Sets the output Contents file. Defaults to
<filename>$(DIST)/Contents-$(ARCH)</>. If this setting causes multiple
Packages files to map onto a single Contents file (such as the default)
then <command/apt-ftparchive/ will integrate those package files
together automatically.
</VarListEntry>
<VarListEntry><term>Contents::Header</term>
<ListItem><Para>
Sets header file to prepend to the contents output.
</VarListEntry>

<VarListEntry><term>BinCacheDB</term>
<ListItem><Para>
Sets the binary cache database to use for this
section. Multiple sections can share the same database.
</VarListEntry>
<VarListEntry><term>FileList</term>
<ListItem><Para>
Specifies that instead of walking the directory tree,
<command/apt-ftparchive/ should read the list of files from the given
file. Relative files names are prefixed with the archive directory.
</VarListEntry>
<VarListEntry><term>SourceFileList</term>
<ListItem><Para>
Specifies that instead of walking the directory tree,
<command/apt-ftparchive/ should read the list of files from the given
file. Relative files names are prefixed with the archive directory.
This is used when processing source indexs.
</VarListEntry>
</VariableList>
</refsect2>
<refsect2><title>Tree Section</>
<para>
The <literal/Tree/ section defines a standard Debian file tree which
consists of a base directory, then multiple sections in that base
directory and finally multiple Architectures in each section. The exact
pathing used is defined by the <literal/Directory/ substitution variable.
<para>
The <literal/Tree/ section takes a scope tag which sets the
<literal/$(DIST)/ variable and defines the root of the tree
(the path is prefixed by <literal/ArchiveDir/).
Typically this is a setting such as <filename>dists/woody</>.
<para>
All of the settings defined in the <literal/TreeDefault/ section can be
use in a <literal/Tree/ section as well as three new variables.
<para>
When processing a <literal/Tree/ section <command/apt-ftparchive/
performs an operation similar to:
<informalexample><programlisting>
for i in Sections do
for j in Architectures do
Generate for DIST=scope SECTION=i ARCH=j
</programlisting></informalexample>

<VariableList>
<VarListEntry><term>Sections</term>
<ListItem><Para>
This is a space separated list of sections which appear
under the distribution, typically this is something like
<literal/main contrib non-free/.
</VarListEntry>
<VarListEntry><term>Architectures</term>
<ListItem><Para>
This is a space separated list of all the
architectures that appear under search section. The special architecture
'source' is used to indicate that this tree has a source archive.
</VarListEntry>
<VarListEntry><term>BinOverride</term>
<ListItem><Para>
Sets the binary override file. The override file
contains section, priority and maintainer address information.
</VarListEntry>

<VarListEntry><term>SrcOverride</term>
<ListItem><Para>
Sets the source override file. The override file
contains section information.
</VarListEntry>
<VarListEntry><term>ExtraOverride</term>
<ListItem><Para>
Sets the binary extra override file.
</VarListEntry>
<VarListEntry><term>SrcExtraOverride</term>
<ListItem><Para>
Sets the source extra override file.
</VarListEntry>
</VariableList>
</refsect2>
<refsect2><title>BinDirectory Section</>
<para>
The <literal/bindirectory/ section defines a binary directory tree
with no special structure. The scope tag specifies the location of
the binary directory and the settings are similar to the <literal/Tree/
section with no substitution variables or
<literal>Section</><literal>Architecture</> settings.
<VariableList>
<VarListEntry><term>Packages</term>
<ListItem><Para>
Sets the Packages file output.
</VarListEntry>
<VarListEntry><term>SrcPackages</term>
<ListItem><Para>
Sets the Sources file output. At least one of
<literal/Packages/ or <literal/SrcPackages/ is required.
</VarListEntry>
<VarListEntry><term>Contents</term>
<ListItem><Para>
Sets the Contents file output. (Optional)
</VarListEntry>
<VarListEntry><term>BinOverride</term>
<ListItem><Para>
Sets the binary override file.
</VarListEntry>
<VarListEntry><term>SrcOverride</term>
<ListItem><Para>
Sets the source override file.
</VarListEntry>
<VarListEntry><term>ExtraOverride</term>
<ListItem><Para>
Sets the binary extra override file.
</VarListEntry>
<VarListEntry><term>SrcExtraOverride</term>
<ListItem><Para>
Sets the source extra override file.
</VarListEntry>
<VarListEntry><term>BinCacheDB</term>
<ListItem><Para>
Sets the cache DB.
</VarListEntry>
<VarListEntry><term>PathPrefix</term>
<ListItem><Para>
Appends a path to all the output paths.
</VarListEntry>
<VarListEntry><term>FileList, SourceFileList</term>
<ListItem><Para>
Specifies the file list file.
</VarListEntry>
</VariableList>
</refsect2>
</RefSect1>

<RefSect1><Title>The Binary Override File</>
<para>
The binary override file is fully compatible with &dpkg-scanpackages;. It
contains 4 fields separated by spaces. The first field is the package name,
the second is the priority to force that package to, the third is the
the section to force that package to and the final field is the maintainer
permutation field.
<para>
The general form of the maintainer field is:
<literallayout>old [// oldn]* => new</literallayout>
or simply,
<literallayout>new</literallayout>
The first form allows a double-slash separated list of old email addresses
to be specified. If any of those are found then new is substituted for the
maintainer field. The second form unconditionally substitutes the
maintainer field.
</RefSect1>
<RefSect1><title>The Source Override File</>
<para>
The source override file is fully compatible with &dpkg-scansources;. It
contains 2 fields separated by spaces. The first fields is the source
package name, the second is the section to assign it.
</RefSect1>

<RefSect1><title>The Extra Override File</>
<para>
The extra override file allows any arbitrary tag to be added or replaced
in the output. It has 3 columns, the first is the package, the second is
the tag and the remainder of the line is the new value.
</RefSect1>

<RefSect1><Title>Options</>
&apt-cmdblurb;
<VariableList>
<VarListEntry><term><option/--md5/</>
<ListItem><Para>
Generate MD5 sums. This defaults to on, when turned off the generated
index files will not have MD5Sum fields where possible.
Configuration Item: <literal/APT::FTPArchive::MD5/.
</VarListEntry>

<VarListEntry><term><option/-d/</><term><option/--db/</>
<ListItem><Para>
Use a binary caching DB. This has no effect on the generate command.
Configuration Item: <literal/APT::FTPArchive::DB/.
</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.
Configuration Item: <literal/quiet/.
</VarListEntry>

<VarListEntry><term><option/--delink/</>
<ListItem><Para>
Perform Delinking. If the <literal/External-Links/ setting is used then
this option actually enables delinking of the files. It defaults to on and
can be turned off with <option/--no-delink/.
Configuration Item: <literal/APT::FTPArchive::DeLinkAct/.
</VarListEntry>

<VarListEntry><term><option/--contents/</>
<ListItem><Para>
Perform contents generation. When this option is set and package indexes
are being generated with a cache DB then the file listing will also be
extracted and stored in the DB for later use. When using the generate
command this option also allows the creation of any Contents files. The
default is on.
Configuration Item: <literal/APT::FTPArchive::Contents/.
</VarListEntry>

<VarListEntry><term><option/-s/</><term><option/--source-override/</>
<ListItem><Para>
Select the source override file to use with the <literal/sources/ command.
Configuration Item: <literal/APT::FTPArchive::SourceOverride/.
</VarListEntry>

<VarListEntry><term><option/--readonly/</>