Rob Hoelz > Bash-Completion-Plugins-App-Cmd-0.01 > Bash::Completion::Plugins::App::Cmd

Download:
Bash-Completion-Plugins-App-Cmd-0.01.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.01   Source  

NAME ^

Bash::Completion::Plugins::App::Cmd - A Bash::Completion plugin for writing App::Cmd plugins

VERSION ^

version 0.01

SYNOPSIS ^

  use parent 'Bash::Completion::Plugins::App::Cmd';

  # fill in everything you normally would for Bash::Completion,
  # except for complete

  sub command_class { 'My::Cmd' } # mandatory

DESCRIPTION ^

This is a Bash::Completion plugin that assists in writing other Bash::Completion plugins for programs that use App::Cmd. Everything is done similar to writing a normal Bash::Completion plugin, except you need to define the "command_class" method rather than the "complete" in 'Bash::Completion::Plugin' method. "command_class" is the name of the class that you use use App::Cmd::Setup -app from.

METHODS ^

complete

Populates the Bash::Completion request with commands from the given App::Cmd class.

command_class

Returns the name of the class that this plugin will extract command names from. This method must be implemented by subclasses.

SEE ALSO ^

App::Cmd, Bash::Completion

AUTHOR ^

Rob Hoelz <rob@hoelz.ro>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 by Rob Hoelz.

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://github.com/hoelzro/bash-completion-plugins-app-cmd/issues

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.

syntax highlighting: