From 5bef6a7874f5bcf7eae69acbfd6aecc6f2a5e2ce Mon Sep 17 00:00:00 2001
From: Michael Spector <michael@php.net>
Date: Sun, 2 Oct 2005 07:31:52 +0000
Subject: [PATCH] add note about using expect wrapper

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@197330 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/expect/reference.xml | 105 +++++++++++++++++++++++++++++++++
 1 file changed, 105 insertions(+)
 create mode 100644 reference/expect/reference.xml

diff --git a/reference/expect/reference.xml b/reference/expect/reference.xml
new file mode 100644
index 0000000000..0d6b202417
--- /dev/null
+++ b/reference/expect/reference.xml
@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- Purpose: system -->
+<!-- Membership: pecl -->
+
+ <reference id="ref.expect">
+  <title>Expect Functions</title>
+  <titleabbrev>Expect</titleabbrev>
+
+  <partintro>
+   <section id="expect.intro">
+    &reftitle.intro;
+    <para>
+     This extension allows to interact with processes through PTY. You may
+     consider using the <link linkend="wrappers.expect"><literal>expect://</literal>
+     wrapper</link> with the <link linkend="ref.filesystem">filesystem
+     functions</link> which provide a simpler and more intuitive interface.
+    </para>
+   </section>
+   
+   <section id="expect.requirements">
+    &reftitle.required;
+    <para>
+     This module uses the functions of the <ulink
+     url="&url.expect;">expect</ulink> library.
+     You need libexpect version &gt;= 5.43.0.
+    </para>
+   </section>
+   
+   &reference.expect.configure;
+
+   &reference.expect.ini;
+
+   <section id="expect.resources">
+    &reftitle.resources;
+    &no.resource;
+   </section>
+
+   &reference.expect.constants;
+
+   <section id="expect.examples">
+    &reftitle.examples;
+    <para>
+     This example connects to the remote host via SSH, and prints the remote
+     uptime.
+    </para>
+    <example>
+     <title>Expect Usage Example</title>
+     <programlisting role="php">
+<![CDATA[
+<?php
+
+ini_set ("expect.loguser", "Off");
+
+$fp = expect_popen ("ssh root@remotehost uptime");
+
+$cases = array (
+  array (0 => "password:", 1 => "PASSWORD")
+);
+
+switch (expect_expectl ($fp, $cases))
+{
+ case "PASSWORD":
+  fwrite ($fp, "password\n");
+  break;
+ 
+ default:
+  die ("Error was occurred while connecting to the remote host!\n");
+}
+
+while ($line = fgets ($fp)) {
+  print $line;
+}
+fclose ($fp);
+
+?>
+]]>
+     </programlisting>
+    </example>
+   </section>
+  </partintro>
+
+&reference.expect.functions;
+
+ </reference>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->