summaryrefslogtreecommitdiff
path: root/ext/readline/README.md
blob: 5dec48e665d9a44f4bb277c2d923fde6114dfc39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
readline
========

Provides generic line editing, history, and tokenization functions.
See https://www.php.net/manual/en/book.readline.php

Implementation Details
----------------------

C variables starting with `rl_*` are declared by the readline library
(or are macros referring to variables from the libedit library).
See http://web.mit.edu/gnu/doc/html/rlman_2.html

This should only be used in the CLI SAPI.
Historically, the code lived in sapi/cli,
but many distributions build readline as a shared extension.
Therefore, that code was split into ext/readline so that this can dynamically
be loaded. With other SAPIs, readline is/should be disabled.

`readline_cli.c` implements most of the interactive shell(`php -a`).