php-doc-en/reference/readline/functions/readline-info.xml
Mehdi Achour a6d3c34b28 WS, prepare for new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228932 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-04 02:47:39 +00:00

80 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $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:
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
-->