Pinto-Action-Doc-0.004

NAME

App::Pinto::Command::doc - generate html docs from the dists in a stack

VERSION

version 0.004

SYNOPSIS

pinto --root=REPOSITORY_ROOT doc --out=HTML_ROOT [OPTIONS]

DESCRIPTION

This command creates html documents from the distributions on a stack. It uses Pod::ProjectDocs to do the HTML generation. The command's options are a combination of the pinto list and pod2projectdocs commands.

WARNING

The Pinto API is not yet stable so it's entirely possible that changes to Pinto will break this module.

This module doesn't work with remote Pinto repositories.

COMMAND OPTIONS (Pod::ProjectDocs)

--out=HTML_ROOT

-o HTML_ROOT

HTML_ROOT is the directory where the HTML docs will be generated. The directory will be created for you if it doesn't exist.

--title=TITLE

The TITLE that will be used as a header to the generated HTML docs.

--desc=DESCRIPTION

The DESCRIPTION that will be used in the generated HTML docs.

--charset=CHARSET

The CHARSET that will be used in the HTML meta tag. Defaults to UTF-8.

--noindex

Don't create an index on each of the pod pages.

--forcegen

Generate documents each time ignoring the last modified timestamp.

--lang=LANG

The LANG that will be set as xml:lang. Default to 'en'.

COMMAND OPTIONS (Pinto)

--author AUTHOR

-A AUTHOR

Limit the listing to records where the distribution author is AUTHOR. Note this is an exact match, not a pattern match. However, it is not case sensitive.

--distributions PATTERN

-D PATTERN

Limit the listing to records where the distribution archive name matches PATTERN. Note that PATTERN is just a plain string, not a regular expression. The PATTERN will match if it appears anywhere in the distribution archive name.

--packages PATTERN

-P PATTERN

Limit the listing to records where the package name matches PATTERN. Note that PATTERN is just a plain string, not a regular expression. The PATTERN will match if it appears anywhere in the package name.

--pinned

Limit the listing to records for packages that are pinned.

--stack NAME

-s NAME

List the contents of the stack with the given NAME. Defaults to the name of whichever stack is currently marked as the default stack. Use the stacks command to see the stacks in the repository.

--local

Limit the listing to only local distributions.

AUTHOR

Andy Gorman <agorman@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Andy Gorman.

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

Module Install Instructions

To install App::Pinto::Command::doc, simply copy and paste either of the commands in to your terminal