01 Nov 2016 06:02:12 UTC
- Distribution: Getopt-Std-Dump
- Module version: 0.001
- Source (raw)
- Browse (raw)
- How to Contribute
- Testers (2189 / 0 / 32)
- KwaliteeBus factor: 1
- % Coverage
- License: perl_5
- Perl: v5.10.1
- Activity24 month
- Download (15.5KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionPERLANCAR perlancar
- COPYRIGHT AND LICENSE
Getopt::Std::Dump - Run a Getopt::Std-based script but only to dump the spec
This document describes version 0.001 of Getopt::Std::Dump (from Perl distribution Getopt-Std-Dump), released on 2016-10-30.
Run a Getopt::Std-based script but only to dump the spec.
This function runs a CLI script that uses
Getopt::Stdbut monkey-patches beforehand so that
getopt()will dump the spec and then exit. The goal is to get the spec without actually running the script.
This can be used to gather information about the script and then generate documentation about it or do other things (e.g.
App::shcompgento generate a completion script for the original script).
CLI script needs to use
Getopt::Std. This is detected currently by a simple regex. If script is not detected as using
Getopt::Std, status 412 is returned.
Will return an array:
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
filename* => str
Path to the script.
libs => array[str]
Libraries to unshift to @INC when running script.
skip_detect => bool
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
Will be set to 1 when executing the script to be dumped.
Please visit the project's homepage at https://metacpan.org/release/Getopt-Std-Dump.
Source repository is at https://github.com/perlancar/perl-Getopt-Std-Dump.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Getopt-Std-Dump
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.
This software is copyright (c) 2016 by firstname.lastname@example.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.
Module Install Instructions
To install Getopt::Std::Dump, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Getopt::Std::Dump
For more information on module installation, please visit the detailed CPAN module installation guide.