xref: /php-src/ext/readline/README.md (revision 97f10fc3)
1readline
2========
3
4Provides generic line editing, history, and tokenization functions.
5See https://www.php.net/manual/en/book.readline.php
6
7Implementation Details
8----------------------
9
10C variables starting with `rl_*` are declared by the readline library
11(or are macros referring to variables from the libedit library).
12See http://web.mit.edu/gnu/doc/html/rlman_2.html
13
14This should only be used in the CLI SAPI.
15Historically, the code lived in sapi/cli,
16but many distributions build readline as a shared extension.
17Therefore, that code was split into ext/readline so that this can dynamically
18be loaded. With other SAPIs, readline is/should be disabled.
19
20`readline_cli.c` implements most of the interactive shell(`php -a`).
21