Bash-4.3 distribution sources and documentation
[platform/upstream/bash.git] / lib / readline / doc / hsuser.texi
index 75df3ee..69a5016 100644 (file)
@@ -1,7 +1,7 @@
 @ignore
 This file documents the user interface to the GNU History library.
 
 @ignore
 This file documents the user interface to the GNU History library.
 
-Copyright (C) 1988--2011 Free Software Foundation, Inc.
+Copyright (C) 1988--2014 Free Software Foundation, Inc.
 Authored by Brian Fox and Chet Ramey.
 
 Permission is granted to make and distribute verbatim copies of this manual
 Authored by Brian Fox and Chet Ramey.
 
 Permission is granted to make and distribute verbatim copies of this manual
@@ -84,17 +84,18 @@ file named by the @env{HISTFILE} variable (default @file{~/.bash_history}).
 The file named by the value of @env{HISTFILE} is truncated, if
 necessary, to contain no more than the number of lines specified by
 the value of the @env{HISTFILESIZE} variable.
 The file named by the value of @env{HISTFILE} is truncated, if
 necessary, to contain no more than the number of lines specified by
 the value of the @env{HISTFILESIZE} variable.
-When an interactive shell exits, the last
+When a shell with history enabled exits, the last
 @env{$HISTSIZE} lines are copied from the history list to the file
 named by @env{$HISTFILE}.
 If the @code{histappend} shell option is set (@pxref{Bash Builtins}),
 the lines are appended to the history file,
 otherwise the history file is overwritten.
 If @env{HISTFILE}
 @env{$HISTSIZE} lines are copied from the history list to the file
 named by @env{$HISTFILE}.
 If the @code{histappend} shell option is set (@pxref{Bash Builtins}),
 the lines are appended to the history file,
 otherwise the history file is overwritten.
 If @env{HISTFILE}
-is unset, or if the history file is unwritable, the history is
-not saved.  After saving the history, the history file is truncated
-to contain no more than @env{$HISTFILESIZE}
-lines.  If @env{HISTFILESIZE} is not set, no truncation is performed.
+is unset, or if the history file is unwritable, the history is not saved.
+After saving the history, the history file is truncated
+to contain no more than @env{$HISTFILESIZE} lines.
+If @env{HISTFILESIZE} is unset, or set to null, a non-numeric value, or
+a numeric value less than zero, the history file is not truncated.
 
 If the @env{HISTTIMEFORMAT} is set, the time stamp information
 associated with each history entry is written to the history file,
 
 If the @env{HISTTIMEFORMAT} is set, the time stamp information
 associated with each history entry is written to the history file,
@@ -141,8 +142,10 @@ history list and history file.
 @code{fc -s [@var{pat}=@var{rep}] [@var{command}]}
 @end example
 
 @code{fc -s [@var{pat}=@var{rep}] [@var{command}]}
 @end example
 
-Fix Command.  In the first form, a range of commands from @var{first} to
-@var{last} is selected from the history list.  Both @var{first} and
+The first form selects a range of commands from @var{first} to
+@var{last} from the history list and displays or edits and re-executes
+them.
+Both @var{first} and
 @var{last} may be specified as a string (to locate the most recent
 command beginning with that string) or as a number (an index into the
 history list, where a negative number is used as an offset from the
 @var{last} may be specified as a string (to locate the most recent
 command beginning with that string) or as a number (an index into the
 history list, where a negative number is used as an offset from the
@@ -161,6 +164,7 @@ When editing is complete, the edited commands are echoed and executed.
 
 In the second form, @var{command} is re-executed after each instance
 of @var{pat} in the selected command is replaced by @var{rep}.
 
 In the second form, @var{command} is re-executed after each instance
 of @var{pat} in the selected command is replaced by @var{rep}.
+@var{command} is intepreted the same as @var{first} above.
 
 A useful alias to use with the @code{fc} command is @code{r='fc -s'}, so
 that typing @samp{r cc} runs the last command beginning with @code{cc}
 
 A useful alias to use with the @code{fc} command is @code{r='fc -s'}, so
 that typing @samp{r cc} runs the last command beginning with @code{cc}
@@ -208,11 +212,11 @@ to the current history list.  These are lines appended to the history
 file since the beginning of the current Bash session.
 
 @item -r
 file since the beginning of the current Bash session.
 
 @item -r
-Read the current history file and append its contents to
+Read the history file and append its contents to
 the history list.
 
 @item -w
 the history list.
 
 @item -w
-Write out the current history to the history file.
+Write out the current history list to the history file.
 
 @item -p
 Perform history substitution on the @var{arg}s and display the result
 
 @item -p
 Perform history substitution on the @var{arg}s and display the result