Complete::Zsh::Gen::FromPerinciCmdLine - Dump Perinci::CmdLine script and generate zsh completion script from it
This document describes version 0.002 of Complete::Zsh::Gen::FromPerinciCmdLine (from Perl distribution Complete-Zsh-Gen-FromPerinciCmdLine), released on 2016-10-28.
Dump Perinci::CmdLine script and generate zsh completion script from it.
This routine generate zsh completion script which uses _arguments to list each option, allowing zsh to be aware of each option.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
cmdname => str
Command name (by default will be extracted from filename).
compname => str
Completer name (in case different from cmdname).
filename* => filename
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: A script that can be put in $fpath/_$progname (str)
Please visit the project's homepage at https://metacpan.org/release/Complete-Zsh-Gen-FromPerinciCmdLine.
Source repository is at https://github.com/perlancar/perl-Complete-Zsh-Gen-FromPerinciCmdLine.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Complete-Zsh-Gen-FromPerinciCmdLine
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.
To install Complete::Zsh::Gen::FromPerinciCmdLine, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.