NAME
peri-eg-noop-inline - For testing startup overhead of a Perinci::CmdLine::Inline script
VERSION
This document describes version 0.01 of main (from Perl distribution Perinci-Examples-Bin-Inline), released on 2015-11-28.
SYNOPSIS
Usage:
% peri-eg-noop-inline [options]COMPLETION
The distribution comes with a shell completer script (_peri-eg-noop-inline) for this script.
bash
To activate bash completion for this script, put:
complete -C _peri-eg-noop-inline peri-eg-noop-inlinein 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 shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.
tcsh
To activate tcsh completion for this script, put:
complete _peri-eg-noop-inline 'p/*/`peri-eg-noop-inline`/'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/Perinci-Examples-Bin-Inline.
SOURCE
Source repository is at https://github.com/perlancar/perl-Perinci-Examples-Bin-Inline.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Examples-Bin-Inline
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) 2015 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.
OPTIONS
* marks required options.
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:
0By 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]