1 This document details the changes between this version, readline-5.2,
2 and the previous version, readline-5.1.
6 a. Fixed a problem that caused segmentation faults when using readline in
7 callback mode and typing consecutive DEL characters on an empty line.
9 b. Fixed several redisplay problems with multibyte characters, all having to
10 do with the different code paths and variable meanings between single-byte
11 and multibyte character redisplay.
13 c. Fixed a problem with key sequence translation when presented with the
16 d. Fixed a problem that prevented the `a' command in vi mode from being
17 undone and redone properly.
19 e. Fixed a problem that prevented empty inserts in vi mode from being undone
22 f. Fixed a problem that caused readline to initialize with an incorrect idea
23 of whether or not the terminal can autowrap.
25 g. Fixed output of key bindings (like bash `bind -p') to honor the setting of
26 convert-meta and use \e where appropriate.
28 h. Changed the default filename completion function to call the filename
29 dequoting function if the directory completion hook isn't set. This means
30 that any directory completion hooks need to dequote the directory name,
31 since application-specific hooks need to know how the word was quoted,
32 even if no other changes are made.
34 i. Fixed a bug with creating the prompt for a non-interactive search string
35 when there are non-printing characters in the primary prompt.
37 j. Fixed a bug that caused prompts with invisible characters to be redrawn
38 multiple times in a multibyte locale.
40 k. Fixed a bug that could cause the key sequence scanning code to return the
43 l. Fixed a problem with the callback interface that caused it to fail when
44 using multi-character keyboard macros.
46 m. Fixed a bug that could cause a core dump when an edited history entry was
47 re-executed under certain conditions.
49 n. Fixed a bug that caused readline to reference freed memory when attmpting
50 to display a portion of the prompt.
52 o. Fixed a bug with prompt redisplay in a multi-byte locale to avoid redrawing
53 the prompt and input line multiple times.
55 p. Fixed history expansion to not be confused by here-string redirection.
57 q. Readline no longer treats read errors by converting them to newlines, as
58 it does with EOF. This caused partial lines to be returned from readline().
60 r. Fixed a redisplay bug that occurred in multibyte-capable locales when the
61 prompt was one character longer than the screen width.
63 2. New Features in Readline
65 a. Calling applications can now set the keyboard timeout to 0, allowing
68 b. The value of SYS_INPUTRC (configurable at compilation time) is now used as
69 the default last-ditch startup file.
71 c. The history file reading functions now allow windows-like \r\n line
74 -------------------------------------------------------------------------------
75 This document details the changes between this version, readline-5.1,
76 and the previous version, readline-5.0.
78 1. Changes to Readline
80 a. Fixed a bug that caused multiliine prompts to be wrapped and displayed
83 b. Fixed a bug that caused ^P/^N in emacs mode to fail to display the current
86 c. Fixed a problem in computing the number of invisible characters on the first
87 line of a prompt whose length exceeds the screen width.
89 d. Fixed vi-mode searching so that failure preserves the current line rather
90 than the last line in the history list.
92 e. Fixed the vi-mode `~' command (change-case) to have the correct behavior at
93 end-of-line when manipulating multibyte characters.
95 f. Fixed the vi-mode `r' command (change-char) to have the correct behavior at
96 end-of-line when manipulating multibyte characters.
98 g. Fixed multiple bugs in the redisplay of multibyte characters: displaying
99 prompts longer than the screen width containing multibyte characters,
101 h. Fix the calculation of the number of physical characters in the prompt
102 string when it contains multibyte characters.
104 i. A non-zero value for the `rl_complete_suppress_append' variable now causes
105 no `/' to be appended to a directory name.
107 j. Fixed forward-word and backward-word to work when words contained
108 multibyte characters.
110 k. Fixed a bug in finding the delimiter of a `?' substring when performing
111 history expansion in a locale that supports multibyte characters.
113 l. Fixed a memory leak caused by not freeing the timestamp in a history entry.
115 m. Fixed a bug that caused "\M-x" style key bindings to not obey the setting
116 of the `convert-meta' variable.
118 n. Fixed saving and restoring primary prompt when prompting for incremental
119 and non-incremental searches; search prompts now display multibyte
120 characters correctly.
122 o. Fixed a bug that caused keys originally bound to self-insert but shadowed
123 by a multi-character key sequence to not be inserted.
125 p. Fixed code so rl_prep_term_function and rl_deprep_term_function aren't
126 dereferenced if NULL (matching the documentation).
128 q. Extensive changes to readline to add enough state so that commands
129 requiring additional characters (searches, multi-key sequences, numeric
130 arguments, commands requiring an additional specifier character like
131 vi-mode change-char, etc.) work without synchronously waiting for
134 r. Lots of changes so readline builds and runs on MinGW.
136 s. Readline no longer tries to modify the terminal settings when running in
139 t. The Readline display code no longer sets the location of the last invisible
140 character in the prompt if the \[\] sequence is empty.
142 u. The `change-case' command now correctly changes the case of multibyte
145 v. Changes to the shared library construction scripts to deal with Windows
146 DLL naming conventions for Cygwin.
148 w. Fixed the redisplay code to avoid core dumps resulting from a poorly-timed
151 x. Fixed the non-incremental search code in vi mode to dispose of any current
152 undo list when copying a line from the history into the current editing
155 y. Fixed a bug that caused reversing the incremental search direction to
158 z. Fixed the vi-mode `U' command to only undo up to the first time insert mode
159 was entered, as Posix specifies.
161 aa. Fixed a bug in the vi-mode `r' command that left the cursor in the wrong
164 bb. Fixed a redisplay bug caused by moving the cursor vertically to a line
165 with invisible characters in the prompt in a multibyte locale.
167 cc. Fixed a bug that could cause the terminal special chars to be bound in the
168 wrong keymap in vi mode.
170 2. New Features in Readline
172 a. The key sequence sent by the keypad `delete' key is now automatically
173 bound to delete-char.
175 b. A negative argument to menu-complete now cycles backward through the
178 c. A new bindable readline variable: bind-tty-special-chars. If non-zero,
179 readline will bind the terminal special characters to their readline
180 equivalents when it's called (on by default).
182 d. New bindable command: vi-rubout. Saves deleted text for possible
183 reinsertion, as with any vi-mode `text modification' command; `X' is bound
184 to this in vi command mode.
186 e. If the rl_completion_query_items is set to a value < 0, readline never
187 asks the user whether or not to view the possible completions.
189 f. The `C-w' binding in incremental search now understands multibyte
192 g. New application-callable auxiliary function, rl_variable_value, returns
193 a string corresponding to a readline variable's value.
195 h. When parsing inputrc files and variable binding commands, the parser
196 strips trailing whitespace from values assigned to boolean variables
197 before checking them.
199 i. A new external application-controllable variable that allows the LINES
200 and COLUMNS environment variables to set the window size regardless of
201 what the kernel returns.
203 -------------------------------------------------------------------------------
204 This document details the changes between this version, readline-5.0,
205 and the previous version, readline-4.3.
207 1. Changes to Readline
209 a. Fixes to avoid core dumps because of null pointer references in the
210 multibyte character code.
212 b. Fix to avoid infinite recursion caused by certain key combinations.
214 c. Fixed a bug that caused the vi-mode `last command' to be set incorrectly.
216 d. Readline no longer tries to read ahead more than one line of input, even
217 when more is available.
219 e. Fixed the code that adjusts the point to not mishandle null wide
222 f. Fixed a bug in the history expansion `g' modifier that caused it to skip
225 g. Fixed a bug that caused the prompt to overwrite previous output when the
226 output doesn't contain a newline and the locale supports multibyte
227 characters. This same change fixes the problem of readline redisplay
228 slowing down dramatically as the line gets longer in multibyte locales.
230 h. History traversal with arrow keys in vi insertion mode causes the cursor
231 to be placed at the end of the new line, like in emacs mode.
233 i. The locale initialization code does a better job of using the right
234 precedence and defaulting when checking the appropriate environment
237 j. Fixed the history word tokenizer to handle <( and >( better when used as
240 k. The overwrite mode code received several bug fixes to improve undo.
242 l. Many speedups to the multibyte character redisplay code.
244 m. The callback character reading interface should not hang waiting to read
247 n. Fixed a bug with redoing vi-mode `s' command.
249 o. The code that initializes the terminal tracks changes made to the terminal
250 special characters with stty(1) (or equivalent), so that these changes
251 are reflected in the readline bindings. New application-callable function
252 to make it work: rl_tty_unset_default_bindings().
254 p. Fixed a bug that could cause garbage to be inserted in the buffer when
255 changing character case in vi mode when using a multibyte locale.
257 q. Fixed a bug in the redisplay code that caused problems on systems
258 supporting multibyte characters when moving between history lines when the
259 new line has more glyphs but fewer bytes.
261 r. Undo and redo now work better after exiting vi insertion mode.
263 s. Make sure system calls are restarted after a SIGWINCH is received using
266 t. Improvements to the code that displays possible completions when using
267 multibyte characters.
269 u. Fixed a problem when parsing nested if statements in inputrc files.
271 v. The completer now takes multibyte characters into account when looking for
272 quoted substrings on which to perform completion.
274 w. The history search functions now perform better bounds checking on the
277 x. Change to history expansion functions to treat `^' as equivalent to word
278 one, as the documention states.
280 y. Some changes to the display code to improve display and redisplay of
281 multibyte characters.
283 z. Changes to speed up the multibyte character redisplay code.
285 aa. Fixed a bug in the vi-mode `E' command that caused it to skip over the
286 last character of a word if invoked while point was on the word's
287 next-to-last character.
289 bb. Fixed a bug that could cause incorrect filename quoting when
290 case-insensitive completion was enabled and the word being completed
291 contained backslashes quoting word break characters.
293 cc. Fixed a bug in redisplay triggered when the prompt string contains
294 invisible characters.
296 dd. Fixed some display (and other) bugs encountered in multibyte locales
297 when a non-ascii character was the last character on a line.
299 ee. Fixed some display bugs caused by multibyte characters in prompt strings.
301 ff. Fixed a problem with history expansion caused by non-whitespace characters
302 used as history word delimiters.
304 gg. Fixed a problem that could cause readline to refer to freed memory when
305 moving between history lines while doing searches.
307 hh. Improvements to the code that expands and displays prompt strings
308 containing multibyte characters.
310 ii. Fixed a problem with vi-mode not correctly remembering the numeric argument
311 to the last `c'hange command for later use with `.'.
313 jj. Fixed a bug in vi-mode that caused multi-digit count arguments to work
316 kk. Fixed a problem in vi-mode that caused the last text modification command
317 to not be remembered across different command lines.
319 ll. Fixed problems with changing characters and changing case at the end of
322 mm. Fixed a problem with readline saving the contents of the current line
323 before beginning a non-interactive search.
325 nn. Fixed a problem with EOF detection when using rl_event_hook.
327 oo. Fixed a problem with the vi mode `p' and `P' commands ignoring numeric
330 2. New Features in Readline
332 a. History expansion has a new `a' modifier equivalent to the `g' modifier
333 for compatibility with the BSD csh.
335 b. History expansion has a new `G' modifier equivalent to the BSD csh `g'
336 modifier, which performs a substitution once per word.
338 c. All non-incremental search operations may now undo the operation of
339 replacing the current line with the history line.
341 d. The text inserted by an `a' command in vi mode can be reinserted with
344 e. New bindable variable, `show-all-if-unmodified'. If set, the readline
345 completer will list possible completions immediately if there is more
346 than one completion and partial completion cannot be performed.
348 f. There is a new application-callable `free_history_entry()' function.
350 g. History list entries now contain timestamp information; the history file
351 functions know how to read and write timestamp information associated
354 h. Four new key binding functions have been added:
356 rl_bind_key_if_unbound()
357 rl_bind_key_if_unbound_in_map()
358 rl_bind_keyseq_if_unbound()
359 rl_bind_keyseq_if_unbound_in_map()
361 i. New application variable, rl_completion_quote_character, set to any
362 quote character readline finds before it calls the application completion
365 j. New application variable, rl_completion_suppress_quote, settable by an
366 application completion function. If set to non-zero, readline does not
367 attempt to append a closing quote to a completed word.
369 k. New application variable, rl_completion_found_quote, set to a non-zero
370 value if readline determines that the word to be completed is quoted.
371 Set before readline calls any application completion function.
373 l. New function hook, rl_completion_word_break_hook, called when readline
374 needs to break a line into words when completion is attempted. Allows
375 the word break characters to vary based on position in the line.
377 m. New bindable command: unix-filename-rubout. Does the same thing as
378 unix-word-rubout, but adds `/' to the set of word delimiters.
380 n. When listing completions, directories have a `/' appended if the
381 `mark-directories' option has been enabled.
383 -------------------------------------------------------------------------------
384 This document details the changes between this version, readline-4.3,
385 and the previous version, readline-4.2a.
387 1. Changes to Readline
389 a. Fixed output of comment-begin character when listing variable values.
391 b. Added some default key bindings for common escape sequences produced by
394 c. Fixed the mark handling code to be more emacs-compatible.
396 d. A bug was fixed in the code that prints possible completions to keep it
397 from printing empty strings in certain circumstances.
399 e. Change the key sequence printing code to print ESC as M\- if ESC is a
400 meta-prefix character -- it's easier for users to understand than \e.
402 f. Fixed unstifle_history() to return values that match the documentation.
404 g. Fixed the event loop (rl_event_hook) to handle the case where the input
405 file descriptor is invalidated.
407 h. Fixed the prompt display code to work better when the application has a
408 custom redisplay function.
410 i. Changes to make reading and writing the history file a little faster, and
411 to cope with huge history files without calling abort(3) from xmalloc.
413 j. The vi-mode `S' and `s' commands are now undone correctly.
415 k. Fixed a problem which caused the display to be messed up when the last
416 line of a multi-line prompt (possibly containing invisible characters)
417 was longer than the screen width.
419 2. New Features in Readline
421 a. Support for key `subsequences': allows, e.g., ESC and ESC-a to both
422 be bound to readline functions. Now the arrow keys may be used in vi
425 b. When listing completions, and the number of lines displayed is more than
426 the screen length, readline uses an internal pager to display the results.
427 This is controlled by the `page-completions' variable (default on).
429 c. New code to handle editing and displaying multibyte characters.
431 d. The behavior introduced in bash-2.05a of deciding whether or not to
432 append a slash to a completed name that is a symlink to a directory has
433 been made optional, controlled by the `mark-symlinked-directories'
434 variable (default is the 2.05a behavior).
436 e. The `insert-comment' command now acts as a toggle if given a numeric
437 argument: if the first characters on the line don't specify a
438 comment, insert one; if they do, delete the comment text
440 f. New application-settable completion variable:
441 rl_completion_mark_symlink_dirs, allows an application's completion
442 function to temporarily override the user's preference for appending
443 slashes to names which are symlinks to directories.
445 g. New function available to application completion functions:
446 rl_completion_mode, to tell how the completion function was invoked
447 and decide which argument to supply to rl_complete_internal (to list
450 h. Readline now has an overwrite mode, toggled by the `overwrite-mode'
451 bindable command, which could be bound to `Insert'.
453 i. New application-settable completion variable:
454 rl_completion_suppress_append, inhibits appending of
455 rl_completion_append_character to completed words.
457 j. New key bindings when reading an incremental search string: ^W yanks
458 the currently-matched word out of the current line into the search
459 string; ^Y yanks the rest of the current line into the search string,
460 DEL or ^H deletes characters from the search string.
462 -------------------------------------------------------------------------------
463 This document details the changes between this version, readline-4.2a,
464 and the previous version, readline-4.2.
466 1. Changes to Readline
468 a. More `const' and type casting fixes.
470 b. Changed rl_message() to use vsnprintf(3) (if available) to fix buffer
473 c. The completion code no longer appends a `/' or ` ' to a match when
474 completing a symbolic link that resolves to a directory name, unless
475 the match does not add anything to the word being completed. This
476 means that a tab will complete the word up to the full name, but not
477 add anything, and a subsequent tab will add a slash.
479 d. Fixed a trivial typo that made the vi-mode `dT' command not work.
481 e. Fixed the tty code so that ^S and ^Q can be inserted with rl_quoted_insert.
483 f. Fixed the tty code so that ^V works more than once.
485 g. Changed the use of __P((...)) for function prototypes to PARAMS((...))
486 because the use of __P in typedefs conflicted g++ and glibc.
488 h. The completion code now attempts to do a better job of preserving the
489 case of the word the user typed if ignoring case in completions.
491 i. Readline defaults to not echoing the input and lets the terminal
492 initialization code enable echoing if there is a controlling terminal.
494 j. The key binding code now processes only two hex digits after a `\x'
495 escape sequence, and the documentation was changed to note that the
496 octal and hex escape sequences result in an eight-bit value rather
499 k. Fixed a few places where negative array subscripts could have occurred.
501 l. Fixed the vi-mode code to use a better method to determine the bounds of
502 the array used to hold the marks, and to avoid out-of-bounds references.
504 m. Fixed the defines in chardefs.h to work better when chars are signed.
506 n. Fixed configure.in to use the new names for bash autoconf macros.
508 o. Readline no longer attempts to define its own versions of some ctype
509 macros if they are implemented as functions in libc but not as macros in
512 p. Fixed a problem where rl_backward could possibly set point to before
513 the beginning of the line.
515 q. Fixed Makefile to not put -I/usr/include into CFLAGS, since it can cause
516 include file problems.
518 2. New Features in Readline
520 a. Added extern declaration for rl_get_termcap to readline.h, making it a
521 public function (it was always there, just not in readline.h).
523 b. New #defines in readline.h: RL_READLINE_VERSION, currently 0x0402,
524 RL_VERSION_MAJOR, currently 4, and RL_VERSION_MINOR, currently 2.
526 c. New readline variable: rl_readline_version, mirrors RL_READLINE_VERSION.
528 d. New bindable boolean readline variable: match-hidden-files. Controls
529 completion of files beginning with a `.' (on Unix). Enabled by default.
531 e. The history expansion code now allows any character to terminate a
532 `:first-' modifier, like csh.
534 f. The incremental search code remembers the last search string and uses
535 it if ^R^R is typed without a search string.
537 h. New bindable variable `history-preserve-point'. If set, the history
538 code attempts to place the user at the same location on each history
539 line retrived with previous-history or next-history.
541 -------------------------------------------------------------------------------
542 This document details the changes between this version, readline-4.2,
543 and the previous version, readline-4.1.
545 1. Changes to Readline
547 a. When setting the terminal attributes on systems using `struct termio',
548 readline waits for output to drain before changing the attributes.
550 b. A fix was made to the history word tokenization code to avoid attempts to
551 dereference a null pointer.
553 c. Readline now defaults rl_terminal_name to $TERM if the calling application
554 has left it unset, and tries to initialize with the resultant value.
556 d. Instead of calling (*rl_getc_function)() directly to get input in certain
557 places, readline now calls rl_read_key() consistently.
559 e. Fixed a bug in the completion code that allowed a backslash to quote a
560 single quote inside a single-quoted string.
562 f. rl_prompt is no longer assigned directly from the argument to readline(),
563 but uses memory allocated by readline. This allows constant strings to
564 be passed to readline without problems arising when the prompt processing
565 code wants to modify the string.
567 g. Fixed a bug that caused non-interactive history searches to return the
568 wrong line when performing multiple searches backward for the same string.
570 h. Many variables, function arguments, and function return values are now
571 declared `const' where appropriate, to improve behavior when linking with
574 i. The control character detection code now works better on systems where
575 `char' is unsigned by default.
577 j. The vi-mode numeric argument is now capped at 999999, just like emacs mode.
579 k. The Function, CPFunction, CPPFunction, and VFunction typedefs have been
580 replaced with a set of specific prototyped typedefs, though they are
581 still in the readline header files for backwards compatibility.
583 m. Nearly all of the (undocumented) internal global variables in the library
584 now have an _rl_ prefix -- there were a number that did not, like
585 screenheight, screenwidth, alphabetic, etc.
587 n. The ding() convenience function has been renamed to rl_ding(), though the
588 old function is still defined for backwards compatibility.
590 o. The completion convenience functions filename_completion_function,
591 username_completion_function, and completion_matches now have an rl_
592 prefix, though the old names are still defined for backwards compatibility.
594 p. The functions shared by readline and bash (linkage is satisfied from bash
595 when compiling with bash, and internally otherwise) now have an sh_ prefix.
597 q. Changed the shared library creation procedure on Linux and BSD/OS 4.x so
598 that the `soname' contains only the major version number rather than the
599 major and minor numbers.
601 r. Fixed a redisplay bug that occurred when the prompt spanned more than one
602 physical line and contained invisible characters.
604 s. Added a missing `includedir' variable to the Makefile.
606 t. When installing the shared libraries, make sure symbolic links are relative.
608 u. Added configure test so that it can set `${MAKE}' appropriately.
610 v. Fixed a bug in rl_forward that could cause the point to be set to before
611 the beginning of the line in vi mode.
613 w. Fixed a bug in the callback read-char interface to make it work when a
614 readline function pushes some input onto the input stream with
615 rl_execute_next (like the incremental search functions).
617 x. Fixed a file descriptor leak in the history file manipulation code that
618 was tripped when attempting to truncate a non-regular file (like
621 y. Changes to make all of the exported readline functions declared in
622 readline.h have an rl_ prefix (rltty_set_default_bindings is now
623 rl_tty_set_default_bindings, crlf is now rl_crlf, etc.)
625 z. The formatted documentation included in the base readline distribution
626 is no longer removed on a `make distclean'.
628 aa. Some changes were made to avoid gcc warnings with -Wall.
630 bb. rl_get_keymap_by_name now finds keymaps case-insensitively, so
631 `set keymap EMACS' works.
633 cc. The history file writing and truncation functions now return a useful
636 dd. Fixed a bug that could cause applications to dereference a NULL pointer
637 if a NULL second argument was passed to history_expand().
639 ee. If a hook function assigned to rl_event_hook sets rl_done to a non-zero
640 value, rl_read_key() now immediately returns '\n' (which is assumed to
641 be bound to accept-line).
643 2. New Features in Readline
645 a. The blink timeout for paren matching is now settable by applications,
646 via the rl_set_paren_blink_timeout() function.
648 b. _rl_executing_macro has been renamed to rl_executing_macro, which means
649 it's now part of the public interface.
651 c. Readline has a new variable, rl_readline_state, which is a bitmap that
652 encapsulates the current state of the library; intended for use by
653 callbacks and hook functions.
655 d. rlfe has a new -l option to log input and output (-a appends to logfile),
656 a new -n option to set the readline application name, and -v and -h
657 options for version and help information.
659 e. rlfe can now perform filename completion for the inferior process if the
660 OS has a /proc/<PID>/cwd that can be read with readlink(2) to get the
661 inferior's current working directory.
663 f. A new file, rltypedefs.h, contains the new typedefs for function pointers
664 and is installed by `make install'.
666 g. New application-callable function rl_set_prompt(const char *prompt):
667 expands its prompt string argument and sets rl_prompt to the result.
669 h. New application-callable function rl_set_screen_size(int rows, int cols):
670 public method for applications to set readline's idea of the screen
673 i. The history example program (examples/histexamp.c) is now built as one
676 j. The documentation has been updated to cover nearly all of the public
677 functions and variables declared in readline.h.
679 k. New function, rl_get_screen_size (int *rows, int *columns), returns
680 readline's idea of the screen dimensions.
682 l. The timeout in rl_gather_tyi (readline keyboard input polling function)
683 is now settable via a function (rl_set_keyboard_input_timeout()).
685 m. Renamed the max_input_history variable to history_max_entries; the old
686 variable is maintained for backwards compatibility.
688 n. The list of characters that separate words for the history tokenizer is
689 now settable with a variable: history_word_delimiters. The default
692 o. There is a new history.3 manual page documenting the history library.
694 -------------------------------------------------------------------------------
695 This document details the changes between this version, readline-4.1,
696 and the previous version, readline-4.0.
698 1. Changes to Readline
700 a. Changed the HTML documents so that the table-of-contents is no longer
703 b. Changes to the shared object configuration for: Irix 5.x, Irix 6.x,
706 c. The shared library major and minor versions are now constructed
707 automatically by configure and substituted into the makefiles.
709 d. It's now possible to install the shared libraries separately from the
712 e. The history library tries to truncate the history file only if it is a
715 f. A bug that caused _rl_dispatch to address negative array indices on
716 systems with signed chars was fixed.
718 g. rl-yank-nth-arg now leaves the history position the same as when it was
721 h. Changes to the completion code to handle MS-DOS drive-letter:pathname
724 i. Completion is now case-insensitive by default on MS-DOS.
726 j. Fixes to the history file manipulation code for MS-DOS.
728 k. Readline attempts to bind the arrow keys to appropriate defaults on MS-DOS.
730 l. Some fixes were made to the redisplay code for better operation on MS-DOS.
732 m. The quoted-insert code will now insert tty special chars like ^C.
734 n. A bug was fixed that caused the display code to reference memory before
735 the start of the prompt string.
737 o. More support for __EMX__ (OS/2).
739 p. A bug was fixed in readline's signal handling that could cause infinite
740 recursion in signal handlers.
742 q. A bug was fixed that caused the point to be less than zero when rl_forward
743 was given a very large numeric argument.
745 r. The vi-mode code now gets characters via the application-settable value
746 of rl_getc_function rather than calling rl_getc directly.
748 s. The history file code now uses O_BINARY mode when reading and writing
749 the history file on cygwin32.
751 t. Fixed a bug in the redisplay code for lines with more than 256 line
754 u. A bug was fixed which caused invisible character markers to not be
755 stripped from the prompt string if the terminal was in no-echo mode.
757 v. Readline no longer tries to get the variables it needs for redisplay
758 from the termcap entry if the calling application has specified its
759 own redisplay function. Readline treats the terminal as `dumb' in
762 w. Fixes to the SIGWINCH code so that a multiple-line prompt with escape
763 sequences is redrawn correctly.
765 x. Changes to the install and install-shared targets so that the libraries
766 and header files are installed separately.
768 2. New Features in Readline
770 a. A new Readline `user manual' is in doc/rluserman.texinfo.
772 b. Parentheses matching is now always compiled into readline, and enabled
773 or disabled when the value of the `blink-matching-paren' variable is
776 c. MS-DOS systems now use ~/_inputrc as the last-ditch inputrc filename.
778 d. MS-DOS systems now use ~/_history as the default history file.
780 e. history-search-{forward,backward} now leave the point at the end of the
781 line when the string to search for is empty, like
782 {reverse,forward}-search-history.
784 f. history-search-{forward,backward} now leave the last history line found
785 in the readline buffer if the second or subsequent search fails.
787 g. New function for use by applications: rl_on_new_line_with_prompt, used
788 when an application displays the prompt itself before calling readline().
790 h. New variable for use by applications: rl_already_prompted. An application
791 that displays the prompt itself before calling readline() must set this to
794 i. A new variable, rl_gnu_readline_p, always 1. The intent is that an
795 application can verify whether or not it is linked with the `real'
796 readline library or some substitute.
798 j. Per Bothner's `rlfe' (pronounced `Ralphie') readline front-end program
799 is included in the examples subdirectory, though it is not built
802 -------------------------------------------------------------------------------
803 This document details the changes between this version, readline-4.0,
804 and the previous version, readline-2.2.
806 1. Changes to Readline
808 a. The version number is now 4.0, to match the major and minor version
809 numbers on the shared readline and history libraries. Future
810 releases will maintain the identical numbering.
812 b. Fixed a typo in the `make install' recipe that copied libreadline.a
813 to libhistory.old right after installing it.
815 c. The readline and history info files are now installed out of the source
816 directory if they are not found in the build directory.
818 d. The library no longer exports a function named `savestring' -- backwards
819 compatibility be damned.
821 e. There is no longer any #ifdef SHELL code in the source files.
823 f. Some changes were made to the key binding code to fix memory leaks and
824 better support Win32 systems.
826 g. Fixed a silly typo in the paren matching code -- it's microseconds, not
829 h. The readline library should be compilable by C++ compilers.
831 i. The readline.h public header file now includes function prototypes for
832 all readline functions, and some changes were made to fix errors in the
833 source files uncovered by the use of prototypes.
835 j. The maximum numeric argument is now clamped at 1000000.
837 k. Fixes to rl_yank_last_arg to make it behave better.
839 l. Fixed a bug in the display code that caused core dumps if the prompt
840 string length exceeded 1024 characters.
842 m. The menu completion code was fixed to properly insert a single completion
843 if there is only one match.
845 n. A bug was fixed that caused the display code to improperly display tabs
848 o. A fix was made to the completion code in which a typo caused the wrong
849 value to be passed to the function that computed the longest common
850 prefix of the list of matches.
852 p. The completion code now checks the value of rl_filename_completion_desired,
853 which is set by application-supplied completion functions to indicate
854 that filename completion is being performed, to decide whether or not to
855 call an application-supplied `ignore completions' function.
857 q. Code was added to the history library to catch history substitutions
858 using `&' without a previous history substitution or search having been
862 2. New Features in Readline
864 a. There is a new script, support/shobj-conf, to do system-specific shared
865 object and library configuration. It generates variables for configure
866 to substitute into makefiles. The README file provides a detailed
867 explanation of the shared library creation process.
869 b. Shared libraries and objects are now built in the `shlib' subdirectory.
870 There is a shlib/Makefile.in to control the build process. `make shared'
871 from the top-level directory is still the right way to build shared
872 versions of the libraries.
874 c. rlconf.h is now installed, so applications can find out which features
875 have been compiled into the installed readline and history libraries.
877 d. rlstdc.h is now an installed header file.
879 e. Many changes to the signal handling:
880 o Readline now catches SIGQUIT and cleans up the tty before returning;
881 o A new variable, rl_catch_signals, is available to application writers
882 to indicate to readline whether or not it should install its own
883 signal handlers for SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP,
884 SIGTTIN, and SIGTTOU;
885 o A new variable, rl_catch_sigwinch, is available to application
886 writers to indicate to readline whether or not it should install its
887 own signal handler for SIGWINCH, which will chain to the calling
888 applications's SIGWINCH handler, if one is installed;
889 o There is a new function, rl_free_line_state, for application signal
890 handlers to call to free up the state associated with the current
891 line after receiving a signal;
892 o There is a new function, rl_cleanup_after_signal, to clean up the
893 display and terminal state after receiving a signal;
894 o There is a new function, rl_reset_after_signal, to reinitialize the
895 terminal and display state after an application signal handler
896 returns and readline continues
898 f. There is a new function, rl_resize_terminal, to reset readline's idea of
899 the screen size after a SIGWINCH.
901 g. New public functions: rl_save_prompt and rl_restore_prompt. These were
902 previously private functions with a `_' prefix. These functions are
903 used when an application wants to write a message to the `message area'
904 with rl_message and have the prompt restored correctly when the message
907 h. New function hook: rl_pre_input_hook, called just before readline starts
908 reading input, after initialization.
910 i. New function hook: rl_display_matches_hook, called when readline would
911 display the list of completion matches. The new function
912 rl_display_match_list is what readline uses internally, and is available
913 for use by application functions called via this hook.
915 j. New bindable function, delete-char-or-list, like tcsh.
917 k. A new variable, rl_erase_empty_line, which, if set by an application using
918 readline, will cause readline to erase, prompt and all, lines on which the
919 only thing typed was a newline.
921 l. There is a new script, support/shlib-install, to install and uninstall
922 the shared readline and history libraries.
924 m. A new bindable variable, `isearch-terminators', which is a string
925 containing the set of characters that should terminate an incremental
926 search without being executed as a command.
928 n. A new bindable function, forward-backward-delete-char.
930 -------------------------------------------------------------------------------
931 This document details the changes between this version, readline-2.2,
932 and the previous version, readline-2.1.
934 1. Changes to Readline
936 a. Added a missing `extern' to a declaration in readline.h that kept
937 readline from compiling cleanly on some systems.
939 b. The history file is now opened with mode 0600 when it is written for
942 c. Changes were made to the SIGWINCH handling code so that prompt redisplay
945 d. ^G now interrupts incremental searches correctly.
947 e. A bug that caused a core dump when the set of characters to be quoted
948 when completing words was empty was fixed.
950 f. Fixed a problem in the readline test program rltest.c that caused a core
953 g. The code that handles parser directives in inputrc files now displays
956 h. The history expansion code was fixed so that the appearance of the
957 history comment character at the beginning of a word inhibits history
958 expansion for that word and the rest of the input line.
960 i. The code that prints completion listings now behaves better if one or
961 more of the filenames contains non-printable characters.
963 j. The time delay when showing matching parentheses is now 0.5 seconds.
966 2. New Features in Readline
968 a. There is now an option for `iterative' yank-last-arg handline, so a user
969 can keep entering `M-.', yanking the last argument of successive history
972 b. New variable, `print-completions-horizontally', which causes completion
973 matches to be displayed across the screen (like `ls -x') rather than up
974 and down the screen (like `ls').
976 c. New variable, `completion-ignore-case', which causes filename completion
977 and matching to be performed case-insensitively.
979 d. There is a new bindable command, `magic-space', which causes history
980 expansion to be performed on the current readline buffer and a space to
981 be inserted into the result.
983 e. There is a new bindable command, `menu-complete', which enables tcsh-like
984 menu completion (successive executions of menu-complete insert a single
985 completion match, cycling through the list of possible completions).
987 f. There is a new bindable command, `paste-from-clipboard', for use on Win32
988 systems, to insert the text from the Win32 clipboard into the editing
991 g. The key sequence translation code now understands printf-style backslash
992 escape sequences, including \NNN octal escapes. These escape sequences
993 may be used in key sequence definitions or macro values.
995 h. An `$include' inputrc file parser directive has been added.