Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Term::Complete (3)

Name

Term::Complete - Perl word completion module

Synopsis

$input = Complete('prompt_string', \@completion_list);
$input = Complete('prompt_string', @completion_list);

Description

Perl Programmers Reference Guide                             Term::Complete(3)



NAME
       Term::Complete - Perl word completion module

SYNOPSIS
           $input = Complete('prompt_string', \@completion_list);
           $input = Complete('prompt_string', @completion_list);

DESCRIPTION
       This routine provides word completion on the list of words in the array
       (or array ref).

       The tty driver is put into raw mode and restored using an operating
       system specific command, in UNIX-like environments "stty".

       The following command characters are defined:

       <tab>
           Attempts word completion.  Cannot be changed.

       ^D  Prints completion list.  Defined by $Term::Complete::complete.

       ^U  Erases the current input.  Defined by $Term::Complete::kill.

       <del>, <bs>
           Erases one character.  Defined by $Term::Complete::erase1 and
           $Term::Complete::erase2.

DIAGNOSTICS
       Bell sounds when word completion fails.

BUGS
       The completion character <tab> cannot be changed.

AUTHOR
       Wayne Thompson



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14                 Term::Complete(3)