.\" -*- 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 "Debian::DpkgLists 3pm"
.TH Debian::DpkgLists 3pm 2024-03-14 "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
Debian::DpkgLists \- scan dpkg database for files/patterns
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&    my @packages = Debian::DpkgLists\->scan_full_path(\*(Aq/full/file/path\*(Aq);
\&    my @packages = Debian::DpkgLists\->scan_partial_path(\*(Aqfile/path\*(Aq);
\&    my @packages = Debian::DpkgLists\->scan_pattern(qr{freedom$});
\&    my @packages = Debian::DpkgLists\->scan_perl_mod(\*(AqSome::Module\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBDebian::DpkgLists\fR is a module for easy searching of \fBdpkg\fR\|(1)'s package
database which contains a simple list of full file names (including the
leading slash).
.PP
There are a couple of different class methods for searching by full or partial
path, a regular expression or a Perl module name.
.PP
Note that dpkg's database represent only dpkg's idea of what is installed on
the system. If you want to also search in packages, available from the Debian
archive but not installed locally, see Debian::AptContents.
.SH CLASS-METHODS
.IX Header "CLASS-METHODS"
.IP "scan_full_path ( \fIpath\fR )" 4
.IX Item "scan_full_path ( path )"
Scans dpkg database for files, whose full path is equal to \fIpath\fR. Use when
you have the full path of the file you want, like \f(CW\*(C`/usr/bin/perl\*(C'\fR.
.Sp
Returns a (possibly empty) list of packages containing \fIpath\fR.
.IP "scan_partial_path ( \fIpath\fR )" 4
.IX Item "scan_partial_path ( path )"
Scans dpkg database for files, whose full path ends with \fIpath\fR. Use when
you only care about the file name or other trailing portion of the full path
like \f(CW\*(C`bin/perl\*(C'\fR (matches \f(CW\*(C`/usr/bin/perl\*(C'\fR and \f(CW\*(C`/sbin/perl\*(C'\fR).
.Sp
Returns a (possibly empty) list of packages containing files whose full path
ends with \fIpath\fR.
.IP "scan_pattern ( \fIpattern\fR )" 4
.IX Item "scan_pattern ( pattern )"
Scans dpkg database for files, whose full path matches \fIpattern\fR.
.Sp
Returns a (possibly empty) list of packages containing files whose full path
matches \fIpattern\fR.
.IP "scan_perl_mod ( \fIModule::Name\fR )" 4
.IX Item "scan_perl_mod ( Module::Name )"
Scans dpkg database for files, corresponding to given \fIModule::Name\fR. This
is a shorthand method for "scan_pattern" with a pattern that matches
\&\f(CW\*(C`/Module/Name.pm$\*(C'\fR in all directories in \f(CW@INC\fR.
.Sp
Returns a (possibly empty) list of packages containing possible \fIModule::Name\fR
files.
.SH AUTHOR
.IX Header "AUTHOR"
.IP "Damyan Ivanov <dmn@debian.org>" 4
.IX Item "Damyan Ivanov <dmn@debian.org>"
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
.PD 0
.IP "Copyright (C) 2010 Damyan Ivanov <dmn@debian.org>" 4
.IX Item "Copyright (C) 2010 Damyan Ivanov <dmn@debian.org>"
.IP "Copyright (C) 2019\-2020 gregor herrmann <gregoa@debian.org>" 4
.IX Item "Copyright (C) 2019-2020 gregor herrmann <gregoa@debian.org>"
.PD
.PP
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License version 2 as published by the Free
Software Foundation.
.PP
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110\-1301 USA.