[BACK]Return to history.html CVS log [TXT] [DIR] Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / readline / doc

Diff for /embedaddon/readline/doc/history.html between versions 1.1.1.1 and 1.1.1.2

version 1.1.1.1, 2014/07/30 08:16:46 version 1.1.1.2, 2021/03/17 01:01:01
Line 1 Line 1
 <HTML>  <HTML>
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">  <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- Created on February, 11  2014 by texi2html 1.64 --><!-- Created on October, 30  2020 by texi2html 1.64 -->
 <!--   <!-- 
 Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)  Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
             Karl Berry  <karl@freefriends.org>              Karl Berry  <karl@freefriends.org>
Line 118  History expansions are introduced by the appearance of Line 118  History expansions are introduced by the appearance of
 history expansion character, which is <SAMP>`!'</SAMP> by default.  history expansion character, which is <SAMP>`!'</SAMP> by default.
 </P><P>  </P><P>
   
   History expansion implements shell-like quoting conventions:
   a backslash can be used to remove the special handling for the next character;
   single quotes enclose verbatim sequences of characters, and can be used to
   inhibit history expansion;
   and characters enclosed within double quotes may be subject to history
   expansion, since backslash can escape the history expansion character,
   but single quotes may not, since they are not treated specially within
   double quotes.
   </P><P>
   
 <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0>   <BLOCKQUOTE><TABLE BORDER=0 CELLSPACING=0> 
 <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="history.html#SEC3">1.1.1 Event Designators</A></TD><TD>&nbsp;&nbsp;</TD><TD ALIGN="left" VALIGN="TOP">How to specify which history line to use.</TD></TR>  <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="history.html#SEC3">1.1.1 Event Designators</A></TD><TD>&nbsp;&nbsp;</TD><TD ALIGN="left" VALIGN="TOP">How to specify which history line to use.</TD></TR>
 <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="history.html#SEC4">1.1.2 Word Designators</A></TD><TD>&nbsp;&nbsp;</TD><TD ALIGN="left" VALIGN="TOP">Specifying which words are of interest.</TD></TR>  <TR><TD ALIGN="left" VALIGN="TOP"><A HREF="history.html#SEC4">1.1.2 Word Designators</A></TD><TD>&nbsp;&nbsp;</TD><TD ALIGN="left" VALIGN="TOP">Specifying which words are of interest.</TD></TR>
Line 182  containing <VAR>string</VAR>. Line 192  containing <VAR>string</VAR>.
 The trailing  The trailing
 <SAMP>`?'</SAMP> may be omitted if the <VAR>string</VAR> is followed immediately by  <SAMP>`?'</SAMP> may be omitted if the <VAR>string</VAR> is followed immediately by
 a newline.  a newline.
   If <VAR>string</VAR> is missing, the string from the most recent search is used;
   it is an error if there is no previous search string.
 <P>  <P>
   
 <DT><CODE>^<VAR>string1</VAR>^<VAR>string2</VAR>^</CODE>  <DT><CODE>^<VAR>string1</VAR>^<VAR>string2</VAR>^</CODE>
 <DD>Quick Substitution.  Repeat the last command, replacing <VAR>string1</VAR>  <DD>Quick Substitution.  Repeat the last command, replacing <VAR>string1</VAR>
 with <VAR>string2</VAR>.  Equivalent to  with <VAR>string2</VAR>.  Equivalent to
<CODE>!!:s/<VAR>string1</VAR>/<VAR>string2</VAR>/</CODE>.<CODE>!!:s^<VAR>string1</VAR>^<VAR>string2</VAR>^</CODE>.
 <P>  <P>
   
 <DT><CODE>!#</CODE>  <DT><CODE>!#</CODE>
Line 264  Here are the word designators: Line 276  Here are the word designators:
 <P>  <P>
   
 <DT><CODE>%</CODE>  <DT><CODE>%</CODE>
