.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::PkgRecords 3pm"
.TH AptPkg::PkgRecords 3pm 2024-03-07 "perl v5.38.2" "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::PkgRecords \- APT package description class
.SH SYNOPSIS
.IX Header "SYNOPSIS"
use AptPkg::PkgRecords;
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The AptPkg::PkgRecords module provides an interface to the parsed
contents of package files.
.SS AptPkg::PkgRecords
.IX Subsection "AptPkg::PkgRecords"
The AptPkg::PkgRecords package Implements the \fBAPT\fR pkgRecords class.
.PP
An instance of the AptPkg::PkgRecords class may be fetched using the
\&\f(CW\*(C`packages\*(C'\fR method from an AptPkg::Cache object.
.PP
\fIMethods\fR
.IX Subsection "Methods"
.IP lookup(\fIPACK\fR) 4
.IX Item "lookup(PACK)"
Return a hash (or hash reference, depending on context) for the given
package.
.Sp
\&\fIPACK\fR may either be an AptPkg::Cache::VerFile object, an
AptPkg::Cache::DescFile object or a package name.
.Sp
The hash contains the following keys:
.RS 4
.Sp
.RS 4
\&\f(CW\*(C`FileName\*(C'\fR, \f(CW\*(C`Checksum\-FileSize\*(C'\fR, \f(CW\*(C`MD5Hash\*(C'\fR, \f(CW\*(C`SHA256\*(C'\fR, \f(CW\*(C`SourcePkg\*(C'\fR,
\&\f(CW\*(C`Maintainer\*(C'\fR, \f(CW\*(C`ShortDesc\*(C'\fR, \f(CW\*(C`LongDesc\*(C'\fR and \f(CW\*(C`Name\*(C'\fR.
.RE
.RE
.RS 4
.Sp
with values taken from the packages or translation file.
.Sp
Note that \f(CW\*(C`LongDesc\*(C'\fR is generally not useful for AptPkg::Cache::VerFile
objects, which refer to the Packages file, as these no longer contain the full
description (now in the Translation files).
.Sp
If \fIPACK\fR is a package name, these additional values are set:
.Sp
.RS 4
\&\f(CW\*(C`Section\*(C'\fR and \f(CW\*(C`VerStr\*(C'\fR.
.RE
.RE
.RS 4
.Sp
and the following values are overridden with the translated versions:
.Sp
.RS 4
\&\f(CW\*(C`ShortDesc\*(C'\fR and \f(CW\*(C`LongDesc\*(C'\fR.
.RE
.RE
.RS 4
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBAptPkg::Cache\fR\|(3pm), \fBAptPkg\fR\|(3pm).
.SH AUTHOR
.IX Header "AUTHOR"
Brendan O'Dea <bod@debian.org>