| rltech.texi (157184) | rltech.texi (165670) |
|---|---|
| 1@comment %**start of header (This is for running Texinfo on a region.) 2@setfilename rltech.info 3@comment %**end of header (This is for running Texinfo on a region.) 4@setchapternewpage odd 5 6@ifinfo 7This document describes the GNU Readline Library, a utility for aiding 8in the consistency of user interface across discrete programs that need 9to provide a command line interface. 10 | 1@comment %**start of header (This is for running Texinfo on a region.) 2@setfilename rltech.info 3@comment %**end of header (This is for running Texinfo on a region.) 4@setchapternewpage odd 5 6@ifinfo 7This document describes the GNU Readline Library, a utility for aiding 8in the consistency of user interface across discrete programs that need 9to provide a command line interface. 10 |
| 11Copyright (C) 1988-2005 Free Software Foundation, Inc. | 11Copyright (C) 1988-2006 Free Software Foundation, Inc. |
| 12 13Permission is granted to make and distribute verbatim copies of 14this manual provided the copyright notice and this permission notice 15pare preserved on all copies. 16 17@ignore 18Permission is granted to process this file through TeX and print the 19results, provided the printed document carries copying permission --- 1008 unchanged lines hidden (view full) --- 1028Unset @var{rl_pending_input}, effectively negating the effect of any 1029previous call to @code{rl_execute_next()}. This works only if the 1030pending input has not already been read with @code{rl_read_key()}. 1031@end deftypefun 1032 1033@deftypefun int rl_set_keyboard_input_timeout (int u) 1034While waiting for keyboard input in @code{rl_read_key()}, Readline will 1035wait for @var{u} microseconds for input before calling any function | 12 13Permission is granted to make and distribute verbatim copies of 14this manual provided the copyright notice and this permission notice 15pare preserved on all copies. 16 17@ignore 18Permission is granted to process this file through TeX and print the 19results, provided the printed document carries copying permission --- 1008 unchanged lines hidden (view full) --- 1028Unset @var{rl_pending_input}, effectively negating the effect of any 1029previous call to @code{rl_execute_next()}. This works only if the 1030pending input has not already been read with @code{rl_read_key()}. 1031@end deftypefun 1032 1033@deftypefun int rl_set_keyboard_input_timeout (int u) 1034While waiting for keyboard input in @code{rl_read_key()}, Readline will 1035wait for @var{u} microseconds for input before calling any function |
| 1036assigned to @code{rl_event_hook}. The default waiting period is 1037one-tenth of a second. Returns the old timeout value. | 1036assigned to @code{rl_event_hook}. @var{u} must be greater than or equal 1037to zero (a zero-length timeout is equivalent to a poll). 1038The default waiting period is one-tenth of a second. 1039Returns the old timeout value. |
| 1038@end deftypefun 1039 1040@node Terminal Management 1041@subsection Terminal Management 1042 1043@deftypefun void rl_prep_terminal (int meta_flag) 1044Modify the terminal settings for Readline's use, so @code{readline()} 1045can read a single character at a time from the keyboard. --- 617 unchanged lines hidden (view full) --- 1663string (the current directory name) as an argument, and may modify that string. 1664If the string is replaced with a new string, the old value should be freed. 1665Any modified directory name should have a trailing slash. 1666The modified value will be displayed as part of the completion, replacing 1667the directory portion of the pathname the user typed. 1668It returns an integer that should be non-zero if the function modifies 1669its directory argument. 1670It could be used to expand symbolic links or shell variables in pathnames. | 1040@end deftypefun 1041 1042@node Terminal Management 1043@subsection Terminal Management 1044 1045@deftypefun void rl_prep_terminal (int meta_flag) 1046Modify the terminal settings for Readline's use, so @code{readline()} 1047can read a single character at a time from the keyboard. --- 617 unchanged lines hidden (view full) --- 1665string (the current directory name) as an argument, and may modify that string. 1666If the string is replaced with a new string, the old value should be freed. 1667Any modified directory name should have a trailing slash. 1668The modified value will be displayed as part of the completion, replacing 1669the directory portion of the pathname the user typed. 1670It returns an integer that should be non-zero if the function modifies 1671its directory argument. 1672It could be used to expand symbolic links or shell variables in pathnames. |
| 1673At the least, even if no other expansion is performed, this function should 1674remove any quote characters from the directory name, because its result will 1675be passed directly to @code{opendir()}. |
|
| 1671@end deftypevar 1672 1673@deftypevar {rl_compdisp_func_t *} rl_completion_display_matches_hook 1674If non-zero, then this is the address of a function to call when 1675completing a word would normally display the list of possible matches. 1676This function is called in lieu of Readline displaying the list. 1677It takes three arguments: 1678(@code{char **}@var{matches}, @code{int} @var{num_matches}, @code{int} @var{max_length}) --- 607 unchanged lines hidden --- | 1676@end deftypevar 1677 1678@deftypevar {rl_compdisp_func_t *} rl_completion_display_matches_hook 1679If non-zero, then this is the address of a function to call when 1680completing a word would normally display the list of possible matches. 1681This function is called in lieu of Readline displaying the list. 1682It takes three arguments: 1683(@code{char **}@var{matches}, @code{int} @var{num_matches}, @code{int} @var{max_length}) --- 607 unchanged lines hidden --- |