<DD>The word matched by the most recent <SAMP>`?<VAR>string</VAR>?'</SAMP> search.<DD>The first word matched by the most recent <SAMP>`?<VAR>string</VAR>?'</SAMP> search,
 if the search string begins with a character that is part of a word.
 <P>  <P>
   
 <DT><CODE><VAR>x</VAR>-<VAR>y</VAR></CODE>  <DT><CODE><VAR>x</VAR>-<VAR>y</VAR></CODE>
Line 283  the empty string is returned in that case. Line 296  the empty string is returned in that case.
   
 <DT><CODE><VAR>x</VAR>-</CODE>  <DT><CODE><VAR>x</VAR>-</CODE>
 <DD>Abbreviates <SAMP>`<VAR>x</VAR>-$'</SAMP> like <SAMP>`<VAR>x</VAR>*'</SAMP>, but omits the last word.  <DD>Abbreviates <SAMP>`<VAR>x</VAR>-$'</SAMP> like <SAMP>`<VAR>x</VAR>*'</SAMP>, but omits the last word.
   If <SAMP>`x'</SAMP> is missing, it defaults to 0.
 <P>  <P>
   
 </DL>  </DL>
Line 312  previous command is used as the event. Line 326  previous command is used as the event.
   
 After the optional word designator, you can add a sequence of one or more  After the optional word designator, you can add a sequence of one or more
 of the following modifiers, each preceded by a <SAMP>`:'</SAMP>.  of the following modifiers, each preceded by a <SAMP>`:'</SAMP>.
   These modify, or edit, the word or words selected from the history event.
 </P><P>  </P><P>
   
 <DL COMPACT>  <DL COMPACT>
Line 339  the basename. Line 354  the basename.
   
 <DT><CODE>s/<VAR>old</VAR>/<VAR>new</VAR>/</CODE>  <DT><CODE>s/<VAR>old</VAR>/<VAR>new</VAR>/</CODE>
 <DD>Substitute <VAR>new</VAR> for the first occurrence of <VAR>old</VAR> in the  <DD>Substitute <VAR>new</VAR> for the first occurrence of <VAR>old</VAR> in the
event line.  Any delimiter may be used in place of <SAMP>`/'</SAMP>.event line.
 Any character may be used as the delimiter in place of <SAMP>`/'</SAMP>.
 The delimiter may be quoted in <VAR>old</VAR> and <VAR>new</VAR>  The delimiter may be quoted in <VAR>old</VAR> and <VAR>new</VAR>
 with a single backslash.  If <SAMP>`&#38;'</SAMP> appears in <VAR>new</VAR>,  with a single backslash.  If <SAMP>`&#38;'</SAMP> appears in <VAR>new</VAR>,
 it is replaced by <VAR>old</VAR>.  A single backslash will quote  it is replaced by <VAR>old</VAR>.  A single backslash will quote
the <SAMP>`&#38;'</SAMP>.  The final delimiter is optional if it is the lastthe <SAMP>`&#38;'</SAMP>.
 If <VAR>old</VAR> is null, it is set to the last <VAR>old</VAR>
 substituted, or, if no previous history substitutions took place,
 the last <VAR>string</VAR>
 in a !?<VAR>string</VAR><CODE>[?]</CODE>
 search.
 If <VAR>new</VAR> is is null, each matching <VAR>old</VAR> is deleted.
 The final delimiter is optional if it is the last
 character on the input line.  character on the input line.
 <P>  <P>
   
Line 359  or with <SAMP>`&#38;'</SAMP>. Line 382  or with <SAMP>`&#38;'</SAMP>.
 <P>  <P>
   
 <DT><CODE>G</CODE>  <DT><CODE>G</CODE>
<DD>Apply the following <SAMP>`s'</SAMP> modifier once to each word in the event.<DD>Apply the following <SAMP>`s'</SAMP> or <SAMP>`&#38;'</SAMP> modifier once to each word
 in the event.
 <P>  <P>
   
 </DL>  </DL>
Line 422  data with each line, and utilize information from prev Line 446  data with each line, and utilize information from prev
 composing new ones.   composing new ones. 
 </P><P>  </P><P>
   
