/ 
Getopt-Long-Complete-0.317
River stage three • 24 direct dependents • 100 total dependents
/ demo-getopt-long-complete

NAME

demo-getopt-long-complete - Script to demonstrate Getopt::Long::Complete

VERSION

This document describes version 0.317 of demo-getopt-long-complete (from Perl distribution Getopt-Long-Complete), released on 2023-02-21.

SYNOPSIS

Activate completion using (can be put in your bash startup file):

% complete -C demo-getopt-long-complete demo-getopt-long-complete

Test completion:

% demo-getopt-long-complete <tab>
% demo-getopt-long-complete -<tab>
% demo-getopt-long-complete --int 1 -<tab>
# and so on

COMPLETION

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

bash

To activate bash completion for this script, put:

complete -C demo-getopt-long-complete demo-getopt-long-complete

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 modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete demo-getopt-long-complete 'p/*/`demo-getopt-long-complete`/'

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/Getopt-Long-Complete.

SOURCE

Source repository is at https://github.com/perlancar/perl-Getopt-Long-Complete.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2020, 2017, 2016, 2015, 2014 by perlancar <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.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Getopt-Long-Complete

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.