summaryrefslogtreecommitdiff
path: root/lib/readline/doc/rltech.texi
diff options
context:
space:
mode:
authorChet Ramey <chet.ramey@case.edu>2012-01-09 08:29:19 -0500
committerChet Ramey <chet.ramey@case.edu>2012-01-09 08:29:19 -0500
commit122f603c917da62f45531a1cf715f78f99463dd8 (patch)
tree27f10c1261a13484034fc991aff582baa7708883 /lib/readline/doc/rltech.texi
parentb28ff8c95e6c0c7326e8064a45ac380a0551738e (diff)
downloadbash-122f603c917da62f45531a1cf715f78f99463dd8.tar.gz
commit bash-20110930 snapshot
Diffstat (limited to 'lib/readline/doc/rltech.texi')
-rw-r--r--lib/readline/doc/rltech.texi24
1 files changed, 20 insertions, 4 deletions
diff --git a/lib/readline/doc/rltech.texi b/lib/readline/doc/rltech.texi
index 7df31035..8340203d 100644
--- a/lib/readline/doc/rltech.texi
+++ b/lib/readline/doc/rltech.texi
@@ -1729,23 +1729,39 @@ the directory portion of the pathname the user typed.
At the least, even if no other expansion is performed, this function should
remove any quote characters from the directory name, because its result will
be passed directly to @code{opendir()}.
+
The directory completion hook returns an integer that should be non-zero if
the function modifies its directory argument.
The function should not modify the directory argument if it returns 0.
@end deftypevar
-@ignore
-@deftypevar extern rl_icppfunc_t *rl_directory_rewrite_hook;
+@deftypevar {rl_icppfunc_t *} rl_directory_rewrite_hook;
If non-zero, this is the address of a function to call when completing
a directory name. This function takes the address of the directory name
to be modified as an argument. Unlike @code{rl_directory_completion_hook},
it only modifies the directory name used in @code{opendir}, not what is
displayed when the possible completions are printed or inserted. It is
called before rl_directory_completion_hook.
+At the least, even if no other expansion is performed, this function should
+remove any quote characters from the directory name, because its result will
+be passed directly to @code{opendir()}.
-I'm not happy with how this works yet, so it's undocumented.
+The directory rewrite hook returns an integer that should be non-zero if
+the function modfies its directory argument.
+The function should not modify the directory argument if it returns 0.
+@end deftypevar
+
+@deftypevar {rl_icppfunc_t *} rl_filename_stat_hook
+If non-zero, this is the address of a function for the completer to
+call before deciding which character to append to a completed name.
+This function modifies its filename name argument, and the modified value
+is passed to @code{stat()} to determine the file's type and characteristics.
+This function does not need to remove quote characters from the filename.
+
+The stat hook returns an integer that should be non-zero if
+the function modfies its directory argument.
+The function should not modify the directory argument if it returns 0.
@end deftypevar
-@end ignore
@deftypevar {rl_dequote_func_t *} rl_filename_rewrite_hook
If non-zero, this is the address of a function called when reading