The programmer using the History library has available functionsA programmer using the History library has available functions
 for remembering lines on a history list, associating arbitrary data  for remembering lines on a history list, associating arbitrary data
 with a line, removing lines from the list, searching through the list  with a line, removing lines from the list, searching through the list
 for a line containing an arbitrary text string, and referencing any line  for a line containing an arbitrary text string, and referencing any line
Line 438  in new commands.  The basic history manipulation comma Line 462  in new commands.  The basic history manipulation comma
 the history substitution provided by <CODE>csh</CODE>.  the history substitution provided by <CODE>csh</CODE>.
 </P><P>  </P><P>
   
If the programmer desires, he can use the Readline library, whichThe programmer can also use the Readline library, which
 includes some history manipulation by default, and has the added  includes some history manipulation by default, and has the added
 advantage of command line editing.  advantage of command line editing.
 </P><P>  </P><P>
Line 620  parameters managing the list itself. Line 644  parameters managing the list itself.
 <DT><U>Function:</U> void <B>add_history</B> <I>(const char *string)</I>  <DT><U>Function:</U> void <B>add_history</B> <I>(const char *string)</I>
 <DD>Place <VAR>string</VAR> at the end of the history list.  The associated data  <DD>Place <VAR>string</VAR> at the end of the history list.  The associated data
 field (if any) is set to <CODE>NULL</CODE>.  field (if any) is set to <CODE>NULL</CODE>.
   If the maximum number of history entries has been set using
   <CODE>stifle_history()</CODE>, and the new number of history entries would exceed
   that maximum, the oldest history entry is removed.
 </DL>  </DL>
 </P><P>  </P><P>
   
Line 670  of an invalid <VAR>which</VAR>, a <CODE>NULL</CODE> po Line 697  of an invalid <VAR>which</VAR>, a <CODE>NULL</CODE> po
 <DL>  <DL>
 <DT><U>Function:</U> void <B>stifle_history</B> <I>(int max)</I>  <DT><U>Function:</U> void <B>stifle_history</B> <I>(int max)</I>
 <DD>Stifle the history list, remembering only the last <VAR>max</VAR> entries.  <DD>Stifle the history list, remembering only the last <VAR>max</VAR> entries.
   The history list will contain only <VAR>max</VAR> entries at a time.
 </DL>  </DL>
 </P><P>  </P><P>
   
Line 740  pointer. Line 768  pointer.
 <A NAME="IDX17"></A>  <A NAME="IDX17"></A>
 <DL>  <DL>
 <DT><U>Function:</U> HIST_ENTRY * <B>history_get</B> <I>(int offset)</I>  <DT><U>Function:</U> HIST_ENTRY * <B>history_get</B> <I>(int offset)</I>
<DD>Return the history entry at position <VAR>offset</VAR>, starting from<DD>Return the history entry at position <VAR>offset</VAR>.
<CODE>history_base</CODE> (see section <A HREF="history.html#SEC17">2.4 History Variables</A>).The range of valid
If there is no entry there, or if <VAR>offset</VAR>values of <VAR>offset</VAR> starts at <CODE>history_base</CODE> and ends at
is greater than the history length, return a <CODE>NULL</CODE> pointer.<VAR>history_length</VAR> - 1 (see section <A HREF="history.html#SEC17">2.4 History Variables</A>).
 If there is no entry there, or if <VAR>offset</VAR> is outside the valid
 range, return a <CODE>NULL</CODE> pointer.
 </DL>  </DL>
 </P><P>  </P><P>
   
Line 751  is greater than the history length, return a <CODE>NUL Line 781  is greater than the history length, return a <CODE>NUL
 <DL>  <DL>
 <DT><U>Function:</U> time_t <B>history_get_time</B> <I>(HIST_ENTRY *entry)</I>  <DT><U>Function:</U> time_t <B>history_get_time</B> <I>(HIST_ENTRY *entry)</I>
 <DD>Return the time stamp associated with the history entry <VAR>entry</VAR>.  <DD>Return the time stamp associated with the history entry <VAR>entry</VAR>.
   If the timestamp is missing or invalid, return 0.
 </DL>  </DL>
 </P><P>  </P><P>
   
