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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- Purpose: utilspec.cmdline -->
<!-- Membership: bundled, external -->

 <reference xml:id="ref.readline" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <title>GNU Readline</title>
  <titleabbrev>Readline</titleabbrev>

  <partintro>
   <section xml:id="readline.intro">
    &reftitle.intro;
    <para>
     The readline 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 used from a
     <link linkend="features.commandline">command line</link>.
    </para>
    &note.no-windows.extension;
   </section>

   <section xml:id="readline.requirements">
    &reftitle.required;
    <para>
     To use the readline functions, you need to install libreadline. You can
     find libreadline on the home page of the GNU Readline project, at
     <link xlink:href="&url.readline;">&url.readline;</link>.
     It's maintained by Chet Ramey, who's also the author of Bash.
    </para>
    <para>
     You can also use these functions with the libedit library, a non-GPL
     replacement for the readline library. The libedit library is BSD
     licensed and available for download from
     <link xlink:href="&url.libedit;">&url.libedit;</link>.
    </para>
   </section>

   &reference.readline.configure;

   <section xml:id="readline.configuration">
    &reftitle.runtime;
     &no.config;
   </section>
   
   <section xml:id="readline.resources">
    &reftitle.resources;
     &no.resource;
   </section>

   <section xml:id="readline.constants">
    &reftitle.constants;
     &no.constants;
   </section>
  </partintro>

&reference.readline.entities.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
-->