/ 
App-PODUtils-0.049
River stage one • 1 direct dependent • 1 total dependent
/ sort-pod-headings

NAME

sort-pod-headings - Sort POD headings in text

VERSION

This document describes version 0.049 of sort-pod-headings (from Perl distribution App-PODUtils), released on 2020-06-06.

SYNOPSIS

Usage:

% sort-pod-headings [-A=s+] [-S=s] [--command=s] [--debug] [--format=name]
    [--json] [--log-level=level] [--(no)naked-res]
    [--page-result[=program]] [--quiet] [--sort-arg=s+]
    [--sort-args-json=s] [--sort-sub=s] [--trace] [--verbose]
    [--view-result[=program]] [pod]

DESCRIPTION

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.

OPTIONS

* marks required options.

Main options

--command=s

Default value:

"head1"
--pod=s

Path to a .POD file, or a POD name (e.g. Foo::Bar) which will be searched in @INC.

Default value:

"-"

"-" means standard input.

--sort-arg=s@, -A

Arguments to pass to the Sort::Sub::* routine.

Can be specified multiple times.

--sort-args-json=s

Arguments to pass to the Sort::Sub::* routine (JSON-encoded).

See --sort-arg.

--sort-sub=s, -S

Name of a Sort::Sub::* module (without the prefix).

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]
--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C sort-pod-headings sort-pod-headings

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete sort-pod-headings 'p/*/`sort-pod-headings`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-PODUtils.

SOURCE

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

BUGS

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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.