---
name: "Pod::Tree::PerlDist"
section: "3pm"
platform: "linux"
package: "libpod-tree-perl"
version: "1.31-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Pod::Tree::PerlDist"
---

# Pod::Tree::PerlDist(3pm)

translate Perl distribution documentation to HTML

## NAME

Pod::Tree::PerlDist - translate Perl distribution documentation to HTML

## SYNOPSIS

```
  $perl_map  = Pod::Tree::PerlMap->new;
  $perl_dist = Pod::Tree::PerlDist->new( $perl_dir, $HTML_dir, $perl_map, %opts );
  $perl_dist->scan;
  $perl_dist->index;
  $perl_dist->translate;
  $top = $perl_dist->get_top_entry;
```

## DESCRIPTION

`"Pod::Tree::PerlDist"` translates documents in the Perl distribution to HTML. These include *Changes*, *README*, and assored other files that appear in the top level of the Perl  source tree.

Files that contain PODs are parsed as PODs; files that do not contain PODs are converted to HTML as preformatted text.

`"Pod::Tree::PerlDist"` generates and uses an index of the files  that it finds to construct HTML links. Other modules can also use this index.

## METHODS

- *$perl\_dist* = "new" "Pod::Tree::PerlDist" *$perl\_dir*, *$HTML\_dir*, *$perl\_map*, *%options*

  Creates and returns a new `"Pod::Tree::PerlDist"` object.

  *$perl\_dir* is the root of the Perl source tree.

  *$HTML\_dir* is the directory where HTML files will be written.

  *$perl\_map* maps file names to URLs.

  *%options* are passed through to `"Pod::Tree::HTML"`.

- *$perl\_dist*-\>"scan"

  Scans the top level of the Perl source tree for documentation files. Files that do not generally contain user-level documentation, such as source files, are ignored. The search does not recurse through subdirectories.

  Each file that is located is entered into *$perl\_map*.

- *$perl\_dist*-\>"index"

  Generates a top-level index of all the distribution documents,  and writes it to *HTML\_dir*`"/dist.html"`.

- *$perl\_dist*-\>"translate"

  Translates each distribution document found by `"scan"` to HTML. The HTML pages are written to *HTML\_dir*.

- *$perl\_dist*-\>"get\_top\_entry"

  Returns a hash reference of the form

  ```
    { URL         => $URL,
      description => $description }
  ```

  `"Pod::Tree::PerlTop"` uses this to build a top-level index of all the  Perl PODs.

## LINKING

`"Pod::Tree::PerlDist"` indexes files by their name. To link to a file named *README.win32* write

```
    L<README.win32>
```

## REQUIRES

```
    5.005;
    HTML::Stream;
    Pod::Tree;
    Pod::Tree::HTML;
    Pod::Tree::PerlUtil;
```

## EXPORTS

Nothing.

## SEE ALSO

`"Pod::Tree::HTML"`, `"Pod::Tree::PerlMap"`,

## AUTHOR

Steven McDougall, swmcd@world.std.com

## COPYRIGHT

Copyright (c) 2000 by Steven McDougall.  This module is free software; you can redistribute it and/or modify it under the same terms as Perl.