AptPkg - interface to libapt-pkg

use AptPkg;

The AptPkg module provides a low-level XS interface to libapt-pkg.

Note that this interface is intended to be internal, and may change, see the AptPkg::Config, AptPkg::System, AptPkg::Version, AptPkg::Cache and AptPkg::Source classes for a higher level interface.

The AptPkg package provides the following functions:

_init_config(CONF)

Initialise a Configuration object (pkgInitConfig). See the init method in AptPkg::Config.

_init_system(CONF)

Return a pointer to the system object (pkgInitSystem). See the system method in AptPkg::Config.

_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.

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:

    Find, FindFile, FindDir, FindB, FindAny, Set, Exists,
    ExistsAny, Tree and Dump.

The functions ReadConfigFile and ReadConfigDir are also provided within the package and may be used as methods.

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.

Methods:

    Value, Tag, FullTag, Parent, Child and Next.

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:

    Label, VS, Lock and UnLock.

The AptPkg::Version package wraps a Perl class around the pkgVersioningSystem class. It exposes the following methods:

    Label, CmpVersion, CmpReleaseVer, CheckDep and UpstreamVersion.

The AptPkg::_cache package wraps a Perl class around the pkgCacheFile class. It exposes the following methods:

    Open, Close, FindPkg, PkgBegin, FileList and Packages.

The AptPkg::Cache::_package package wraps a Perl class around the pkgCache::PkgIterator class. It exposes the following methods:

    Next, Name, Section, VersionList, CurrentVer, RevDependsList,
    ProvidesList, Index, SelectedState, InstState, CurrentState and
    Flags.

The AptPkg::Cache::_version package wraps a Perl class around the pkgCache::VerIterator class. It exposes the following methods:

    VerStr, Section, Arch, ParentPkg, DependsList, ProvidesList,
    FileList, Index and Priority.

The AptPkg::Cache::_depends package wraps a Perl class around the pkgCache::DepIterator class. It exposes the following methods:

    TargetVer, TargetPkg, ParentVer, ParentPkg, Index, CompType and
    DepType.

The AptPkg::Cache::_provides package wraps a Perl class around the pkgCache::PrvIterator class. It exposes the following methods:

    Name, ProvideVersion, OwnerVer, OwnerPkg and Index.

The AptPkg::Cache::_pkg_file package wraps a Perl class around the pkgCache::PkgFileIterator class. It exposes the following methods:

    FileName, Archive, Component, Version, Origin, Label, Site,
    Architecture, IndexType and Index.

The AptPkg::Cache::_ver_file package wraps a Perl class around the pkgCache::VerFileIterator class. It exposes the following methods:

    File, Index, Offset and Size.

The AptPkg::Cache::_pkg_records package wraps a Perl class around the pkgRecords class. It exposes the following methods:

    Lookup.

The AptPkg::Cache::_pkg_source_list package wraps a Perl class around the pkgSourceList class. Required as an argument to the AptPkg::_pkg_src_records constructor.

The AptPkg::Cache::_pkg_src_records package wraps a Perl class around the pkgSrcRecords class. It exposes the following methods:

    Restart, Find.

The following APT enumerations are included, used by attributes of AptPkg::Cache.

pkgCache::Dep::DepType

CWAptPkg::Dep::Depends, CWAptPkg::Dep::PreDepends, CWAptPkg::Dep::Suggests, CWAptPkg::Dep::Recommends, CWAptPkg::Dep::Conflicts, CWAptPkg::Dep::Replaces and CWAptPkg::Dep::Obsoletes.

pkgCache::Dep::DepCompareOp

CWAptPkg::Dep::Or, CWAptPkg::Dep::NoOp, CWAptPkg::Dep::LessEq, CWAptPkg::Dep::GreaterEq, CWAptPkg::Dep::Less, CWAptPkg::Dep::Greater, CWAptPkg::Dep::Equals and CWAptPkg::Dep::NotEquals.

pkgCache::State::VerPriority

CWAptPkg::State::Important, CWAptPkg::State::Required, CWAptPkg::State::Standard, CWAptPkg::State::Optional and CWAptPkg::State::Extra.

pkgCache::State::PkgSelectedState

CWAptPkg::State::Unknown, CWAptPkg::State::Install, CWAptPkg::State::Hold, CWAptPkg::State::DeInstall and CWAptPkg::State::Purge.

pkgCache::State::PkgInstState

CWAptPkg::State::Ok, CWAptPkg::State::ReInstReq, CWAptPkg::State::HoldInst and CWAptPkg::State::HoldReInstReq.

pkgCache::State::PkgCurrentState

CWAptPkg::State::NotInstalled, CWAptPkg::State::UnPacked, CWAptPkg::State::HalfConfigured, CWAptPkg::State::HalfInstalled, CWAptPkg::State::ConfigFiles and CWAptPkg::State::Installed.

pkgCache::Flag::PkgFlags

CWAptPkg::Flag::Auto, CWAptPkg::Flag::Essential and CWAptPkg::Flag::Important.

AptPkg::Config(3pm), AptPkg::System(3pm), AptPkg::Version(3pm), AptPkg::Cache(3pm), AptPkg::Source(3pm).

Brendan O'Dea <bod@debian.org>