peri-func-usage - Display command-line usage of a Riap function
This document describes version 1.44 of peri-func-usage (from Perl distribution Perinci-CmdLine), released on 2015-01-11.
From command-line:
% peri-func-usage /Some/Module/somefunc % peri-func-usage --help
* marks required options.
*
{en_US Set path to configuration file}.
Can be specified multiple times.
{en_US Set configuration profile to use}.
{en_US Display this help message}.
{en_US Do not use any configuration file}.
{en_US Riap URL to function, e.g. /Git/Bunch/backup_bunch}.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C peri-func-usage peri-func-usage
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.
~/.bashrc
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.
shcompgen
To activate tcsh completion for this script, put:
complete peri-func-usage 'p/*/`peri-func-usage`/'
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.
~/.tcshrc
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
PERI_FUNC_USAGE_OPT
~/peri-func-usage.conf
/etc/peri-func-usage.conf
Please visit the project's homepage at https://metacpan.org/release/Perinci-CmdLine.
Source repository is at https://github.com/sharyanto/perl-Perinci-CmdLine.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-CmdLine
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.
perlancar <perlancar@cpan.org>
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.
To install Perinci::CmdLine, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Perinci::CmdLine
CPAN shell
perl -MCPAN -e shell install Perinci::CmdLine
For more information on module installation, please visit the detailed CPAN module installation guide.