Debian Codegraph @

upstream/debian-unstable/man3/Term::Complete.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Term::Complete 3perl"
58 .TH Term::Complete 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Term::Complete \- Perl word completion module
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 2
68 \& $input = Complete(\*(Aqprompt_string\*(Aq, \e@completion_list);
69 \& $input = Complete(\*(Aqprompt_string\*(Aq, @completion_list);
70 .Ve
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 This routine provides word completion on the list of words in
74 the array (or array ref).
75 .PP
76 The tty driver is put into raw mode and restored using an operating
77 system specific command, in UNIX-like environments \f(CW\*(C`stty\*(C'\fR.
78 .PP
79 The following command characters are defined:
80 .IP <tab> 4
81 .IX Item "<tab>"
82 Attempts word completion.
83 Cannot be changed.
84 .IP ^D 4
85 .IX Item "^D"
86 Prints completion list.
87 Defined by \fR\f(CI$Term::Complete::complete\fR\fI\fR.
88 .IP ^U 4
89 .IX Item "^U"
90 Erases the current input.
91 Defined by \fR\f(CI$Term::Complete::kill\fR\fI\fR.
92 .IP "<del>, <bs>" 4
93 .IX Item "<del>, <bs>"
94 Erases one character.
95 Defined by \fR\f(CI$Term::Complete::erase1\fR\fI\fR and \fI\fR\f(CI$Term::Complete::erase2\fR\fI\fR.
96 .SH DIAGNOSTICS
97 .IX Header "DIAGNOSTICS"
98 Bell sounds when word completion fails.
99 .SH BUGS
100 .IX Header "BUGS"
101 The completion character <tab> cannot be changed.
102 .SH AUTHOR
103 .IX Header "AUTHOR"
104 Wayne Thompson