NAME
    App::ListPerlReleases - List Perl releases

VERSION
    This document describes version 0.004 of App::ListPerlReleases (from
    Perl distribution App-ListPerlReleases), released on 2021-01-01.

SYNOPSIS
    See the included script list-perl-releases.

DESCRIPTION
    This distribution offers list-perl-releases, a CLI front-end for
    CPAN::Perl::Releases.

FUNCTIONS
  list_perl_releases
    Usage:

     list_perl_releases(%args) -> [$status_code, $reason, $payload, \%result_meta]

    List of Perl releases.

    This utility uses CPAN::Perl::Releases's "perl_tarballs()" to list
    releases of Perl interpreters. For each release, it provides information
    such as version number and location of tarballs in releaser author's
    directory on CPAN.

    Update the CPAN::Perl::Releases module to get the latest list of
    releases.

    This function is not exported by default, but exportable.

    Arguments ('*' denotes required arguments):

    *   detail => *bool* (default: 0)

        Return array of full records instead of just ID fields.

        By default, only the key (ID) field is returned per result entry.

    *   exclude_fields => *array[str]*

        Select fields to return.

    *   fields => *array[str]*

        Select fields to return.

    *   query => *str*

        Search.

    *   random => *bool* (default: 0)

        Return records in random order.

    *   result_limit => *int*

        Only return a certain number of records.

    *   result_start => *int* (default: 1)

        Only return starting from the n'th record.

    *   sort => *array[str]*

        Order records according to certain field(s).

        A list of field names separated by comma. Each field can be prefixed
        with '-' to specify descending order instead of the default
        ascending.

    *   tarball => *str*

        Only return records where the 'tarball' field equals specified
        value.

    *   tarball.contains => *str*

        Only return records where the 'tarball' field contains specified
        text.

    *   tarball.in => *array[str]*

        Only return records where the 'tarball' field is in the specified
        values.

    *   tarball.is => *str*

        Only return records where the 'tarball' field equals specified
        value.

    *   tarball.isnt => *str*

        Only return records where the 'tarball' field does not equal
        specified value.

    *   tarball.max => *str*

        Only return records where the 'tarball' field is less than or equal
        to specified value.

    *   tarball.min => *str*

        Only return records where the 'tarball' field is greater than or
        equal to specified value.

    *   tarball.not_contains => *str*

        Only return records where the 'tarball' field does not contain
        specified text.

    *   tarball.not_in => *array[str]*

        Only return records where the 'tarball' field is not in the
        specified values.

    *   tarball.xmax => *str*

        Only return records where the 'tarball' field is less than specified
        value.

    *   tarball.xmin => *str*

        Only return records where the 'tarball' field is greater than
        specified value.

    *   version => *str*

        Only return records where the 'version' field equals specified
        value.

    *   version.contains => *str*

        Only return records where the 'version' field contains specified
        text.

    *   version.in => *array[str]*

        Only return records where the 'version' field is in the specified
        values.

    *   version.is => *str*

        Only return records where the 'version' field equals specified
        value.

    *   version.isnt => *str*

        Only return records where the 'version' field does not equal
        specified value.

    *   version.max => *str*

        Only return records where the 'version' field is less than or equal
        to specified value.

    *   version.min => *str*

        Only return records where the 'version' field is greater than or
        equal to specified value.

    *   version.not_contains => *str*

        Only return records where the 'version' field does not contain
        specified text.

    *   version.not_in => *array[str]*

        Only return records where the 'version' field is not in the
        specified values.

    *   version.xmax => *str*

        Only return records where the 'version' field is less than specified
        value.

    *   version.xmin => *str*

        Only return records where the 'version' field is greater than
        specified value.

    *   with_field_names => *bool*

        Return field names in each record (as hash/associative array).

        When enabled, function will return each record as hash/associative
        array (field name => value pairs). Otherwise, function will return
        each record as list/array (field value, field value, ...).

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

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

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-ListPerlReleases>.

SEE ALSO
    CPAN::Perl::Releases

    App::perlbrew also offers "perlbrew available" or "perlbrew available
    --all" to list Perl releases.

    <https://www.cpan.org>

AUTHOR
    perlancar <perlancar@cpan.org>

CONTRIBUTING
    To contribute, you can send patches by email/via RT, or send pull
    requests on GitHub.

    Most of the time, you don't need to build the distribution yourself. You
    can simply modify the code, then test via:

     % prove -l

    If you want to build the distribution (e.g. to try to install it locally
    on your system), you can install Dist::Zilla,
    Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two
    other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional
    steps required beyond that are considered a bug and can be reported to
    me.

COPYRIGHT AND LICENSE
    This software is copyright (c) 2022, 2018 by perlancar
    <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.

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

    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.