Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Term::Complete.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Term::Complete 3pm"
61 .TH Term::Complete 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Term::Complete \- Perl word completion module
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& $input = Complete(\*(Aqprompt_string\*(Aq, \e@completion_list);
72 \& $input = Complete(\*(Aqprompt_string\*(Aq, @completion_list);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 This routine provides word completion on the list of words in
77 the array (or array ref).
78 .PP
79 The tty driver is put into raw mode and restored using an operating
80 system specific command, in UNIX\-like environments \f(CW\*(C`stty\*(C'\fR.
81 .PP
82 The following command characters are defined:
83 .IP <tab> 4
84 .IX Item "<tab>"
85 Attempts word completion.
86 Cannot be changed.
87 .IP ^D 4
88 .IX Item "^D"
89 Prints completion list.
90 Defined by \fR\f(CI$Term::Complete::complete\fR\fI\fR.
91 .IP ^U 4
92 .IX Item "^U"
93 Erases the current input.
94 Defined by \fR\f(CI$Term::Complete::kill\fR\fI\fR.
95 .IP "<del>, <bs>" 4
96 .IX Item "<del>, <bs>"
97 Erases one character.
98 Defined by \fR\f(CI$Term::Complete::erase1\fR\fI\fR and \fI\fR\f(CI$Term::Complete::erase2\fR\fI\fR.
99 .SH DIAGNOSTICS
100 .IX Header "DIAGNOSTICS"
101 Bell sounds when word completion fails.
102 .SH BUGS
103 .IX Header "BUGS"
104 The completion character <tab> cannot be changed.
105 .SH AUTHOR
106 .IX Header "AUTHOR"
107 Wayne Thompson