history.0

在非GUI环境下

   IInnffoorrmmaattiioonn AAbboouutt tthhee HHiissttoorryy LLiisstt
       These functions return information about the  entire  history  list  or
       individual list entries.

       _H_I_S_T___E_N_T_R_Y _*_* hhiissttoorryy__lliisstt (_v_o_i_d)
       Return  a  NNUULLLL  terminated  array of _H_I_S_T___E_N_T_R_Y _* which is the current
       input history.  Element 0 of this list is the beginning  of  time.   If
       there is no history, return NNUULLLL.

       _i_n_t wwhheerree__hhiissttoorryy (_v_o_i_d)
       Returns the offset of the current history element.

       _H_I_S_T___E_N_T_R_Y _* ccuurrrreenntt__hhiissttoorryy (_v_o_i_d)
       Return  the  history  entry  at  the current position, as determined by
       wwhheerree__hhiissttoorryy(()).  If there is no entry there, return a NNUULLLL pointer.

       _H_I_S_T___E_N_T_R_Y _* hhiissttoorryy__ggeett (_i_n_t _o_f_f_s_e_t)
       Return the  history  entry  at  position  _o_f_f_s_e_t,  starting  from  hhiiss--
       ttoorryy__bbaassee.   If  there  is no entry there, or if _o_f_f_s_e_t is greater than
       the history length, return a NNUULLLL pointer.

       _t_i_m_e___t hhiissttoorryy__ggeett__ttiimmee (_H_I_S_T___E_N_T_R_Y _*)
       Return the time stamp associated with the history entry passed  as  the
       argument.

       _i_n_t hhiissttoorryy__ttoottaall__bbyytteess (_v_o_i_d)
       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.


   MMoovviinngg AArroouunndd tthhee HHiissttoorryy LLiisstt
       These functions allow the current index into the history list to be set
       or changed.

       _i_n_t hhiissttoorryy__sseett__ppooss (_i_n_t _p_o_s)
       Set the current history offset to _p_o_s, an absolute index into the list.
       Returns  1  on  success, 0 if _p_o_s is less than zero or greater than the
       number of history entries.

       _H_I_S_T___E_N_T_R_Y _* pprreevviioouuss__hhiissttoorryy (_v_o_i_d)
       Back up the current history offset to the previous history  entry,  and
       return  a pointer to that entry.  If there is no previous entry, return
       a NNUULLLL pointer.

       _H_I_S_T___E_N_T_R_Y _* nneexxtt__hhiissttoorryy (_v_o_i_d)
       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 NNUULLLL pointer.


   SSeeaarrcchhiinngg tthhee HHiissttoorryy LLiisstt
       These functions allow searching of the history list  for  entries  con-
       taining a specific string.  Searching may be performed both forward and
       backward  from  the  current  history  position.   The  search  may  be
       _a_n_c_h_o_r_e_d,  meaning  that  the string must match at the beginning of the
       history entry.

       _i_n_t hhiissttoorryy__sseeaarrcchh (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g_, _i_n_t _d_i_r_e_c_t_i_o_n)
       Search the history for _s_t_r_i_n_g, starting at the current history  offset.
       If  _d_i_r_e_c_t_i_o_n  is  less  than  0,  then  the search is through previous
       entries, otherwise through subsequent entries.   If  _s_t_r_i_n_g  is  found,
       then  the  current  history index is set to that history entry, and the
       value returned is the offset in the line of the entry where _s_t_r_i_n_g  was
       found.  Otherwise, nothing is changed, and a -1 is returned.

       _i_n_t hhiissttoorryy__sseeaarrcchh__pprreeffiixx (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g_, _i_n_t _d_i_r_e_c_t_i_o_n)
       Search  the history for _s_t_r_i_n_g, starting at the current history offset.
       The search is anchored: matching lines  must  begin  with  _s_t_r_i_n_g.   If
       _d_i_r_e_c_t_i_o_n  is less than 0, then the search is through previous entries,
       otherwise through subsequent entries.  If _s_t_r_i_n_g  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.

       _i_n_t hhiissttoorryy__sseeaarrcchh__ppooss (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g_, _i_n_t _d_i_r_e_c_t_i_o_n_, _i_n_t _p_o_s)
       Search for _s_t_r_i_n_g in the history list, starting  at  _p_o_s,  an  absolute
       index  into  the  list.   If _d_i_r_e_c_t_i_o_n is negative, the search proceeds
       backward from _p_o_s, otherwise forward.  Returns the  absolute  index  of
       the history element where _s_t_r_i_n_g was found, or -1 otherwise.


   MMaannaaggiinngg tthhee HHiissttoorryy FFiillee
       The  History  library can read the history from and write it to a file.
       This section documents the functions for managing a history file.

       _i_n_t rreeaadd__hhiissttoorryy (_c_o_n_s_t _c_h_a_r _*_f_i_l_e_n_a_m_e)
       Add the contents of _f_i_l_e_n_a_m_e to the history list, a line at a time.  If
       _f_i_l_e_n_a_m_e  is NNUULLLL, then read from _~_/_._h_i_s_t_o_r_y.  Returns 0 if successful,
       or eerrrrnnoo if not.

       _i_n_t rreeaadd__hhiissttoorryy__rraannggee (_c_o_n_s_t _c_h_a_r _*_f_i_l_e_n_a_m_e_, _i_n_t _f_r_o_m_, _i_n_t _t_o)
       Read a range of lines from _f_i_l_e_n_a_m_e, adding them to the  history  list.
       Start  reading  at  line _f_r_o_m and end at _t_o.  If _f_r_o_m is zero, start at
       the beginning.  If _t_o is less than _f_r_o_m, then read until the end of the
       file.   If  _f_i_l_e_n_a_m_e  is NNUULLLL, then read from _~_/_._h_i_s_t_o_r_y.  Returns 0 if
       successful, or eerrrrnnoo if not.

       _i_n_t wwrriittee__hhiissttoorryy (_c_o_n_s_t _c_h_a_r _*_f_i_l_e_n_a_m_e)
       Write the current history to _f_i_l_e_n_a_m_e, overwriting _f_i_l_e_n_a_m_e  if  neces-
       sary.   If _f_i_l_e_n_a_m_e is NNUULLLL, then write the history list to _~_/_._h_i_s_t_o_r_y.
       Returns 0 on success, or eerrrrnnoo on a read or write error.


       _i_n_t aappppeenndd__hhiissttoorryy (_i_n_t _n_e_l_e_m_e_n_t_s_, _c_o_n_s_t _c_h_a_r _*_f_i_l_e_n_a_m_e)
       Append the last _n_e_l_e_m_e_n_t_s of the history list to _f_i_l_e_n_a_m_e.  If _f_i_l_e_n_a_m_e
       is  NNUULLLL, then append to _~_/_._h_i_s_t_o_r_y.  Returns 0 on success, or eerrrrnnoo on
       a read or write error.

       _i_n_t hhiissttoorryy__ttrruunnccaattee__ffiillee (_c_o_n_s_t _c_h_a_r _*_f_i_l_e_n_a_m_e_, _i_n_t _n_l_i_n_e_s)
       Truncate the history file _f_i_l_e_n_a_m_e, leaving only the last _n_l_i_n_e_s lines.
       If  _f_i_l_e_n_a_m_e  is NNUULLLL, then _~_/_._h_i_s_t_o_r_y is truncated.  Returns 0 on suc-
       cess, or eerrrrnnoo on failure.


   HHiissttoorryy EExxppaannssiioonn
       These functions implement history expansion.

       _i_n_t hhiissttoorryy__eexxppaanndd (_c_h_a_r _*_s_t_r_i_n_g_, _c_h_a_r _*_*_o_u_t_p_u_t)
       Expand _s_t_r_i_n_g, placing the result into _o_u_t_p_u_t, a pointer to  a  string.
       Returns:
              0      If  no  expansions  took place (or, if the only change in
                     the text was the removal of escape  characters  preceding
                     the history expansion character);
              1      if expansions did take place;
              -1     if there was an error in expansion;
              2      if  the  returned  line should be displayed, but not exe-
                     cuted, as with the ::pp modifier.
       If an error ocurred in expansion, then _o_u_t_p_u_t  contains  a  descriptive
       error message.

       _c_h_a_r _* ggeett__hhiissttoorryy__eevveenntt (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g_, _i_n_t _*_c_i_n_d_e_x_, _i_n_t _q_c_h_a_r)
       Returns  the  text  of the history event beginning at _s_t_r_i_n_g + _*_c_i_n_d_e_x.
       _*_c_i_n_d_e_x is modified to point to after the event specifier.  At function
       entry,  _c_i_n_d_e_x  points to the index into _s_t_r_i_n_g where the history event
       specification begins.  _q_c_h_a_r is a character that is allowed to end  the
       event  specification  in addition to the ``normal'' terminating charac-
       ters.

       _c_h_a_r _*_* hhiissttoorryy__ttookkeenniizzee (_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g)
       Return an array of tokens parsed out  of  _s_t_r_i_n_g,  much  as  the  shell
       might.    The   tokens   are  split  on  the  characters  in  the  hhiiss--
       ttoorryy__wwoorrdd__ddeelliimmiitteerrss  variable,  and  shell  quoting  conventions   are
       obeyed.

       _c_h_a_r _* hhiissttoorryy__aarrgg__eexxttrraacctt (_i_n_t _f_i_r_s_t_, _i_n_t _l_a_s_t_, _c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g)
       Extract a string segment consisting of the _f_i_r_s_t through _l_a_s_t arguments
       present in _s_t_r_i_n_g.  Arguments are split using hhiissttoorryy__ttookkeenniizzee(()).


   HHiissttoorryy VVaarriiaabblleess
       This section describes the externally-visible variables exported by the
       GNU History Library.

       _i_n_t hhiissttoorryy__bbaassee
       The logical offset of the first entry in the history list.

       _i_n_t hhiissttoorryy__lleennggtthh
       The number of entries currently stored in the history list.

       _i_n_t hhiissttoorryy__mmaaxx__eennttrriieess
       The maximum number of history entries.  This must be changed using ssttii--
       ffllee__hhiissttoorryy(()).

       _i_n_t hhiissttoorryy__wwrriittee__ttiimmeessttaammppss
       If non-zero, timestamps are written to the history file, so they can be
       preserved  between  sessions.   The  default  value  is 0, meaning that
       timestamps are not saved.

       _c_h_a_r hhiissttoorryy__eexxppaannssiioonn__cchhaarr
       The character that introduces a history event.  The default is !!.  Set-
       ting this to 0 inhibits history expansion.

       _c_h_a_r hhiissttoorryy__ssuubbsstt__cchhaarr
       The character that invokes word substitution if found at the start of a
       line.  The default is ^^.

       _c_h_a_r hhiissttoorryy__ccoommmmeenntt__cchhaarr
       During tokenization, if this character is seen as the  first  character
       of  a  word,  then it and all subsequent characters up to a newline are
       ignored, suppressing history expansion for the remainder of  the  line.
       This is disabled by default.

       _c_h_a_r _* hhiissttoorryy__wwoorrdd__ddeelliimmiitteerrss
       The  characters  that  separate  tokens  for  hhiissttoorryy__ttookkeenniizzee(()).   The
       default value is "" \\tt\\nn(())<<>>;;&&||"".

       _c_h_a_r _* hhiissttoorryy__nnoo__eexxppaanndd__cchhaarrss
       The list of characters which inhibit history expansion if found immedi-
       ately  following  hhiissttoorryy__eexxppaannssiioonn__cchhaarr.   The  default is space, tab,
       newline, \\rr, and ==.

       _c_h_a_r _* hhiissttoorryy__sseeaarrcchh__ddeelliimmiitteerr__cchhaarrss
       The list of additional characters which can delimit  a  history  search
       string,  in  addition to space, tab, _: and _? in the case of a substring
       search.  The default is empty.

       _i_n_t hhiissttoorryy__qquuootteess__iinnhhiibbiitt__eexxppaannssiioonn
       If non-zero, single-quoted words are not scanned for the history expan-
       sion character.  The default value is 0.

       _r_l___l_i_n_e_b_u_f___f_u_n_c___t _* hhiissttoorryy__iinnhhiibbiitt__eexxppaannssiioonn__ffuunnccttiioonn
       This  should  be  set to the address of a function that takes two argu-
       ments: a cchhaarr ** (_s_t_r_i_n_g) and an iinntt index into  that  string  (_i).   It
       should  return  a  non-zero  value if the history expansion starting at
       _s_t_r_i_n_g_[_i_] should not be performed; zero  if  the  expansion  should  be
       done.   It  is  intended for use by applications like bbaasshh that use the
       history expansion character for additional purposes.  By default,  this
       variable is set to NNUULLLL.

