The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
FreeBSD-Ports-INDEXhash-1.0.0
River stage one • 1 direct dependent • 1 total dependent
++
/ FreeBSD::Ports::INDEXhash

NAME

FreeBSD::Ports::INDEXhash - Generates a hash out of the FreeBSD Ports index file.

VERSION

Version 1.0.0

SYNOPSIS

Quick summary of what the module does.

Perhaps a little code snippet.

        use FreeBSD::Ports::INDEXhash qw/INDEXhash/;

        my %hash=INDEXhash();

        my @keys=keys(%hash);

        my $keysInt=0;

        while(defined($keys[$keysInt])){
            print "Name: ".$keys[$keysInt]."\n".
                    "Info: ".$hash{$keys[$keysInt]}{info}."\n".
                    "Prefix: ".$hash{$keys[$keysInt]}{prefix}."\n".
                    "Maintainer: ".$hash{$keys[$keysInt]}{maintainer}."\n".
                    "WWW: ".$hash{$keys[$keysInt]}{www}."\n".
                    "Categories: ".join(" ", @{$hash{$keys[$keysInt]}{categories}})."\n".
                    "E-deps: ".join(" ", @{$hash{$keys[$keysInt]}{Edeps}})."\n".
                    "B-deps: ".join(" ", @{$hash{$keys[$keysInt]}{Bdeps}})."\n".
                    "P-deps: ".join(" ", @{$hash{$keys[$keysInt]}{Pdeps}})."\n".
                    "R-deps: ".join(" ", @{$hash{$keys[$keysInt]}{Rdeps}})."\n".
                    "F-deps: ".join(" ", @{$hash{$keys[$keysInt]}{Fdeps}})."\n".
                    "\n";

        $keysInt++;
        };

EXPORT

A list of functions that can be exported. You can delete this section if you don't export anything, such as for a purely object-oriented module.

FUNCTIONS

INDEXhash

This parses the FreeBSD ports index file and a hash of it. Upon error it returns undef.

If a path to it is not passed to this function, it chooses the file automatically. The PORTSDIR enviromental varaiable is respected if using automatically.

HASH FORMAT

The keys of the hash are names of the ports. Each entry is then another hash. See the list of keys below for the description of each one.

info

This is a short description of the port.

prefix

This is the install prefix the port will try to use.

maintainer

This is the email address for the port's maintainer.

www

This is the web site of a port inquestion.

Edeps

This is the extract depends of a port. This is a array.

Bdeps

This is the build depends for the port. This is a array.

Pdeps

This is the package depends for a port. This is a array.

Rdeps

This is the run depends of a port. This is a array.

Fdeps

This is the fetch depends of a port. This is a array.

categories

This is all the categories a specific port falls under. This is a array.

AUTHOR

Zane C. Bowers, <vvelox at vvelox.net>

BUGS

Please report any bugs or feature requests to bug-freebsd-ports-indexhash at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FreeBSD-Ports-INDEXhash. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc FreeBSD::Ports::INDEXhash

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2008 Zane C. Bowers, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

2 POD Errors

The following errors were encountered while parsing the POD:

Around line 182:

'=item' outside of any '=over'

Around line 222:

You forgot a '=back' before '=head1'