Line 807  a <CODE>NULL</CODE> pointer. Line 838  a <CODE>NULL</CODE> pointer.
 <A NAME="IDX22"></A>  <A NAME="IDX22"></A>
 <DL>  <DL>
 <DT><U>Function:</U> HIST_ENTRY * <B>next_history</B> <I>(void)</I>  <DT><U>Function:</U> HIST_ENTRY * <B>next_history</B> <I>(void)</I>
<DD>Move the current history offset forward to the next history entry, and<DD>If the current history offset refers to a valid history entry,
return the a pointer to that entry.  If there is no next entry, returnincrement the current history offset.
a <CODE>NULL</CODE> pointer.If the possibly-incremented history offset refers to a valid history
 entry, return a pointer to that entry;
 otherwise, return a <CODE>BNULL</CODE> pointer.
 </DL>  </DL>
 </P><P>  </P><P>
   
Line 1012  to the "normal" terminating characters. Line 1045  to the "normal" terminating characters.
 <DD>Return an array of tokens parsed out of <VAR>string</VAR>, much as the  <DD>Return an array of tokens parsed out of <VAR>string</VAR>, much as the
 shell might.  The tokens are split on the characters in the  shell might.  The tokens are split on the characters in the
 <VAR>history_word_delimiters</VAR> variable,  <VAR>history_word_delimiters</VAR> variable,
and shell quoting conventions are obeyed.and shell quoting conventions are obeyed as described below.
 </DL>  </DL>
 </P><P>  </P><P>
   
Line 1138  carriage return, and <SAMP>`='</SAMP>. Line 1171  carriage return, and <SAMP>`='</SAMP>.
 <A NAME="IDX46"></A>  <A NAME="IDX46"></A>
 <DL>  <DL>
 <DT><U>Variable:</U> int <B>history_quotes_inhibit_expansion</B>  <DT><U>Variable:</U> int <B>history_quotes_inhibit_expansion</B>
<DD>If non-zero, single-quoted words are not scanned for the history expansion<DD>If non-zero, the history expansion code implements shell-like quoting:
character.  The default value is 0.single-quoted words are not scanned for the history expansion
 character or the history comment character, and double-quoted words may
 have history expansion performed, since single quotes are not special
 within double quotes.
 The default value is 0.
 </DL>  </DL>
 </P><P>  </P><P>
   
 <A NAME="IDX47"></A>  <A NAME="IDX47"></A>
 <DL>  <DL>
   <DT><U>Variable:</U> int <B>history_quoting_state</B>
   <DD>An application may set this variable to indicate that the current line
   being expanded is subject to existing quoting. If set to <SAMP>`''</SAMP>, the
   history expansion function will assume that the line is single-quoted and
   inhibit expansion until it reads an unquoted closing single quote; if set
   to <SAMP>`"'</SAMP>, history expansion will assume the line is double quoted until
   it reads an unquoted closing double quote. If set to zero, the default,
   the history expansion function will assume the line is not quoted and
   treat quote characters within the line as described above.
   This is only effective if <VAR>history_quotes_inhibit_expansion</VAR> is set.
   </DL>
   </P><P>
   
   <A NAME="IDX48"></A>
   <DL>
 <DT><U>Variable:</U> rl_linebuf_func_t * <B>history_inhibit_expansion_function</B>  <DT><U>Variable:</U> rl_linebuf_func_t * <B>history_inhibit_expansion_function</B>
 <DD>This should be set to the address of a function that takes two arguments:  <DD>This should be set to the address of a function that takes two arguments:
 a <CODE>char *</CODE> (<VAR>string</VAR>)  a <CODE>char *</CODE> (<VAR>string</VAR>)
