1 This document details the changes between this version, readline-5.1,
2 and the previous version, readline-5.0.
6 a. Fixed a bug that caused multiliine prompts to be wrapped and displayed
9 b. Fixed a bug that caused ^P/^N in emacs mode to fail to display the current
12 c. Fixed a problem in computing the number of invisible characters on the first
13 line of a prompt whose length exceeds the screen width.
15 d. Fixed vi-mode searching so that failure preserves the current line rather
16 than the last line in the history list.
18 e. Fixed the vi-mode `~' command (change-case) to have the correct behavior at
19 end-of-line when manipulating multibyte characters.
21 f. Fixed the vi-mode `r' command (change-char) to have the correct behavior at
22 end-of-line when manipulating multibyte characters.
24 g. Fixed multiple bugs in the redisplay of multibyte characters: displaying
25 prompts longer than the screen width containing multibyte characters,
27 h. Fix the calculation of the number of physical characters in the prompt
28 string when it contains multibyte characters.
30 i. A non-zero value for the `rl_complete_suppress_append' variable now causes
31 no `/' to be appended to a directory name.
33 j. Fixed forward-word and backward-word to work when words contained
36 k. Fixed a bug in finding the delimiter of a `?' substring when performing
37 history expansion in a locale that supports multibyte characters.
39 l. Fixed a memory leak caused by not freeing the timestamp in a history entry.
41 m. Fixed a bug that caused "\M-x" style key bindings to not obey the setting
42 of the `convert-meta' variable.
44 n. Fixed saving and restoring primary prompt when prompting for incremental
45 and non-incremental searches; search prompts now display multibyte
48 o. Fixed a bug that caused keys originally bound to self-insert but shadowed
49 by a multi-character key sequence to not be inserted.
51 p. Fixed code so rl_prep_term_function and rl_deprep_term_function aren't
52 dereferenced if NULL (matching the documentation).
54 q. Extensive changes to readline to add enough state so that commands
55 requiring additional characters (searches, multi-key sequences, numeric
56 arguments, commands requiring an additional specifier character like
57 vi-mode change-char, etc.) work without synchronously waiting for
60 r. Lots of changes so readline builds and runs on MinGW.
62 s. Readline no longer tries to modify the terminal settings when running in
65 t. The Readline display code no longer sets the location of the last invisible
66 character in the prompt if the \[\] sequence is empty.
68 u. The `change-case' command now correctly changes the case of multibyte
71 v. Changes to the shared library construction scripts to deal with Windows
72 DLL naming conventions for Cygwin.
74 w. Fixed the redisplay code to avoid core dumps resulting from a poorly-timed
77 x. Fixed the non-incremental search code in vi mode to dispose of any current
78 undo list when copying a line from the history into the current editing
81 y. Fixed a bug that caused reversing the incremental search direction to
84 z. Fixed the vi-mode `U' command to only undo up to the first time insert mode
85 was entered, as Posix specifies.
87 aa. Fixed a bug in the vi-mode `r' command that left the cursor in the wrong
90 bb. Fixed a redisplay bug caused by moving the cursor vertically to a line
91 with invisible characters in the prompt in a multibyte locale.
93 cc. Fixed a bug that could cause the terminal special chars to be bound in the
94 wrong keymap in vi mode.
96 2. New Features in Readline
98 a. The key sequence sent by the keypad `delete' key is now automatically
101 b. A negative argument to menu-complete now cycles backward through the
104 c. A new bindable readline variable: bind-tty-special-chars. If non-zero,
105 readline will bind the terminal special characters to their readline
106 equivalents when it's called (on by default).
108 d. New bindable command: vi-rubout. Saves deleted text for possible
109 reinsertion, as with any vi-mode `text modification' command; `X' is bound
110 to this in vi command mode.
112 e. If the rl_completion_query_items is set to a value < 0, readline never
113 asks the user whether or not to view the possible completions.
115 f. The `C-w' binding in incremental search now understands multibyte
118 g. New application-callable auxiliary function, rl_variable_value, returns
119 a string corresponding to a readline variable's value.
121 h. When parsing inputrc files and variable binding commands, the parser
122 strips trailing whitespace from values assigned to boolean variables
123 before checking them.
125 i. A new external application-controllable variable that allows the LINES
126 and COLUMNS environment variables to set the window size regardless of
127 what the kernel returns.
129 -------------------------------------------------------------------------------
130 This document details the changes between this version, readline-5.0,
131 and the previous version, readline-4.3.
133 1. Changes to Readline
135 a. Fixes to avoid core dumps because of null pointer references in the
136 multibyte character code.
138 b. Fix to avoid infinite recursion caused by certain key combinations.
140 c. Fixed a bug that caused the vi-mode `last command' to be set incorrectly.
142 d. Readline no longer tries to read ahead more than one line of input, even
143 when more is available.
145 e. Fixed the code that adjusts the point to not mishandle null wide
148 f. Fixed a bug in the history expansion `g' modifier that caused it to skip
151 g. Fixed a bug that caused the prompt to overwrite previous output when the
152 output doesn't contain a newline and the locale supports multibyte
153 characters. This same change fixes the problem of readline redisplay
154 slowing down dramatically as the line gets longer in multibyte locales.
156 h. History traversal with arrow keys in vi insertion mode causes the cursor
157 to be placed at the end of the new line, like in emacs mode.
159 i. The locale initialization code does a better job of using the right
160 precedence and defaulting when checking the appropriate environment
163 j. Fixed the history word tokenizer to handle <( and >( better when used as
166 k. The overwrite mode code received several bug fixes to improve undo.
168 l. Many speedups to the multibyte character redisplay code.
170 m. The callback character reading interface should not hang waiting to read
173 n. Fixed a bug with redoing vi-mode `s' command.
175 o. The code that initializes the terminal tracks changes made to the terminal
176 special characters with stty(1) (or equivalent), so that these changes
177 are reflected in the readline bindings. New application-callable function
178 to make it work: rl_tty_unset_default_bindings().
180 p. Fixed a bug that could cause garbage to be inserted in the buffer when
181 changing character case in vi mode when using a multibyte locale.
183 q. Fixed a bug in the redisplay code that caused problems on systems
184 supporting multibyte characters when moving between history lines when the
185 new line has more glyphs but fewer bytes.
187 r. Undo and redo now work better after exiting vi insertion mode.
189 s. Make sure system calls are restarted after a SIGWINCH is received using
192 t. Improvements to the code that displays possible completions when using
193 multibyte characters.
195 u. Fixed a problem when parsing nested if statements in inputrc files.
197 v. The completer now takes multibyte characters into account when looking for
198 quoted substrings on which to perform completion.
200 w. The history search functions now perform better bounds checking on the
203 x. Change to history expansion functions to treat `^' as equivalent to word
204 one, as the documention states.
206 y. Some changes to the display code to improve display and redisplay of
207 multibyte characters.
209 z. Changes to speed up the multibyte character redisplay code.
211 aa. Fixed a bug in the vi-mode `E' command that caused it to skip over the
212 last character of a word if invoked while point was on the word's
213 next-to-last character.
215 bb. Fixed a bug that could cause incorrect filename quoting when
216 case-insensitive completion was enabled and the word being completed
217 contained backslashes quoting word break characters.
219 cc. Fixed a bug in redisplay triggered when the prompt string contains
220 invisible characters.
222 dd. Fixed some display (and other) bugs encountered in multibyte locales
223 when a non-ascii character was the last character on a line.
225 ee. Fixed some display bugs caused by multibyte characters in prompt strings.
227 ff. Fixed a problem with history expansion caused by non-whitespace characters
228 used as history word delimiters.
230 gg. Fixed a problem that could cause readline to refer to freed memory when
231 moving between history lines while doing searches.
233 hh. Improvements to the code that expands and displays prompt strings
234 containing multibyte characters.
236 ii. Fixed a problem with vi-mode not correctly remembering the numeric argument
237 to the last `c'hange command for later use with `.'.
239 jj. Fixed a bug in vi-mode that caused multi-digit count arguments to work
242 kk. Fixed a problem in vi-mode that caused the last text modification command
243 to not be remembered across different command lines.
245 ll. Fixed problems with changing characters and changing case at the end of
248 mm. Fixed a problem with readline saving the contents of the current line
249 before beginning a non-interactive search.
251 nn. Fixed a problem with EOF detection when using rl_event_hook.
253 oo. Fixed a problem with the vi mode `p' and `P' commands ignoring numeric
256 2. New Features in Readline
258 a. History expansion has a new `a' modifier equivalent to the `g' modifier
259 for compatibility with the BSD csh.
261 b. History expansion has a new `G' modifier equivalent to the BSD csh `g'
262 modifier, which performs a substitution once per word.
264 c. All non-incremental search operations may now undo the operation of
265 replacing the current line with the history line.
267 d. The text inserted by an `a' command in vi mode can be reinserted with
270 e. New bindable variable, `show-all-if-unmodified'. If set, the readline
271 completer will list possible completions immediately if there is more
272 than one completion and partial completion cannot be performed.
274 f. There is a new application-callable `free_history_entry()' function.
276 g. History list entries now contain timestamp information; the history file
277 functions know how to read and write timestamp information associated
280 h. Four new key binding functions have been added:
282 rl_bind_key_if_unbound()
283 rl_bind_key_if_unbound_in_map()
284 rl_bind_keyseq_if_unbound()
285 rl_bind_keyseq_if_unbound_in_map()
287 i. New application variable, rl_completion_quote_character, set to any
288 quote character readline finds before it calls the application completion
291 j. New application variable, rl_completion_suppress_quote, settable by an
292 application completion function. If set to non-zero, readline does not
293 attempt to append a closing quote to a completed word.
295 k. New application variable, rl_completion_found_quote, set to a non-zero
296 value if readline determines that the word to be completed is quoted.
297 Set before readline calls any application completion function.
299 l. New function hook, rl_completion_word_break_hook, called when readline
300 needs to break a line into words when completion is attempted. Allows
301 the word break characters to vary based on position in the line.
303 m. New bindable command: unix-filename-rubout. Does the same thing as
304 unix-word-rubout, but adds `/' to the set of word delimiters.
306 n. When listing completions, directories have a `/' appended if the
307 `mark-directories' option has been enabled.
309 -------------------------------------------------------------------------------
310 This document details the changes between this version, readline-4.3,
311 and the previous version, readline-4.2a.
313 1. Changes to Readline
315 a. Fixed output of comment-begin character when listing variable values.
317 b. Added some default key bindings for common escape sequences produced by
320 c. Fixed the mark handling code to be more emacs-compatible.
322 d. A bug was fixed in the code that prints possible completions to keep it
323 from printing empty strings in certain circumstances.
325 e. Change the key sequence printing code to print ESC as M\- if ESC is a
326 meta-prefix character -- it's easier for users to understand than \e.
328 f. Fixed unstifle_history() to return values that match the documentation.
330 g. Fixed the event loop (rl_event_hook) to handle the case where the input
331 file descriptor is invalidated.
333 h. Fixed the prompt display code to work better when the application has a
334 custom redisplay function.
336 i. Changes to make reading and writing the history file a little faster, and
337 to cope with huge history files without calling abort(3) from xmalloc.
339 j. The vi-mode `S' and `s' commands are now undone correctly.
341 k. Fixed a problem which caused the display to be messed up when the last
342 line of a multi-line prompt (possibly containing invisible characters)
343 was longer than the screen width.
345 2. New Features in Readline
347 a. Support for key `subsequences': allows, e.g., ESC and ESC-a to both
348 be bound to readline functions. Now the arrow keys may be used in vi
351 b. When listing completions, and the number of lines displayed is more than
352 the screen length, readline uses an internal pager to display the results.
353 This is controlled by the `page-completions' variable (default on).
355 c. New code to handle editing and displaying multibyte characters.
357 d. The behavior introduced in bash-2.05a of deciding whether or not to
358 append a slash to a completed name that is a symlink to a directory has
359 been made optional, controlled by the `mark-symlinked-directories'
360 variable (default is the 2.05a behavior).
362 e. The `insert-comment' command now acts as a toggle if given a numeric
363 argument: if the first characters on the line don't specify a
364 comment, insert one; if they do, delete the comment text
366 f. New application-settable completion variable:
367 rl_completion_mark_symlink_dirs, allows an application's completion
368 function to temporarily override the user's preference for appending
369 slashes to names which are symlinks to directories.
371 g. New function available to application completion functions:
372 rl_completion_mode, to tell how the completion function was invoked
373 and decide which argument to supply to rl_complete_internal (to list
376 h. Readline now has an overwrite mode, toggled by the `overwrite-mode'
377 bindable command, which could be bound to `Insert'.
379 i. New application-settable completion variable:
380 rl_completion_suppress_append, inhibits appending of
381 rl_completion_append_character to completed words.
383 j. New key bindings when reading an incremental search string: ^W yanks
384 the currently-matched word out of the current line into the search
385 string; ^Y yanks the rest of the current line into the search string,
386 DEL or ^H deletes characters from the search string.
388 -------------------------------------------------------------------------------
389 This document details the changes between this version, readline-4.2a,
390 and the previous version, readline-4.2.
392 1. Changes to Readline
394 a. More `const' and type casting fixes.
396 b. Changed rl_message() to use vsnprintf(3) (if available) to fix buffer
399 c. The completion code no longer appends a `/' or ` ' to a match when
400 completing a symbolic link that resolves to a directory name, unless
401 the match does not add anything to the word being completed. This
402 means that a tab will complete the word up to the full name, but not
403 add anything, and a subsequent tab will add a slash.
405 d. Fixed a trivial typo that made the vi-mode `dT' command not work.
407 e. Fixed the tty code so that ^S and ^Q can be inserted with rl_quoted_insert.
409 f. Fixed the tty code so that ^V works more than once.
411 g. Changed the use of __P((...)) for function prototypes to PARAMS((...))
412 because the use of __P in typedefs conflicted g++ and glibc.
414 h. The completion code now attempts to do a better job of preserving the
415 case of the word the user typed if ignoring case in completions.
417 i. Readline defaults to not echoing the input and lets the terminal
418 initialization code enable echoing if there is a controlling terminal.
420 j. The key binding code now processes only two hex digits after a `\x'
421 escape sequence, and the documentation was changed to note that the
422 octal and hex escape sequences result in an eight-bit value rather
425 k. Fixed a few places where negative array subscripts could have occurred.
427 l. Fixed the vi-mode code to use a better method to determine the bounds of
428 the array used to hold the marks, and to avoid out-of-bounds references.
430 m. Fixed the defines in chardefs.h to work better when chars are signed.
432 n. Fixed configure.in to use the new names for bash autoconf macros.
434 o. Readline no longer attempts to define its own versions of some ctype
435 macros if they are implemented as functions in libc but not as macros in
438 p. Fixed a problem where rl_backward could possibly set point to before
439 the beginning of the line.
441 q. Fixed Makefile to not put -I/usr/include into CFLAGS, since it can cause
442 include file problems.
444 2. New Features in Readline
446 a. Added extern declaration for rl_get_termcap to readline.h, making it a
447 public function (it was always there, just not in readline.h).
449 b. New #defines in readline.h: RL_READLINE_VERSION, currently 0x0402,
450 RL_VERSION_MAJOR, currently 4, and RL_VERSION_MINOR, currently 2.
452 c. New readline variable: rl_readline_version, mirrors RL_READLINE_VERSION.
454 d. New bindable boolean readline variable: match-hidden-files. Controls
455 completion of files beginning with a `.' (on Unix). Enabled by default.
457 e. The history expansion code now allows any character to terminate a
458 `:first-' modifier, like csh.
460 f. The incremental search code remembers the last search string and uses
461 it if ^R^R is typed without a search string.
463 h. New bindable variable `history-preserve-point'. If set, the history
464 code attempts to place the user at the same location on each history
465 line retrived with previous-history or next-history.
467 -------------------------------------------------------------------------------
468 This document details the changes between this version, readline-4.2,
469 and the previous version, readline-4.1.
471 1. Changes to Readline
473 a. When setting the terminal attributes on systems using `struct termio',
474 readline waits for output to drain before changing the attributes.
476 b. A fix was made to the history word tokenization code to avoid attempts to
477 dereference a null pointer.
479 c. Readline now defaults rl_terminal_name to $TERM if the calling application
480 has left it unset, and tries to initialize with the resultant value.
482 d. Instead of calling (*rl_getc_function)() directly to get input in certain
483 places, readline now calls rl_read_key() consistently.
485 e. Fixed a bug in the completion code that allowed a backslash to quote a
486 single quote inside a single-quoted string.
488 f. rl_prompt is no longer assigned directly from the argument to readline(),
489 but uses memory allocated by readline. This allows constant strings to
490 be passed to readline without problems arising when the prompt processing
491 code wants to modify the string.
493 g. Fixed a bug that caused non-interactive history searches to return the
494 wrong line when performing multiple searches backward for the same string.
496 h. Many variables, function arguments, and function return values are now
497 declared `const' where appropriate, to improve behavior when linking with
500 i. The control character detection code now works better on systems where
501 `char' is unsigned by default.
503 j. The vi-mode numeric argument is now capped at 999999, just like emacs mode.
505 k. The Function, CPFunction, CPPFunction, and VFunction typedefs have been
506 replaced with a set of specific prototyped typedefs, though they are
507 still in the readline header files for backwards compatibility.
509 m. Nearly all of the (undocumented) internal global variables in the library
510 now have an _rl_ prefix -- there were a number that did not, like
511 screenheight, screenwidth, alphabetic, etc.
513 n. The ding() convenience function has been renamed to rl_ding(), though the
514 old function is still defined for backwards compatibility.
516 o. The completion convenience functions filename_completion_function,
517 username_completion_function, and completion_matches now have an rl_
518 prefix, though the old names are still defined for backwards compatibility.
520 p. The functions shared by readline and bash (linkage is satisfied from bash
521 when compiling with bash, and internally otherwise) now have an sh_ prefix.
523 q. Changed the shared library creation procedure on Linux and BSD/OS 4.x so
524 that the `soname' contains only the major version number rather than the
525 major and minor numbers.
527 r. Fixed a redisplay bug that occurred when the prompt spanned more than one
528 physical line and contained invisible characters.
530 s. Added a missing `includedir' variable to the Makefile.
532 t. When installing the shared libraries, make sure symbolic links are relative.
534 u. Added configure test so that it can set `${MAKE}' appropriately.
536 v. Fixed a bug in rl_forward that could cause the point to be set to before
537 the beginning of the line in vi mode.
539 w. Fixed a bug in the callback read-char interface to make it work when a
540 readline function pushes some input onto the input stream with
541 rl_execute_next (like the incremental search functions).
543 x. Fixed a file descriptor leak in the history file manipulation code that
544 was tripped when attempting to truncate a non-regular file (like
547 y. Changes to make all of the exported readline functions declared in
548 readline.h have an rl_ prefix (rltty_set_default_bindings is now
549 rl_tty_set_default_bindings, crlf is now rl_crlf, etc.)
551 z. The formatted documentation included in the base readline distribution
552 is no longer removed on a `make distclean'.
554 aa. Some changes were made to avoid gcc warnings with -Wall.
556 bb. rl_get_keymap_by_name now finds keymaps case-insensitively, so
557 `set keymap EMACS' works.
559 cc. The history file writing and truncation functions now return a useful
562 dd. Fixed a bug that could cause applications to dereference a NULL pointer
563 if a NULL second argument was passed to history_expand().
565 ee. If a hook function assigned to rl_event_hook sets rl_done to a non-zero
566 value, rl_read_key() now immediately returns '\n' (which is assumed to
567 be bound to accept-line).
569 2. New Features in Readline
571 a. The blink timeout for paren matching is now settable by applications,
572 via the rl_set_paren_blink_timeout() function.
574 b. _rl_executing_macro has been renamed to rl_executing_macro, which means
575 it's now part of the public interface.
577 c. Readline has a new variable, rl_readline_state, which is a bitmap that
578 encapsulates the current state of the library; intended for use by
579 callbacks and hook functions.
581 d. rlfe has a new -l option to log input and output (-a appends to logfile),
582 a new -n option to set the readline application name, and -v and -h
583 options for version and help information.
585 e. rlfe can now perform filename completion for the inferior process if the
586 OS has a /proc/<PID>/cwd that can be read with readlink(2) to get the
587 inferior's current working directory.
589 f. A new file, rltypedefs.h, contains the new typedefs for function pointers
590 and is installed by `make install'.
592 g. New application-callable function rl_set_prompt(const char *prompt):
593 expands its prompt string argument and sets rl_prompt to the result.
595 h. New application-callable function rl_set_screen_size(int rows, int cols):
596 public method for applications to set readline's idea of the screen
599 i. The history example program (examples/histexamp.c) is now built as one
602 j. The documentation has been updated to cover nearly all of the public
603 functions and variables declared in readline.h.
605 k. New function, rl_get_screen_size (int *rows, int *columns), returns
606 readline's idea of the screen dimensions.
608 l. The timeout in rl_gather_tyi (readline keyboard input polling function)
609 is now settable via a function (rl_set_keyboard_input_timeout()).
611 m. Renamed the max_input_history variable to history_max_entries; the old
612 variable is maintained for backwards compatibility.
614 n. The list of characters that separate words for the history tokenizer is
615 now settable with a variable: history_word_delimiters. The default
618 o. There is a new history.3 manual page documenting the history library.
620 -------------------------------------------------------------------------------
621 This document details the changes between this version, readline-4.1,
622 and the previous version, readline-4.0.
624 1. Changes to Readline
626 a. Changed the HTML documents so that the table-of-contents is no longer
629 b. Changes to the shared object configuration for: Irix 5.x, Irix 6.x,
632 c. The shared library major and minor versions are now constructed
633 automatically by configure and substituted into the makefiles.
635 d. It's now possible to install the shared libraries separately from the
638 e. The history library tries to truncate the history file only if it is a
641 f. A bug that caused _rl_dispatch to address negative array indices on
642 systems with signed chars was fixed.
644 g. rl-yank-nth-arg now leaves the history position the same as when it was
647 h. Changes to the completion code to handle MS-DOS drive-letter:pathname
650 i. Completion is now case-insensitive by default on MS-DOS.
652 j. Fixes to the history file manipulation code for MS-DOS.
654 k. Readline attempts to bind the arrow keys to appropriate defaults on MS-DOS.
656 l. Some fixes were made to the redisplay code for better operation on MS-DOS.
658 m. The quoted-insert code will now insert tty special chars like ^C.
660 n. A bug was fixed that caused the display code to reference memory before
661 the start of the prompt string.
663 o. More support for __EMX__ (OS/2).
665 p. A bug was fixed in readline's signal handling that could cause infinite
666 recursion in signal handlers.
668 q. A bug was fixed that caused the point to be less than zero when rl_forward
669 was given a very large numeric argument.
671 r. The vi-mode code now gets characters via the application-settable value
672 of rl_getc_function rather than calling rl_getc directly.
674 s. The history file code now uses O_BINARY mode when reading and writing
675 the history file on cygwin32.
677 t. Fixed a bug in the redisplay code for lines with more than 256 line
680 u. A bug was fixed which caused invisible character markers to not be
681 stripped from the prompt string if the terminal was in no-echo mode.
683 v. Readline no longer tries to get the variables it needs for redisplay
684 from the termcap entry if the calling application has specified its
685 own redisplay function. Readline treats the terminal as `dumb' in
688 w. Fixes to the SIGWINCH code so that a multiple-line prompt with escape
689 sequences is redrawn correctly.
691 x. Changes to the install and install-shared targets so that the libraries
692 and header files are installed separately.
694 2. New Features in Readline
696 a. A new Readline `user manual' is in doc/rluserman.texinfo.
698 b. Parentheses matching is now always compiled into readline, and enabled
699 or disabled when the value of the `blink-matching-paren' variable is
702 c. MS-DOS systems now use ~/_inputrc as the last-ditch inputrc filename.
704 d. MS-DOS systems now use ~/_history as the default history file.
706 e. history-search-{forward,backward} now leave the point at the end of the
707 line when the string to search for is empty, like
708 {reverse,forward}-search-history.
710 f. history-search-{forward,backward} now leave the last history line found
711 in the readline buffer if the second or subsequent search fails.
713 g. New function for use by applications: rl_on_new_line_with_prompt, used
714 when an application displays the prompt itself before calling readline().
716 h. New variable for use by applications: rl_already_prompted. An application
717 that displays the prompt itself before calling readline() must set this to
720 i. A new variable, rl_gnu_readline_p, always 1. The intent is that an
721 application can verify whether or not it is linked with the `real'
722 readline library or some substitute.
724 j. Per Bothner's `rlfe' (pronounced `Ralphie') readline front-end program
725 is included in the examples subdirectory, though it is not built
728 -------------------------------------------------------------------------------
729 This document details the changes between this version, readline-4.0,
730 and the previous version, readline-2.2.
732 1. Changes to Readline
734 a. The version number is now 4.0, to match the major and minor version
735 numbers on the shared readline and history libraries. Future
736 releases will maintain the identical numbering.
738 b. Fixed a typo in the `make install' recipe that copied libreadline.a
739 to libhistory.old right after installing it.
741 c. The readline and history info files are now installed out of the source
742 directory if they are not found in the build directory.
744 d. The library no longer exports a function named `savestring' -- backwards
745 compatibility be damned.
747 e. There is no longer any #ifdef SHELL code in the source files.
749 f. Some changes were made to the key binding code to fix memory leaks and
750 better support Win32 systems.
752 g. Fixed a silly typo in the paren matching code -- it's microseconds, not
755 h. The readline library should be compilable by C++ compilers.
757 i. The readline.h public header file now includes function prototypes for
758 all readline functions, and some changes were made to fix errors in the
759 source files uncovered by the use of prototypes.
761 j. The maximum numeric argument is now clamped at 1000000.
763 k. Fixes to rl_yank_last_arg to make it behave better.
765 l. Fixed a bug in the display code that caused core dumps if the prompt
766 string length exceeded 1024 characters.
768 m. The menu completion code was fixed to properly insert a single completion
769 if there is only one match.
771 n. A bug was fixed that caused the display code to improperly display tabs
774 o. A fix was made to the completion code in which a typo caused the wrong
775 value to be passed to the function that computed the longest common
776 prefix of the list of matches.
778 p. The completion code now checks the value of rl_filename_completion_desired,
779 which is set by application-supplied completion functions to indicate
780 that filename completion is being performed, to decide whether or not to
781 call an application-supplied `ignore completions' function.
783 q. Code was added to the history library to catch history substitutions
784 using `&' without a previous history substitution or search having been
788 2. New Features in Readline
790 a. There is a new script, support/shobj-conf, to do system-specific shared
791 object and library configuration. It generates variables for configure
792 to substitute into makefiles. The README file provides a detailed
793 explanation of the shared library creation process.
795 b. Shared libraries and objects are now built in the `shlib' subdirectory.
796 There is a shlib/Makefile.in to control the build process. `make shared'
797 from the top-level directory is still the right way to build shared
798 versions of the libraries.
800 c. rlconf.h is now installed, so applications can find out which features
801 have been compiled into the installed readline and history libraries.
803 d. rlstdc.h is now an installed header file.
805 e. Many changes to the signal handling:
806 o Readline now catches SIGQUIT and cleans up the tty before returning;
807 o A new variable, rl_catch_signals, is available to application writers
808 to indicate to readline whether or not it should install its own
809 signal handlers for SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP,
810 SIGTTIN, and SIGTTOU;
811 o A new variable, rl_catch_sigwinch, is available to application
812 writers to indicate to readline whether or not it should install its
813 own signal handler for SIGWINCH, which will chain to the calling
814 applications's SIGWINCH handler, if one is installed;
815 o There is a new function, rl_free_line_state, for application signal
816 handlers to call to free up the state associated with the current
817 line after receiving a signal;
818 o There is a new function, rl_cleanup_after_signal, to clean up the
819 display and terminal state after receiving a signal;
820 o There is a new function, rl_reset_after_signal, to reinitialize the
821 terminal and display state after an application signal handler
822 returns and readline continues
824 f. There is a new function, rl_resize_terminal, to reset readline's idea of
825 the screen size after a SIGWINCH.
827 g. New public functions: rl_save_prompt and rl_restore_prompt. These were
828 previously private functions with a `_' prefix. These functions are
829 used when an application wants to write a message to the `message area'
830 with rl_message and have the prompt restored correctly when the message
833 h. New function hook: rl_pre_input_hook, called just before readline starts
834 reading input, after initialization.
836 i. New function hook: rl_display_matches_hook, called when readline would
837 display the list of completion matches. The new function
838 rl_display_match_list is what readline uses internally, and is available
839 for use by application functions called via this hook.
841 j. New bindable function, delete-char-or-list, like tcsh.
843 k. A new variable, rl_erase_empty_line, which, if set by an application using
844 readline, will cause readline to erase, prompt and all, lines on which the
845 only thing typed was a newline.
847 l. There is a new script, support/shlib-install, to install and uninstall
848 the shared readline and history libraries.
850 m. A new bindable variable, `isearch-terminators', which is a string
851 containing the set of characters that should terminate an incremental
852 search without being executed as a command.
854 n. A new bindable function, forward-backward-delete-char.
856 -------------------------------------------------------------------------------
857 This document details the changes between this version, readline-2.2,
858 and the previous version, readline-2.1.
860 1. Changes to Readline
862 a. Added a missing `extern' to a declaration in readline.h that kept
863 readline from compiling cleanly on some systems.
865 b. The history file is now opened with mode 0600 when it is written for
868 c. Changes were made to the SIGWINCH handling code so that prompt redisplay
871 d. ^G now interrupts incremental searches correctly.
873 e. A bug that caused a core dump when the set of characters to be quoted
874 when completing words was empty was fixed.
876 f. Fixed a problem in the readline test program rltest.c that caused a core
879 g. The code that handles parser directives in inputrc files now displays
882 h. The history expansion code was fixed so that the appearance of the
883 history comment character at the beginning of a word inhibits history
884 expansion for that word and the rest of the input line.
886 i. The code that prints completion listings now behaves better if one or
887 more of the filenames contains non-printable characters.
889 j. The time delay when showing matching parentheses is now 0.5 seconds.
892 2. New Features in Readline
894 a. There is now an option for `iterative' yank-last-arg handline, so a user
895 can keep entering `M-.', yanking the last argument of successive history
898 b. New variable, `print-completions-horizontally', which causes completion
899 matches to be displayed across the screen (like `ls -x') rather than up
900 and down the screen (like `ls').
902 c. New variable, `completion-ignore-case', which causes filename completion
903 and matching to be performed case-insensitively.
905 d. There is a new bindable command, `magic-space', which causes history
906 expansion to be performed on the current readline buffer and a space to
907 be inserted into the result.
909 e. There is a new bindable command, `menu-complete', which enables tcsh-like
910 menu completion (successive executions of menu-complete insert a single
911 completion match, cycling through the list of possible completions).
913 f. There is a new bindable command, `paste-from-clipboard', for use on Win32
914 systems, to insert the text from the Win32 clipboard into the editing
917 g. The key sequence translation code now understands printf-style backslash
918 escape sequences, including \NNN octal escapes. These escape sequences
919 may be used in key sequence definitions or macro values.
921 h. An `$include' inputrc file parser directive has been added.