sort-pod-headings - Sort POD headings in text
This document describes version 0.050 of sort-pod-headings (from Perl distribution App-PODUtils), released on 2021-07-20.
Usage:
% sort-pod-headings [--command=str] [--debug|--log-level=level|--quiet|--trace|--verbose] [--format=name|--json] [--naked-pod|-N|--no-naked-pod|--nonaked-pod] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [(--sort-arg=str)+] [--sort-sub=sortsub::spec] [--sort-args-json=json|(-A=str)+] [-S=sortsub::spec] -- [pod]
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
* marks required options.
*
Default value:
"head1"
Strip =pod and =cut delimiters.
Normally, when outputing POD text, the `=pod` header and `=cut` footer are included. This option, if enabled, strips the outputting of such header/footer.
Path to a .POD file, or a POD name (e.g. Foo::Bar) which will be searched in @INC.
"-"
"-" means standard input.
Can also be specified as the 1st command-line argument.
Arguments to pass to the Sort::Sub::* routine.
Can be specified multiple times.
Arguments to pass to the Sort::Sub::* routine (JSON-encoded).
See --sort-arg.
--sort-arg
Name of a Sort::Sub::* module (without the prefix).
Shortcut for --log-level=debug.
Set log level.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Choose output format, e.g. json, text.
undef
Set output format to json.
When outputing as JSON, strip result envelope.
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]
Filter output through a pager.
View output using a viewer.
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
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.
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).
For fish and zsh, install shcompgen as described above.
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2021, 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.