| | |
| | | --- readline-5.2/doc/history.3.orig Mon Apr 4 00:12:21 2011 |
| | | +++ readline-5.2/doc/history.3 Mon Apr 4 00:13:09 2011 |
| | | --- readline-8.1/doc/history.3 |
| | | +++ readline-8.1/doc/history.3 |
| | | @@ -19,16 +19,16 @@ |
| | | .ds lp \fR\|(\fP |
| | | .ds rp \fR\|)\fP |
| | |
| | | .if t \fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3,\|\\$4,\|\\$5\fP\|\\*(rp |
| | | .if n \fI\\$1\fP \fB\\$2\fP \\*(lp\fI\\$3, \\$4, \\$5\fP\\*(rp |
| | | .br |
| | | @@ -331,14 +331,14 @@ |
| | | @@ -346,61 +346,61 @@ This section describes functions used to |
| | | the state of the History library when you want to use the history |
| | | functions in your program. |
| | | |
| | |
| | | Set the state of the history list according to \fIstate\fP. |
| | | |
| | | .SS History List Management |
| | | @@ -346,43 +346,43 @@ |
| | | These functions manage individual entries on the history list, or set |
| | | parameters managing the list itself. |
| | | |
| | |
| | | +.F1 void add_history "const char *string" |
| | | Place \fIstring\fP at the end of the history list. The associated data |
| | | field (if any) is set to \fBNULL\fP. |
| | | If the maximum number of history entries has been set using |
| | | \fBstifle_history()\fP, and the new number of history entries would exceed |
| | | that maximum, the oldest history entry is removed. |
| | | |
| | | -.Fn1 void add_history_time "const char *string" |
| | | +.F1 void add_history_time "const char *string" |
| | |
| | | -.Fn1 void stifle_history "int max" |
| | | +.F1 void stifle_history "int max" |
| | | Stifle the history list, remembering only the last \fImax\fP entries. |
| | | The history list will contain only \fImax\fP entries at a time. |
| | | |
| | | -.Fn1 int unstifle_history "void" |
| | | +.F1 int unstifle_history "void" |
| | |
| | | Returns non-zero if the history is stifled, zero if it is not. |
| | | |
| | | .SS Information About the History List |
| | | @@ -390,29 +390,29 @@ |
| | | @@ -408,30 +408,30 @@ Returns non-zero if the history is stifl |
| | | These functions return information about the entire history list or |
| | | individual list entries. |
| | | |
| | |
| | | |
| | | -.Fn1 "HIST_ENTRY *" history_get "int offset" |
| | | +.F1 "HIST_ENTRY *" history_get "int offset" |
| | | Return the history entry at position \fIoffset\fP, starting from |
| | | \fBhistory_base\fP. |
| | | If there is no entry there, or if \fIoffset\fP |
| | | is greater than the history length, return a \fBNULL\fP pointer. |
| | | Return the history entry at position \fIoffset\fP. |
| | | The range of valid values of \fIoffset\fP starts at \fBhistory_base\fP |
| | | and ends at \fBhistory_length\fP \- 1. |
| | | If there is no entry there, or if \fIoffset\fP is outside the valid |
| | | range, return a \fBNULL\fP pointer. |
| | | |
| | | -.Fn1 "time_t" history_get_time "HIST_ENTRY *" |
| | | +.F1 "time_t" history_get_time "HIST_ENTRY *" |
| | |
| | | Return the number of bytes that the primary history entries are using. |
| | | This function returns the sum of the lengths of all the lines in the |
| | | history. |
| | | @@ -422,18 +422,18 @@ |
| | | @@ -441,18 +441,18 @@ history. |
| | | These functions allow the current index into the history list to be |
| | | set or changed. |
| | | |
| | |
| | | |
| | | -.Fn1 "HIST_ENTRY *" next_history "void" |
| | | +.F1 "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. |
| | | @@ -445,7 +445,7 @@ |
| | | 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 |
| | | @@ -466,7 +466,7 @@ a specific string. Searching may be per |
| | | from the current history position. The search may be \fIanchored\fP, |
| | | meaning that the string must match at the beginning of the history entry. |
| | | |
| | |
| | | Search the history for \fIstring\fP, starting at the current history offset. |
| | | If \fIdirection\fP is less than 0, then the search is through |
| | | previous entries, otherwise through subsequent entries. |
| | | @@ -455,7 +455,7 @@ |
| | | @@ -476,7 +476,7 @@ returned is the offset in the line of th |
| | | \fIstring\fP was found. Otherwise, nothing is changed, and a -1 is |
| | | returned. |
| | | |
| | |
| | | Search the history for \fIstring\fP, starting at the current history |
| | | offset. The search is anchored: matching lines must begin with |
| | | \fIstring\fP. If \fIdirection\fP is less than 0, then the search is |
| | | @@ -464,7 +464,7 @@ |
| | | @@ -485,7 +485,7 @@ If \fIstring\fP is found, then the |
| | | current history index is set to that entry, and the return value is 0. |
| | | Otherwise, nothing is changed, and a -1 is returned. |
| | | |
| | |
| | | Search for \fIstring\fP in the history list, starting at \fIpos\fP, an |
| | | absolute index into the list. If \fIdirection\fP is negative, the search |
| | | proceeds backward from \fIpos\fP, otherwise forward. Returns the absolute |
| | | @@ -474,12 +474,12 @@ |
| | | @@ -495,12 +495,12 @@ index of the history element where \fIst |
| | | The History library can read the history from and write it to a file. |
| | | This section documents the functions for managing a history file. |
| | | |
| | |
| | | Read a range of lines from \fIfilename\fP, adding them to the history list. |
| | | Start reading at line \fIfrom\fP and end at \fIto\fP. |
| | | If \fIfrom\fP is zero, start at the beginning. If \fIto\fP is less than |
| | | @@ -487,7 +487,7 @@ |
| | | @@ -508,19 +508,19 @@ If \fIfrom\fP is zero, start at the begi |
| | | \fBNULL\fP, then read from \fI~/.history\fP. Returns 0 if successful, |
| | | or \fBerrno\fP if not. |
| | | |
| | |
| | | Write the current history to \fIfilename\fP, overwriting \fIfilename\fP |
| | | if necessary. |
| | | If \fIfilename\fP is \fBNULL\fP, then write the history list to \fI~/.history\fP. |
| | | @@ -494,12 +494,12 @@ |
| | | Returns 0 on success, or \fBerrno\fP on a read or write error. |
| | | |
| | | |
| | |
| | | Truncate the history file \fIfilename\fP, leaving only the last |
| | | \fInlines\fP lines. |
| | | If \fIfilename\fP is \fBNULL\fP, then \fI~/.history\fP is truncated. |
| | | @@ -509,7 +509,7 @@ |
| | | @@ -530,7 +530,7 @@ Returns 0 on success, or \fBerrno\fP on |
| | | |
| | | These functions implement history expansion. |
| | | |
| | |
| | | Expand \fIstring\fP, placing the result into \fIoutput\fP, a pointer |
| | | to a string. Returns: |
| | | .RS |
| | | @@ -534,7 +534,7 @@ |
| | | If an error ocurred in expansion, then \fIoutput\fP contains a descriptive |
| | | @@ -555,7 +555,7 @@ as with the \fB:p\fP modifier. |
| | | If an error occurred in expansion, then \fIoutput\fP contains a descriptive |
| | | error message. |
| | | |
| | | -.Fn3 "char *" get_history_event "const char *string" "int *cindex" "int qchar" |
| | |
| | | Returns the text of the history event beginning at \fIstring\fP + |
| | | \fI*cindex\fP. \fI*cindex\fP is modified to point to after the event |
| | | specifier. At function entry, \fIcindex\fP points to the index into |
| | | @@ -542,7 +542,7 @@ |
| | | @@ -563,14 +563,14 @@ specifier. At function entry, \fIcindex |
| | | is a character that is allowed to end the event specification in addition |
| | | to the ``normal'' terminating characters. |
| | | |
| | |
| | | Return an array of tokens parsed out of \fIstring\fP, much as the |
| | | shell might. |
| | | The tokens are split on the characters in the |
| | | @@ -549,7 +549,7 @@ |
| | | \fBhistory_word_delimiters\fP variable, |
| | | and shell quoting conventions are obeyed. |
| | | |