NAME

peri-pkg-doc - Display text/POD documentation of Riap package

VERSION

version 0.30

SYNOPSIS

From command-line:

% peri-pkg-doc /Some/Module/
% peri-pkg-doc --format=text https://example.com/api/
% peri-pkg-doc --help

DESCRIPTION

This script will generate text/POD documentation for a Riap package. All information about entities like functions and variables in the package will be retrieved and displayed as well. The end result looks similar to a POD documentation for a Perl module.

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

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

To install Perinci::To::POD, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Perinci::To::POD

CPAN shell

perl -MCPAN -e shell
install Perinci::To::POD

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)