Merge from vendor branch SENDMAIL:
[dragonfly.git] / contrib / readline-5.0 / CHANGES
1 This document details the changes between this version, readline-5.0,
2 and the previous version, readline-4.3.
3
4 1.  Changes to Readline
5
6 a.  Fixes to avoid core dumps because of null pointer references in the
7     multibyte character code.
8
9 b.  Fix to avoid infinite recursion caused by certain key combinations.
10
11 c.  Fixed a bug that caused the vi-mode `last command' to be set incorrectly.
12
13 d.  Readline no longer tries to read ahead more than one line of input, even
14     when more is available.
15
16 e.  Fixed the code that adjusts the point to not mishandle null wide
17     characters.
18
19 f.  Fixed a bug in the history expansion `g' modifier that caused it to skip
20     every other match.
21
22 g.  Fixed a bug that caused the prompt to overwrite previous output when the
23     output doesn't contain a newline and the locale supports multibyte
24     characters.  This same change fixes the problem of readline redisplay
25     slowing down dramatically as the line gets longer in multibyte locales.
26
27 h.  History traversal with arrow keys in vi insertion mode causes the cursor
28     to be placed at the end of the new line, like in emacs mode.
29
30 i.  The locale initialization code does a better job of using the right
31     precedence and defaulting when checking the appropriate environment
32     variables.
33
34 j.  Fixed the history word tokenizer to handle <( and >( better when used as
35     part of bash.
36
37 k.  The overwrite mode code received several bug fixes to improve undo.
38
39 l.  Many speedups to the multibyte character redisplay code.
40
41 m.  The callback character reading interface should not hang waiting to read
42     keyboard input.
43
44 n.  Fixed a bug with redoing vi-mode `s' command.
45
46 o.  The code that initializes the terminal tracks changes made to the terminal
47     special characters with stty(1) (or equivalent), so that these changes
48     are reflected in the readline bindings.  New application-callable function
49     to make it work:  rl_tty_unset_default_bindings().
50
51 p.  Fixed a bug that could cause garbage to be inserted in the buffer when
52     changing character case in vi mode when using a multibyte locale.
53
54 q.  Fixed a bug in the redisplay code that caused problems on systems
55     supporting multibyte characters when moving between history lines when the
56     new line has more glyphs but fewer bytes.
57
58 r.  Undo and redo now work better after exiting vi insertion mode.
59
60 s.  Make sure system calls are restarted after a SIGWINCH is received using
61     SA_RESTART.
62
63 t.  Improvements to the code that displays possible completions when using
64     multibyte characters.
65
66 u.  Fixed a problem when parsing nested if statements in inputrc files.
67
68 v.  The completer now takes multibyte characters into account when looking for
69     quoted substrings on which to perform completion.
70
71 w.  The history search functions now perform better bounds checking on the
72     history list.
73
74 x.  Change to history expansion functions to treat `^' as equivalent to word 
75     one, as the documention states.
76
77 y.  Some changes to the display code to improve display and redisplay of
78     multibyte characters.
79
80 z.  Changes to speed up the multibyte character redisplay code.
81
82 aa. Fixed a bug in the vi-mode `E' command that caused it to skip over the
83     last character of a word if invoked while point was on the word's
84     next-to-last character.
85
86 bb. Fixed a bug that could cause incorrect filename quoting when
87     case-insensitive completion was enabled and the word being completed
88     contained backslashes quoting word break characters.
89
90 cc. Fixed a bug in redisplay triggered when the prompt string contains
91     invisible characters.
92
93 dd. Fixed some display (and other) bugs encountered in multibyte locales
94     when a non-ascii character was the last character on a line.
95
96 ee. Fixed some display bugs caused by multibyte characters in prompt strings.
97
98 ff. Fixed a problem with history expansion caused by non-whitespace characters
99     used as history word delimiters.
100
101 gg. Fixed a problem that could cause readline to refer to freed memory when
102     moving between history lines while doing searches.
103
104 hh. Improvements to the code that expands and displays prompt strings
105     containing multibyte characters.
106
107 ii. Fixed a problem with vi-mode not correctly remembering the numeric argument
108     to the last `c'hange command for later use with `.'.
109
110 jj. Fixed a bug in vi-mode that caused multi-digit count arguments to work   
111     incorrectly.
112
113 kk. Fixed a problem in vi-mode that caused the last text modification command
114     to not be remembered across different command lines.
115
116 ll. Fixed problems with changing characters and changing case at the end of
117     the line.
118
119 mm. Fixed a problem with readline saving the contents of the current line
120     before beginning a non-interactive search.
121
122 nn. Fixed a problem with EOF detection when using rl_event_hook.
123
124 oo. Fixed a problem with the vi mode `p' and `P' commands ignoring numeric
125     arguments.
126
127 2.  New Features in Readline
128
129 a.  History expansion has a new `a' modifier equivalent to the `g' modifier
130     for compatibility with the BSD csh.
131
132 b.  History expansion has a new `G' modifier equivalent to the BSD csh `g'
133     modifier, which performs a substitution once per word.
134
135 c.  All non-incremental search operations may now undo the operation of
136     replacing the current line with the history line.
137
138 d.  The text inserted by an `a' command in vi mode can be reinserted with
139     `.'.
140
141 e.  New bindable variable, `show-all-if-unmodified'.  If set, the readline
142     completer will list possible completions immediately if there is more
143     than one completion and partial completion cannot be performed.
144
145 f.  There is a new application-callable `free_history_entry()' function.
146
147 g.  History list entries now contain timestamp information; the history file
148     functions know how to read and write timestamp information associated
149     with each entry.
150
151 h.  Four new key binding functions have been added:
152
153         rl_bind_key_if_unbound()
154         rl_bind_key_if_unbound_in_map()
155         rl_bind_keyseq_if_unbound()
156         rl_bind_keyseq_if_unbound_in_map()
157
158 i.  New application variable, rl_completion_quote_character, set to any
159     quote character readline finds before it calls the application completion
160     function.
161
162 j.  New application variable, rl_completion_suppress_quote, settable by an   
163     application completion function.  If set to non-zero, readline does not
164     attempt to append a closing quote to a completed word.
165     
166 k.  New application variable, rl_completion_found_quote, set to a non-zero
167     value if readline determines that the word to be completed is quoted.
168     Set before readline calls any application completion function.
169
170 l.  New function hook, rl_completion_word_break_hook, called when readline
171     needs to break a line into words when completion is attempted.  Allows
172     the word break characters to vary based on position in the line.
173
174 m.  New bindable command: unix-filename-rubout.  Does the same thing as
175     unix-word-rubout, but adds `/' to the set of word delimiters.
176
177 n.  When listing completions, directories have a `/' appended if the
178     `mark-directories' option has been enabled.
179
180 -------------------------------------------------------------------------------
181 This document details the changes between this version, readline-4.3,
182 and the previous version, readline-4.2a.
183
184 1.  Changes to Readline
185
186 a.  Fixed output of comment-begin character when listing variable values.
187
188 b.  Added some default key bindings for common escape sequences produced by
189     HOME and END keys.
190
191 c.  Fixed the mark handling code to be more emacs-compatible.
192
193 d.  A bug was fixed in the code that prints possible completions to keep it
194     from printing empty strings in certain circumstances.
195
196 e.  Change the key sequence printing code to print ESC as M\- if ESC is a
197     meta-prefix character -- it's easier for users to understand than \e.
198
199 f.  Fixed unstifle_history() to return values that match the documentation.
200
201 g.  Fixed the event loop (rl_event_hook) to handle the case where the input
202     file descriptor is invalidated.
203
204 h.  Fixed the prompt display code to work better when the application has a
205     custom redisplay function.
206
207 i.  Changes to make reading and writing the history file a little faster, and
208     to cope with huge history files without calling abort(3) from xmalloc.
209
210 j.  The vi-mode `S' and `s' commands are now undone correctly.
211
212 k.  Fixed a problem which caused the display to be messed up when the last
213     line of a multi-line prompt (possibly containing invisible characters)
214     was longer than the screen width.
215
216 2.  New Features in Readline
217
218 a.  Support for key `subsequences':  allows, e.g., ESC and ESC-a to both
219     be bound to readline functions.  Now the arrow keys may be used in vi
220     insert mode.
221
222 b.  When listing completions, and the number of lines displayed is more than
223     the screen length, readline uses an internal pager to display the results.
224     This is controlled by the `page-completions' variable (default on).
225
226 c.  New code to handle editing and displaying multibyte characters.
227
228 d.  The behavior introduced in bash-2.05a of deciding whether or not to
229     append a slash to a completed name that is a symlink to a directory has
230     been made optional, controlled by the `mark-symlinked-directories'
231     variable (default is the 2.05a behavior).
232
233 e.  The `insert-comment' command now acts as a toggle if given a numeric
234     argument:  if the first characters on the line don't specify a
235     comment, insert one; if they do, delete the comment text
236
237 f.  New application-settable completion variable:
238     rl_completion_mark_symlink_dirs, allows an application's completion
239     function to temporarily override the user's preference for appending
240     slashes to names which are symlinks to directories.
241
242 g.  New function available to application completion functions:
243     rl_completion_mode, to tell how the completion function was invoked
244     and decide which argument to supply to rl_complete_internal (to list
245     completions, etc.).
246
247 h.  Readline now has an overwrite mode, toggled by the `overwrite-mode'
248     bindable command, which could be bound to `Insert'.
249
250 i.  New application-settable completion variable:
251     rl_completion_suppress_append, inhibits appending of
252     rl_completion_append_character to completed words.
253
254 j.  New key bindings when reading an incremental search string:  ^W yanks
255     the currently-matched word out of the current line into the search
256     string; ^Y yanks the rest of the current line into the search string,
257     DEL or ^H deletes characters from the search string.
258
259 -------------------------------------------------------------------------------
260 This document details the changes between this version, readline-4.2a,
261 and the previous version, readline-4.2.
262
263 1.  Changes to Readline
264
265 a.  More `const' and type casting fixes.
266
267 b.  Changed rl_message() to use vsnprintf(3) (if available) to fix buffer
268     overflow problems.
269
270 c.  The completion code no longer appends a `/' or ` ' to a match when
271     completing a symbolic link that resolves to a directory name, unless
272     the match does not add anything to the word being completed.  This
273     means that a tab will complete the word up to the full name, but not
274     add anything, and a subsequent tab will add a slash.
275
276 d.  Fixed a trivial typo that made the vi-mode `dT' command not work.
277
278 e.  Fixed the tty code so that ^S and ^Q can be inserted with rl_quoted_insert.
279
280 f.  Fixed the tty code so that ^V works more than once.
281
282 g.  Changed the use of __P((...)) for function prototypes to PARAMS((...))
283     because the use of __P in typedefs conflicted g++ and glibc.
284
285 h.  The completion code now attempts to do a better job of preserving the
286     case of the word the user typed if ignoring case in completions.
287
288 i.  Readline defaults to not echoing the input and lets the terminal
289     initialization code enable echoing if there is a controlling terminal.
290
291 j.  The key binding code now processes only two hex digits after a `\x'
292     escape sequence, and the documentation was changed to note that the
293     octal and hex escape sequences result in an eight-bit value rather
294     than strict ASCII.
295
296 k.  Fixed a few places where negative array subscripts could have occurred.
297     
298 l.  Fixed the vi-mode code to use a better method to determine the bounds of
299     the array used to hold the marks, and to avoid out-of-bounds references.
300     
301 m.  Fixed the defines in chardefs.h to work better when chars are signed.
302     
303 n.  Fixed configure.in to use the new names for bash autoconf macros.
304     
305 o.  Readline no longer attempts to define its own versions of some ctype
306     macros if they are implemented as functions in libc but not as macros in
307     <ctype.h>.
308
309 p.  Fixed a problem where rl_backward could possibly set point to before
310     the beginning of the line.
311
312 q.  Fixed Makefile to not put -I/usr/include into CFLAGS, since it can cause
313     include file problems.
314
315 2.  New Features in Readline
316
317 a.  Added extern declaration for rl_get_termcap to readline.h, making it a
318     public function (it was always there, just not in readline.h).
319
320 b.  New #defines in readline.h:  RL_READLINE_VERSION, currently 0x0402,
321     RL_VERSION_MAJOR, currently 4, and RL_VERSION_MINOR, currently 2.
322
323 c.  New readline variable:  rl_readline_version, mirrors RL_READLINE_VERSION.
324
325 d.  New bindable boolean readline variable:  match-hidden-files.  Controls
326     completion of files beginning with a `.' (on Unix).  Enabled by default.
327
328 e.  The history expansion code now allows any character to terminate a
329     `:first-' modifier, like csh.
330
331 f.  The incremental search code remembers the last search string and uses
332     it if ^R^R is typed without a search string.
333
334 h.  New bindable variable `history-preserve-point'.  If set, the history
335     code attempts to place the user at the same location on each history
336     line retrived with previous-history or next-history.
337
338 -------------------------------------------------------------------------------
339 This document details the changes between this version, readline-4.2,
340 and the previous version, readline-4.1.
341
342 1.  Changes to Readline
343
344 a.  When setting the terminal attributes on systems using `struct termio',
345     readline waits for output to drain before changing the attributes.
346
347 b.  A fix was made to the history word tokenization code to avoid attempts to
348     dereference a null pointer.
349
350 c.  Readline now defaults rl_terminal_name to $TERM if the calling application
351     has left it unset, and tries to initialize with the resultant value.
352
353 d.  Instead of calling (*rl_getc_function)() directly to get input in certain
354     places, readline now calls rl_read_key() consistently.
355
356 e.  Fixed a bug in the completion code that allowed a backslash to quote a
357     single quote inside a single-quoted string.
358
359 f.  rl_prompt is no longer assigned directly from the argument to readline(),
360     but uses memory allocated by readline.  This allows constant strings to
361     be passed to readline without problems arising when the prompt processing
362     code wants to modify the string.
363
364 g.  Fixed a bug that caused non-interactive history searches to return the
365     wrong line when performing multiple searches backward for the same string.
366
367 h.  Many variables, function arguments, and function return values are now
368     declared `const' where appropriate, to improve behavior when linking with
369     C++ code.
370
371 i.  The control character detection code now works better on systems where
372     `char' is unsigned by default.
373
374 j.  The vi-mode numeric argument is now capped at 999999, just like emacs mode.
375
376 k.  The Function, CPFunction, CPPFunction, and VFunction typedefs have been
377     replaced with a set of specific prototyped typedefs, though they are
378     still in the readline header files for backwards compatibility.
379
380 m.  Nearly all of the (undocumented) internal global variables in the library
381     now have an _rl_ prefix -- there were a number that did not, like
382     screenheight, screenwidth, alphabetic, etc.
383
384 n.  The ding() convenience function has been renamed to rl_ding(), though the
385     old function is still defined for backwards compatibility.
386
387 o.  The completion convenience functions filename_completion_function,
388     username_completion_function, and completion_matches now have an rl_
389     prefix, though the old names are still defined for backwards compatibility.
390
391 p.  The functions shared by readline and bash (linkage is satisfied from bash
392     when compiling with bash, and internally otherwise) now have an sh_ prefix.
393
394 q.  Changed the shared library creation procedure on Linux and BSD/OS 4.x so
395     that the `soname' contains only the major version number rather than the
396     major and minor numbers.
397
398 r.  Fixed a redisplay bug that occurred when the prompt spanned more than one
399     physical line and contained invisible characters.
400
401 s.  Added a missing `includedir' variable to the Makefile.
402
403 t.  When installing the shared libraries, make sure symbolic links are relative.
404
405 u.  Added configure test so that it can set `${MAKE}' appropriately.
406
407 v.  Fixed a bug in rl_forward that could cause the point to be set to before
408     the beginning of the line in vi mode.
409
410 w.  Fixed a bug in the callback read-char interface to make it work when a
411     readline function pushes some input onto the input stream with
412     rl_execute_next (like the incremental search functions).
413
414 x.  Fixed a file descriptor leak in the history file manipulation code that
415     was tripped when attempting to truncate a non-regular file (like
416     /dev/null).
417
418 y.  Changes to make all of the exported readline functions declared in
419     readline.h have an rl_ prefix (rltty_set_default_bindings is now
420     rl_tty_set_default_bindings, crlf is now rl_crlf, etc.)
421
422 z.  The formatted documentation included in the base readline distribution
423     is no longer removed on a `make distclean'.
424
425 aa. Some changes were made to avoid gcc warnings with -Wall.
426
427 bb. rl_get_keymap_by_name now finds keymaps case-insensitively, so
428     `set keymap EMACS' works.
429
430 cc. The history file writing and truncation functions now return a useful
431     status on error.
432
433 dd. Fixed a bug that could cause applications to dereference a NULL pointer
434     if a NULL second argument was passed to history_expand().
435
436 ee. If a hook function assigned to rl_event_hook sets rl_done to a non-zero
437     value, rl_read_key() now immediately returns '\n' (which is assumed to   
438     be bound to accept-line).
439
440 2.  New Features in Readline
441
442 a.  The blink timeout for paren matching is now settable by applications,
443     via the rl_set_paren_blink_timeout() function.
444
445 b.  _rl_executing_macro has been renamed to rl_executing_macro, which means
446     it's now part of the public interface.
447
448 c.  Readline has a new variable, rl_readline_state, which is a bitmap that
449     encapsulates the current state of the library; intended for use by
450     callbacks and hook functions.
451
452 d.  rlfe has a new -l option to log input and output (-a appends to logfile),
453     a new -n option to set the readline application name, and -v and -h
454     options for version and help information.
455
456 e.  rlfe can now perform filename completion for the inferior process if the
457     OS has a /proc/<PID>/cwd that can be read with readlink(2) to get the
458     inferior's current working directory.
459
460 f.  A new file, rltypedefs.h, contains the new typedefs for function pointers
461     and is installed by `make install'.
462
463 g.  New application-callable function rl_set_prompt(const char *prompt):
464     expands its prompt string argument and sets rl_prompt to the result.
465
466 h.  New application-callable function rl_set_screen_size(int rows, int cols):
467     public method for applications to set readline's idea of the screen
468     dimensions.
469
470 i.  The history example program (examples/histexamp.c) is now built as one
471     of the examples.
472
473 j.  The documentation has been updated to cover nearly all of the public
474     functions and variables declared in readline.h.
475
476 k.  New function, rl_get_screen_size (int *rows, int *columns), returns
477     readline's idea of the screen dimensions.
478
479 l.  The timeout in rl_gather_tyi (readline keyboard input polling function)
480     is now settable via a function (rl_set_keyboard_input_timeout()).
481
482 m.  Renamed the max_input_history variable to history_max_entries; the old
483     variable is maintained for backwards compatibility.
484
485 n.  The list of characters that separate words for the history tokenizer is
486     now settable with a variable:  history_word_delimiters.  The default
487     value is as before.
488
489 o.  There is a new history.3 manual page documenting the history library.
490
491 -------------------------------------------------------------------------------
492 This document details the changes between this version, readline-4.1,
493 and the previous version, readline-4.0.
494
495 1.  Changes to Readline
496
497 a.  Changed the HTML documents so that the table-of-contents is no longer
498     a separate file.
499
500 b.  Changes to the shared object configuration for: Irix 5.x, Irix 6.x,
501     OSF/1.
502
503 c.  The shared library major and minor versions are now constructed
504     automatically by configure and substituted into the makefiles.
505
506 d.  It's now possible to install the shared libraries separately from the
507     static libraries.
508
509 e.  The history library tries to truncate the history file only if it is a
510     regular file.
511
512 f.  A bug that caused _rl_dispatch to address negative array indices on
513     systems with signed chars was fixed.
514
515 g.  rl-yank-nth-arg now leaves the history position the same as when it was
516     called.
517
518 h.  Changes to the completion code to handle MS-DOS drive-letter:pathname
519     filenames.
520
521 i.  Completion is now case-insensitive by default on MS-DOS.
522
523 j.  Fixes to the history file manipulation code for MS-DOS.
524
525 k.  Readline attempts to bind the arrow keys to appropriate defaults on MS-DOS.
526
527 l.  Some fixes were made to the redisplay code for better operation on MS-DOS.
528
529 m.  The quoted-insert code will now insert tty special chars like ^C.
530
531 n.  A bug was fixed that caused the display code to reference memory before
532     the start of the prompt string.
533
534 o.  More support for __EMX__ (OS/2).
535
536 p.  A bug was fixed in readline's signal handling that could cause infinite
537     recursion in signal handlers.
538
539 q.  A bug was fixed that caused the point to be less than zero when rl_forward
540     was given a very large numeric argument.
541
542 r.  The vi-mode code now gets characters via the application-settable value
543     of rl_getc_function rather than calling rl_getc directly.
544
545 s.  The history file code now uses O_BINARY mode when reading and writing
546     the history file on cygwin32.
547
548 t.  Fixed a bug in the redisplay code for lines with more than 256 line
549     breaks.
550
551 u.  A bug was fixed which caused invisible character markers to not be
552     stripped from the prompt string if the terminal was in no-echo mode.
553     
554 v.  Readline no longer tries to get the variables it needs for redisplay 
555     from the termcap entry if the calling application has specified its
556     own redisplay function.  Readline treats the terminal as `dumb' in
557     this case.
558
559 w.  Fixes to the SIGWINCH code so that a multiple-line prompt with escape
560     sequences is redrawn correctly.
561
562 x.  Changes to the install and install-shared targets so that the libraries
563     and header files are installed separately.
564
565 2.  New Features in Readline
566
567 a.  A new Readline `user manual' is in doc/rluserman.texinfo.
568
569 b.  Parentheses matching is now always compiled into readline, and enabled
570     or disabled when the value of the `blink-matching-paren' variable is
571     changed.
572
573 c.  MS-DOS systems now use ~/_inputrc as the last-ditch inputrc filename.
574
575 d.  MS-DOS systems now use ~/_history as the default history file.
576
577 e.  history-search-{forward,backward} now leave the point at the end of the
578     line when the string to search for is empty, like
579     {reverse,forward}-search-history.
580
581 f.  history-search-{forward,backward} now leave the last history line found
582     in the readline buffer if the second or subsequent search fails.
583
584 g.  New function for use by applications:  rl_on_new_line_with_prompt, used
585     when an application displays the prompt itself before calling readline().
586
587 h.  New variable for use by applications:  rl_already_prompted.  An application
588     that displays the prompt itself before calling readline() must set this to
589     a non-zero value.
590
591 i.  A new variable, rl_gnu_readline_p, always 1.  The intent is that an
592     application can verify whether or not it is linked with the `real'
593     readline library or some substitute.
594
595 j.  Per Bothner's `rlfe' (pronounced `Ralphie') readline front-end program
596     is included in the examples subdirectory, though it is not built
597     by default.
598
599 -------------------------------------------------------------------------------
600 This document details the changes between this version, readline-4.0,
601 and the previous version, readline-2.2.
602
603 1.  Changes to Readline
604
605 a.  The version number is now 4.0, to match the major and minor version
606     numbers on the shared readline and history libraries.  Future
607     releases will maintain the identical numbering.
608
609 b.  Fixed a typo in the `make install' recipe that copied libreadline.a
610     to libhistory.old right after installing it.
611
612 c.  The readline and history info files are now installed out of the source
613     directory if they are not found in the build directory.
614
615 d.  The library no longer exports a function named `savestring' -- backwards
616     compatibility be damned.
617
618 e.  There is no longer any #ifdef SHELL code in the source files.
619
620 f.  Some changes were made to the key binding code to fix memory leaks and
621     better support Win32 systems.
622
623 g.  Fixed a silly typo in the paren matching code -- it's microseconds, not
624     milliseconds.
625
626 h.  The readline library should be compilable by C++ compilers.
627
628 i.  The readline.h public header file now includes function prototypes for
629     all readline functions, and some changes were made to fix errors in the
630     source files uncovered by the use of prototypes.
631
632 j.  The maximum numeric argument is now clamped at 1000000.
633
634 k.  Fixes to rl_yank_last_arg to make it behave better.
635
636 l.  Fixed a bug in the display code that caused core dumps if the prompt
637     string length exceeded 1024 characters.
638
639 m.  The menu completion code was fixed to properly insert a single completion
640     if there is only one match.
641
642 n.  A bug was fixed that caused the display code to improperly display tabs
643     after newlines.
644
645 o.  A fix was made to the completion code in which a typo caused the wrong
646     value to be passed to the function that computed the longest common
647     prefix of the list of matches.
648
649 p.  The completion code now checks the value of rl_filename_completion_desired,
650     which is set by application-supplied completion functions to indicate
651     that filename completion is being performed, to decide whether or not to
652     call an application-supplied `ignore completions' function.
653
654 q.  Code was added to the history library to catch history substitutions
655     using `&' without a previous history substitution or search having been
656     performed.
657
658
659 2.  New Features in Readline
660
661 a.  There is a new script, support/shobj-conf, to do system-specific shared
662     object and library configuration.  It generates variables for configure
663     to substitute into makefiles.  The README file provides a detailed
664     explanation of the shared library creation process.
665
666 b.  Shared libraries and objects are now built in the `shlib' subdirectory.
667     There is a shlib/Makefile.in to control the build process.  `make shared'
668     from the top-level directory is still the right way to build shared
669     versions of the libraries.
670
671 c.  rlconf.h is now installed, so applications can find out which features
672     have been compiled into the installed readline and history libraries.
673
674 d.  rlstdc.h is now an installed header file.
675
676 e.  Many changes to the signal handling:
677         o Readline now catches SIGQUIT and cleans up the tty before returning;
678         o A new variable, rl_catch_signals, is available to application writers 
679           to indicate to readline whether or not it should install its own
680           signal handlers for SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP,
681           SIGTTIN, and SIGTTOU;
682         o A new variable, rl_catch_sigwinch, is available to application
683           writers to indicate to readline whether or not it should install its
684           own signal handler for SIGWINCH, which will chain to the calling
685           applications's SIGWINCH handler, if one is installed;
686         o There is a new function, rl_free_line_state, for application signal
687           handlers to call to free up the state associated with the current
688           line after receiving a signal;
689         o There is a new function, rl_cleanup_after_signal, to clean up the
690           display and terminal state after receiving a signal;
691         o There is a new function, rl_reset_after_signal, to reinitialize the
692           terminal and display state after an application signal handler
693           returns and readline continues
694
695 f.  There is a new function, rl_resize_terminal, to reset readline's idea of
696     the screen size after a SIGWINCH.
697
698 g.  New public functions: rl_save_prompt and rl_restore_prompt.  These were
699     previously private functions with a `_' prefix.  These functions are
700     used when an application wants to write a message to the `message area'
701     with rl_message and have the prompt restored correctly when the message
702     is erased.
703
704 h.  New function hook: rl_pre_input_hook, called just before readline starts
705     reading input, after initialization.
706
707 i.  New function hook: rl_display_matches_hook, called when readline would
708     display the list of completion matches.  The new function
709     rl_display_match_list is what readline uses internally, and is available
710     for use by application functions called via this hook.
711
712 j.  New bindable function, delete-char-or-list, like tcsh.
713
714 k.  A new variable, rl_erase_empty_line, which, if set by an application using
715     readline, will cause readline to erase, prompt and all, lines on which the
716     only thing typed was a newline.
717
718 l.  There is a new script, support/shlib-install, to install and uninstall
719     the shared readline and history libraries.
720
721 m.  A new bindable variable, `isearch-terminators', which is a string
722     containing the set of characters that should terminate an incremental
723     search without being executed as a command.
724
725 n.  A new bindable function, forward-backward-delete-char.
726
727 -------------------------------------------------------------------------------
728 This document details the changes between this version, readline-2.2,
729 and the previous version, readline-2.1.
730
731 1.  Changes to Readline
732
733 a.  Added a missing `extern' to a declaration in readline.h that kept
734     readline from compiling cleanly on some systems.
735
736 b.  The history file is now opened with mode 0600 when it is written for
737     better security.
738
739 c.  Changes were made to the SIGWINCH handling code so that prompt redisplay
740     is done better.
741
742 d.  ^G now interrupts incremental searches correctly.
743
744 e.  A bug that caused a core dump when the set of characters to be quoted
745     when completing words was empty was fixed.
746
747 f.  Fixed a problem in the readline test program rltest.c that caused a core
748     dump.
749
750 g.  The code that handles parser directives in inputrc files now displays
751     more error messages.
752
753 h.  The history expansion code was fixed so that the appearance of the
754     history comment character at the beginning of a word inhibits history
755     expansion for that word and the rest of the input line.
756
757 i.  The code that prints completion listings now behaves better if one or
758     more of the filenames contains non-printable characters.
759
760 j.  The time delay when showing matching parentheses is now 0.5 seconds.
761
762
763 2.  New Features in Readline
764
765 a.  There is now an option for `iterative' yank-last-arg handline, so a user
766     can keep entering `M-.', yanking the last argument of successive history
767     lines.
768
769 b.  New variable, `print-completions-horizontally', which causes completion
770     matches to be displayed across the screen (like `ls -x') rather than up
771     and down the screen (like `ls').
772
773 c.  New variable, `completion-ignore-case', which causes filename completion
774     and matching to be performed case-insensitively.
775
776 d.  There is a new bindable command, `magic-space', which causes history
777     expansion to be performed on the current readline buffer and a space to
778     be inserted into the result.
779
780 e.  There is a new bindable command, `menu-complete', which enables tcsh-like
781     menu completion (successive executions of menu-complete insert a single
782     completion match, cycling through the list of possible completions).
783
784 f.  There is a new bindable command, `paste-from-clipboard', for use on Win32
785     systems, to insert the text from the Win32 clipboard into the editing
786     buffer.
787
788 g.  The key sequence translation code now understands printf-style backslash
789     escape sequences, including \NNN octal escapes.  These escape sequences
790     may be used in key sequence definitions or macro values.
791
792 h.  An `$include' inputrc file parser directive has been added.