App::PODUtils - Command-line utilities related to POD
This document describes version 0.047 of App::PODUtils (from Perl distribution App-PODUtils), released on 2020-03-08.
This distribution provides the following command-line utilities related to Perl POD:
dump-pod-structure
elide-pod
poddump
podless
reverse-pod-headings
sort-pod-headings
Usage:
dump_pod_structure(%args) -> [status, msg, payload, meta]
Dump POD structure using Pod::Elemental.
This is actually just a shortcut for:
% podsel FILENAME --root --dump --transform Pod5 --transform Nester
This function is not exported.
Arguments ('*' denotes required arguments):
pod => perl::pod_filename (default: "-")
Path to a .POD file, or a POD name (e.g. Foo::Bar) which will be searched in @INC.
"-" means standard input.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
reverse_pod_headings(%args) -> any
Reverse POD headings.
command => str (default: "head1")
sort_pod_headings(%args) -> any
Sort POD headings in text.
This utility sorts POD headings in text. By default it sorts =head1 headings. For example this POD:
=head1 b some text for b =head1 a text for a =head2 a2 =head2 a1 =head1 c text for c
will be sorted into:
=head1 a text for a =head2 a2 =head2 a1 =head1 b some text for b =head1 c text for c
Note that the =head2 headings are not sorted. If you want to sort those, you can rerun the utility and specify the --command=head2 option.
--command=head2
sort_args => hash
Arguments to pass to the Sort::Sub::* routine.
sort_sub => sortsub::spec
Name of a Sort::Sub::* module (without the prefix).
Please visit the project's homepage at https://metacpan.org/release/App-PODUtils.
Source repository is at https://github.com/perlancar/perl-App-PODUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-PODUtils
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.
pomdump. Perinci::To::POD=HASH(0x55aa003ac738).
podsel.
pod2html
podtohtml from App::podtohtml
App::PMUtils
App::PlUtils
perlancar <perlancar@cpan.org>
This software is copyright (c) 2020, 2019, 2018, 2017, 2016 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.
To install App::PODUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::PODUtils
CPAN shell
perl -MCPAN -e shell install App::PODUtils
For more information on module installation, please visit the detailed CPAN module installation guide.