didou Sun Feb 4 02:47:03 2007 UTC
Modified files:
/phpdoc/en/reference/readline/functions readline-add-history.xml
readline-callback-handler-install.xml
readline-callback-handler-remove.xml
readline-callback-read-char.xml
readline-clear-history.xml
readline-completion-function.xml
readline-info.xml
readline-list-history.xml
readline-on-new-line.xml
readline-read-history.xml
readline-redisplay.xml
readline-write-history.xml
readline.xml
Log:
WS, prepare for new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-add-history.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/readline/functions/readline-add-history.xml
diff -u phpdoc/en/reference/readline/functions/readline-add-history.xml:1.3
phpdoc/en/reference/readline/functions/readline-add-history.xml:1.4
--- phpdoc/en/reference/readline/functions/readline-add-history.xml:1.3 Fri Jun
24 09:11:46 2005
+++ phpdoc/en/reference/readline/functions/readline-add-history.xml Sun Feb
4 02:47:03 2007
@@ -1,22 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/readline.xml, last change in rev 1.1 -->
- <refentry id="function.readline-add-history">
- <refnamediv>
- <refname>readline_add_history</refname>
- <refpurpose>Adds a line to the history</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>bool</type><methodname>readline_add_history</methodname>
- <methodparam><type>string</type><parameter>line</parameter></methodparam>
- </methodsynopsis>
- <para>
- This function adds a line to the command line history.
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.readline-add-history">
+ <refnamediv>
+ <refname>readline_add_history</refname>
+ <refpurpose>Adds a line to the history</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>readline_add_history</methodname>
+ <methodparam><type>string</type><parameter>line</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ This function adds a line to the command line history.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>line</parameter></term>
+ <listitem>
+ <para>
+ The line to be added in the history.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-callback-handler-install.xml?r1=1.1&r2=1.2&diff_format=u
Index:
phpdoc/en/reference/readline/functions/readline-callback-handler-install.xml
diff -u
phpdoc/en/reference/readline/functions/readline-callback-handler-install.xml:1.1
phpdoc/en/reference/readline/functions/readline-callback-handler-install.xml:1.2
---
phpdoc/en/reference/readline/functions/readline-callback-handler-install.xml:1.1
Wed Aug 25 04:38:38 2004
+++
phpdoc/en/reference/readline/functions/readline-callback-handler-install.xml
Sun Feb 4 02:47:03 2007
@@ -1,43 +1,70 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
- <refentry id="function.readline-callback-handler-install">
- <refnamediv>
- <refname>readline_callback_handler_install</refname>
- <refpurpose>Initializes the readline callback interface and terminal,
prints the prompt and returns immediately</refpurpose>
- </refnamediv>
- <refsect1>
- &reftitle.description;
- <methodsynopsis>
-
<type>bool</type><methodname>readline_callback_handler_install</methodname>
-
<methodparam><type>string</type><parameter>prompt</parameter></methodparam>
-
<methodparam><type>callback</type><parameter>callback</parameter></methodparam>
- </methodsynopsis>
- <para>
- Sets up a readline callback interface then prints
- <parameter>prompt</parameter> and immediately returns. The
- <parameter>callback</parameter> function takes one parameter; the user
- input returned. Calling this function twice without removing the previous
- callback interface will automatically and conveniently overwrite the old
- interface.
- </para>
- <para>
- The callback feature is useful when combined with
- <function>stream_select</function> as it allows interleaving of IO and
- user input, unlike <function>readline</function>.
- </para>
- </refsect1>
- <refsect1>
- &reftitle.returnvalues;
- <para>
- &return.success;
- </para>
- </refsect1>
- <refsect1>
- &reftitle.examples;
- <para>
- <example>
- <title>Readline Callback Interface Example</title>
- <programlisting role="php">
+<!-- $Revision: 1.2 $ -->
+<refentry id="function.readline-callback-handler-install">
+ <refnamediv>
+ <refname>readline_callback_handler_install</refname>
+ <refpurpose>Initializes the readline callback interface and terminal, prints
the prompt and returns immediately</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>readline_callback_handler_install</methodname>
+ <methodparam><type>string</type><parameter>prompt</parameter></methodparam>
+
<methodparam><type>callback</type><parameter>callback</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Sets up a readline callback interface then prints
+ <parameter>prompt</parameter> and immediately returns.
+ Calling this function twice without removing the previous
+ callback interface will automatically and conveniently overwrite the old
+ interface.
+ </para>
+ <para>
+ The callback feature is useful when combined with
+ <function>stream_select</function> as it allows interleaving of IO and
+ user input, unlike <function>readline</function>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>prompt</parameter></term>
+ <listitem>
+ <para>
+ The prompt message.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>callback</parameter></term>
+ <listitem>
+ <para>
+ The <parameter>callback</parameter> function takes one parameter; the
+ user input returned.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+ <refsect1 role="description">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>Readline Callback Interface Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
function rl_callback($ret)
@@ -71,19 +98,23 @@
echo "Prompting disabled. All done.\n";
?>
]]>
- </programlisting>
- </example>
- </para>
- </refsect1>
- <refsect1>
- &reftitle.seealso;
- <para>
- <function>readline_callback_handler_remove</function>,
- <function>readline_callback_read_char</function>&listendand;
- <function>stream_select</function>.
- </para>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>readline_callback_handler_remove</function></member>
+ <member><function>readline_callback_read_char</function></member>
+ <member><function>stream_select</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-callback-handler-remove.xml?r1=1.1&r2=1.2&diff_format=u
Index:
phpdoc/en/reference/readline/functions/readline-callback-handler-remove.xml
diff -u
phpdoc/en/reference/readline/functions/readline-callback-handler-remove.xml:1.1
phpdoc/en/reference/readline/functions/readline-callback-handler-remove.xml:1.2
---
phpdoc/en/reference/readline/functions/readline-callback-handler-remove.xml:1.1
Wed Aug 25 04:38:38 2004
+++ phpdoc/en/reference/readline/functions/readline-callback-handler-remove.xml
Sun Feb 4 02:47:03 2007
@@ -1,43 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
- <refentry id="function.readline-callback-handler-remove">
- <refnamediv>
- <refname>readline_callback_handler_remove</refname>
- <refpurpose>Removes a previously installed callback handler and restores
terminal settings</refpurpose>
- </refnamediv>
- <refsect1>
- &reftitle.description;
- <methodsynopsis>
-
<type>bool</type><methodname>readline_callback_handler_remove</methodname>
- <void/>
- </methodsynopsis>
- <para>
- Removes a previously installed callback handler and restores terminal
- settings.
- </para>
- </refsect1>
- <refsect1>
- &reftitle.examples;
- <para>
- See <function>readline_callback_handler_install</function> for an example
- of how to use the readline callback interface.
- </para>
- </refsect1>
- <refsect1>
- &reftitle.returnvalues;
- <para>
- Returns &true; if a previously installed callback handler was removed, or
- &false; if one could not be found.
- </para>
- </refsect1>
- <refsect1>
- &reftitle.seealso;
- <para>
- <function>readline_callback_handler_install</function>, and
- <function>readline_callback_read_char</function>.
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.2 $ -->
+<refentry id="function.readline-callback-handler-remove">
+ <refnamediv>
+ <refname>readline_callback_handler_remove</refname>
+ <refpurpose>Removes a previously installed callback handler and restores
terminal settings</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>readline_callback_handler_remove</methodname>
+ <void/>
+ </methodsynopsis>
+ <para>
+ Removes a previously installed callback handler and restores terminal
+ settings.
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &true; if a previously installed callback handler was removed, or
+ &false; if one could not be found.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ See <function>readline_callback_handler_install</function> for an example
+ of how to use the readline callback interface.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>readline_callback_handler_install</function></member>
+ <member><function>readline_callback_read_char</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-callback-read-char.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/readline/functions/readline-callback-read-char.xml
diff -u
phpdoc/en/reference/readline/functions/readline-callback-read-char.xml:1.1
phpdoc/en/reference/readline/functions/readline-callback-read-char.xml:1.2
--- phpdoc/en/reference/readline/functions/readline-callback-read-char.xml:1.1
Wed Aug 25 04:38:38 2004
+++ phpdoc/en/reference/readline/functions/readline-callback-read-char.xml
Sun Feb 4 02:47:03 2007
@@ -1,38 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
- <refentry id="function.readline-callback-read-char">
- <refnamediv>
- <refname>readline_callback_read_char</refname>
- <refpurpose>Reads a character and informs the readline callback interface
when a line is received</refpurpose>
- </refnamediv>
- <refsect1>
- &reftitle.description;
- <methodsynopsis>
- <type>void</type><methodname>readline_callback_read_char</methodname>
- <void />
- </methodsynopsis>
- <para>
- Reads a character of user input. When a line is received, this function
- informs the readline callback interface installed using
- <function>readline_callback_handler_install</function> that a line
- is ready for input.
- </para>
- </refsect1>
- <refsect1>
- &reftitle.examples;
- <para>
- See <function>readline_callback_handler_install</function> for an example
- of how to use the readline callback interface.
- </para>
- </refsect1>
- <refsect1>
- &reftitle.seealso;
- <para>
- <function>readline_callback_handler_install</function>, and
- <function>readline_callback_handler_remove</function>.
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.2 $ -->
+<refentry id="function.readline-callback-read-char">
+ <refnamediv>
+ <refname>readline_callback_read_char</refname>
+ <refpurpose>Reads a character and informs the readline callback interface
when a line is received</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>readline_callback_read_char</methodname>
+ <void />
+ </methodsynopsis>
+ <para>
+ Reads a character of user input. When a line is received, this function
+ informs the readline callback interface installed using
+ <function>readline_callback_handler_install</function> that a line
+ is ready for input.
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ See <function>readline_callback_handler_install</function> for an example
+ of how to use the readline callback interface.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>readline_callback_handler_install</function></member>
+ <member><function>readline_callback_handler_remove</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-clear-history.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/readline/functions/readline-clear-history.xml
diff -u phpdoc/en/reference/readline/functions/readline-clear-history.xml:1.2
phpdoc/en/reference/readline/functions/readline-clear-history.xml:1.3
--- phpdoc/en/reference/readline/functions/readline-clear-history.xml:1.2
Wed Apr 17 06:43:43 2002
+++ phpdoc/en/reference/readline/functions/readline-clear-history.xml Sun Feb
4 02:47:03 2007
@@ -1,22 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
-<!-- splitted from ./en/functions/readline.xml, last change in rev 1.1 -->
- <refentry id="function.readline-clear-history">
- <refnamediv>
- <refname>readline_clear_history</refname>
- <refpurpose>Clears the history</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>bool</type><methodname>readline_clear_history</methodname>
- <void/>
- </methodsynopsis>
- <para>
- This function clears the entire command line history.
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.3 $ -->
+<refentry id="function.readline-clear-history">
+ <refnamediv>
+ <refname>readline_clear_history</refname>
+ <refpurpose>Clears the history</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>readline_clear_history</methodname>
+ <void/>
+ </methodsynopsis>
+ <para>
+ This function clears the entire command line history.
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-completion-function.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/readline/functions/readline-completion-function.xml
diff -u
phpdoc/en/reference/readline/functions/readline-completion-function.xml:1.5
phpdoc/en/reference/readline/functions/readline-completion-function.xml:1.6
--- phpdoc/en/reference/readline/functions/readline-completion-function.xml:1.5
Thu Nov 11 14:54:24 2004
+++ phpdoc/en/reference/readline/functions/readline-completion-function.xml
Sun Feb 4 02:47:03 2007
@@ -1,26 +1,47 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/readline.xml, last change in rev 1.1 -->
- <refentry id="function.readline-completion-function">
- <refnamediv>
- <refname>readline_completion_function</refname>
- <refpurpose>Registers a completion function</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>bool</type><methodname>readline_completion_function</methodname>
-
<methodparam><type>callback</type><parameter>function</parameter></methodparam>
- </methodsynopsis>
- <para>
- This function registers a completion function. You must supply
- the name of an existing function which accepts a partial command
- line and returns an array of possible matches. This is the same
- kind of functionality you'd get if you hit your tab key while
- using Bash.
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.readline-completion-function">
+ <refnamediv>
+ <refname>readline_completion_function</refname>
+ <refpurpose>Registers a completion function</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>readline_completion_function</methodname>
+
<methodparam><type>callback</type><parameter>function</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ This function registers a completion function. This is the same kind of
+ functionality you'd get if you hit your tab key while using Bash.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>function</parameter></term>
+ <listitem>
+ <para>
+ You must supply the name of an existing function which accepts a
+ partial command line and returns an array of possible matches.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-info.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/readline/functions/readline-info.xml
diff -u phpdoc/en/reference/readline/functions/readline-info.xml:1.2
phpdoc/en/reference/readline/functions/readline-info.xml:1.3
--- phpdoc/en/reference/readline/functions/readline-info.xml:1.2 Wed Apr
17 06:43:43 2002
+++ phpdoc/en/reference/readline/functions/readline-info.xml Sun Feb 4
02:47:03 2007
@@ -1,32 +1,62 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
-<!-- splitted from ./en/functions/readline.xml, last change in rev 1.1 -->
- <refentry id="function.readline-info">
- <refnamediv>
- <refname>readline_info</refname>
- <refpurpose>Gets/sets various internal readline variables</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>mixed</type><methodname>readline_info</methodname>
- <methodparam
choice="opt"><type>string</type><parameter>varname</parameter></methodparam>
- <methodparam
choice="opt"><type>string</type><parameter>newvalue</parameter></methodparam>
- </methodsynopsis>
- <para>
- If called with no parameters, this function returns an array of
- values for all the setting readline uses. The elements will
- be indexed by the following values: done, end, erase_empty_line,
- library_version, line_buffer, mark, pending_input, point, prompt,
- readline_name, and terminal_name.
- </para>
- <para>
- If called with one parameter, the value of that setting is
- returned. If called with two parameters, the setting will be
- changed to the given value.
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.3 $ -->
+<refentry id="function.readline-info">
+ <refnamediv>
+ <refname>readline_info</refname>
+ <refpurpose>Gets/sets various internal readline variables</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>mixed</type><methodname>readline_info</methodname>
+ <methodparam
choice="opt"><type>string</type><parameter>varname</parameter></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>newvalue</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Gets or sets various internal readline variables.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>varname</parameter></term>
+ <listitem>
+ <para>
+ A variable name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>newvalue</parameter></term>
+ <listitem>
+ <para>
+ If provided, this will be the new value of the setting.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ If called with no parameters, this function returns an array of
+ values for all the setting readline uses. The elements will
+ be indexed by the following values: done, end, erase_empty_line,
+ library_version, line_buffer, mark, pending_input, point, prompt,
+ readline_name, and terminal_name.
+ </para>
+ <para>
+ If called with one or two parameters, the old value is returned.
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-list-history.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/readline/functions/readline-list-history.xml
diff -u phpdoc/en/reference/readline/functions/readline-list-history.xml:1.2
phpdoc/en/reference/readline/functions/readline-list-history.xml:1.3
--- phpdoc/en/reference/readline/functions/readline-list-history.xml:1.2
Wed Apr 17 06:43:43 2002
+++ phpdoc/en/reference/readline/functions/readline-list-history.xml Sun Feb
4 02:47:03 2007
@@ -1,23 +1,31 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
-<!-- splitted from ./en/functions/readline.xml, last change in rev 1.1 -->
- <refentry id="function.readline-list-history">
- <refnamediv>
- <refname>readline_list_history</refname>
- <refpurpose>Lists the history</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>array</type><methodname>readline_list_history</methodname>
- <void/>
- </methodsynopsis>
- <para>
- This function returns an array of the entire command line
- history. The elements are indexed by integers starting at zero.
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.3 $ -->
+<refentry id="function.readline-list-history">
+ <refnamediv>
+ <refname>readline_list_history</refname>
+ <refpurpose>Lists the history</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>array</type><methodname>readline_list_history</methodname>
+ <void/>
+ </methodsynopsis>
+ <para>
+ Gets the entire command line history.
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns an array of the entire command line history. The elements are
+ indexed by integers starting at zero.
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-on-new-line.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/readline/functions/readline-on-new-line.xml
diff -u phpdoc/en/reference/readline/functions/readline-on-new-line.xml:1.1
phpdoc/en/reference/readline/functions/readline-on-new-line.xml:1.2
--- phpdoc/en/reference/readline/functions/readline-on-new-line.xml:1.1 Fri Sep
17 12:46:42 2004
+++ phpdoc/en/reference/readline/functions/readline-on-new-line.xml Sun Feb
4 02:47:03 2007
@@ -1,23 +1,30 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.1 $ -->
- <refentry id="function.readline-on-new-line">
- <refnamediv>
- <refname>readline_on_new_line</refname>
- <refpurpose>
- Inform readline that the cursor has moved to a new line
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>void</type><methodname>readline_on_new_line</methodname>
- <void/>
- </methodsynopsis>
+<!-- $Revision: 1.2 $ -->
+<refentry id="function.readline-on-new-line">
+ <refnamediv>
+ <refname>readline_on_new_line</refname>
+ <refpurpose>Inform readline that the cursor has moved to a new
line</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>readline_on_new_line</methodname>
+ <void/>
+ </methodsynopsis>
+ <para>
+ Tells readline that the cursor has moved to a new line.
+ </para>
+ </refsect1>
- &warn.undocumented.func;
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
- </refsect1>
- </refentry>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-read-history.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/readline/functions/readline-read-history.xml
diff -u phpdoc/en/reference/readline/functions/readline-read-history.xml:1.3
phpdoc/en/reference/readline/functions/readline-read-history.xml:1.4
--- phpdoc/en/reference/readline/functions/readline-read-history.xml:1.3
Wed Aug 18 14:15:20 2004
+++ phpdoc/en/reference/readline/functions/readline-read-history.xml Sun Feb
4 02:47:03 2007
@@ -1,22 +1,46 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/readline.xml, last change in rev 1.1 -->
- <refentry id="function.readline-read-history">
- <refnamediv>
- <refname>readline_read_history</refname>
- <refpurpose>Reads the history</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>bool</type><methodname>readline_read_history</methodname>
- <methodparam
choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
- </methodsynopsis>
- <para>
- This function reads a command history from a file.
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.readline-read-history">
+ <refnamediv>
+ <refname>readline_read_history</refname>
+ <refpurpose>Reads the history</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>readline_read_history</methodname>
+ <methodparam
choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ This function reads a command history from a file.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ Path to the filename containing the command history.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-redisplay.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/readline/functions/readline-redisplay.xml
diff -u phpdoc/en/reference/readline/functions/readline-redisplay.xml:1.1
phpdoc/en/reference/readline/functions/readline-redisplay.xml:1.2
--- phpdoc/en/reference/readline/functions/readline-redisplay.xml:1.1 Fri Sep
17 12:46:42 2004
+++ phpdoc/en/reference/readline/functions/readline-redisplay.xml Sun Feb
4 02:47:03 2007
@@ -1,23 +1,29 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.1 $ -->
- <refentry id="function.readline-redisplay">
- <refnamediv>
- <refname>readline_redisplay</refname>
- <refpurpose>
- Ask readline to redraw the display
- </refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>void</type><methodname>readline_redisplay</methodname>
- <void/>
- </methodsynopsis>
+<!-- $Revision: 1.2 $ -->
+<refentry id="function.readline-redisplay">
+ <refnamediv>
+ <refname>readline_redisplay</refname>
+ <refpurpose>Redraws the display</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>void</type><methodname>readline_redisplay</methodname>
+ <void/>
+ </methodsynopsis>
+ <para>
+ Redraws readline to redraw the display.
+ </para>
+ </refsect1>
- &warn.undocumented.func;
-
- </refsect1>
- </refentry>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.void;
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline-write-history.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/readline/functions/readline-write-history.xml
diff -u phpdoc/en/reference/readline/functions/readline-write-history.xml:1.3
phpdoc/en/reference/readline/functions/readline-write-history.xml:1.4
--- phpdoc/en/reference/readline/functions/readline-write-history.xml:1.3
Wed Aug 18 14:15:20 2004
+++ phpdoc/en/reference/readline/functions/readline-write-history.xml Sun Feb
4 02:47:03 2007
@@ -1,22 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/readline.xml, last change in rev 1.1 -->
- <refentry id="function.readline-write-history">
- <refnamediv>
- <refname>readline_write_history</refname>
- <refpurpose>Writes the history</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>bool</type><methodname>readline_write_history</methodname>
- <methodparam
choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
- </methodsynopsis>
- <para>
- This function writes the command history to a file.
- </para>
- </refsect1>
- </refentry>
+<!-- $Revision: 1.4 $ -->
+<refentry id="function.readline-write-history">
+ <refnamediv>
+ <refname>readline_write_history</refname>
+ <refpurpose>Writes the history</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>bool</type><methodname>readline_write_history</methodname>
+ <methodparam
choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ This function writes the command history to a file.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ Path to the saved file.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &return.success;
+ </para>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/readline/functions/readline.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/readline/functions/readline.xml
diff -u phpdoc/en/reference/readline/functions/readline.xml:1.5
phpdoc/en/reference/readline/functions/readline.xml:1.6
--- phpdoc/en/reference/readline/functions/readline.xml:1.5 Thu Nov 11
14:54:25 2004
+++ phpdoc/en/reference/readline/functions/readline.xml Sun Feb 4 02:47:03 2007
@@ -1,27 +1,53 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/readline.xml, last change in rev 1.1 -->
- <refentry id="function.readline">
- <refnamediv>
- <refname>readline</refname>
- <refpurpose>Reads a line</refpurpose>
- </refnamediv>
- <refsect1>
- <title>Description</title>
- <methodsynopsis>
- <type>string</type><methodname>readline</methodname>
-
<methodparam><type>string</type><parameter>prompt</parameter></methodparam>
- </methodsynopsis>
- <para>
- This function returns a single string from the user. You may
- specify a string with which to prompt the user. The line
- returned has the ending newline removed. You must add this line
- to the history yourself using
- <function>readline_add_history</function>.
- </para>
- <example>
- <title><function>readline</function></title>
- <programlisting role="php">
+<!-- $Revision: 1.6 $ -->
+<refentry id="function.readline">
+ <refnamediv>
+ <refname>readline</refname>
+ <refpurpose>Reads a line</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <type>string</type><methodname>readline</methodname>
+ <methodparam
choice="opt"><type>string</type><parameter>prompt</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Reads a single line from the user. You must add this line to the history
+ yourself using <function>readline_add_history</function>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>prompt</parameter></term>
+ <listitem>
+ <para>
+ You may specify a string with which to prompt the user.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a single string from the user. The line returned has the ending
+ newline removed.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>readline</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
//get 3 commands from user
@@ -37,10 +63,12 @@
print_r(readline_info());
?>
]]>
- </programlisting>
- </example>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
