---
name: "CPAN::Common::Index::LocalPackage"
section: "3pm"
platform: "linux"
package: "libcpan-common-index-perl"
version: "0.010-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/CPAN::Common::Index::LocalPackage"
---

# CPAN::Common::Index::LocalPackage(3pm)

Search index via custom local CPAN package flatfile

## NAME

CPAN::Common::Index::LocalPackage - Search index via custom local CPAN package flatfile

## VERSION

version 0.010

## SYNOPSIS

```
  use CPAN::Common::Index::LocalPackage;
  $index = CPAN::Common::Index::LocalPackage->new(
    { source => "mypackages.details.txt" }
  );
```

## DESCRIPTION

This module implements a CPAN::Common::Index that searches for packages in a local index file in the same form as the CPAN 02packages.details.txt file.

There is no support for searching on authors.

## ATTRIBUTES

### source (REQUIRED)

Path to a local file in the form of 02packages.details.txt.  It may be compressed with a ".gz" suffix or it may be uncompressed.

### cache

Path to a local directory to store a (possibly uncompressed) copy of the source index.  Defaults to a temporary directory if not specified.

## AUTHOR

David Golden \<dagolden@cpan.org\>

## COPYRIGHT AND LICENSE

This software is Copyright (c) 2013 by David Golden.

This is free software, licensed under:

```
  The Apache License, Version 2.0, January 2004
```
