NAME

App::lcpan::Cmd::doc - Show POD documentation of module/.pod/script

VERSION

This document describes version 1.066 of App::lcpan::Cmd::doc (from Perl distribution App-lcpan), released on 2021-05-31.

FUNCTIONS

handle_cmd

Usage:

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

Show POD documentation of module/.pod/script.

Examples:

• Seach module/POD/script named Rinci:

   handle_cmd(name => "Rinci");

• Specifically choose .pm file:

   handle_cmd(name => "Rinci.pm");

• Specifically choose .pod file:

   handle_cmd(name => "Rinci.pod");

• Look for script first named strict:

   handle_cmd(name => "strict", script => 1);

• Dump the raw POD instead of rendering it:

   handle_cmd(name => "Text::Table::Tiny", format => "raw");

This command extracts module (.pm)/.pod/script from release tarballs and render its POD documentation. Since the documentation is retrieved from the release tarballs in the mirror, the module/.pod/script needs not be installed.

Note that currently this command has trouble finding documentation for core modules because those are contained in perl release tarballs instead of release tarballs of modules, and lcpan is currently not designed to work with those.

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.

• format => str (default: "man")

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

• name* => str

  Module or script name.

  If the name matches both module name and script name, the module will be chosen. To choose the script, use --script (-s).

• script => bool

  Look for script first.

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

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2020, 2019, 2018, 2017, 2016, 2015 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.

cpanm App::lcpan

perl -MCPAN -e shell
install App::lcpan