mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
expect: fix XML to get remove of useless wrapping para tags (#5116)
This commit is contained in:
Gina Peter Banyard
committed by
GitHub
GitHub
parent
b090c44768
commit
1ad8299bbc
@@ -29,71 +29,69 @@
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>expect</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An Expect stream, previously opened with
|
||||
<function>expect_popen</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>cases</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An array of expect cases. Each expect case is an indexed array,
|
||||
as described in the following table:
|
||||
<table>
|
||||
<title>Expect Case Array</title>
|
||||
<tgroup cols="5">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Index Key</entry>
|
||||
<entry>Value Type</entry>
|
||||
<entry>Description</entry>
|
||||
<entry>Is Mandatory</entry>
|
||||
<entry>Default Value</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>0</entry>
|
||||
<entry>string</entry>
|
||||
<entry>pattern, that will be matched against the output from the stream</entry>
|
||||
<entry>yes</entry>
|
||||
<entry></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>1</entry>
|
||||
<entry>mixed</entry>
|
||||
<entry>value, that will be returned by this function, if the pattern matches</entry>
|
||||
<entry>yes</entry>
|
||||
<entry></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>2</entry>
|
||||
<entry>integer</entry>
|
||||
<entry>
|
||||
pattern type, one of:
|
||||
<link linkend="constant.exp-glob"><constant>EXP_GLOB</constant></link>,
|
||||
<link linkend="constant.exp-exact"><constant>EXP_EXACT</constant></link>
|
||||
or
|
||||
<link linkend="constant.exp-regexp"><constant>EXP_REGEXP</constant></link>
|
||||
</entry>
|
||||
<entry>no</entry>
|
||||
<entry><link linkend="constant.exp-glob"><constant>EXP_GLOB</constant></link></entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>expect</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An Expect stream, previously opened with
|
||||
<function>expect_popen</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>cases</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
An array of expect cases. Each expect case is an indexed array,
|
||||
as described in the following table:
|
||||
<table>
|
||||
<title>Expect Case Array</title>
|
||||
<tgroup cols="5">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Index Key</entry>
|
||||
<entry>Value Type</entry>
|
||||
<entry>Description</entry>
|
||||
<entry>Is Mandatory</entry>
|
||||
<entry>Default Value</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>0</entry>
|
||||
<entry>string</entry>
|
||||
<entry>pattern, that will be matched against the output from the stream</entry>
|
||||
<entry>yes</entry>
|
||||
<entry/>
|
||||
</row>
|
||||
<row>
|
||||
<entry>1</entry>
|
||||
<entry>mixed</entry>
|
||||
<entry>value, that will be returned by this function, if the pattern matches</entry>
|
||||
<entry>yes</entry>
|
||||
<entry/>
|
||||
</row>
|
||||
<row>
|
||||
<entry>2</entry>
|
||||
<entry>integer</entry>
|
||||
<entry>
|
||||
pattern type, one of:
|
||||
<link linkend="constant.exp-glob"><constant>EXP_GLOB</constant></link>,
|
||||
<link linkend="constant.exp-exact"><constant>EXP_EXACT</constant></link>
|
||||
or
|
||||
<link linkend="constant.exp-regexp"><constant>EXP_REGEXP</constant></link>
|
||||
</entry>
|
||||
<entry>no</entry>
|
||||
<entry><link linkend="constant.exp-glob"><constant>EXP_GLOB</constant></link></entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
@@ -110,34 +108,31 @@
|
||||
</refsect1>
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<para>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>PECL expect 0.2.1</entry>
|
||||
<entry>
|
||||
Prior to version 0.2.1, in <parameter>match</parameter> parameter a match string was returned,
|
||||
not an array of match substrings.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</para>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>PECL expect 0.2.1</entry>
|
||||
<entry>
|
||||
Prior to version 0.2.1, in <parameter>match</parameter> parameter a match string was returned,
|
||||
not an array of match substrings.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</refsect1>
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>expect_expectl</function> example</title>
|
||||
<programlisting role="php">
|
||||
<example>
|
||||
<title><function>expect_expectl</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
// Copies file from remote host:
|
||||
@@ -170,20 +165,16 @@ while (true) {
|
||||
fclose($stream);
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>expect_popen</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
<simplelist>
|
||||
<member><function>expect_popen</function></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<refentry xml:id="function.expect-popen" xmlns="http://docbook.org/ns/docbook">
|
||||
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.expect-popen">
|
||||
<refnamediv>
|
||||
<refname>expect_popen</refname>
|
||||
<refpurpose>Execute command via Bourne shell, and open the PTY stream to
|
||||
@@ -18,18 +18,16 @@
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>command</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Command to execute.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>command</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Command to execute.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
@@ -43,10 +41,9 @@
|
||||
</refsect1>
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>expect_popen</function> example</title>
|
||||
<programlisting role="php">
|
||||
<example>
|
||||
<title><function>expect_popen</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
// Login to the PHP.net CVS repository:
|
||||
@@ -56,20 +53,16 @@ fwrite ($stream, "phpfi\n");
|
||||
fclose ($stream);
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>popen</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
<simplelist>
|
||||
<member><function>popen</function></member>
|
||||
</simplelist>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision$ -->
|
||||
<section xml:id="expect.configuration" xmlns="http://docbook.org/ns/docbook">
|
||||
<section xmlns="http://docbook.org/ns/docbook" xml:id="expect.configuration">
|
||||
&reftitle.runtime;
|
||||
&extension.runtime;
|
||||
<para>
|
||||
@@ -22,108 +22,105 @@
|
||||
<entry><link linkend="ini.expect.timeout">expect.timeout</link></entry>
|
||||
<entry>"10"</entry>
|
||||
<entry><constant>INI_ALL</constant></entry>
|
||||
<entry></entry>
|
||||
<entry/>
|
||||
</row>
|
||||
<row>
|
||||
<entry><link linkend="ini.expect.loguser">expect.loguser</link></entry>
|
||||
<entry>"1"</entry>
|
||||
<entry><constant>INI_ALL</constant></entry>
|
||||
<entry></entry>
|
||||
<entry/>
|
||||
</row>
|
||||
<row>
|
||||
<entry><link linkend="ini.expect.logfile">expect.logfile</link></entry>
|
||||
<entry>""</entry>
|
||||
<entry><constant>INI_ALL</constant></entry>
|
||||
<entry></entry>
|
||||
<entry/>
|
||||
</row>
|
||||
<row>
|
||||
<entry><link linkend="ini.expect.match-max">expect.match_max</link></entry>
|
||||
<entry>""</entry>
|
||||
<entry><constant>INI_ALL</constant></entry>
|
||||
<entry></entry>
|
||||
<entry/>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
&ini.php.constants;
|
||||
</para>
|
||||
|
||||
|
||||
&ini.descriptions.title;
|
||||
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry xml:id="ini.expect.timeout">
|
||||
<term>
|
||||
<parameter>expect.timeout</parameter>
|
||||
<type>int</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 xml:id="ini.expect.loguser">
|
||||
<term>
|
||||
<parameter>expect.loguser</parameter>
|
||||
<type>bool</type>
|
||||
</term>
|
||||
<listitem>
|
||||
<variablelist>
|
||||
<varlistentry xml:id="ini.expect.timeout">
|
||||
<term>
|
||||
<parameter>expect.timeout</parameter>
|
||||
<type>int</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>
|
||||
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.
|
||||
A value of "0" causes the <function>expect_expectl</function>
|
||||
function to return immediately.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</note>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="ini.expect.logfile">
|
||||
<term>
|
||||
<parameter>expect.logfile</parameter>
|
||||
<type>string</type>
|
||||
</term>
|
||||
<listitem>
|
||||
<varlistentry xml:id="ini.expect.loguser">
|
||||
<term>
|
||||
<parameter>expect.loguser</parameter>
|
||||
<type>bool</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 xml: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>
|
||||
Name of the file, where the output from the spawned process will be
|
||||
written. If this file doesn't exist, it will be created.
|
||||
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>
|
||||
<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>
|
||||
</note>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry xml:id="ini.expect.match-max">
|
||||
<term>
|
||||
<parameter>expect.match_max</parameter>
|
||||
<type>int</type>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Changes default size (2000 bytes) of the buffer used to match asterisks
|
||||
in patterns.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry xml:id="ini.expect.match-max">
|
||||
<term>
|
||||
<parameter>expect.match_max</parameter>
|
||||
<type>int</type>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Changes default size (2000 bytes) of the buffer used to match asterisks
|
||||
in patterns.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
</variablelist>
|
||||
</section>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
mode: sgml
|
||||
|
||||
Reference in New Issue
Block a user