diff options
Diffstat (limited to 'upstream/debian-unstable/man3/Term::Complete.3perl')
-rw-r--r-- | upstream/debian-unstable/man3/Term::Complete.3perl | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/Term::Complete.3perl b/upstream/debian-unstable/man3/Term::Complete.3perl new file mode 100644 index 00000000..19a8dea4 --- /dev/null +++ b/upstream/debian-unstable/man3/Term::Complete.3perl @@ -0,0 +1,104 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" ======================================================================== +.\" +.IX Title "Term::Complete 3perl" +.TH Term::Complete 3perl 2024-01-12 "perl v5.38.2" "Perl Programmers Reference Guide" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH NAME +Term::Complete \- Perl word completion module +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 2 +\& $input = Complete(\*(Aqprompt_string\*(Aq, \e@completion_list); +\& $input = Complete(\*(Aqprompt_string\*(Aq, @completion_list); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +This routine provides word completion on the list of words in +the array (or array ref). +.PP +The tty driver is put into raw mode and restored using an operating +system specific command, in UNIX-like environments \f(CW\*(C`stty\*(C'\fR. +.PP +The following command characters are defined: +.IP <tab> 4 +.IX Item "<tab>" +Attempts word completion. +Cannot be changed. +.IP ^D 4 +.IX Item "^D" +Prints completion list. +Defined by \fR\f(CI$Term::Complete::complete\fR\fI\fR. +.IP ^U 4 +.IX Item "^U" +Erases the current input. +Defined by \fR\f(CI$Term::Complete::kill\fR\fI\fR. +.IP "<del>, <bs>" 4 +.IX Item "<del>, <bs>" +Erases one character. +Defined by \fR\f(CI$Term::Complete::erase1\fR\fI\fR and \fI\fR\f(CI$Term::Complete::erase2\fR\fI\fR. +.SH DIAGNOSTICS +.IX Header "DIAGNOSTICS" +Bell sounds when word completion fails. +.SH BUGS +.IX Header "BUGS" +The completion character <tab> cannot be changed. +.SH AUTHOR +.IX Header "AUTHOR" +Wayne Thompson |