diff options
author | ache <ache@FreeBSD.org> | 1997-06-07 12:17:44 +0000 |
---|---|---|
committer | ache <ache@FreeBSD.org> | 1997-06-07 12:17:44 +0000 |
commit | 8bae2ea4258b589851380ebd61175c3004082c65 (patch) | |
tree | c28b4a346165715fe130aa4dc5ac4aa7b24c3a6d /contrib/libreadline/doc | |
parent | 28dfe89a8d85a2fb72d31828cc776459649ed121 (diff) | |
parent | b6bac891b077ba9da2b507a621c4a85d8eb378f1 (diff) | |
download | FreeBSD-src-8bae2ea4258b589851380ebd61175c3004082c65.zip FreeBSD-src-8bae2ea4258b589851380ebd61175c3004082c65.tar.gz |
This commit was generated by cvs2svn to compensate for changes in r26497,
which included commits to RCS files with non-trunk default branches.
Diffstat (limited to 'contrib/libreadline/doc')
-rw-r--r-- | contrib/libreadline/doc/Makefile.in | 123 | ||||
-rw-r--r-- | contrib/libreadline/doc/hstech.texinfo | 11 | ||||
-rw-r--r-- | contrib/libreadline/doc/rltech.texinfo | 18 | ||||
-rw-r--r-- | contrib/libreadline/doc/rluser.texinfo | 52 |
4 files changed, 181 insertions, 23 deletions
diff --git a/contrib/libreadline/doc/Makefile.in b/contrib/libreadline/doc/Makefile.in new file mode 100644 index 0000000..bbbd5c3 --- /dev/null +++ b/contrib/libreadline/doc/Makefile.in @@ -0,0 +1,123 @@ +# This makefile for Readline library documentation is in -*- text -*- mode. +# Emacs likes it that way. +top_srcdir = @top_srcdir@ +srcdir = @srcdir@ + +prefix = @prefix@ +infodir = @infodir@ + +mandir = @mandir@ +man3dir = $(mandir)/man3 + +RM = rm -f + +TEXINPUTDIR = $(srcdir) + +MAKEINFO = makeinfo +TEXI2DVI = $(srcdir)/texi2dvi +TEXI2HTML = $(srcdir)/texi2html +QUIETPS = #set this to -q to shut up dvips +DVIPS = dvips -D 300 $(QUIETPS) -o $@ # tricky + +INSTALL = @INSTALL@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_DATA = @INSTALL_DATA@ + +RLSRC = $(srcdir)/rlman.texinfo $(srcdir)/rluser.texinfo \ + $(srcdir)/rltech.texinfo +HISTSRC = $(srcdir)/hist.texinfo $(srcdir)/hsuser.texinfo \ + $(srcdir)/hstech.texinfo + +# This should be a program that converts troff to an ascii-readable format +NROFF = groff -Tascii + +# This should be a program that converts troff to postscript +GROFF = groff + +DVIOBJ = readline.dvi history.dvi +INFOOBJ = readline.info history.info +PSOBJ = readline.ps history.ps +HTMLOBJ = readline.html history.html +TEXTOBJ = readline.0 + +CREATED_DOCS = $(DVIOBJ) $(INFOOBJ) $(PSOBJ) $(HTMLOBJ) $(TEXTOBJ) + +.SUFFIXES: .0 .3 .ps .txt .dvi + +.3.0: + $(RM) $@ + -${NROFF} -man $< > $@ + +all: info dvi html ps text +nodvi: info html text + +readline.dvi: $(RLSRC) + TEXINPUTS=.:$(TEXINPUTDIR):$$TEXINPUTS $(TEXI2DVI) $(srcdir)/rlman.texinfo + mv rlman.dvi readline.dvi + +readline.info: $(RLSRC) + $(MAKEINFO) --no-split -I $(TEXINPUTDIR) -o $@ $(srcdir)/rlman.texinfo + +history.dvi: ${HISTSRC} + TEXINPUTS=.:$(TEXINPUTDIR):$$TEXINPUTS $(TEXI2DVI) $(srcdir)/hist.texinfo + mv hist.dvi history.dvi + +history.info: ${HISTSRC} + $(MAKEINFO) --no-split -I $(TEXINPUTDIR) -o $@ $(srcdir)/hist.texinfo + +readline.ps: readline.dvi + $(RM) $@ + $(DVIPS) readline.dvi + +history.ps: history.dvi + $(RM) $@ + $(DVIPS) history.dvi + +readline.html: ${RLSRC} + $(TEXI2HTML) -I $(TEXINPUTDIR) $(srcdir)/rlman.texinfo + sed -e 's:rlman.html:readline.html:' -e 's:rlman_toc.html:readline_toc.html:' rlman.html > readline.html + sed -e 's:rlman.html:readline.html:' -e 's:rlman_toc.html:readline_toc.html:' rlman_toc.html > readline_toc.html + $(RM) rlman.html rlman_toc.html + +history.html: ${HISTSRC} + $(TEXI2HTML) -I $(TEXINPUTDIR) $(srcdir)/hist.texinfo + sed -e 's:hist.html:history.html:' -e 's:hist_toc.html:history_toc.html:' hist.html > history.html + sed -e 's:hist.html:history.html:' -e 's:hist_toc.html:history_toc.html:' hist_toc.html > history_toc.html + $(RM) hist.html hist_toc.html + +info: $(INFOOBJ) +dvi: $(DVIOBJ) +ps: $(PSOBJ) +html: $(HTMLOBJ) +text: $(TEXTOBJ) + +readline.0: $(srcdir)/readline.3 + +clean: + $(RM) *.aux *.cp *.fn *.ky *.log *.pg *.toc *.tp *.vr *.cps *.pgs \ + *.fns *.kys *.tps *.vrs *.o core + +distclean: clean + $(RM) $(CREATED_DOCS) + +mostlyclean: clean + +maintainer-clean: clean + $(RM) $(CREATED_DOCS) + +installdirs: $(top_srcdir)/support/mkdirs + -$(SHELL) $(top_srcdir)/support/mkdirs $(infodir) $(man3dir) + +install: installdirs info + ${INSTALL_DATA} readline.info $(infodir)/readline.info + ${INSTALL_DATA} history.info $(infodir)/history.info + if $(SHELL) -c 'install-info --version' >/dev/null 2>&1; then \ + install-info --dir-file=$(infodir)/dir $(infodir)/readline.info ; \ + install-info --dir-file=$(infodir)/dir $(infodir)/history.info ; \ + else true; fi + -${INSTALL_DATA} $(srcdir)/readline.3 $(man3dir)/readline.3 + +uninstall: + $(RM) $(infodir)/readline.info + $(RM) $(infodir)/history.info + $(RM) $(man3dir)/readline.3 diff --git a/contrib/libreadline/doc/hstech.texinfo b/contrib/libreadline/doc/hstech.texinfo index be41318..5410090 100644 --- a/contrib/libreadline/doc/hstech.texinfo +++ b/contrib/libreadline/doc/hstech.texinfo @@ -415,6 +415,17 @@ If non-zero, single-quoted words are not scanned for the history expansion character. The default value is 0. @end deftypevar +@deftypevar {Function *} history_inhibit_expansion_function +This should be set to the address of a function that takes two arguments: +a @code{char *} (@var{string}) and an integer index into that string (@var{i}). +It should return a non-zero value if the history expansion starting at +@var{string[i]} should not be performed; zero if the expansion should +be done. +It is intended for use by applications like Bash that use the history +expansion character for additional purposes. +By default, this variable is set to NULL. +@end deftypevar + @node History Programming Example @section History Programming Example diff --git a/contrib/libreadline/doc/rltech.texinfo b/contrib/libreadline/doc/rltech.texinfo index 6704d0e..ea0d317 100644 --- a/contrib/libreadline/doc/rltech.texinfo +++ b/contrib/libreadline/doc/rltech.texinfo @@ -312,7 +312,7 @@ to get a character from the input stream. By default, it is set to (@pxref{Utility Functions}). @end deftypevar -@deftypevar {Function *} rl_redisplay_function +@deftypevar {VFunction *} rl_redisplay_function If non-zero, @code{readline} will call indirectly through this pointer to update the display with the current contents of the editing buffer. By default, it is set to @code{rl_redisplay}, the default @code{readline} @@ -417,6 +417,11 @@ Return the keymap matching @var{name}. @var{name} is one which would be supplied in a @code{set keymap} inputrc line (@pxref{Readline Init File}). @end deftypefun +@deftypefun {char *} rl_get_keymap_name (Keymap keymap) +Return the name matching @var{keymap}. @var{name} is one which would +be supplied in a @code{set keymap} inputrc line (@pxref{Readline Init File}). +@end deftypefun + @node Binding Keys @subsection Binding Keys @@ -576,7 +581,7 @@ that text. @node Redisplay @subsection Redisplay -@deftypefun int rl_redisplay () +@deftypefun void rl_redisplay () Change what's displayed on the screen to reflect the current contents of @code{rl_line_buffer}. @end deftypefun @@ -650,6 +655,11 @@ before Readline attempts to read characters from the terminal with @code{rl_read_key ()}. @end deftypefun +@deftypefun rl_extend_line_buffer (int len) +Ensure that @code{rl_line_buffer} has enough space to hold @var{len} +characters, possibly reallocating it if necessary. +@end deftypefun + @deftypefun int rl_initialize () Initialize or re-initialize Readline's internal state. @end deftypefun @@ -870,7 +880,7 @@ that does the initial simple matching selection algorithm (see This is a pointer to the generator function for @code{completion_matches ()}. If the value of @code{rl_completion_entry_function} is @code{(Function *)NULL} then the default filename generator function, -@code{filename_entry_function ()}, is used. +@code{filename_completion_function ()}, is used. @end deftypevar @node Completion Functions @@ -1069,7 +1079,7 @@ by @code{rl_filename_quoting_function}. @end deftypevar @deftypevar int rl_inhibit_completion -If this variable is non-zero, completion is inhibited. The completion +If this variable is non-zero, completion is inhibit<ed. The completion character will be inserted as any other bound to @code{self-insert}. @end deftypevar diff --git a/contrib/libreadline/doc/rluser.texinfo b/contrib/libreadline/doc/rluser.texinfo index 65111f3..f7d6fd8 100644 --- a/contrib/libreadline/doc/rluser.texinfo +++ b/contrib/libreadline/doc/rluser.texinfo @@ -605,31 +605,31 @@ Meta-Control-h: backward-kill-word Text after the function name is ignored # # Arrow keys in keypad mode # -#"\M-OD" backward-char -#"\M-OC" forward-char -#"\M-OA" previous-history -#"\M-OB" next-history +#"\M-OD": backward-char +#"\M-OC": forward-char +#"\M-OA": previous-history +#"\M-OB": next-history # # Arrow keys in ANSI mode # -"\M-[D" backward-char -"\M-[C" forward-char -"\M-[A" previous-history -"\M-[B" next-history +"\M-[D": backward-char +"\M-[C": forward-char +"\M-[A": previous-history +"\M-[B": next-history # # Arrow keys in 8 bit keypad mode # -#"\M-\C-OD" backward-char -#"\M-\C-OC" forward-char -#"\M-\C-OA" previous-history -#"\M-\C-OB" next-history +#"\M-\C-OD": backward-char +#"\M-\C-OC": forward-char +#"\M-\C-OA": previous-history +#"\M-\C-OB": next-history # # Arrow keys in 8 bit ANSI mode # -#"\M-\C-[D" backward-char -#"\M-\C-[C" forward-char -#"\M-\C-[A" previous-history -#"\M-\C-[B" next-history +#"\M-\C-[D": backward-char +#"\M-\C-[C": forward-char +#"\M-\C-[A": previous-history +#"\M-\C-[B": next-history C-q: quoted-insert @@ -921,10 +921,18 @@ Add this digit to the argument already accumulating, or start a new argument. @key{M--} starts a negative argument. @item universal-argument () -Each time this is executed, the argument count is multiplied by four. +This is another way to specify an argument. +If this command is followed by one or more digits, optionally with a +leading minus sign, those digits define the argument. +If the command is followed by digits, executing @code{universal-argument} +again ends the numeric argument, but is otherwise ignored. +As a special case, if this command is immediately followed by a +character that is neither a digit or minus sign, the argument count +for the next command is multiplied by four. The argument count is initially one, so executing this function the -first time makes the argument count four. By default, this is not -bound to a key. +first time makes the argument count four, a second time makes the +argument count sixteen, and so on. +By default, this is not bound to a key. @end ftable @node Commands For Completion @@ -1122,6 +1130,12 @@ word expansions. @item history-expand-line (M-^) Perform history expansion on the current line. +@item alias-expand-line +Perform alias expansion on the current line (@pxref{Aliases}). + +@item history-and-alias-expand-line +Perform history and alias expansion on the current line. + @item insert-last-argument (M-., M-_) A synonym for @code{yank-last-arg}. |