| 1 | This document details the changes between this version, readline-8.0, and the |
| 2 | previous version, readline-7.0. |
| 3 | |
| 4 | 1. Changes to Readline |
| 5 | |
| 6 | a. Added a guard to prevent nested macros from causing an infinite expansion |
| 7 | loop. |
| 8 | |
| 9 | b. Instead of allocating enough history list entries to hold the maximum list |
| 10 | size, cap the number allocated initially. |
| 11 | |
| 12 | c. Added a strategy to avoid allocating huge amounts of memory if a block of |
| 13 | history entries without timestamps occurs after a block with timestamps. |
| 14 | |
| 15 | d. Added support for keyboard timeouts when an ESC character is the last |
| 16 | character in a macro. |
| 17 | |
| 18 | e. There are several performance improvements when in a UTF-8 locale. |
| 19 | |
| 20 | f. Readline does a better job of preserving the original set of blocked |
| 21 | signals when using pselect() to wait for input. |
| 22 | |
| 23 | g. Fixed a bug that caused multibyte characters in macros to be mishandled. |
| 24 | |
| 25 | h. Fixed several bugs in the code that calculates line breaks when expanding |
| 26 | prompts that span several lines, contain multibyte characters, and contain |
| 27 | invisible character seqeuences. |
| 28 | |
| 29 | i. Fixed several bugs in cursor positioning when displaying lines with prompts |
| 30 | containing invisible characters and multibyte characters. |
| 31 | |
| 32 | j. When performing case-insensitive completion, Readline no longer sorts the |
| 33 | list of matches unless directed to do so. |
| 34 | |
| 35 | k. Fixed a problem with key sequences ending with a backslash. |
| 36 | |
| 37 | l. Fixed out-of-bounds and free memory read errors found via fuzzing. |
| 38 | |
| 39 | m. Fixed several cases where the mark was set to an invalid value. |
| 40 | |
| 41 | n. Fixed a problem with the case-changing operators in the case where the |
| 42 | lower and upper case versions of a character do not have the same number |
| 43 | of bytes. |
| 44 | |
| 45 | o. Handle incremental and non-incremental search character reads returning EOF. |
| 46 | |
| 47 | p. Handle the case where a failing readline command at the end of a multi-key |
| 48 | sequence could be misinterpreted. |
| 49 | |
| 50 | q. The history library now prints a meaningful error message if the history |
| 51 | file isn't a regular file. |
| 52 | |
| 53 | r. Fixed a problem with vi-mode redo (`.') on a command when trying to replace |
| 54 | a multibyte character. |
| 55 | |
| 56 | s. The key binding code now attempts to remove a keymap if a key unbinding |
| 57 | leaves it empty. |
| 58 | |
| 59 | t. Fixed a line-wrapping issue that caused problems for some terminal |
| 60 | emulators. |
| 61 | |
| 62 | u. If there is a key bound to the tty's VDISCARD special character, readline |
| 63 | disables VDISCARD while it is active. |
| 64 | |
| 65 | v. Fixed a problem with exiting bracketed paste mode on terminals that assume |
| 66 | the bracketed paste mode character sequence contains visible characters. |
| 67 | |
| 68 | w. Fixed a bug that could cause a key binding command to refer to an |
| 69 | uninitialized variable. |
| 70 | |
| 71 | x. Added more UTF-8-specific versions of multibyte functions, and optimized |
| 72 | existing functions if the current locale uses UTF-8 encoding. |
| 73 | |
| 74 | y. Fixed a problem with bracketed-paste inserting more than one character and |
| 75 | interacting with other readline functions. |
| 76 | |
| 77 | z. Fixed a bug that caused the history library to attempt to append a history |
| 78 | line to a non-existent history entry. |
| 79 | |
| 80 | aa. If using bracketed paste mode, output a newline after the \r that is the |
| 81 | last character of the mode disable string to avoid overwriting output. |
| 82 | |
| 83 | bb. Fixes to the vi-mode `b', `B', `w', `W', `e', and `E' commands to better |
| 84 | handle multibyte characters. |
| 85 | |
| 86 | cc. Fixed a redisplay problem that caused an extra newline to be generated on |
| 87 | accept-line when the line length is exactly the screenwidth. |
| 88 | |
| 89 | dd. Fixed a bug with adding multibyte characters to an incremental search |
| 90 | string. |
| 91 | |
| 92 | ee. Fixed a bug with redoing text insertions in vi mode. |
| 93 | |
| 94 | ff. Fixed a bug with pasting text into an incremental search string if bracketed |
| 95 | paste mode is enabled. ESC cannot be one of the incremental search |
| 96 | terminator characters for this to work. |
| 97 | |
| 98 | gg. Fixed a bug with anchored search patterns when performing searches in vi |
| 99 | mode. |
| 100 | |
| 101 | 2. New Features in Readline |
| 102 | |
| 103 | a. Non-incremental vi-mode search (`N', `n') can search for a shell pattern, as |
| 104 | Posix specifies (uses fnmatch(3) if available). |
| 105 | |
| 106 | b. There are new `next-screen-line' and `previous-screen-line' bindable |
| 107 | commands, which move the cursor to the same column in the next, or previous, |
| 108 | physical line, respectively. |
| 109 | |
| 110 | c. There are default key bindings for control-arrow-key key combinations. |
| 111 | |
| 112 | d. A negative argument (-N) to `quoted-insert' means to insert the next N |
| 113 | characters using quoted-insert. |
| 114 | |
| 115 | e. New public function: rl_check_signals(), which allows applications to |
| 116 | respond to signals that readline catches while waiting for input using |
| 117 | a custom read function. |
| 118 | |
| 119 | f. There is new support for conditionally testing the readline version in an |
| 120 | inputrc file, with a full set of arithmetic comparison operators available. |
| 121 | |
| 122 | g. There is a simple variable comparison facility available for use within an |
| 123 | inputrc file. Allowable operators are equality and inequality; string |
| 124 | variables may be compared to a value; boolean variables must be compared to |
| 125 | either `on' or `off'; variable names are separated from the operator by |
| 126 | whitespace. |
| 127 | |
| 128 | h. The history expansion library now understands command and process |
| 129 | substitution and extended globbing and allows them to appear anywhere in a |
| 130 | word. |
| 131 | |
| 132 | i. The history library has a new variable that allows applications to set the |
| 133 | initial quoting state, so quoting state can be inherited from a previous |
| 134 | line. |
| 135 | |
| 136 | j. Readline now allows application-defined keymap names; there is a new public |
| 137 | function, rl_set_keymap_name(), to do that. |
| 138 | |
| 139 | k. The "Insert" keypad key, if available, now puts readline into overwrite |
| 140 | mode. |
| 141 | |
| 142 | ------------------------------------------------------------------------------- |
| 143 | This document details the changes between this version, readline-7.0, and the |
| 144 | previous version, readline-6.3. |
| 145 | |
| 146 | 1. Changes to Readline |
| 147 | |
| 148 | a. A bug that caused vi-mode `.' to be unable to redo `c', `d', and `y' |
| 149 | commands with modifiers was fixed. |
| 150 | |
| 151 | b. Fixed a bug that caused callback mode to dump core when reading a |
| 152 | multiple-key sequence (e.g., arrow keys). |
| 153 | |
| 154 | c. Fixed a bug that caused the redisplay code to erase some of the line when |
| 155 | using horizontal scrolling with incremental search. |
| 156 | |
| 157 | d. Readline's input handler now performs signal processing if read(2) is |
| 158 | interrupted by SIGALRM or SIGVTALRM. |
| 159 | |
| 160 | e. Fixed a problem with revert-all-at-newline freeing freed memory. |
| 161 | |
| 162 | f. Clarified the documentation for the history_quotes_inhibit_expansion |
| 163 | variable to note that it inhibits scanning for the history comment |
| 164 | character and that it only affects double-quoted strings. |
| 165 | |
| 166 | g. Fixed an off-by-one error in the prompt printed when performing searches. |
| 167 | |
| 168 | h. Use pselect(2), if available, to wait for input before calling read(2), so |
| 169 | a SIGWINCH can interrupt it, since it doesn't interrupt read(2). |
| 170 | |
| 171 | i. Some memory leaks caused by signals interrupting filename completion have |
| 172 | been fixed. |
| 173 | |
| 174 | j. Reading EOF twice on a non-empty line causes EOF to be returned, rather |
| 175 | than the partial line. This can cause partial lines to be executed on |
| 176 | SIGHUP, for example. |
| 177 | |
| 178 | k. Fixed a bug concerning deleting multibyte characters from the search |
| 179 | string while performing an incremental search. |
| 180 | |
| 181 | l. Fixed a bug with tilde expanding directory names in filename completion. |
| 182 | |
| 183 | m. Fixed a bug that did not allow binding sequences beginning with a `\'. |
| 184 | |
| 185 | n. Fixed a redisplay bug involving incorrect line wrapping when the prompt |
| 186 | contains a multibyte character in the last screen column. |
| 187 | |
| 188 | o. Fixed a bug that caused history expansion to disregard characters that are |
| 189 | documented to delimit a history event specifier without requiring `:'. |
| 190 | |
| 191 | p. Fixed a bug that could cause reading past the end of a string when reading |
| 192 | the value when binding the set of isearch terminators. |
| 193 | |
| 194 | q. Fixed a bug that caused readline commands that depend on knowing which |
| 195 | key invoked them to misbehave when dispatching key sequences that are |
| 196 | prefixes of other key bindings. |
| 197 | |
| 198 | r. Paren matching now works in vi insert mode. |
| 199 | |
| 200 | s. Colored completion prefixes are now displayed using a different color, less |
| 201 | likely to collide with files. |
| 202 | |
| 203 | t. Fixed a bug that caused vi-mode character search to misbehave when |
| 204 | running in callback mode. |
| 205 | |
| 206 | u. Fixed a bug that caused output to be delayed when input is coming from a |
| 207 | macro in vi-mode. |
| 208 | |
| 209 | v. Fixed a bug that caused the vi-mode `.' command to misbehave when redoing |
| 210 | a multi-key key sequence via a macro. |
| 211 | |
| 212 | w. Fixed a bug that caused problems with applications that supply their own |
| 213 | input function when performing completion. |
| 214 | |
| 215 | x. When read returns -1/EIO when attempting to read a key, return an error |
| 216 | instead of line termination back to the caller. |
| 217 | |
| 218 | y. Updated tty auditing feature based on patch from Red Hat. |
| 219 | |
| 220 | z. Fixed a bug that could cause the history library to crash on overflows |
| 221 | introduced by malicious editing of timestamps in the history file. |
| 222 | |
| 223 | aa. The history file writing functions only attempt to create and use a backup |
| 224 | history file if the history file exists and is a regular file. |
| 225 | |
| 226 | bb. Fixed an out-of-bounds read in readline's internal tilde expansion interface. |
| 227 | |
| 228 | cc. Fixed several redisplay bugs with prompt strings containing multibyte |
| 229 | and non-visible characters whose physical length is longer than the screen |
| 230 | width. |
| 231 | |
| 232 | dd. Fixed a redisplay bug with prompt strings containing invisible characters |
| 233 | whose physical length exceeds the screen width and using incremental search. |
| 234 | |
| 235 | ee. Readline prints more descriptive error messages when it encounters errors |
| 236 | while reading an inputrc file. |
| 237 | |
| 238 | ff. Fixed a bug in the character insertion code that attempts to optimize |
| 239 | typeahead when it reads a character that is not bound to self-insert and |
| 240 | resets the key sequence state. |
| 241 | |
| 242 | gg. When refreshing the line as the result of a key sequence, Readline attempts |
| 243 | to redraw only the last line of a multiline prompt. |
| 244 | |
| 245 | hh. Fixed an issue that caused completion of git commands to display |
| 246 | incorrectly when using colored-completion-prefix. |
| 247 | |
| 248 | ii. Fixed several redisplay bugs having to do with multibyte characters and |
| 249 | invisible characters in prompt strings. |
| 250 | |
| 251 | jj. Fixed a bug that caused mode strings to be displayed incorrectly if the |
| 252 | prompt was shorter than the mode string. |
| 253 | |
| 254 | 2. New Features in Readline |
| 255 | |
| 256 | a. The history truncation code now uses the same error recovery mechansim as |
| 257 | the history writing code, and restores the old version of the history file |
| 258 | on error. The error recovery mechanism handles symlinked history files. |
| 259 | |
| 260 | b. There is a new bindable variable, `enable-bracketed-paste', which enables |
| 261 | support for a terminal's bracketed paste mode. |
| 262 | |
| 263 | c. The editing mode indicators can now be strings and are user-settable |
| 264 | (new `emacs-mode-string', `vi-cmd-mode-string' and `vi-ins-mode-string' |
| 265 | variables). Mode strings can contain invisible character sequences. |
| 266 | Setting mode strings to null strings restores the defaults. |
| 267 | |
| 268 | d. Prompt expansion adds the mode string to the last line of a multi-line |
| 269 | prompt (one with embedded newlines). |
| 270 | |
| 271 | e. There is a new bindable variable, `colored-completion-prefix', which, if |
| 272 | set, causes the common prefix of a set of possible completions to be |
| 273 | displayed in color. |
| 274 | |
| 275 | f. There is a new bindable command `vi-yank-pop', a vi-mode version of emacs- |
| 276 | mode yank-pop. |
| 277 | |
| 278 | g. The redisplay code underwent several efficiency improvements for multibyte |
| 279 | locales. |
| 280 | |
| 281 | h. The insert-char function attempts to batch-insert all pending typeahead |
| 282 | that maps to self-insert, as long as it is coming from the terminal. |
| 283 | |
| 284 | i. rl_callback_sigcleanup: a new application function that can clean up and |
| 285 | unset any state set by readline's callback mode. Intended to be used |
| 286 | after a signal. |
| 287 | |
| 288 | j. If an incremental search string has its last character removed with DEL, the |
| 289 | resulting empty search string no longer matches the previous line. |
| 290 | |
| 291 | k. If readline reads a history file that begins with `#' (or the value of |
| 292 | the history comment character) and has enabled history timestamps, the history |
| 293 | entries are assumed to be delimited by timestamps. This allows multi-line |
| 294 | history entries. |
| 295 | |
| 296 | l. Readline now throws an error if it parses a key binding without a terminating |
| 297 | `:' or whitespace. |
| 298 | |
| 299 | m. The default binding for ^W in vi mode now uses word boundaries specified |
| 300 | by Posix (vi-unix-word-rubout is bindable command name). |
| 301 | |
| 302 | n. rl_clear_visible_line: new application-callable function; clears all |
| 303 | screen lines occupied by the current visible readline line. |
| 304 | |
| 305 | o. rl_tty_set_echoing: application-callable function that controls whether |
| 306 | or not readline thinks it is echoing terminal output. |
| 307 | |
| 308 | p. Handle >| and strings of digits preceding and following redirection |
| 309 | specifications as single tokens when tokenizing the line for history |
| 310 | expansion. |
| 311 | |
| 312 | q. Fixed a bug with displaying completions when the prefix display length |
| 313 | is greater than the length of the completions to be displayed. |
| 314 | |
| 315 | r. The :p history modifier now applies to the entire line, so any expansion |
| 316 | specifying :p causes the line to be printed instead of expanded. |
| 317 | |
| 318 | s. New application-callable function: rl_pending_signal(): returns the signal |
| 319 | number of any signal readline has caught but not yet handled. |
| 320 | |
| 321 | t. New application-settable variable: rl_persistent_signal_handlers: if set |
| 322 | to a non-zero value, readline will enable the readline-6.2 signal handler |
| 323 | behavior in callback mode: handlers are installed when |
| 324 | rl_callback_handler_install is called and removed removed when a complete |
| 325 | line has been read. |
| 326 | |
| 327 | ------------------------------------------------------------------------------- |
| 328 | This document details the changes between this version, readline-6.3, and the |
| 329 | previous version, readline-6.2. |
| 330 | |
| 331 | 1. Changes to Readline |
| 332 | |
| 333 | a. Fixed a bug that did not allow the `dd', `cc', or `yy' vi editing mode |
| 334 | commands to work on the entire line. |
| 335 | |
| 336 | b. Fixed a bug that caused redisplay problems with prompts longer than 128 |
| 337 | characters and history searches. |
| 338 | |
| 339 | c. Fixed a bug that caused readline to try and run code to modify its idea |
| 340 | of the screen size in a signal handler context upon receiving a SIGWINCH. |
| 341 | |
| 342 | d. Fixed a bug that caused the `meta' key to be enabled beyond the duration |
| 343 | of an individual call top readline(). |
| 344 | |
| 345 | e. Added a workaround for a wcwidth bug in Mac OS X that caused readline's |
| 346 | redisplay to mishandle zero-width combining characters. |
| 347 | |
| 348 | f. Fixed a bug that caused readline to `forget' part of a key sequence when |
| 349 | a multiple-key sequence caused it to break out of an incremental search. |
| 350 | |
| 351 | g. Fixed bugs that caused readline to execute code in a signal handler |
| 352 | context if interrupted while reading from the file system during completion. |
| 353 | |
| 354 | h. Fixed a bug that caused readline to `forget' part of a key sequence when |
| 355 | reading an unbound multi-character key sequence. |
| 356 | |
| 357 | i. Fixed a bug that caused Readline's signal handlers to be installed beyond |
| 358 | the bounds of a single call to readline(). |
| 359 | |
| 360 | j. Fixed a bug that caused the `.' command to not redo the most recent `R' |
| 361 | command in vi mode. |
| 362 | |
| 363 | k. Fixed a bug that caused ignoring case in completion matches to result in |
| 364 | readline using the wrong match. |
| 365 | |
| 366 | l. Paren matching now works in vi insert mode. |
| 367 | |
| 368 | m. Fix menu-completion to make show-all-if-ambiguous and menu-complete-display-prefix |
| 369 | work together. |
| 370 | |
| 371 | n. Fixed a bug that didn't allow the `cc', `dd', or `yy' commands to be redone |
| 372 | in vi editing mode. |
| 373 | |
| 374 | o. Fixed a bug that caused the filename comparison code to not compare |
| 375 | multibyte characters correctly when using case-sensitive or case-mapping |
| 376 | comparisons. |
| 377 | |
| 378 | p. Fixed the input reading loop to call the input hook function only when there |
| 379 | is no terminal input available. |
| 380 | |
| 381 | q. Fixed a bug that caused binding a macro to a multi-character key sequence |
| 382 | where the sequence and macro value share a common prefix to not perform |
| 383 | the macro replacement. |
| 384 | |
| 385 | r. Fixed several redisplay errors with multibyte characters and prompts |
| 386 | containing invisible characters when using horizontal scrolling. |
| 387 | |
| 388 | s. Fixed a bug that caused redisplay errors when trying to overwrite |
| 389 | existing characters using multibyte characters. |
| 390 | |
| 391 | t. Fixed a bug in vi mode that caused the arrow keys to set the saved last |
| 392 | vi-mode command to the wrong value. |
| 393 | |
| 394 | u. Fixed a bug that caused double-quoted strings to be scanned incorrectly |
| 395 | when being used as the value of a readline variable assignment. |
| 396 | |
| 397 | v. Fixed a bug with vi mode that prevented `.' from repeating a command |
| 398 | entered on a previous line (command). |
| 399 | |
| 400 | w. Fixed a bug that could cause completion to core dump if it was interrupted |
| 401 | by a signal. |
| 402 | |
| 403 | x. Fixed a bug that could cause readline to crash and seg fault attempting to |
| 404 | expand an empty history entry. |
| 405 | |
| 406 | y. Fixed a bug that caused display problems with multi-line prompts containing |
| 407 | invisible characters on multiple lines. |
| 408 | |
| 409 | z. Fixed a bug that caused effects made by undoing changes to a history line to |
| 410 | be discarded. |
| 411 | |
| 412 | 2. New Features in Readline |
| 413 | |
| 414 | a. Readline is now more responsive to SIGHUP and other fatal signals when |
| 415 | reading input from the terminal or performing word completion but no |
| 416 | longer attempts to run any not-allowable functions from a signal handler |
| 417 | context. |
| 418 | |
| 419 | b. There are new bindable commands to search the history for the string of |
| 420 | characters between the beginning of the line and the point |
| 421 | (history-substring-search-forward, history-substring-search-backward) |
| 422 | |
| 423 | c. Readline allows quoted strings as the values of variables when setting |
| 424 | them with `set'. As a side effect, trailing spaces and tabs are ignored |
| 425 | when setting a string variable's value. |
| 426 | |
| 427 | d. The history library creates a backup of the history file when writing it |
| 428 | and restores the backup on a write error. |
| 429 | |
| 430 | e. New application-settable variable: rl_filename_stat_hook: a function called |
| 431 | with a filename before using it in a call to stat(2). Bash uses it to |
| 432 | expand shell variables so things like $HOME/Downloads have a slash |
| 433 | appended. |
| 434 | |
| 435 | f. New bindable function `print-last-kbd-macro', prints the most-recently- |
| 436 | defined keyboard macro in a reusable format. |
| 437 | |
| 438 | g. New user-settable variable `colored-stats', enables use of colored text |
| 439 | to denote file types when displaying possible completions (colored analog |
| 440 | of visible-stats). |
| 441 | |
| 442 | h. New user-settable variable `keyseq-timout', acts as an inter-character |
| 443 | timeout when reading input or incremental search strings. |
| 444 | |
| 445 | i. New application-callable function: rl_clear_history. Clears the history list |
| 446 | and frees all readline-associated private data. |
| 447 | |
| 448 | j. New user-settable variable, show-mode-in-prompt, adds a characters to the |
| 449 | beginning of the prompt indicating the current editing mode. |
| 450 | |
| 451 | k. New application-settable variable: rl_input_available_hook; function to be |
| 452 | called when readline needs to check whether there is data available on its |
| 453 | input source. The default hook checks rl_instream. |
| 454 | |
| 455 | l. Readline calls an application-set event hook (rl_signal_event_hook) after |
| 456 | it gets a signal while reading input (read returns -1/EINTR but readline |
| 457 | does not handle the signal immediately) to allow the application to handle |
| 458 | or otherwise note it. Not currently called for SIGHUP or SIGTERM. |
| 459 | |
| 460 | m. If the user-settable variable `history-size' is set to a value less than |
| 461 | 0, the history list size is unlimited. |
| 462 | |
| 463 | n. When creating shared libraries on Mac OS X, the pathname written into the |
| 464 | library (install_name) no longer includes the minor version number. |
| 465 | |
| 466 | ------------------------------------------------------------------------------- |
| 467 | This document details the changes between this version, readline-6.2, |
| 468 | and the previous version, readline-6.1. |
| 469 | |
| 470 | 1. Changes to Readline |
| 471 | |
| 472 | a. Fixed a bug that caused the unconverted filename to be added to the list of |
| 473 | completions when the application specified filename conversion functions. |
| 474 | |
| 475 | b. Fixed a bug that caused the wrong filename to be passed to opendir when the |
| 476 | application has specified a filename dequoting function. |
| 477 | |
| 478 | c. Fixed a bug when repeating a character search in vi mode in the case where |
| 479 | there was no search to repeat. |
| 480 | |
| 481 | d. When show-all-if-ambiguous is set, the completion routines no longer insert |
| 482 | a common match prefix that is shorter than the text being completed. |
| 483 | |
| 484 | e. The full set of vi editing commands may now be used in callback mode. |
| 485 | |
| 486 | f. Fixed a bug that caused readline to not update its idea of the terminal |
| 487 | dimensions while running in `no-echo' mode. |
| 488 | |
| 489 | h. Fixed a bug that caused readline to dump core if an application called |
| 490 | rl_prep_terminal without setting rl_instream. |
| 491 | |
| 492 | i. Fixed a bug that caused meta-prefixed characters bound to incremental |
| 493 | search forward or backward to not be recognized if they were typed |
| 494 | subsequently. |
| 495 | |
| 496 | j. The incremental search code treats key sequences that map to the same |
| 497 | functions as (default) ^G, ^W, and ^Y as equivalent to those characters. |
| 498 | |
| 499 | k. Fixed a bug in menu-complete that caused it to misbehave with large |
| 500 | negative argument. |
| 501 | |
| 502 | l. Fixed a bug that caused vi-mode yank-last-arg to ring the bell when invoked |
| 503 | at the end of the line. |
| 504 | |
| 505 | m. Fixed a bug that made an explicit argument of 0 to yank-last-arg behave |
| 506 | as if it were a negative argument. |
| 507 | |
| 508 | n. Fixed a bug that caused directory names in words to be completed to not |
| 509 | be dequoted correctly. |
| 510 | |
| 511 | 2. New Features in Readline |
| 512 | |
| 513 | a. The history library does not try to write the history filename in the |
| 514 | current directory if $HOME is unset. This closes a potential security |
| 515 | problem if the application does not specify a history filename. |
| 516 | |
| 517 | b. New bindable variable `completion-display-width' to set the number of |
| 518 | columns used when displaying completions. |
| 519 | |
| 520 | c. New bindable variable `completion-case-map' to cause case-insensitive |
| 521 | completion to treat `-' and `_' as identical. |
| 522 | |
| 523 | d. There are new bindable vi-mode command names to avoid readline's case- |
| 524 | insensitive matching not allowing them to be bound separately. |
| 525 | |
| 526 | e. New bindable variable `menu-complete-display-prefix' causes the menu |
| 527 | completion code to display the common prefix of the possible completions |
| 528 | before cycling through the list, instead of after. |
| 529 | |
| 530 | ------------------------------------------------------------------------------- |
| 531 | This document details the changes between this version, readline-6.1, |
| 532 | and the previous version, readline-6.0. |
| 533 | |
| 534 | 1. Changes to Readline |
| 535 | |
| 536 | a. The SIGWINCH signal handler now avoids calling the redisplay code if |
| 537 | one arrives while in the middle of redisplay. |
| 538 | |
| 539 | b. Changes to the timeout code to make sure that timeout values greater |
| 540 | than one second are handled better. |
| 541 | |
| 542 | c. Fixed a bug in the redisplay code that was triggered by a prompt |
| 543 | containing invisible characters exactly the width of the screen. |
| 544 | |
| 545 | d. Fixed a bug in the redisplay code encountered when running in horizontal |
| 546 | scroll mode. |
| 547 | |
| 548 | e. Fixed a bug that prevented menu completion from properly completing |
| 549 | filenames. |
| 550 | |
| 551 | f. Fixed a redisplay bug caused by a multibyte character causing a line to |
| 552 | wrap. |
| 553 | |
| 554 | g. Fixed a bug that caused key sequences of two characters to not be |
| 555 | recognized when a longer sequence identical in the first two characters |
| 556 | was bound. |
| 557 | |
| 558 | h. Fixed a bug that caused history expansion to be attempted on $'...' |
| 559 | single-quoted strings. |
| 560 | |
| 561 | i. Fixed a bug that caused incorrect redisplay when the prompt contained |
| 562 | multibyte characters in an `invisible' sequence bracketed by \[ and |
| 563 | \]. |
| 564 | |
| 565 | j. Fixed a bug that caused history expansion to short-circuit after |
| 566 | encountering a multibyte character. |
| 567 | |
| 568 | k. Fixed a bug that caused applications using the callback interface to not |
| 569 | react to SIGINT (or other signals) until another character arrived. |
| 570 | |
| 571 | 2. New Features in Readline |
| 572 | |
| 573 | a. New bindable function: menu-complete-backward. |
| 574 | |
| 575 | b. In the vi insertion keymap, C-n is now bound to menu-complete by default, |
| 576 | and C-p to menu-complete-backward. |
| 577 | |
| 578 | c. When in vi command mode, repeatedly hitting ESC now does nothing, even |
| 579 | when ESC introduces a bound key sequence. This is closer to how |
| 580 | historical vi behaves. |
| 581 | |
| 582 | d. New bindable function: skip-csi-sequence. Can be used as a default to |
| 583 | consume key sequences generated by keys like Home and End without having |
| 584 | to bind all keys. |
| 585 | |
| 586 | e. New application-settable function: rl_filename_rewrite_hook. Can be used |
| 587 | to rewite or modify filenames read from the file system before they are |
| 588 | compared to the word to be completed. |
| 589 | |
| 590 | f. New bindable variable: skip-completed-text, active when completing in the |
| 591 | middle of a word. If enabled, it means that characters in the completion |
| 592 | that match characters in the remainder of the word are "skipped" rather |
| 593 | than inserted into the line. |
| 594 | |
| 595 | g. The pre-readline-6.0 version of menu completion is available as |
| 596 | "old-menu-complete" for users who do not like the readline-6.0 version. |
| 597 | |
| 598 | h. New bindable variable: echo-control-characters. If enabled, and the |
| 599 | tty ECHOCTL bit is set, controls the echoing of characters corresponding |
| 600 | to keyboard-generated signals. |
| 601 | |
| 602 | i. New bindable variable: enable-meta-key. Controls whether or not readline |
| 603 | sends the smm/rmm sequences if the terminal indicates it has a meta key |
| 604 | that enables eight-bit characters. |
| 605 | |
| 606 | ------------------------------------------------------------------------------- |
| 607 | This document details the changes between this version, readline-6.0, |
| 608 | and the previous version, readline-5.2. |
| 609 | |
| 610 | 1. Changes to Readline |
| 611 | |
| 612 | a. Fixed a number of redisplay errors in environments supporting multibyte |
| 613 | characters. |
| 614 | |
| 615 | b. Fixed bugs in vi command mode that caused motion commands to inappropriately |
| 616 | set the mark. |
| 617 | |
| 618 | c. When using the arrow keys in vi insertion mode, readline allows movement |
| 619 | beyond the current end of the line (unlike command mode). |
| 620 | |
| 621 | d. Fixed bugs that caused readline to loop when the terminal has been taken |
| 622 | away and reads return -1/EIO. |
| 623 | |
| 624 | e. Fixed bugs in redisplay occurring when displaying prompts containing |
| 625 | invisible characters. |
| 626 | |
| 627 | f. Fixed a bug that caused the completion append character to not be reset to |
| 628 | the default after an application-specified completion function changed it. |
| 629 | |
| 630 | g. Fixed a problem that caused incorrect positioning of the cursor while in |
| 631 | emacs editing mode when moving forward at the end of a line while using |
| 632 | a locale supporting multibyte characters. |
| 633 | |
| 634 | h. Fixed an off-by-one error that caused readline to drop every 511th |
| 635 | character of buffered input. |
| 636 | |
| 637 | i. Fixed a bug that resulted in SIGTERM not being caught or cleaned up. |
| 638 | |
| 639 | j. Fixed redisplay bugs caused by multiline prompts with invisible characters |
| 640 | or no characters following the final newline. |
| 641 | |
| 642 | k. Fixed redisplay bug caused by prompts consisting solely of invisible |
| 643 | characters. |
| 644 | |
| 645 | l. Fixed a bug in the code that buffers characters received very quickly in |
| 646 | succession which caused characters to be dropped. |
| 647 | |
| 648 | m. Fixed a bug that caused readline to reference uninitialized data structures |
| 649 | if it received a SIGWINCH before completing initialzation. |
| 650 | |
| 651 | n. Fixed a bug that caused the vi-mode `last command' to be set incorrectly |
| 652 | and therefore unrepeatable. |
| 653 | |
| 654 | o. Fixed a bug that caused readline to disable echoing when it was being used |
| 655 | with an output file descriptor that was not a terminal. |
| 656 | |
| 657 | p. Readline now blocks SIGINT while manipulating internal data structures |
| 658 | during redisplay. |
| 659 | |
| 660 | q. Fixed a bug in redisplay that caused readline to segfault when pasting a |
| 661 | very long line (over 130,000 characters). |
| 662 | |
| 663 | r. Fixed bugs in redisplay when using prompts with no visible printing |
| 664 | characters. |
| 665 | |
| 666 | s. Fixed a bug that caused redisplay errors when using prompts with invisible |
| 667 | characters and numeric arguments to a command in a multibyte locale. |
| 668 | |
| 669 | t. Fixed a bug that caused redisplay errors when using prompts with invisible |
| 670 | characters spanning more than two physical screen lines. |
| 671 | |
| 672 | 2. New Features in Readline |
| 673 | |
| 674 | a. A new variable, rl_sort_completion_matches; allows applications to inhibit |
| 675 | match list sorting (but beware: some things don't work right if |
| 676 | applications do this). |
| 677 | |
| 678 | b. A new variable, rl_completion_invoking_key; allows applications to discover |
| 679 | the key that invoked rl_complete or rl_menu_complete. |
| 680 | |
| 681 | c. The functions rl_block_sigint and rl_release_sigint are now public and |
| 682 | available to calling applications who want to protect critical sections |
| 683 | (like redisplay). |
| 684 | |
| 685 | d. The functions rl_save_state and rl_restore_state are now public and |
| 686 | available to calling applications; documented rest of readline's state |
| 687 | flag values. |
| 688 | |
| 689 | e. A new user-settable variable, `history-size', allows setting the maximum |
| 690 | number of entries in the history list. |
| 691 | |
| 692 | f. There is a new implementation of menu completion, with several improvements |
| 693 | over the old; the most notable improvement is a better `completions |
| 694 | browsing' mode. |
| 695 | |
| 696 | g. The menu completion code now uses the rl_menu_completion_entry_function |
| 697 | variable, allowing applications to provide their own menu completion |
| 698 | generators. |
| 699 | |
| 700 | h. There is support for replacing a prefix of a pathname with a `...' when |
| 701 | displaying possible completions. This is controllable by setting the |
| 702 | `completion-prefix-display-length' variable. Matches with a common prefix |
| 703 | longer than this value have the common prefix replaced with `...'. |
| 704 | |
| 705 | i. There is a new `revert-all-at-newline' variable. If enabled, readline will |
| 706 | undo all outstanding changes to all history lines when `accept-line' is |
| 707 | executed. |
| 708 | |
| 709 | ------------------------------------------------------------------------------- |
| 710 | This document details the changes between this version, readline-5.2, |
| 711 | and the previous version, readline-5.1. |
| 712 | |
| 713 | 1. Changes to Readline |
| 714 | |
| 715 | a. Fixed a problem that caused segmentation faults when using readline in |
| 716 | callback mode and typing consecutive DEL characters on an empty line. |
| 717 | |
| 718 | b. Fixed several redisplay problems with multibyte characters, all having to |
| 719 | do with the different code paths and variable meanings between single-byte |
| 720 | and multibyte character redisplay. |
| 721 | |
| 722 | c. Fixed a problem with key sequence translation when presented with the |
| 723 | sequence \M-\C-x. |
| 724 | |
| 725 | d. Fixed a problem that prevented the `a' command in vi mode from being |
| 726 | undone and redone properly. |
| 727 | |
| 728 | e. Fixed a problem that prevented empty inserts in vi mode from being undone |
| 729 | properly. |
| 730 | |
| 731 | f. Fixed a problem that caused readline to initialize with an incorrect idea |
| 732 | of whether or not the terminal can autowrap. |
| 733 | |
| 734 | g. Fixed output of key bindings (like bash `bind -p') to honor the setting of |
| 735 | convert-meta and use \e where appropriate. |
| 736 | |
| 737 | h. Changed the default filename completion function to call the filename |
| 738 | dequoting function if the directory completion hook isn't set. This means |
| 739 | that any directory completion hooks need to dequote the directory name, |
| 740 | since application-specific hooks need to know how the word was quoted, |
| 741 | even if no other changes are made. |
| 742 | |
| 743 | i. Fixed a bug with creating the prompt for a non-interactive search string |
| 744 | when there are non-printing characters in the primary prompt. |
| 745 | |
| 746 | j. Fixed a bug that caused prompts with invisible characters to be redrawn |
| 747 | multiple times in a multibyte locale. |
| 748 | |
| 749 | k. Fixed a bug that could cause the key sequence scanning code to return the |
| 750 | wrong function. |
| 751 | |
| 752 | l. Fixed a problem with the callback interface that caused it to fail when |
| 753 | using multi-character keyboard macros. |
| 754 | |
| 755 | m. Fixed a bug that could cause a core dump when an edited history entry was |
| 756 | re-executed under certain conditions. |
| 757 | |
| 758 | n. Fixed a bug that caused readline to reference freed memory when attmpting |
| 759 | to display a portion of the prompt. |
| 760 | |
| 761 | o. Fixed a bug with prompt redisplay in a multi-byte locale to avoid redrawing |
| 762 | the prompt and input line multiple times. |
| 763 | |
| 764 | p. Fixed history expansion to not be confused by here-string redirection. |
| 765 | |
| 766 | q. Readline no longer treats read errors by converting them to newlines, as |
| 767 | it does with EOF. This caused partial lines to be returned from readline(). |
| 768 | |
| 769 | r. Fixed a redisplay bug that occurred in multibyte-capable locales when the |
| 770 | prompt was one character longer than the screen width. |
| 771 | |
| 772 | 2. New Features in Readline |
| 773 | |
| 774 | a. Calling applications can now set the keyboard timeout to 0, allowing |
| 775 | poll-like behavior. |
| 776 | |
| 777 | b. The value of SYS_INPUTRC (configurable at compilation time) is now used as |
| 778 | the default last-ditch startup file. |
| 779 | |
| 780 | c. The history file reading functions now allow windows-like \r\n line |
| 781 | terminators. |
| 782 | |
| 783 | ------------------------------------------------------------------------------- |
| 784 | This document details the changes between this version, readline-5.1, |
| 785 | and the previous version, readline-5.0. |
| 786 | |
| 787 | 1. Changes to Readline |
| 788 | |
| 789 | a. Fixed a bug that caused multiliine prompts to be wrapped and displayed |
| 790 | incorrectly. |
| 791 | |
| 792 | b. Fixed a bug that caused ^P/^N in emacs mode to fail to display the current |
| 793 | line correctly. |
| 794 | |
| 795 | c. Fixed a problem in computing the number of invisible characters on the first |
| 796 | line of a prompt whose length exceeds the screen width. |
| 797 | |
| 798 | d. Fixed vi-mode searching so that failure preserves the current line rather |
| 799 | than the last line in the history list. |
| 800 | |
| 801 | e. Fixed the vi-mode `~' command (change-case) to have the correct behavior at |
| 802 | end-of-line when manipulating multibyte characters. |
| 803 | |
| 804 | f. Fixed the vi-mode `r' command (change-char) to have the correct behavior at |
| 805 | end-of-line when manipulating multibyte characters. |
| 806 | |
| 807 | g. Fixed multiple bugs in the redisplay of multibyte characters: displaying |
| 808 | prompts longer than the screen width containing multibyte characters, |
| 809 | |
| 810 | h. Fix the calculation of the number of physical characters in the prompt |
| 811 | string when it contains multibyte characters. |
| 812 | |
| 813 | i. A non-zero value for the `rl_complete_suppress_append' variable now causes |
| 814 | no `/' to be appended to a directory name. |
| 815 | |
| 816 | j. Fixed forward-word and backward-word to work when words contained |
| 817 | multibyte characters. |
| 818 | |
| 819 | k. Fixed a bug in finding the delimiter of a `?' substring when performing |
| 820 | history expansion in a locale that supports multibyte characters. |
| 821 | |
| 822 | l. Fixed a memory leak caused by not freeing the timestamp in a history entry. |
| 823 | |
| 824 | m. Fixed a bug that caused "\M-x" style key bindings to not obey the setting |
| 825 | of the `convert-meta' variable. |
| 826 | |
| 827 | n. Fixed saving and restoring primary prompt when prompting for incremental |
| 828 | and non-incremental searches; search prompts now display multibyte |
| 829 | characters correctly. |
| 830 | |
| 831 | o. Fixed a bug that caused keys originally bound to self-insert but shadowed |
| 832 | by a multi-character key sequence to not be inserted. |
| 833 | |
| 834 | p. Fixed code so rl_prep_term_function and rl_deprep_term_function aren't |
| 835 | dereferenced if NULL (matching the documentation). |
| 836 | |
| 837 | q. Extensive changes to readline to add enough state so that commands |
| 838 | requiring additional characters (searches, multi-key sequences, numeric |
| 839 | arguments, commands requiring an additional specifier character like |
| 840 | vi-mode change-char, etc.) work without synchronously waiting for |
| 841 | additional input. |
| 842 | |
| 843 | r. Lots of changes so readline builds and runs on MinGW. |
| 844 | |
| 845 | s. Readline no longer tries to modify the terminal settings when running in |
| 846 | callback mode. |
| 847 | |
| 848 | t. The Readline display code no longer sets the location of the last invisible |
| 849 | character in the prompt if the \[\] sequence is empty. |
| 850 | |
| 851 | u. The `change-case' command now correctly changes the case of multibyte |
| 852 | characters. |
| 853 | |
| 854 | v. Changes to the shared library construction scripts to deal with Windows |
| 855 | DLL naming conventions for Cygwin. |
| 856 | |
| 857 | w. Fixed the redisplay code to avoid core dumps resulting from a poorly-timed |
| 858 | SIGWINCH. |
| 859 | |
| 860 | x. Fixed the non-incremental search code in vi mode to dispose of any current |
| 861 | undo list when copying a line from the history into the current editing |
| 862 | buffer. |
| 863 | |
| 864 | y. Fixed a bug that caused reversing the incremental search direction to |
| 865 | not work correctly. |
| 866 | |
| 867 | z. Fixed the vi-mode `U' command to only undo up to the first time insert mode |
| 868 | was entered, as Posix specifies. |
| 869 | |
| 870 | aa. Fixed a bug in the vi-mode `r' command that left the cursor in the wrong |
| 871 | place. |
| 872 | |
| 873 | bb. Fixed a redisplay bug caused by moving the cursor vertically to a line |
| 874 | with invisible characters in the prompt in a multibyte locale. |
| 875 | |
| 876 | cc. Fixed a bug that could cause the terminal special chars to be bound in the |
| 877 | wrong keymap in vi mode. |
| 878 | |
| 879 | 2. New Features in Readline |
| 880 | |
| 881 | a. The key sequence sent by the keypad `delete' key is now automatically |
| 882 | bound to delete-char. |
| 883 | |
| 884 | b. A negative argument to menu-complete now cycles backward through the |
| 885 | completion list. |
| 886 | |
| 887 | c. A new bindable readline variable: bind-tty-special-chars. If non-zero, |
| 888 | readline will bind the terminal special characters to their readline |
| 889 | equivalents when it's called (on by default). |
| 890 | |
| 891 | d. New bindable command: vi-rubout. Saves deleted text for possible |
| 892 | reinsertion, as with any vi-mode `text modification' command; `X' is bound |
| 893 | to this in vi command mode. |
| 894 | |
| 895 | e. If the rl_completion_query_items is set to a value < 0, readline never |
| 896 | asks the user whether or not to view the possible completions. |
| 897 | |
| 898 | f. The `C-w' binding in incremental search now understands multibyte |
| 899 | characters. |
| 900 | |
| 901 | g. New application-callable auxiliary function, rl_variable_value, returns |
| 902 | a string corresponding to a readline variable's value. |
| 903 | |
| 904 | h. When parsing inputrc files and variable binding commands, the parser |
| 905 | strips trailing whitespace from values assigned to boolean variables |
| 906 | before checking them. |
| 907 | |
| 908 | i. A new external application-controllable variable that allows the LINES |
| 909 | and COLUMNS environment variables to set the window size regardless of |
| 910 | what the kernel returns. |
| 911 | |
| 912 | ------------------------------------------------------------------------------- |
| 913 | This document details the changes between this version, readline-5.0, |
| 914 | and the previous version, readline-4.3. |
| 915 | |
| 916 | 1. Changes to Readline |
| 917 | |
| 918 | a. Fixes to avoid core dumps because of null pointer references in the |
| 919 | multibyte character code. |
| 920 | |
| 921 | b. Fix to avoid infinite recursion caused by certain key combinations. |
| 922 | |
| 923 | c. Fixed a bug that caused the vi-mode `last command' to be set incorrectly. |
| 924 | |
| 925 | d. Readline no longer tries to read ahead more than one line of input, even |
| 926 | when more is available. |
| 927 | |
| 928 | e. Fixed the code that adjusts the point to not mishandle null wide |
| 929 | characters. |
| 930 | |
| 931 | f. Fixed a bug in the history expansion `g' modifier that caused it to skip |
| 932 | every other match. |
| 933 | |
| 934 | g. Fixed a bug that caused the prompt to overwrite previous output when the |
| 935 | output doesn't contain a newline and the locale supports multibyte |
| 936 | characters. This same change fixes the problem of readline redisplay |
| 937 | slowing down dramatically as the line gets longer in multibyte locales. |
| 938 | |
| 939 | h. History traversal with arrow keys in vi insertion mode causes the cursor |
| 940 | to be placed at the end of the new line, like in emacs mode. |
| 941 | |
| 942 | i. The locale initialization code does a better job of using the right |
| 943 | precedence and defaulting when checking the appropriate environment |
| 944 | variables. |
| 945 | |
| 946 | j. Fixed the history word tokenizer to handle <( and >( better when used as |
| 947 | part of bash. |
| 948 | |
| 949 | k. The overwrite mode code received several bug fixes to improve undo. |
| 950 | |
| 951 | l. Many speedups to the multibyte character redisplay code. |
| 952 | |
| 953 | m. The callback character reading interface should not hang waiting to read |
| 954 | keyboard input. |
| 955 | |
| 956 | n. Fixed a bug with redoing vi-mode `s' command. |
| 957 | |
| 958 | o. The code that initializes the terminal tracks changes made to the terminal |
| 959 | special characters with stty(1) (or equivalent), so that these changes |
| 960 | are reflected in the readline bindings. New application-callable function |
| 961 | to make it work: rl_tty_unset_default_bindings(). |
| 962 | |
| 963 | p. Fixed a bug that could cause garbage to be inserted in the buffer when |
| 964 | changing character case in vi mode when using a multibyte locale. |
| 965 | |
| 966 | q. Fixed a bug in the redisplay code that caused problems on systems |
| 967 | supporting multibyte characters when moving between history lines when the |
| 968 | new line has more glyphs but fewer bytes. |
| 969 | |
| 970 | r. Undo and redo now work better after exiting vi insertion mode. |
| 971 | |
| 972 | s. Make sure system calls are restarted after a SIGWINCH is received using |
| 973 | SA_RESTART. |
| 974 | |
| 975 | t. Improvements to the code that displays possible completions when using |
| 976 | multibyte characters. |
| 977 | |
| 978 | u. Fixed a problem when parsing nested if statements in inputrc files. |
| 979 | |
| 980 | v. The completer now takes multibyte characters into account when looking for |
| 981 | quoted substrings on which to perform completion. |
| 982 | |
| 983 | w. The history search functions now perform better bounds checking on the |
| 984 | history list. |
| 985 | |
| 986 | x. Change to history expansion functions to treat `^' as equivalent to word |
| 987 | one, as the documention states. |
| 988 | |
| 989 | y. Some changes to the display code to improve display and redisplay of |
| 990 | multibyte characters. |
| 991 | |
| 992 | z. Changes to speed up the multibyte character redisplay code. |
| 993 | |
| 994 | aa. Fixed a bug in the vi-mode `E' command that caused it to skip over the |
| 995 | last character of a word if invoked while point was on the word's |
| 996 | next-to-last character. |
| 997 | |
| 998 | bb. Fixed a bug that could cause incorrect filename quoting when |
| 999 | case-insensitive completion was enabled and the word being completed |
| 1000 | contained backslashes quoting word break characters. |
| 1001 | |
| 1002 | cc. Fixed a bug in redisplay triggered when the prompt string contains |
| 1003 | invisible characters. |
| 1004 | |
| 1005 | dd. Fixed some display (and other) bugs encountered in multibyte locales |
| 1006 | when a non-ascii character was the last character on a line. |
| 1007 | |
| 1008 | ee. Fixed some display bugs caused by multibyte characters in prompt strings. |
| 1009 | |
| 1010 | ff. Fixed a problem with history expansion caused by non-whitespace characters |
| 1011 | used as history word delimiters. |
| 1012 | |
| 1013 | gg. Fixed a problem that could cause readline to refer to freed memory when |
| 1014 | moving between history lines while doing searches. |
| 1015 | |
| 1016 | hh. Improvements to the code that expands and displays prompt strings |
| 1017 | containing multibyte characters. |
| 1018 | |
| 1019 | ii. Fixed a problem with vi-mode not correctly remembering the numeric argument |
| 1020 | to the last `c'hange command for later use with `.'. |
| 1021 | |
| 1022 | jj. Fixed a bug in vi-mode that caused multi-digit count arguments to work |
| 1023 | incorrectly. |
| 1024 | |
| 1025 | kk. Fixed a problem in vi-mode that caused the last text modification command |
| 1026 | to not be remembered across different command lines. |
| 1027 | |
| 1028 | ll. Fixed problems with changing characters and changing case at the end of |
| 1029 | the line. |
| 1030 | |
| 1031 | mm. Fixed a problem with readline saving the contents of the current line |
| 1032 | before beginning a non-interactive search. |
| 1033 | |
| 1034 | nn. Fixed a problem with EOF detection when using rl_event_hook. |
| 1035 | |
| 1036 | oo. Fixed a problem with the vi mode `p' and `P' commands ignoring numeric |
| 1037 | arguments. |
| 1038 | |
| 1039 | 2. New Features in Readline |
| 1040 | |
| 1041 | a. History expansion has a new `a' modifier equivalent to the `g' modifier |
| 1042 | for compatibility with the BSD csh. |
| 1043 | |
| 1044 | b. History expansion has a new `G' modifier equivalent to the BSD csh `g' |
| 1045 | modifier, which performs a substitution once per word. |
| 1046 | |
| 1047 | c. All non-incremental search operations may now undo the operation of |
| 1048 | replacing the current line with the history line. |
| 1049 | |
| 1050 | d. The text inserted by an `a' command in vi mode can be reinserted with |
| 1051 | `.'. |
| 1052 | |
| 1053 | e. New bindable variable, `show-all-if-unmodified'. If set, the readline |
| 1054 | completer will list possible completions immediately if there is more |
| 1055 | than one completion and partial completion cannot be performed. |
| 1056 | |
| 1057 | f. There is a new application-callable `free_history_entry()' function. |
| 1058 | |
| 1059 | g. History list entries now contain timestamp information; the history file |
| 1060 | functions know how to read and write timestamp information associated |
| 1061 | with each entry. |
| 1062 | |
| 1063 | h. Four new key binding functions have been added: |
| 1064 | |
| 1065 | rl_bind_key_if_unbound() |
| 1066 | rl_bind_key_if_unbound_in_map() |
| 1067 | rl_bind_keyseq_if_unbound() |
| 1068 | rl_bind_keyseq_if_unbound_in_map() |
| 1069 | |
| 1070 | i. New application variable, rl_completion_quote_character, set to any |
| 1071 | quote character readline finds before it calls the application completion |
| 1072 | function. |
| 1073 | |
| 1074 | j. New application variable, rl_completion_suppress_quote, settable by an |
| 1075 | application completion function. If set to non-zero, readline does not |
| 1076 | attempt to append a closing quote to a completed word. |
| 1077 | |
| 1078 | k. New application variable, rl_completion_found_quote, set to a non-zero |
| 1079 | value if readline determines that the word to be completed is quoted. |
| 1080 | Set before readline calls any application completion function. |
| 1081 | |
| 1082 | l. New function hook, rl_completion_word_break_hook, called when readline |
| 1083 | needs to break a line into words when completion is attempted. Allows |
| 1084 | the word break characters to vary based on position in the line. |
| 1085 | |
| 1086 | m. New bindable command: unix-filename-rubout. Does the same thing as |
| 1087 | unix-word-rubout, but adds `/' to the set of word delimiters. |
| 1088 | |
| 1089 | n. When listing completions, directories have a `/' appended if the |
| 1090 | `mark-directories' option has been enabled. |
| 1091 | |
| 1092 | ------------------------------------------------------------------------------- |
| 1093 | This document details the changes between this version, readline-4.3, |
| 1094 | and the previous version, readline-4.2a. |
| 1095 | |
| 1096 | 1. Changes to Readline |
| 1097 | |
| 1098 | a. Fixed output of comment-begin character when listing variable values. |
| 1099 | |
| 1100 | b. Added some default key bindings for common escape sequences produced by |
| 1101 | HOME and END keys. |
| 1102 | |
| 1103 | c. Fixed the mark handling code to be more emacs-compatible. |
| 1104 | |
| 1105 | d. A bug was fixed in the code that prints possible completions to keep it |
| 1106 | from printing empty strings in certain circumstances. |
| 1107 | |
| 1108 | e. Change the key sequence printing code to print ESC as M\- if ESC is a |
| 1109 | meta-prefix character -- it's easier for users to understand than \e. |
| 1110 | |
| 1111 | f. Fixed unstifle_history() to return values that match the documentation. |
| 1112 | |
| 1113 | g. Fixed the event loop (rl_event_hook) to handle the case where the input |
| 1114 | file descriptor is invalidated. |
| 1115 | |
| 1116 | h. Fixed the prompt display code to work better when the application has a |
| 1117 | custom redisplay function. |
| 1118 | |
| 1119 | i. Changes to make reading and writing the history file a little faster, and |
| 1120 | to cope with huge history files without calling abort(3) from xmalloc. |
| 1121 | |
| 1122 | j. The vi-mode `S' and `s' commands are now undone correctly. |
| 1123 | |
| 1124 | k. Fixed a problem which caused the display to be messed up when the last |
| 1125 | line of a multi-line prompt (possibly containing invisible characters) |
| 1126 | was longer than the screen width. |
| 1127 | |
| 1128 | 2. New Features in Readline |
| 1129 | |
| 1130 | a. Support for key `subsequences': allows, e.g., ESC and ESC-a to both |
| 1131 | be bound to readline functions. Now the arrow keys may be used in vi |
| 1132 | insert mode. |
| 1133 | |
| 1134 | b. When listing completions, and the number of lines displayed is more than |
| 1135 | the screen length, readline uses an internal pager to display the results. |
| 1136 | This is controlled by the `page-completions' variable (default on). |
| 1137 | |
| 1138 | c. New code to handle editing and displaying multibyte characters. |
| 1139 | |
| 1140 | d. The behavior introduced in bash-2.05a of deciding whether or not to |
| 1141 | append a slash to a completed name that is a symlink to a directory has |
| 1142 | been made optional, controlled by the `mark-symlinked-directories' |
| 1143 | variable (default is the 2.05a behavior). |
| 1144 | |
| 1145 | e. The `insert-comment' command now acts as a toggle if given a numeric |
| 1146 | argument: if the first characters on the line don't specify a |
| 1147 | comment, insert one; if they do, delete the comment text |
| 1148 | |
| 1149 | f. New application-settable completion variable: |
| 1150 | rl_completion_mark_symlink_dirs, allows an application's completion |
| 1151 | function to temporarily override the user's preference for appending |
| 1152 | slashes to names which are symlinks to directories. |
| 1153 | |
| 1154 | g. New function available to application completion functions: |
| 1155 | rl_completion_mode, to tell how the completion function was invoked |
| 1156 | and decide which argument to supply to rl_complete_internal (to list |
| 1157 | completions, etc.). |
| 1158 | |
| 1159 | h. Readline now has an overwrite mode, toggled by the `overwrite-mode' |
| 1160 | bindable command, which could be bound to `Insert'. |
| 1161 | |
| 1162 | i. New application-settable completion variable: |
| 1163 | rl_completion_suppress_append, inhibits appending of |
| 1164 | rl_completion_append_character to completed words. |
| 1165 | |
| 1166 | j. New key bindings when reading an incremental search string: ^W yanks |
| 1167 | the currently-matched word out of the current line into the search |
| 1168 | string; ^Y yanks the rest of the current line into the search string, |
| 1169 | DEL or ^H deletes characters from the search string. |
| 1170 | |
| 1171 | ------------------------------------------------------------------------------- |
| 1172 | This document details the changes between this version, readline-4.2a, |
| 1173 | and the previous version, readline-4.2. |
| 1174 | |
| 1175 | 1. Changes to Readline |
| 1176 | |
| 1177 | a. More `const' and type casting fixes. |
| 1178 | |
| 1179 | b. Changed rl_message() to use vsnprintf(3) (if available) to fix buffer |
| 1180 | overflow problems. |
| 1181 | |
| 1182 | c. The completion code no longer appends a `/' or ` ' to a match when |
| 1183 | completing a symbolic link that resolves to a directory name, unless |
| 1184 | the match does not add anything to the word being completed. This |
| 1185 | means that a tab will complete the word up to the full name, but not |
| 1186 | add anything, and a subsequent tab will add a slash. |
| 1187 | |
| 1188 | d. Fixed a trivial typo that made the vi-mode `dT' command not work. |
| 1189 | |
| 1190 | e. Fixed the tty code so that ^S and ^Q can be inserted with rl_quoted_insert. |
| 1191 | |
| 1192 | f. Fixed the tty code so that ^V works more than once. |
| 1193 | |
| 1194 | g. Changed the use of __P((...)) for function prototypes to PARAMS((...)) |
| 1195 | because the use of __P in typedefs conflicted g++ and glibc. |
| 1196 | |
| 1197 | h. The completion code now attempts to do a better job of preserving the |
| 1198 | case of the word the user typed if ignoring case in completions. |
| 1199 | |
| 1200 | i. Readline defaults to not echoing the input and lets the terminal |
| 1201 | initialization code enable echoing if there is a controlling terminal. |
| 1202 | |
| 1203 | j. The key binding code now processes only two hex digits after a `\x' |
| 1204 | escape sequence, and the documentation was changed to note that the |
| 1205 | octal and hex escape sequences result in an eight-bit value rather |
| 1206 | than strict ASCII. |
| 1207 | |
| 1208 | k. Fixed a few places where negative array subscripts could have occurred. |
| 1209 | |
| 1210 | l. Fixed the vi-mode code to use a better method to determine the bounds of |
| 1211 | the array used to hold the marks, and to avoid out-of-bounds references. |
| 1212 | |
| 1213 | m. Fixed the defines in chardefs.h to work better when chars are signed. |
| 1214 | |
| 1215 | n. Fixed configure.in to use the new names for bash autoconf macros. |
| 1216 | |
| 1217 | o. Readline no longer attempts to define its own versions of some ctype |
| 1218 | macros if they are implemented as functions in libc but not as macros in |
| 1219 | <ctype.h>. |
| 1220 | |
| 1221 | p. Fixed a problem where rl_backward could possibly set point to before |
| 1222 | the beginning of the line. |
| 1223 | |
| 1224 | q. Fixed Makefile to not put -I/usr/include into CFLAGS, since it can cause |
| 1225 | include file problems. |
| 1226 | |
| 1227 | 2. New Features in Readline |
| 1228 | |
| 1229 | a. Added extern declaration for rl_get_termcap to readline.h, making it a |
| 1230 | public function (it was always there, just not in readline.h). |
| 1231 | |
| 1232 | b. New #defines in readline.h: RL_READLINE_VERSION, currently 0x0402, |
| 1233 | RL_VERSION_MAJOR, currently 4, and RL_VERSION_MINOR, currently 2. |
| 1234 | |
| 1235 | c. New readline variable: rl_readline_version, mirrors RL_READLINE_VERSION. |
| 1236 | |
| 1237 | d. New bindable boolean readline variable: match-hidden-files. Controls |
| 1238 | completion of files beginning with a `.' (on Unix). Enabled by default. |
| 1239 | |
| 1240 | e. The history expansion code now allows any character to terminate a |
| 1241 | `:first-' modifier, like csh. |
| 1242 | |
| 1243 | f. The incremental search code remembers the last search string and uses |
| 1244 | it if ^R^R is typed without a search string. |
| 1245 | |
| 1246 | h. New bindable variable `history-preserve-point'. If set, the history |
| 1247 | code attempts to place the user at the same location on each history |
| 1248 | line retrived with previous-history or next-history. |
| 1249 | |
| 1250 | ------------------------------------------------------------------------------- |
| 1251 | This document details the changes between this version, readline-4.2, |
| 1252 | and the previous version, readline-4.1. |
| 1253 | |
| 1254 | 1. Changes to Readline |
| 1255 | |
| 1256 | a. When setting the terminal attributes on systems using `struct termio', |
| 1257 | readline waits for output to drain before changing the attributes. |
| 1258 | |
| 1259 | b. A fix was made to the history word tokenization code to avoid attempts to |
| 1260 | dereference a null pointer. |
| 1261 | |
| 1262 | c. Readline now defaults rl_terminal_name to $TERM if the calling application |
| 1263 | has left it unset, and tries to initialize with the resultant value. |
| 1264 | |
| 1265 | d. Instead of calling (*rl_getc_function)() directly to get input in certain |
| 1266 | places, readline now calls rl_read_key() consistently. |
| 1267 | |
| 1268 | e. Fixed a bug in the completion code that allowed a backslash to quote a |
| 1269 | single quote inside a single-quoted string. |
| 1270 | |
| 1271 | f. rl_prompt is no longer assigned directly from the argument to readline(), |
| 1272 | but uses memory allocated by readline. This allows constant strings to |
| 1273 | be passed to readline without problems arising when the prompt processing |
| 1274 | code wants to modify the string. |
| 1275 | |
| 1276 | g. Fixed a bug that caused non-interactive history searches to return the |
| 1277 | wrong line when performing multiple searches backward for the same string. |
| 1278 | |
| 1279 | h. Many variables, function arguments, and function return values are now |
| 1280 | declared `const' where appropriate, to improve behavior when linking with |
| 1281 | C++ code. |
| 1282 | |
| 1283 | i. The control character detection code now works better on systems where |
| 1284 | `char' is unsigned by default. |
| 1285 | |
| 1286 | j. The vi-mode numeric argument is now capped at 999999, just like emacs mode. |
| 1287 | |
| 1288 | k. The Function, CPFunction, CPPFunction, and VFunction typedefs have been |
| 1289 | replaced with a set of specific prototyped typedefs, though they are |
| 1290 | still in the readline header files for backwards compatibility. |
| 1291 | |
| 1292 | m. Nearly all of the (undocumented) internal global variables in the library |
| 1293 | now have an _rl_ prefix -- there were a number that did not, like |
| 1294 | screenheight, screenwidth, alphabetic, etc. |
| 1295 | |
| 1296 | n. The ding() convenience function has been renamed to rl_ding(), though the |
| 1297 | old function is still defined for backwards compatibility. |
| 1298 | |
| 1299 | o. The completion convenience functions filename_completion_function, |
| 1300 | username_completion_function, and completion_matches now have an rl_ |
| 1301 | prefix, though the old names are still defined for backwards compatibility. |
| 1302 | |
| 1303 | p. The functions shared by readline and bash (linkage is satisfied from bash |
| 1304 | when compiling with bash, and internally otherwise) now have an sh_ prefix. |
| 1305 | |
| 1306 | q. Changed the shared library creation procedure on Linux and BSD/OS 4.x so |
| 1307 | that the `soname' contains only the major version number rather than the |
| 1308 | major and minor numbers. |
| 1309 | |
| 1310 | r. Fixed a redisplay bug that occurred when the prompt spanned more than one |
| 1311 | physical line and contained invisible characters. |
| 1312 | |
| 1313 | s. Added a missing `includedir' variable to the Makefile. |
| 1314 | |
| 1315 | t. When installing the shared libraries, make sure symbolic links are relative. |
| 1316 | |
| 1317 | u. Added configure test so that it can set `${MAKE}' appropriately. |
| 1318 | |
| 1319 | v. Fixed a bug in rl_forward that could cause the point to be set to before |
| 1320 | the beginning of the line in vi mode. |
| 1321 | |
| 1322 | w. Fixed a bug in the callback read-char interface to make it work when a |
| 1323 | readline function pushes some input onto the input stream with |
| 1324 | rl_execute_next (like the incremental search functions). |
| 1325 | |
| 1326 | x. Fixed a file descriptor leak in the history file manipulation code that |
| 1327 | was tripped when attempting to truncate a non-regular file (like |
| 1328 | /dev/null). |
| 1329 | |
| 1330 | y. Changes to make all of the exported readline functions declared in |
| 1331 | readline.h have an rl_ prefix (rltty_set_default_bindings is now |
| 1332 | rl_tty_set_default_bindings, crlf is now rl_crlf, etc.) |
| 1333 | |
| 1334 | z. The formatted documentation included in the base readline distribution |
| 1335 | is no longer removed on a `make distclean'. |
| 1336 | |
| 1337 | aa. Some changes were made to avoid gcc warnings with -Wall. |
| 1338 | |
| 1339 | bb. rl_get_keymap_by_name now finds keymaps case-insensitively, so |
| 1340 | `set keymap EMACS' works. |
| 1341 | |
| 1342 | cc. The history file writing and truncation functions now return a useful |
| 1343 | status on error. |
| 1344 | |
| 1345 | dd. Fixed a bug that could cause applications to dereference a NULL pointer |
| 1346 | if a NULL second argument was passed to history_expand(). |
| 1347 | |
| 1348 | ee. If a hook function assigned to rl_event_hook sets rl_done to a non-zero |
| 1349 | value, rl_read_key() now immediately returns '\n' (which is assumed to |
| 1350 | be bound to accept-line). |
| 1351 | |
| 1352 | 2. New Features in Readline |
| 1353 | |
| 1354 | a. The blink timeout for paren matching is now settable by applications, |
| 1355 | via the rl_set_paren_blink_timeout() function. |
| 1356 | |
| 1357 | b. _rl_executing_macro has been renamed to rl_executing_macro, which means |
| 1358 | it's now part of the public interface. |
| 1359 | |
| 1360 | c. Readline has a new variable, rl_readline_state, which is a bitmap that |
| 1361 | encapsulates the current state of the library; intended for use by |
| 1362 | callbacks and hook functions. |
| 1363 | |
| 1364 | d. rlfe has a new -l option to log input and output (-a appends to logfile), |
| 1365 | a new -n option to set the readline application name, and -v and -h |
| 1366 | options for version and help information. |
| 1367 | |
| 1368 | e. rlfe can now perform filename completion for the inferior process if the |
| 1369 | OS has a /proc/<PID>/cwd that can be read with readlink(2) to get the |
| 1370 | inferior's current working directory. |
| 1371 | |
| 1372 | f. A new file, rltypedefs.h, contains the new typedefs for function pointers |
| 1373 | and is installed by `make install'. |
| 1374 | |
| 1375 | g. New application-callable function rl_set_prompt(const char *prompt): |
| 1376 | expands its prompt string argument and sets rl_prompt to the result. |
| 1377 | |
| 1378 | h. New application-callable function rl_set_screen_size(int rows, int cols): |
| 1379 | public method for applications to set readline's idea of the screen |
| 1380 | dimensions. |
| 1381 | |
| 1382 | i. The history example program (examples/histexamp.c) is now built as one |
| 1383 | of the examples. |
| 1384 | |
| 1385 | j. The documentation has been updated to cover nearly all of the public |
| 1386 | functions and variables declared in readline.h. |
| 1387 | |
| 1388 | k. New function, rl_get_screen_size (int *rows, int *columns), returns |
| 1389 | readline's idea of the screen dimensions. |
| 1390 | |
| 1391 | l. The timeout in rl_gather_tyi (readline keyboard input polling function) |
| 1392 | is now settable via a function (rl_set_keyboard_input_timeout()). |
| 1393 | |
| 1394 | m. Renamed the max_input_history variable to history_max_entries; the old |
| 1395 | variable is maintained for backwards compatibility. |
| 1396 | |
| 1397 | n. The list of characters that separate words for the history tokenizer is |
| 1398 | now settable with a variable: history_word_delimiters. The default |
| 1399 | value is as before. |
| 1400 | |
| 1401 | o. There is a new history.3 manual page documenting the history library. |
| 1402 | |
| 1403 | ------------------------------------------------------------------------------- |
| 1404 | This document details the changes between this version, readline-4.1, |
| 1405 | and the previous version, readline-4.0. |
| 1406 | |
| 1407 | 1. Changes to Readline |
| 1408 | |
| 1409 | a. Changed the HTML documents so that the table-of-contents is no longer |
| 1410 | a separate file. |
| 1411 | |
| 1412 | b. Changes to the shared object configuration for: Irix 5.x, Irix 6.x, |
| 1413 | OSF/1. |
| 1414 | |
| 1415 | c. The shared library major and minor versions are now constructed |
| 1416 | automatically by configure and substituted into the makefiles. |
| 1417 | |
| 1418 | d. It's now possible to install the shared libraries separately from the |
| 1419 | static libraries. |
| 1420 | |
| 1421 | e. The history library tries to truncate the history file only if it is a |
| 1422 | regular file. |
| 1423 | |
| 1424 | f. A bug that caused _rl_dispatch to address negative array indices on |
| 1425 | systems with signed chars was fixed. |
| 1426 | |
| 1427 | g. rl-yank-nth-arg now leaves the history position the same as when it was |
| 1428 | called. |
| 1429 | |
| 1430 | h. Changes to the completion code to handle MS-DOS drive-letter:pathname |
| 1431 | filenames. |
| 1432 | |
| 1433 | i. Completion is now case-insensitive by default on MS-DOS. |
| 1434 | |
| 1435 | j. Fixes to the history file manipulation code for MS-DOS. |
| 1436 | |
| 1437 | k. Readline attempts to bind the arrow keys to appropriate defaults on MS-DOS. |
| 1438 | |
| 1439 | l. Some fixes were made to the redisplay code for better operation on MS-DOS. |
| 1440 | |
| 1441 | m. The quoted-insert code will now insert tty special chars like ^C. |
| 1442 | |
| 1443 | n. A bug was fixed that caused the display code to reference memory before |
| 1444 | the start of the prompt string. |
| 1445 | |
| 1446 | o. More support for __EMX__ (OS/2). |
| 1447 | |
| 1448 | p. A bug was fixed in readline's signal handling that could cause infinite |
| 1449 | recursion in signal handlers. |
| 1450 | |
| 1451 | q. A bug was fixed that caused the point to be less than zero when rl_forward |
| 1452 | was given a very large numeric argument. |
| 1453 | |
| 1454 | r. The vi-mode code now gets characters via the application-settable value |
| 1455 | of rl_getc_function rather than calling rl_getc directly. |
| 1456 | |
| 1457 | s. The history file code now uses O_BINARY mode when reading and writing |
| 1458 | the history file on cygwin32. |
| 1459 | |
| 1460 | t. Fixed a bug in the redisplay code for lines with more than 256 line |
| 1461 | breaks. |
| 1462 | |
| 1463 | u. A bug was fixed which caused invisible character markers to not be |
| 1464 | stripped from the prompt string if the terminal was in no-echo mode. |
| 1465 | |
| 1466 | v. Readline no longer tries to get the variables it needs for redisplay |
| 1467 | from the termcap entry if the calling application has specified its |
| 1468 | own redisplay function. Readline treats the terminal as `dumb' in |
| 1469 | this case. |
| 1470 | |
| 1471 | w. Fixes to the SIGWINCH code so that a multiple-line prompt with escape |
| 1472 | sequences is redrawn correctly. |
| 1473 | |
| 1474 | x. Changes to the install and install-shared targets so that the libraries |
| 1475 | and header files are installed separately. |
| 1476 | |
| 1477 | 2. New Features in Readline |
| 1478 | |
| 1479 | a. A new Readline `user manual' is in doc/rluserman.texinfo. |
| 1480 | |
| 1481 | b. Parentheses matching is now always compiled into readline, and enabled |
| 1482 | or disabled when the value of the `blink-matching-paren' variable is |
| 1483 | changed. |
| 1484 | |
| 1485 | c. MS-DOS systems now use ~/_inputrc as the last-ditch inputrc filename. |
| 1486 | |
| 1487 | d. MS-DOS systems now use ~/_history as the default history file. |
| 1488 | |
| 1489 | e. history-search-{forward,backward} now leave the point at the end of the |
| 1490 | line when the string to search for is empty, like |
| 1491 | {reverse,forward}-search-history. |
| 1492 | |
| 1493 | f. history-search-{forward,backward} now leave the last history line found |
| 1494 | in the readline buffer if the second or subsequent search fails. |
| 1495 | |
| 1496 | g. New function for use by applications: rl_on_new_line_with_prompt, used |
| 1497 | when an application displays the prompt itself before calling readline(). |
| 1498 | |
| 1499 | h. New variable for use by applications: rl_already_prompted. An application |
| 1500 | that displays the prompt itself before calling readline() must set this to |
| 1501 | a non-zero value. |
| 1502 | |
| 1503 | i. A new variable, rl_gnu_readline_p, always 1. The intent is that an |
| 1504 | application can verify whether or not it is linked with the `real' |
| 1505 | readline library or some substitute. |
| 1506 | |
| 1507 | j. Per Bothner's `rlfe' (pronounced `Ralphie') readline front-end program |
| 1508 | is included in the examples subdirectory, though it is not built |
| 1509 | by default. |
| 1510 | |
| 1511 | ------------------------------------------------------------------------------- |
| 1512 | This document details the changes between this version, readline-4.0, |
| 1513 | and the previous version, readline-2.2. |
| 1514 | |
| 1515 | 1. Changes to Readline |
| 1516 | |
| 1517 | a. The version number is now 4.0, to match the major and minor version |
| 1518 | numbers on the shared readline and history libraries. Future |
| 1519 | releases will maintain the identical numbering. |
| 1520 | |
| 1521 | b. Fixed a typo in the `make install' recipe that copied libreadline.a |
| 1522 | to libhistory.old right after installing it. |
| 1523 | |
| 1524 | c. The readline and history info files are now installed out of the source |
| 1525 | directory if they are not found in the build directory. |
| 1526 | |
| 1527 | d. The library no longer exports a function named `savestring' -- backwards |
| 1528 | compatibility be damned. |
| 1529 | |
| 1530 | e. There is no longer any #ifdef SHELL code in the source files. |
| 1531 | |
| 1532 | f. Some changes were made to the key binding code to fix memory leaks and |
| 1533 | better support Win32 systems. |
| 1534 | |
| 1535 | g. Fixed a silly typo in the paren matching code -- it's microseconds, not |
| 1536 | milliseconds. |
| 1537 | |
| 1538 | h. The readline library should be compilable by C++ compilers. |
| 1539 | |
| 1540 | i. The readline.h public header file now includes function prototypes for |
| 1541 | all readline functions, and some changes were made to fix errors in the |
| 1542 | source files uncovered by the use of prototypes. |
| 1543 | |
| 1544 | j. The maximum numeric argument is now clamped at 1000000. |
| 1545 | |
| 1546 | k. Fixes to rl_yank_last_arg to make it behave better. |
| 1547 | |
| 1548 | l. Fixed a bug in the display code that caused core dumps if the prompt |
| 1549 | string length exceeded 1024 characters. |
| 1550 | |
| 1551 | m. The menu completion code was fixed to properly insert a single completion |
| 1552 | if there is only one match. |
| 1553 | |
| 1554 | n. A bug was fixed that caused the display code to improperly display tabs |
| 1555 | after newlines. |
| 1556 | |
| 1557 | o. A fix was made to the completion code in which a typo caused the wrong |
| 1558 | value to be passed to the function that computed the longest common |
| 1559 | prefix of the list of matches. |
| 1560 | |
| 1561 | p. The completion code now checks the value of rl_filename_completion_desired, |
| 1562 | which is set by application-supplied completion functions to indicate |
| 1563 | that filename completion is being performed, to decide whether or not to |
| 1564 | call an application-supplied `ignore completions' function. |
| 1565 | |
| 1566 | q. Code was added to the history library to catch history substitutions |
| 1567 | using `&' without a previous history substitution or search having been |
| 1568 | performed. |
| 1569 | |
| 1570 | |
| 1571 | 2. New Features in Readline |
| 1572 | |
| 1573 | a. There is a new script, support/shobj-conf, to do system-specific shared |
| 1574 | object and library configuration. It generates variables for configure |
| 1575 | to substitute into makefiles. The README file provides a detailed |
| 1576 | explanation of the shared library creation process. |
| 1577 | |
| 1578 | b. Shared libraries and objects are now built in the `shlib' subdirectory. |
| 1579 | There is a shlib/Makefile.in to control the build process. `make shared' |
| 1580 | from the top-level directory is still the right way to build shared |
| 1581 | versions of the libraries. |
| 1582 | |
| 1583 | c. rlconf.h is now installed, so applications can find out which features |
| 1584 | have been compiled into the installed readline and history libraries. |
| 1585 | |
| 1586 | d. rlstdc.h is now an installed header file. |
| 1587 | |
| 1588 | e. Many changes to the signal handling: |
| 1589 | o Readline now catches SIGQUIT and cleans up the tty before returning; |
| 1590 | o A new variable, rl_catch_signals, is available to application writers |
| 1591 | to indicate to readline whether or not it should install its own |
| 1592 | signal handlers for SIGINT, SIGTERM, SIGQUIT, SIGALRM, SIGTSTP, |
| 1593 | SIGTTIN, and SIGTTOU; |
| 1594 | o A new variable, rl_catch_sigwinch, is available to application |
| 1595 | writers to indicate to readline whether or not it should install its |
| 1596 | own signal handler for SIGWINCH, which will chain to the calling |
| 1597 | applications's SIGWINCH handler, if one is installed; |
| 1598 | o There is a new function, rl_free_line_state, for application signal |
| 1599 | handlers to call to free up the state associated with the current |
| 1600 | line after receiving a signal; |
| 1601 | o There is a new function, rl_cleanup_after_signal, to clean up the |
| 1602 | display and terminal state after receiving a signal; |
| 1603 | o There is a new function, rl_reset_after_signal, to reinitialize the |
| 1604 | terminal and display state after an application signal handler |
| 1605 | returns and readline continues |
| 1606 | |
| 1607 | f. There is a new function, rl_resize_terminal, to reset readline's idea of |
| 1608 | the screen size after a SIGWINCH. |
| 1609 | |
| 1610 | g. New public functions: rl_save_prompt and rl_restore_prompt. These were |
| 1611 | previously private functions with a `_' prefix. These functions are |
| 1612 | used when an application wants to write a message to the `message area' |
| 1613 | with rl_message and have the prompt restored correctly when the message |
| 1614 | is erased. |
| 1615 | |
| 1616 | h. New function hook: rl_pre_input_hook, called just before readline starts |
| 1617 | reading input, after initialization. |
| 1618 | |
| 1619 | i. New function hook: rl_display_matches_hook, called when readline would |
| 1620 | display the list of completion matches. The new function |
| 1621 | rl_display_match_list is what readline uses internally, and is available |
| 1622 | for use by application functions called via this hook. |
| 1623 | |
| 1624 | j. New bindable function, delete-char-or-list, like tcsh. |
| 1625 | |
| 1626 | k. A new variable, rl_erase_empty_line, which, if set by an application using |
| 1627 | readline, will cause readline to erase, prompt and all, lines on which the |
| 1628 | only thing typed was a newline. |
| 1629 | |
| 1630 | l. There is a new script, support/shlib-install, to install and uninstall |
| 1631 | the shared readline and history libraries. |
| 1632 | |
| 1633 | m. A new bindable variable, `isearch-terminators', which is a string |
| 1634 | containing the set of characters that should terminate an incremental |
| 1635 | search without being executed as a command. |
| 1636 | |
| 1637 | n. A new bindable function, forward-backward-delete-char. |
| 1638 | |
| 1639 | ------------------------------------------------------------------------------- |
| 1640 | This document details the changes between this version, readline-2.2, |
| 1641 | and the previous version, readline-2.1. |
| 1642 | |
| 1643 | 1. Changes to Readline |
| 1644 | |
| 1645 | a. Added a missing `extern' to a declaration in readline.h that kept |
| 1646 | readline from compiling cleanly on some systems. |
| 1647 | |
| 1648 | b. The history file is now opened with mode 0600 when it is written for |
| 1649 | better security. |
| 1650 | |
| 1651 | c. Changes were made to the SIGWINCH handling code so that prompt redisplay |
| 1652 | is done better. |
| 1653 | |
| 1654 | d. ^G now interrupts incremental searches correctly. |
| 1655 | |
| 1656 | e. A bug that caused a core dump when the set of characters to be quoted |
| 1657 | when completing words was empty was fixed. |
| 1658 | |
| 1659 | f. Fixed a problem in the readline test program rltest.c that caused a core |
| 1660 | dump. |
| 1661 | |
| 1662 | g. The code that handles parser directives in inputrc files now displays |
| 1663 | more error messages. |
| 1664 | |
| 1665 | h. The history expansion code was fixed so that the appearance of the |
| 1666 | history comment character at the beginning of a word inhibits history |
| 1667 | expansion for that word and the rest of the input line. |
| 1668 | |
| 1669 | i. The code that prints completion listings now behaves better if one or |
| 1670 | more of the filenames contains non-printable characters. |
| 1671 | |
| 1672 | j. The time delay when showing matching parentheses is now 0.5 seconds. |
| 1673 | |
| 1674 | |
| 1675 | 2. New Features in Readline |
| 1676 | |
| 1677 | a. There is now an option for `iterative' yank-last-arg handline, so a user |
| 1678 | can keep entering `M-.', yanking the last argument of successive history |
| 1679 | lines. |
| 1680 | |
| 1681 | b. New variable, `print-completions-horizontally', which causes completion |
| 1682 | matches to be displayed across the screen (like `ls -x') rather than up |
| 1683 | and down the screen (like `ls'). |
| 1684 | |
| 1685 | c. New variable, `completion-ignore-case', which causes filename completion |
| 1686 | and matching to be performed case-insensitively. |
| 1687 | |
| 1688 | d. There is a new bindable command, `magic-space', which causes history |
| 1689 | expansion to be performed on the current readline buffer and a space to |
| 1690 | be inserted into the result. |
| 1691 | |
| 1692 | e. There is a new bindable command, `menu-complete', which enables tcsh-like |
| 1693 | menu completion (successive executions of menu-complete insert a single |
| 1694 | completion match, cycling through the list of possible completions). |
| 1695 | |
| 1696 | f. There is a new bindable command, `paste-from-clipboard', for use on Win32 |
| 1697 | systems, to insert the text from the Win32 clipboard into the editing |
| 1698 | buffer. |
| 1699 | |
| 1700 | g. The key sequence translation code now understands printf-style backslash |
| 1701 | escape sequences, including \NNN octal escapes. These escape sequences |
| 1702 | may be used in key sequence definitions or macro values. |
| 1703 | |
| 1704 | h. An `$include' inputrc file parser directive has been added. |