summaryrefslogtreecommitdiff
path: root/doc/history.3
diff options
context:
space:
mode:
authorChet Ramey <chet.ramey@case.edu>2016-09-15 17:02:15 -0400
committerChet Ramey <chet.ramey@case.edu>2016-09-15 17:02:15 -0400
commitd49a9082c0e15bba8cd3d8cc0a994409cf823cac (patch)
treef0737355f68bc024a31beb0a5dd3c0370f522071 /doc/history.3
parent96c967e80aeaeda3c06ab298de77efd41288bb86 (diff)
downloadreadline-d49a9082c0e15bba8cd3d8cc0a994409cf823cac.tar.gz
Readline-7.0 distribution sources and documentationreadline-7.0
Diffstat (limited to 'doc/history.3')
-rw-r--r--doc/history.322
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/history.3 b/doc/history.3
index ada9a38..7ddc26a 100644
--- a/doc/history.3
+++ b/doc/history.3
@@ -6,9 +6,9 @@
.\" Case Western Reserve University
.\" chet.ramey@case.edu
.\"
-.\" Last Change: Thu Thu Jun 27 10:34:44 EDT 2013
+.\" Last Change: Sun May 24 18:01:17 EDT 2015
.\"
-.TH HISTORY 3 "2013 June 27" "GNU History 6.3"
+.TH HISTORY 3 "2015 May 24" "GNU History 6.3"
.\"
.\" File Name macro. This used to be `.PN', for Path Name,
.\" but Sun doesn't seem to like that very much.
@@ -40,8 +40,8 @@
.SH NAME
history \- GNU History Library
.SH COPYRIGHT
-.if t The GNU History Library is Copyright \(co 1989-2011 by the Free Software Foundation, Inc.
-.if n The GNU History Library is Copyright (C) 1989-2011 by the Free Software Foundation, Inc.
+.if t The GNU History Library is Copyright \(co 1989-2014 by the Free Software Foundation, Inc.
+.if n The GNU History Library is Copyright (C) 1989-2014 by the Free Software Foundation, Inc.
.SH DESCRIPTION
Many programs read input from the user a line at a time. The GNU
History library is able to keep track of those lines, associate arbitrary
@@ -134,7 +134,7 @@ The entire command line typed so far.
.SS Word Designators
.PP
Word designators are used to select desired words from the event.
-A
+A
.B :
separates the event specification from the word designator.
It may be omitted if the word designator begins with a
@@ -441,9 +441,11 @@ return a pointer to that entry. If there is no previous entry, return
a \fBNULL\fP pointer.
.Fn1 "HIST_ENTRY *" next_history "void"
-Move the current history offset forward to the next history entry, and
-return the a pointer to that entry. If there is no next entry, return
-a \fBNULL\fP pointer.
+If the current history offset refers to a valid history entry,
+increment the current history offset.
+If the possibly-incremented history offset refers to a valid history
+entry, return a pointer to that entry;
+otherwise, return a \fBNULL\fP pointer.
.SS Searching the History List
@@ -613,8 +615,8 @@ string, in addition to space, tab, \fI:\fP and \fI?\fP in the case of
a substring search. The default is empty.
.Vb int history_quotes_inhibit_expansion
-If non-zero, single-quoted words are not scanned for the history expansion
-character. The default value is 0.
+If non-zero, double-quoted words are not scanned for the history expansion
+character or the history comment character. The default value is 0.
.Vb "rl_linebuf_func_t *" history_inhibit_expansion_function
This should be set to the address of a function that takes two arguments: