The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-lcpan-1.069
River stage two • 41 direct dependents • 69 total dependents
14 ++
/ App::lcpan::Cmd::update

NAME

App::lcpan::Cmd::update - Create/update local CPAN mirror

VERSION

This document describes version 1.069 of App::lcpan::Cmd::update (from Perl distribution App-lcpan), released on 2022-03-27.

FUNCTIONS

handle_cmd

Usage:

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

Create/update local CPAN mirror.

This subcommand first create/update the mirror files by downloading from a remote CPAN mirror, then update the index.

This function is not exported.

Arguments ('*' denotes required arguments):

  • cpan => dirname

    Location of your local CPAN mirror, e.g. /path/to/cpan.

    Defaults to ~/cpan.

  • exclude_author => array[str]

    Exclude files from certain author(s).

  • force_update_index => bool

    Update the index even though there is no change in files.

  • include_author => array[str]

    Only include files from certain author(s).

  • index_name => filename (default: "index.db")

    Filename of index.

    If index_name is a filename without any path, e.g. index.db then index will be located in the top-level of cpan. If index_name contains a path, e.g. ./index.db or /home/ujang/lcpan.db then the index will be located solely using the index_name.

  • max_file_size => int

    If set, skip downloading files larger than this.

  • remote_url => str

    Select CPAN mirror to download from.

  • retry_delay => int

    Number of seconds to delay between retry attempt.

  • retry_max_attempts => int

    Number of retry attempts on failed HTTP request.

  • skip_file_indexing_pass_1 => bool

  • skip_file_indexing_pass_2 => bool

  • skip_file_indexing_pass_3 => bool

  • skip_index_file_patterns => array[re]

    Skip one or more file patterns from being indexed.

  • skip_index_files => array[str]

    Skip one or more files from being indexed.

  • skip_sub_indexing => bool (default: 1)

    Since sub indexing is still experimental, it is not enabled by default. To enable it, pass the --no-skip-sub-indexing option.

  • skip_sub_indexing_file_patterns => array[re]

    Skip one or more file patterns from being parsed for subs.

  • skip_sub_indexing_files => array[str]

    Skip one or more files from being parsed for subs.

  • update_files => bool (default: 1)

    Update the files.

  • update_index => bool (default: 1)

    Update the index.

  • use_bootstrap => bool (default: 1)

    Whether to use bootstrap database from App-lcpan-Bootstrap.

    If you are indexing your private CPAN-like repository, you want to turn this off.

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-lcpan.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-lcpan.

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, 2021, 2020, 2019, 2018, 2017, 2016, 2015 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-lcpan

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.