NAME
    Sub::Spec::BashComplete - Provide bash completion for Sub::Spec::CmdLine
    programs

VERSION
    version 0.19

SYNOPSIS
     # require'd by Sub::Spec::CmdLine bash completion is enabled

DESCRIPTION
    NOTICE: The Sub::Spec specification is deprecated as of Jan 2012. Rinci
    is the new specification to replace Sub::Spec, it is about 95%
    compatible with Sub::Spec, but corrects a few issues and is more
    generic. Perinci:: is the family of Perl modules that implement the
    Rinci specification. Many of its modules can handle existing Sub::Spec
    sub specs. Perinci::BashComplete is the replacement for
    Sub::Spec::BashComplete.

    This module provides functionality for doing bash completion. It is
    meant to be used by Sub::Spec::CmdLine, but nevertheless some routines
    is reusable outside it.

FUNCTIONS
    None of the functions are exported by default, but they are exportable.

  complete_env($word, \%opts) => ARRAY
    Complete from environment variables (%ENV). Word should be '' or '$' or
    'foo' or '$foo'. Return list of possible completion, e.g. "('$USER',
    '$HOME', ...)".

    Options:

    *   ci => BOOL (default 0)

        If set to true, match case-insensitively.

  complete_program($word, \%opts) => ARRAY
    Complete from program names (or dir names). Only program which is
    executable will be listed. Word can be '/usr/bin/foo' or 'foo' or ''. If
    word doesn't contain '/', will search from PATH.

  complete_file($word, \%opts) => ARRAY
    Complete from file names in the current directory.

    Options:

    *   f => BOOL (default 1)

        If set to 0, will not complete files, only directories.

    *   d => BOOL (default 1)

        If set to 0, will not complete directories, only files.

  complete_subcommand($word, \%subcommands, \%opts) => ARRAY
    Complete from subcommand names in %subcommands.

    Options:

    *   ci => BOOL (default 0)

        If set to true, match case-insensitively.

  bash_complete_spec_arg(\%spec, \%opts) => ARRAY
    Complete subroutine arguments (from $spec{args}, where %spec is a
    Sub::Spec subroutine spec). Word can be 'argname' or '--arg' or
    '--arg='.

    Options:

    *   words => ARRAYREF

        If unset, will be taken from COMP_LINE and COMP_POINT.

    *   cword => INT

    *   args_sub => CODEREF

    *   arg_sub => {ARGNAME => CODEREF, ...}

BUGS/LIMITATIONS/TODOS
    Due to parsing limitation (invokes subshell), can't complete unclosed
    quotes, e.g.

     foo "bar <tab>

    while shell function can complete this because they are provided
    COMP_WORDS and COMP_CWORD by bash.

SEE ALSO
    Sub::Spec

    Sub::Spec::CmdLine

    Other bash completion modules on CPAN: Getopt::Complete,
    Bash::Completion.

AUTHOR
    Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2012 by Steven Haryanto.

    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.