diff options
author | Andy Dougherty <doughera.lafayette.edu> | 1995-12-21 00:01:16 +0000 |
---|---|---|
committer | Andy Dougherty <doughera.lafayette.edu> | 1995-12-21 00:01:16 +0000 |
commit | cb1a09d0194fed9b905df7b04a4bc031d354609d (patch) | |
tree | f0c890a5a8f5274873421ac573dfc719188e5eec /lib/Term/Complete.pm | |
parent | 3712091946b37b5feabcc1f630b32639406ad717 (diff) | |
download | perl-cb1a09d0194fed9b905df7b04a4bc031d354609d.tar.gz |
This is patch.2b1g to perl5.002beta1.
cd to your perl source directory, and type
patch -p1 -N < patch.2b1g
This patch is just my packaging of Tom's documentation patches
he released as patch.2b1g.
Patch and enjoy,
Andy Dougherty doughera@lafcol.lafayette.edu
Dept. of Physics
Lafayette College, Easton PA 18042
Diffstat (limited to 'lib/Term/Complete.pm')
-rw-r--r-- | lib/Term/Complete.pm | 79 |
1 files changed, 56 insertions, 23 deletions
diff --git a/lib/Term/Complete.pm b/lib/Term/Complete.pm index 97c71fe43f..6faef2296e 100644 --- a/lib/Term/Complete.pm +++ b/lib/Term/Complete.pm @@ -5,30 +5,63 @@ require Exporter; @ISA = qw(Exporter); @EXPORT = qw(Complete); -# # @(#)complete.pl,v1.1 (me@anywhere.EBay.Sun.COM) 09/23/91 -# -# Author: Wayne Thompson -# -# Description: -# This routine provides word completion. -# (TAB) attempts word completion. -# (^D) prints completion list. -# (These may be changed by setting $Complete::complete, etc.) -# -# Diagnostics: -# Bell when word completion fails. -# -# Dependencies: -# The tty driver is put into raw mode. -# -# Bugs: -# -# Usage: -# $input = complete('prompt_string', \@completion_list); -# or -# $input = complete('prompt_string', @completion_list); -# + +=head1 NAME + +Term::Complete - Perl word completion module + +=head1 SYNOPSIS + + $input = complete('prompt_string', \@completion_list); + $input = complete('prompt_string', @completion_list); + +=head1 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 using the system command +C<stty raw -echo> and restored using C<stty -raw echo>. + +The following command characters are defined: + +=over 4 + +=item <tab> +Attempts word completion. +Cannot be changed. + +=item ^D + +Prints completion list. +Defined by I<$Term::Complete::complete>. + +=item ^U + +Erases the current input. +Defined by I<$Term::Complete::kill>. + +=item <del>, <bs> + +Erases one character. +Defined by I<$Term::Complete::erase1> and I<$Term::Complete::erase2>. + +=back + +=head1 DIAGNOSTICS + +Bell sounds when word completion fails. + +=head1 BUGS + +The completion charater <tab> cannot be changed. + +=head1 AUTHOR + +Wayne Thompson + +=cut CONFIG: { $complete = "\004"; |