FFIILLEESS
       _~_/_._h_i_s_t_o_r_y
              Default filename for reading and writing saved history

SSEEEE AALLSSOO
       _T_h_e _G_n_u _R_e_a_d_l_i_n_e _L_i_b_r_a_r_y, Brian Fox and Chet Ramey
       _T_h_e _G_n_u _H_i_s_t_o_r_y _L_i_b_r_a_r_y, Brian Fox and Chet Ramey
       _b_a_s_h(1)
       _r_e_a_d_l_i_n_e(3)

AAUUTTHHOORRSS
       Brian Fox, Free Software Foundation
       [e-mail]

       Chet Ramey, Case Western Reserve University
       [e-mail]

BBUUGG RREEPPOORRTTSS
       If  you  find  a bug in the hhiissttoorryy library, you should report it.  But
       first, you should make sure that it  really  is  a  bug,  and  that  it
       appears in the latest version of the hhiissttoorryy library that you have.

       Once  you have determined that a bug actually exists, mail a bug report
       to _b_u_g_-_r_e_a_d_l_i_n_e@_g_n_u_._o_r_g.  If you have a fix, you are  welcome  to  mail
       that  as  well!   Suggestions  and  `philosophical'  bug reports may be
       mailed to  _b_u_g_-_r_e_a_d_l_i_n_e@_g_n_u_._o_r_g  or  posted  to  the  Usenet  newsgroup
       ggnnuu..bbaasshh..bbuugg.

       Comments and bug reports concerning this manual page should be directed
       to _c_h_e_t_@_i_n_s_._C_W_R_U_._E_d_u.



GNU History 5.0                  2003 July 31                       HISTORY(3)