NAME
    Complete::Module - Complete with installed Perl module names

VERSION
    This document describes version 0.12 of Complete::Module (from Perl
    distribution Complete-Module), released on 2014-12-28.

SYNOPSIS
     use Complete::Module qw(complete_module);
     my $res = complete_module(word => 'Text::A');
     # -> ['Text::ANSI', 'Text::ANSITable', 'Text::ANSITable::', 'Text::Abbrev']

FUNCTIONS
  complete_module(%args) -> any
    Complete with installed Perl module names.

    For each directory in @INC (coderefs are ignored), find Perl modules and
    module prefixes which have "word" as prefix. So for example, given "Te"
    as "word", will return e.g. "[Template, Template::, Term::, Test,
    Test::, Text::]". Given "Text::" will return "[Text::ASCIITable,
    Text::Abbrev, ...]" and so on.

    This function has a bit of overlapping functionality with
    "Module::List", but this function is geared towards shell tab
    completion. Compared to "Module::List", here are some differences: 1)
    list modules where prefix is incomplete; 2) interface slightly
    different; 3) (currently) doesn't do recursing; 4) contains conveniences
    for completion, e.g. map casing, expand intermediate paths (see
    "Complete" for more details on those features), autoselection of path
    separator character, some shortcuts, and so on.

    Arguments ('*' denotes required arguments):

    *   ci => *bool*

        Whether to do case-insensitive search.

    *   exp_im_path => *bool*

    *   find_pm => *bool* (default: 1)

        Whether to find .pm files.

    *   find_pmc => *bool* (default: 1)

        Whether to find .pmc files.

    *   find_pod => *bool* (default: 1)

        Whether to find .pod files.

    *   find_prefix => *bool* (default: 1)

        Whether to find module prefixes.

    *   map_case => *bool*

    *   ns_prefix => *str*

        Namespace prefix.

        This is useful if you want to complete module under a specific
        namespace (instead of the root). For example, if you set "ns_prefix"
        to "Dist::Zilla::Plugin" (or "Dist::Zilla::Plugin::") and word is
        "F", you can get "['FakeRelease', 'FileFinder::', 'FinderCode']"
        (those are modules under the "Dist::Zilla::Plugin::" namespace).

    *   word* => *str*

    Return value:

     (any)

SETTINGS
  $Complete::Module::OPT_SHORTCUT_PREFIXES => hash
    Shortcut prefixes. The default is:

     {
       dzb => "Dist/Zilla/PluginBundle/",
       dzp => "Dist/Zilla/Plugin/",
       pwb => "Pod/Weaver/PluginBundle/",
       pwp => "Pod/Weaver/Plugin/",
       pws => "Pod/Weaver/Section/",
     }

    If user types one of the keys, it will be replaced with the matching
    value from this hash.

ENVIRONMENT
  "COMPLETE_MODULE_OPT_SHORTCUT_PREFIXES" => str
    Can be used to set the default for
    $Complete::Module::OPT_SHORTCUT_PREFIXES. It should be in the form of:

     shortcut1=Value1;shortcut2=Value2;...

    For example:

     dzp=Dist/Zilla/Plugin/;pwp=Pod/Weaver/Plugin/

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/Complete-Module>.

SOURCE
    Source repository is at
    <https://github.com/sharyanto/perl-Complete-Module>.

BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=Complete-Module>

    When submitting a bug or request, please include a test-file or a patch
    to an existing test-file that illustrates the bug or desired feature.

AUTHOR
    perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2014 by perlancar@cpan.org.

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

