start writting documentation for expect

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@197328 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Michael Spector 2005-10-02 06:53:45 +00:00
parent d738e441e8
commit f5fc97ec93
3 changed files with 264 additions and 0 deletions

View file

@ -0,0 +1,44 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="expect.installation">
&reftitle.install;
<para>
&pecl.moved;
&pecl.info;
<ulink url="&url.pecl.package;expect">&url.pecl.package;expect</ulink>.
</para>
<para>
&pecl.source.4;
In order to use these functions you must compile PHP with expect support
by using the <option role="configure">--with-expect[=DIR]</option>
configure option.
</para>
<para>
Windows users will enable <filename>php_expect.dll</filename> inside
of &php.ini; in order to use these functions.
&pecl.windows.4;
&pecl.windows.download;
</para>
</section>
<!-- 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
-->

View file

@ -0,0 +1,97 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<section id="expect.constants">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry>
<term>
<constant>EXP_GLOB</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Indicates that the pattern is a glob-style string pattern.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>EXP_EXACT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Indicates that the pattern is an exact string.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>EXP_REGEXP</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Indicates that the pattern is a regexp-style string pattern.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>EXP_EOF</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Value, returned by <function>expect_expectl</function>, when EOF is
reached.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>EXP_TIMEOUT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Value, returned by <function>expect_expectl</function> upon timeout.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>EXP_FULLBUFFER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Value, returned by <function>expect_expectl</function> if no pattern have
been matched.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- 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
-->

123
reference/expect/ini.xml Normal file
View file

@ -0,0 +1,123 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="expect.configuration">
&reftitle.runtime;
&extension.runtime;
<para>
In order to configure expect extension, there are configuration options
in the <link linkend="configuration.file">configuration file</link> &php.ini;.
<table>
<title>Expect Configuration Options</title>
<tgroup cols="4">
<thead>
<row>
<entry>Name</entry>
<entry>Default</entry>
<entry>Changeable</entry>
</row>
</thead>
<tbody>
<row>
<entry>expect.timeout</entry>
<entry>"10"</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>expect.loguser</entry>
<entry>"On"</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>expect.logfile</entry>
<entry>""</entry>
<entry>PHP_INI_ALL</entry>
</row>
</tbody>
</tgroup>
</table>
&ini.php.constants;
</para>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry id="ini.expect.timeout">
<term>
<parameter>expect.timeout</parameter>
<type>integer</type>
</term>
<listitem>
<para>
The timeout period for waiting for the data, when using the <function>expect_expectl</function> function.
</para>
<para>
A value of "-1" disables a timeout from occurring.
</para>
<note>
<para>
A value of "0" causes the <function>expect_expectl</function> function to return immediately.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry id="ini.expect.loguser">
<term>
<parameter>expect.loguser</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Whether expect should send any output from the spawned process to stdout.
Since interactive programs typically echo their input, this usually suffices
to show both sides of the conversation.
</para>
</listitem>
</varlistentry>
<varlistentry id="ini.expect.logfile">
<term>
<parameter>expect.logfile</parameter>
<type>string</type>
</term>
<listitem>
<para>
Name of the file, where the output from the spawned process will be
written. If this file doesn't exist, it will be created.
</para>
<note>
<para>
If this configuration is not empty, the output is written regardless of
the value of <link linkend="ini.expect.loguser">expect.loguser</link>
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<!-- 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
-->