.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Test::Expect 3pm"
.TH Test::Expect 3pm "2022-11-19" "perl v5.36.0" "User Contributed Perl Documentation"
.\" 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"
Test::Expect \- Automated driving and testing of terminal\-based programs
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 12
\&  # in a t/*.t file:
\&  use Test::Expect;
\&  use Test::More tests => 13;
\&  expect_run(
\&    command => ["perl", "testme.pl"],
\&    prompt  => \*(Aqtestme: \*(Aq,
\&    quit    => \*(Aqquit\*(Aq,
\&  );
\&  expect("ping", "pong", "expect");
\&  expect_send("ping", "expect_send");
\&  expect_is("* Hi there, to testme", "expect_is");
\&  expect_like(qr/Hi there, to testme/, "expect_like");
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Test::Expect is a module for automated driving and testing of
terminal-based programs.  It is handy for testing interactive programs
which have a prompt, and is based on the same concepts as the Tcl
Expect tool.  As in Expect::Simple, the Expect object is made
available for tweaking.
.PP
Test::Expect is intended for use in a test script.
.SH "SUBROUTINES"
.IX Header "SUBROUTINES"
.SS "expect_run"
.IX Subsection "expect_run"
The expect_run subroutine sets up Test::Expect. You must pass in
the interactive program to run, what the prompt of the program is, and
which command quits the program:
.PP
.Vb 5
\&  expect_run(
\&    command => ["perl", "testme.pl"],
\&    prompt  => \*(Aqtestme: \*(Aq,
\&    quit    => \*(Aqquit\*(Aq,
\&  );
.Ve
.PP
The \f(CW\*(C`command\*(C'\fR may either be a string, or an arrayref of program and
arguments; the latter for bypasses the shell.
.SS "expect"
.IX Subsection "expect"
The expect subroutine is the catch all subroutine. You pass in the
command, the expected output of the subroutine and an optional
comment.
.PP
.Vb 1
\&  expect("ping", "pong", "expect");
.Ve
.SS "expect_send"
.IX Subsection "expect_send"
The expect_send subroutine sends a command to the program. You pass in
the command and an optional comment.
.PP
.Vb 1
\&  expect_send("ping", "expect_send");
.Ve
.SS "expect_is"
.IX Subsection "expect_is"
The expect_is subroutine tests the output of the program like
Test::More's is. It has an optional comment:
.PP
.Vb 1
\&  expect_is("* Hi there, to testme", "expect_is");
.Ve
.SS "expect_like"
.IX Subsection "expect_like"
The expect_like subroutine tests the output of the program like
Test::More's like. It has an optional comment:
.PP
.Vb 1
\&  expect_like(qr/Hi there, to testme/, "expect_like");
.Ve
.SS "expect_handle"
.IX Subsection "expect_handle"
This returns the Expect object.
.SS "expect_quit"
.IX Subsection "expect_quit"
Closes the Expect handle.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Expect, Expect::Simple.
.SH "AUTHOR"
.IX Header "AUTHOR"
Best Practical Solutions, \s-1LLC\s0 <modules@bestpractical.com>
.PP
Original module by Leon Brocard, <acme@astray.com>
.SH "BUGS"
.IX Header "BUGS"
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This extension is Copyright (C) 2015 Best Practical Solutions, \s-1LLC.\s0
.PP
Copyright (C) 2005, Leon Brocard
.PP
This module is free software; you can redistribute it or modify it
under the same terms as Perl itself.