.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "AptPkg 3pm"
.TH AptPkg 3pm "2021-02-15" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
AptPkg \- interface to libapt\-pkg
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
use AptPkg;
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The AptPkg module provides a low-level \s-1XS\s0 interface to libapt-pkg.
.PP
Note that this interface is intended to be internal, and may change,
see the AptPkg::Config, AptPkg::System, AptPkg::Version, AptPkg::Cache,
Apt::Policy and AptPkg::Source classes for a higher level interface.
.SS "AptPkg"
.IX Subsection "AptPkg"
The AptPkg package provides the following functions:
.IP "_init_config(\fI\s-1CONF\s0\fR)" 4
.IX Item "_init_config(CONF)"
Initialise a Configuration object (pkgInitConfig).  See the init
method in AptPkg::Config.
.IP "_init_system(\fI\s-1CONF\s0\fR)" 4
.IX Item "_init_system(CONF)"
Return a pointer to the system object (pkgInitSystem).  See the system
method in AptPkg::Config.
.IP "_parse_cmdline(\fI\s-1CONF\s0\fR, \fI\s-1ARG_DEFS\s0\fR, ...)" 4
.IX Item "_parse_cmdline(CONF, ARG_DEFS, ...)"
Constructs a CommandLine instance, invokes the Parse method and
returns the remaining arguments.  See the parse_cmdline method in
AptPkg::Config.
.SS "AptPkg::_config"
.IX Subsection "AptPkg::_config"
The AptPkg::_config package wraps a Perl class around the
Configuration class.  It provides an instance of the global _config
object, and exposes the following methods:
.PP
.Vb 2
\&    Find, FindFile, FindDir, FindB, FindAny, Set, Exists,
\&    ExistsAny, Tree and Dump.
.Ve
.PP
The functions ReadConfigFile and ReadConfigDir are also provided
within the package and may be used as methods.
.SS "AptPkg::_config::item"
.IX Subsection "AptPkg::_config::item"
The AptPkg::_config::item package wraps a Perl class around the
Configuration::Item class.  The AptPkg::_config Tree method returns an
instance of this class.
.PP
Methods:
.PP
.Vb 1
\&    Value, Tag, FullTag, Parent, Child and Next.
.Ve
.SS "AptPkg::System"
.IX Subsection "AptPkg::System"
The AptPkg::System package wraps a Perl class around the pkgSystem
class.  It provides an instance of the global _system object, and
exposes the following methods:
.PP
.Vb 1
\&    Label, VS, Lock and UnLock.
.Ve
.SS "AptPkg::Version"
.IX Subsection "AptPkg::Version"
The AptPkg::Version package wraps a Perl class around the
pkgVersioningSystem class.  It exposes the following methods:
.PP
.Vb 1
\&    Label, CmpVersion, CmpReleaseVer, CheckDep and UpstreamVersion.
.Ve
.SS "AptPkg::_cache"
.IX Subsection "AptPkg::_cache"
The AptPkg::_cache package wraps a Perl class around the pkgCacheFile
class.  It exposes the following methods:
.PP
.Vb 2
\&    Open, Close, FindPkg, PkgBegin, FileList, Packages, Policy, MultiArchCache
\&    and NativeArch.
.Ve
.SS "AptPkg::Cache::_package"
.IX Subsection "AptPkg::Cache::_package"
The AptPkg::Cache::_package package wraps a Perl class around the
pkgCache::PkgIterator class.  It exposes the following methods:
.PP
.Vb 3
\&    Next, Name, FullName, Arch, Section, VersionList, CurrentVer,
\&    RevDependsList, ProvidesList, Index, SelectedState, InstState,
\&    CurrentState and Flags.
.Ve
.SS "AptPkg::Cache::_version"
.IX Subsection "AptPkg::Cache::_version"
The AptPkg::Cache::_version package wraps a Perl class around the
pkgCache::VerIterator class.  It exposes the following methods:
.PP
.Vb 3
\&    VerStr, Section, MultiArch, Arch, ParentPkg, DescriptionList,
\&    TranslatedDescription, DependsList, ProvidesList, FileList, Index
\&    and Priority.
.Ve
.SS "AptPkg::Cache::_depends"
.IX Subsection "AptPkg::Cache::_depends"
The AptPkg::Cache::_depends package wraps a Perl class around the
pkgCache::DepIterator class.  It exposes the following methods:
.PP
.Vb 2
\&    TargetVer, TargetPkg, ParentVer, ParentPkg, Index, CompType and
\&    DepType.
.Ve
.SS "AptPkg::Cache::_provides"
.IX Subsection "AptPkg::Cache::_provides"
The AptPkg::Cache::_provides package wraps a Perl class around the
pkgCache::PrvIterator class.  It exposes the following methods:
.PP
.Vb 1
\&    Name, ProvideVersion, OwnerVer, OwnerPkg and Index.
.Ve
.SS "AptPkg::Cache::_description"
.IX Subsection "AptPkg::Cache::_description"
The AptPkg::Cache::_description package wraps a Perl class around the
pkgCache::DescIterator class.  It exposes the following methods:
.PP
.Vb 1
\&    LanguageCode, md5 and FileList.
.Ve
.SS "AptPkg::Cache::_pkg_file"
.IX Subsection "AptPkg::Cache::_pkg_file"
The AptPkg::Cache::_pkg_file package wraps a Perl class around the
pkgCache::PkgFileIterator class.  It exposes the following methods:
.PP
.Vb 2
\&    FileName, Archive, Component, Version, Origin, Label, Site,
\&    IndexType and Index.
.Ve
.SS "AptPkg::Cache::_ver_file"
.IX Subsection "AptPkg::Cache::_ver_file"
The AptPkg::Cache::_ver_file package wraps a Perl class around the
pkgCache::VerFileIterator class.  It exposes the following methods:
.PP
.Vb 1
\&    File, Index, Offset and Size.
.Ve
.SS "AptPkg::Cache::_desc_file"
.IX Subsection "AptPkg::Cache::_desc_file"
The AptPkg::Cache::_desc_file package wraps a Perl class around the
pkgCache::DescFileIterator class.  It exposes the following methods:
.PP
.Vb 1
\&    File
.Ve
.SS "AptPkg::Cache::_pkg_records"
.IX Subsection "AptPkg::Cache::_pkg_records"
The AptPkg::Cache::_pkg_records package wraps a Perl class around the
pkgRecords class.  It exposes the following methods:
.PP
.Vb 1
\&    Lookup.
.Ve
.SS "AptPkg::_policy"
.IX Subsection "AptPkg::_policy"
The AptPkg::_policy package wraps a Perl class around the pkgPolicy
class.  It exposes the following methods:
.PP
.Vb 1
\&    GetPriority and GetCandidateVer.
.Ve
.SS "AptPkg::_source_list"
.IX Subsection "AptPkg::_source_list"
The AptPkg::_source_list package wraps a Perl class around
the pkgSourceList class.  Required as an argument to the
AptPkg::_src_records constructor.
.SS "AptPkg::_src_records"
.IX Subsection "AptPkg::_src_records"
The AptPkg::_src_records package wraps a Perl class around
the pkgSrcRecords class.  It exposes the following methods:
.PP
.Vb 1
\&    Restart, Find.
.Ve
.SS "Constants"
.IX Subsection "Constants"
The following \fB\s-1APT\s0\fR enumerations are included, used by attributes of
AptPkg::Cache.
.PP
\fIpkgCache::Version::VerMultiArch\fR
.IX Subsection "pkgCache::Version::VerMultiArch"
.PP
\&\f(CW\*(C`AptPkg::Version::No\*(C'\fR,
\&\f(CW\*(C`AptPkg::Version::All\*(C'\fR,
\&\f(CW\*(C`AptPkg::Version::Foreign\*(C'\fR,
\&\f(CW\*(C`AptPkg::Version::Same\*(C'\fR,
\&\f(CW\*(C`AptPkg::Version::Allowed\*(C'\fR,
\&\f(CW\*(C`AptPkg::Version::AllForeign\*(C'\fR and
\&\f(CW\*(C`AptPkg::Version::AllAllowed\*(C'\fR.
.PP
\fIpkgCache::Dep::DepType\fR
.IX Subsection "pkgCache::Dep::DepType"
.PP
\&\f(CW\*(C`AptPkg::Dep::Depends\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::PreDepends\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::Suggests\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::Recommends\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::Conflicts\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::Replaces\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::Obsoletes\*(C'\fR
\&\f(CW\*(C`AptPkg::Dep::DpkgBreaks\*(C'\fR and
\&\f(CW\*(C`AptPkg::Dep::Enhances\*(C'\fR.
.PP
\fIpkgCache::Dep::DepCompareOp\fR
.IX Subsection "pkgCache::Dep::DepCompareOp"
.PP
\&\f(CW\*(C`AptPkg::Dep::Or\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::NoOp\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::LessEq\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::GreaterEq\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::Less\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::Greater\*(C'\fR,
\&\f(CW\*(C`AptPkg::Dep::Equals\*(C'\fR and
\&\f(CW\*(C`AptPkg::Dep::NotEquals\*(C'\fR.
.PP
\fIpkgCache::State::VerPriority\fR
.IX Subsection "pkgCache::State::VerPriority"
.PP
\&\f(CW\*(C`AptPkg::State::Important\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::Required\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::Standard\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::Optional\*(C'\fR and
\&\f(CW\*(C`AptPkg::State::Extra\*(C'\fR.
.PP
\fIpkgCache::State::PkgSelectedState\fR
.IX Subsection "pkgCache::State::PkgSelectedState"
.PP
\&\f(CW\*(C`AptPkg::State::Unknown\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::Install\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::Hold\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::DeInstall\*(C'\fR and
\&\f(CW\*(C`AptPkg::State::Purge\*(C'\fR.
.PP
\fIpkgCache::State::PkgInstState\fR
.IX Subsection "pkgCache::State::PkgInstState"
.PP
\&\f(CW\*(C`AptPkg::State::Ok\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::ReInstReq\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::HoldInst\*(C'\fR and
\&\f(CW\*(C`AptPkg::State::HoldReInstReq\*(C'\fR.
.PP
\fIpkgCache::State::PkgCurrentState\fR
.IX Subsection "pkgCache::State::PkgCurrentState"
.PP
\&\f(CW\*(C`AptPkg::State::NotInstalled\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::UnPacked\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::HalfConfigured\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::HalfInstalled\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::ConfigFiles\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::Installed\*(C'\fR,
\&\f(CW\*(C`AptPkg::State::TriggersAwaited\*(C'\fR and
\&\f(CW\*(C`AptPkg::State::TriggersPending\*(C'\fR.
.PP
\fIpkgCache::Flag::PkgFlags\fR
.IX Subsection "pkgCache::Flag::PkgFlags"
.PP
\&\f(CW\*(C`AptPkg::Flag::Auto\*(C'\fR,
\&\f(CW\*(C`AptPkg::Flag::Essential\*(C'\fR and
\&\f(CW\*(C`AptPkg::Flag::Important\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBAptPkg::Config\fR\|(3pm), \fBAptPkg::System\fR\|(3pm), \fBAptPkg::Version\fR\|(3pm),
\&\fBAptPkg::Cache\fR\|(3pm), \fBAptPkg::Source\fR\|(3pm).
.SH "AUTHOR"
.IX Header "AUTHOR"
Brendan O'Dea <bod@debian.org>