php-doc-en/reference/readline/reference.xml

78 lines
2.2 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<reference id="ref.readline">
<title>GNU Readline</title>
<titleabbrev>Readline</titleabbrev>
<partintro>
<simpara>
The <function>readline</function> functions implement an interface
to the GNU Readline library. These are functions that provide
editable command lines. An example being the way Bash allows you
to use the arrow keys to insert characters or scroll through
command history. Because of the interactive nature of this
library, it will be of little use for writing Web applications,
but may be useful when writing scripts meant to be run from a
shell.
</simpara>
<section id="readline.requirements">
<title>Requirements</title>
<para>
To use the readline functions, you need to install libreadline and
compile PHP with support for readline.
</para>
</section>
<section id="readline.installation">
<title>Installation</title>
<para>
To compile PHP with readline support, you need to configure PHP
<option role="configure">--with-readline</option> after you've installed
libreadline. You can find libreadline on the home page of the GNU
Readline project, at <ulink url="&url.readline;">&url.readline;</ulink>.
It's maintained by Chet Ramey, who's also the author of Bash.
</para>
</section>
<section id="readline.configuration">
<title>Runtime Configuration</title>
&no.config;
</section>
<section id="readline.resources">
<title>Resource types</title>
&no.resource;
</section>
<section id="readline.constants">
<title>Predefined constants</title>
&no.constants;
</section>
</partintro>
&reference.readline.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
-->