Luckasoft has asked for the wisdom of the Perl Monks concerning the following question:

Hello, could anyone tell me what is the file "perllocal.pod" used for?

I mean, when new module or package added, its description is added into the "perllocal.pod".

But some packages are not described there at all. What is the difference?

-----------------------

Does anybody know util or script, which scans lib directory and creates "perllocal.pod" file?

Any help appreciated, as I did not even find the perllocal.pod formal format description

Replies are listed 'Best First'.
Re: perllocal.pod
by simonm (Vicar) on Dec 08, 2004 at 22:10 UTC
    The perllocal.pod contains a list of locally-installed modules not included with the standard distribution.

    If you download and install Perl and then install several CPAN modules, only the CPAN modules will be listed in perllocal.

    I belive it's updated during the "make install" process, by code in ExtUtils::MakeMaker.

    You can read it with the perldoc command or with the pod2text/pod2html commands.

Re: perllocal.pod
by runrig (Abbot) on Dec 08, 2004 at 22:10 UTC
    Stuff is added to perllocal when you install modules via 'make install' due to stuff in ExtUtils::MakeMaker.

    Update: Additionally, if you are running ActiveState perl, you are probably installing modules via ppm, and those modules will not get added to perllocal, though some non-core modules that ActiveState includes in its distribution do show up in perllocal.

Re: perllocal.pod
by Crian (Curate) on Dec 08, 2004 at 20:42 UTC

    > Any help appreciated, as I did not even find the perllocal.pod formal format description

    I guess it's in pod format, since perldoc perllocal shows the contents, it has the extension pod and it looks like pod if I open it into an editor.

    If you are searching for the description of pod then have a look at perldoc perlpod.