perlancar > Perinci-CmdLine > peri-func-usage

Download:
Perinci-CmdLine-1.41.tar.gz

Annotate this POD

Website

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

peri-func-usage - Display command-line usage of a Riap function

VERSION ^

This document describes version 1.41 of peri-func-usage (from Perl distribution Perinci-CmdLine), released on 2014-12-19.

SYNOPSIS ^

From command-line:

 % peri-func-usage /Some/Module/somefunc
 % peri-func-usage --help

DESCRIPTION ^

OPTIONS ^

* marks required options.

--config-path=s

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--help, -h, -?

Display this help message.

--no-config

Do not use any configuration file.

--url=s*

Riap URL to function, e.g. /Git/Bunch/backup_bunch.

--version, -v

FILES ^

/etc/peri-func-usage.conf

~/peri-func-usage.conf

COMPLETION ^

This script has shell tab completion capability with support for several shells.

bash

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.

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-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.

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-CmdLine.

SOURCE ^

Source repository is at https://github.com/perlancar/perl-Perinci-CmdLine.

BUGS ^

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.

AUTHOR ^

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2014 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.

syntax highlighting: