Dist::Zilla::Plugin::InsertCommandOutput - Insert the output of command into your POD
This document describes version 0.057 of Dist::Zilla::Plugin::InsertCommandOutput (from Perl distribution Dist-Zilla-Plugin-InsertCommandOutput), released on 2022-10-28.
In dist.ini:
[InsertCommandOutput] ;indent=4 ;include_command=0 ;substitute_template=0
In your POD:
# COMMAND: netstat -anp
This module finds # COMMAND: ... directives in your POD, pass it to the Perl's backtick operator, and insert the result into your POD as a verbatim paragraph (unless if you set make_verbatim to 0, in which case output will be inserted as-is). If command fails ($? is non-zero), build will be aborted.
# COMMAND: ...
make_verbatim
$?
Uint. Default: 1. Number of spaces to indent each line of output with. Can be set to 0 to not indent at all.
Bool, default false. If set to true, will also show the command in the output.
Bool, default true.
Bool, default false.
Bool, default false. If set to true, will substitute some template variables in the command with their actual values:
[[prog]]
The name of the program (guessed from the current filename, and in the actual command to execute will be quoted($^X) + " " + quoted(filename)). Empty if current filename is not a script.
[[module]]
The name of the module (guessed from the current filename). Empty if current filename is not a module.
Please visit the project's homepage at https://metacpan.org/release/Dist-Zilla-Plugin-InsertCommandOutput.
Source repository is at https://github.com/perlancar/perl-Dist-Zilla-Plugin-InsertCommandOutput.
Dist::Zilla::Plugin::InsertCodeResult, which can also be used to accomplish the same thing, e.g. with # CODE: my $res = `netstat -anp`; die if $?; $res except the DZP::InstallCommandResult plugin is shorter.
# CODE: my $res = `netstat -anp`; die if $?; $res
Dist::Zilla::Plugin::InsertCodeOutput, which can also be used to accomplish the same thing, e.g. with # CODE: system "netstat -anp"; die if $?.
# CODE: system "netstat -anp"; die if $?
Dist::Zilla::Plugin::InsertExample
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2021, 2019, 2018, 2015, 2014 by perlancar <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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-InsertCommandOutput
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.
To install Dist::Zilla::Plugin::InsertCommandOutput, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dist::Zilla::Plugin::InsertCommandOutput
CPAN shell
perl -MCPAN -e shell install Dist::Zilla::Plugin::InsertCommandOutput
For more information on module installation, please visit the detailed CPAN module installation guide.