- SEE ALSO
- COPYRIGHT AND LICENSE
poddump - Dump POD structure using Pod::Elemental
This document describes version 0.044 of poddump (from Perl distribution App-PODUtils), released on 2019-12-14.
% poddump [options] [pod]
This is actually just a shortcut for:
% podsel FILENAME --root --dump --transform Pod5 --transform Nester
* marks required options.
Path to a .POD file, or a POD name (e.g. Foo::Bar) which will be searched in @INC.
"-" means standard input.
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.
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
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:
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C poddump poddump
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 poddump 'p/*/`poddump`/'
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.
pomdump. Similar script, but using Pod::POM as backend to parse POD document into tree.
This software is copyright (c) 2019, 2018, 2017, 2016 by email@example.com.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.