view release on metacpan or  search on metacpan

lib/CPAN/Search/Lite/Index.pm  view on Meta::CPAN

such as C<Foo::Bar>, the documentation will be saved as a
file F<Foo/Bar.html>, while the sources will be saved
as F<Foo/Bar.pm.html>.

=item * html_root = /usr/local/httpd/htdocs/CPAN

This specifies where the html files created from the pod files 
will be kept. A subdirectory C<dist_name> under this directory
will be created corresponding to the name of the distribution.

=item * ignore = some_dist_name_to_ignore

This specifies a name of a distribution (without a version
number) to ignore in indexing. This option may be given
a number of times to specify an array of values, or may
be specified as

  ignore = <<EOL
  Module-CPANTS-asHash
  CORBA-IDL
  EOL

This array of values (which may include regular expressions)
is joined together as

  $pat = join '|', @ignore_dists

and if the distribution name matches

  $dist_name =~ /^($pat)$/

the distribution is ignored.

=item * no_mirror = 1

This specifies that a local CPAN mirror isn't available,
and as such no pod or html files will be extracted nor created.

=item * no_ppm = 1

This can be used to signal to not gather information on Win32
ppm packages from the repositories specified in C<$repositories>
of L<CPAN::Search::Lite::Util>.

=item * remote_mirror = http://cpan.wherever.edu

If C<no_mirror> is specified, the value of C<remote_mirror> will
be used to fetch the CPAN indices. If not given, I<http://www.cpan.org>
will be used.

=item * multiplexer = http://cpan.redirect.edu/cpan

This can be used to specify a multiplexer to redirect
downloads to nearby CPAN mirrors. See, for example,
L<Apache::GeoIP> for one implementation.

=item * cat_threshold = 0.99

Many modules do not have a category (chapter) associated with
them. In such cases, when populating the database, the 
I<AI::Catgorizer> module is used to guess which category
should be assigned to such a module, based on available information 
for those modules that do have a category. The value of I<cat_threshold>
is used to determine if the guessed category should be accepted
(a perfect match has a score of 1, and no match has 0). If no
such value is given, a default of 0.995 is used.

=item * no_cat = 1

Set I<no_cat> equal to a true value if you don't want
I<AI::Categorizer> to try categorizing modules which
don't have a category assigned.

=back

=head2 DB

This is used to store connection information to the
database used to populate the tables.

=over 3

=item * db = pause

This is the name of the database used. It is assumed here that the
database has already been created, and that appropriate
read, write, update, create, and delete permissions for the
user specified below have already been granted.

=item * user = sarah

This is the user under which to connect to the database.

=item * passwd = lianne

This is the password to use for the user.

=back

=head2 WWW

This is used for various information related to a web
interface.

=over 3

=item * css = cpan.css

If specified, this will be used as the I<css> file when
generating the html files from the pod files of the
distribution. It is assumed this file appears directly
beneath the C<html_root> of the C<CPAN> section.

=item * up_img = up.gif

If specified, this will be used as an image in the
generated html files linking each section to the
top-most index. If not specifed, the text I<__top> will
be used. It is assumed this image appears directly
beneath the C<html_root> of the C<CPAN> section.

=item * dist_info = http://cpan.uwinnipeg.ca/dist/

If specified, this will be used to provide a link