Line 1968  to permit their use in free software. Line 2020  to permit their use in free software.
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX17"><CODE>history_get</CODE></A></TD><TD valign=top><A HREF="history.html#SEC12">2.3.3 Information About the History List</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX17"><CODE>history_get</CODE></A></TD><TD valign=top><A HREF="history.html#SEC12">2.3.3 Information About the History List</A></TD></TR>
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX3"><CODE>history_get_history_state</CODE></A></TD><TD valign=top><A HREF="history.html#SEC10">2.3.1 Initializing History and State Management</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX3"><CODE>history_get_history_state</CODE></A></TD><TD valign=top><A HREF="history.html#SEC10">2.3.1 Initializing History and State Management</A></TD></TR>
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX18"><CODE>history_get_time</CODE></A></TD><TD valign=top><A HREF="history.html#SEC12">2.3.3 Information About the History List</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX18"><CODE>history_get_time</CODE></A></TD><TD valign=top><A HREF="history.html#SEC12">2.3.3 Information About the History List</A></TD></TR>
<TR><TD></TD><TD valign=top><A HREF="history.html#IDX47"><CODE>history_inhibit_expansion_function</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR><TR><TD></TD><TD valign=top><A HREF="history.html#IDX48"><CODE>history_inhibit_expansion_function</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX13"><CODE>history_is_stifled</CODE></A></TD><TD valign=top><A HREF="history.html#SEC11">2.3.2 History List Management</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX13"><CODE>history_is_stifled</CODE></A></TD><TD valign=top><A HREF="history.html#SEC11">2.3.2 History List Management</A></TD></TR>
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX37"><CODE>history_length</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX37"><CODE>history_length</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX14"><CODE>history_list</CODE></A></TD><TD valign=top><A HREF="history.html#SEC12">2.3.3 Information About the History List</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX14"><CODE>history_list</CODE></A></TD><TD valign=top><A HREF="history.html#SEC12">2.3.3 Information About the History List</A></TD></TR>
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX38"><CODE>history_max_entries</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX38"><CODE>history_max_entries</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX45"><CODE>history_no_expand_chars</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX45"><CODE>history_no_expand_chars</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX46"><CODE>history_quotes_inhibit_expansion</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX46"><CODE>history_quotes_inhibit_expansion</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>
   <TR><TD></TD><TD valign=top><A HREF="history.html#IDX47"><CODE>history_quoting_state</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX24"><CODE>history_search</CODE></A></TD><TD valign=top><A HREF="history.html#SEC14">2.3.5 Searching the History List</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX24"><CODE>history_search</CODE></A></TD><TD valign=top><A HREF="history.html#SEC14">2.3.5 Searching the History List</A></TD></TR>
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX44"><CODE>history_search_delimiter_chars</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX44"><CODE>history_search_delimiter_chars</CODE></A></TD><TD valign=top><A HREF="history.html#SEC17">2.4 History Variables</A></TD></TR>
 <TR><TD></TD><TD valign=top><A HREF="history.html#IDX26"><CODE>history_search_pos</CODE></A></TD><TD valign=top><A HREF="history.html#SEC14">2.3.5 Searching the History List</A></TD></TR>  <TR><TD></TD><TD valign=top><A HREF="history.html#IDX26"><CODE>history_search_pos</CODE></A></TD><TD valign=top><A HREF="history.html#SEC14">2.3.5 Searching the History List</A></TD></TR>
Line 2127  to permit their use in free software. Line 2180  to permit their use in free software.
 <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="history.html#SEC_About"> ? </A>]</TD>  <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="history.html#SEC_About"> ? </A>]</TD>
 </TR></TABLE>  </TR></TABLE>
 <H1>About this document</H1>  <H1>About this document</H1>
This document was generated by <I>Chet Ramey</I> on <I>February, 11  2014</I>This document was generated by <I>Chet Ramey</I> on <I>October, 30  2020</I>
 using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html  using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
 "><I>texi2html</I></A>  "><I>texi2html</I></A>
 <P></P>    <P></P>  
Line 2289  the following structure: Line 2342  the following structure:
 <BR>    <BR>  
 <FONT SIZE="-1">  <FONT SIZE="-1">
 This document was generated  This document was generated
by <I>Chet Ramey</I> on <I>February, 11  2014</I>by <I>Chet Ramey</I> on <I>October, 30  2020</I>
 using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html  using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
 "><I>texi2html</I></A>  "><I>texi2html</I></A>
   
Removed from v.1.1.1.1  
changed lines
  Added in v.1.1.1.2

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>