history.n
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:4k
- '"
- '" Copyright (c) 1993 The Regents of the University of California.
- '" Copyright (c) 1994-1997 Sun Microsystems, Inc.
- '"
- '" See the file "license.terms" for information on usage and redistribution
- '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
- '"
- '" RCS: @(#) $Id: history.n,v 1.2.40.1 2004/10/27 12:52:40 dkf Exp $
- '"
- .so man.macros
- .TH history n "" Tcl "Tcl Built-In Commands"
- .BS
- '" Note: do not modify the .SH NAME line immediately below!
- .SH NAME
- history - Manipulate the history list
- .SH SYNOPSIS
- fBhistory fR?fIoptionfR? ?fIarg arg ...fR?
- .BE
- .SH DESCRIPTION
- .PP
- The fBhistoryfR command performs one of several operations related to
- recently-executed commands recorded in a history list. Each of
- these recorded commands is referred to as an ``event''. When
- specifying an event to the fBhistoryfR command, the following
- forms may be used:
- .IP [1]
- A number: if positive, it refers to the event with
- that number (all events are numbered starting at 1). If the number
- is negative, it selects an event relative to the current event
- (fB-1fR refers to the previous event, fB-2fR to the one before that, and
- so on). Event fB0fP refers to the current event.
- .IP [2]
- A string: selects the most recent event that matches the string.
- An event is considered to match the string either if the string is
- the same as the first characters of the event, or if the string
- matches the event in the sense of the fBstring matchfR command.
- .PP
- The fBhistoryfR command can take any of the following forms:
- .TP
- fBhistoryfR
- Same
- as fBhistory infofR, described below.
- .TP
- fBhistory addfI command fR?fBexecfR?
- Adds the fIcommandfR argument to the history list as a new event. If
- fBexecfR is specified (or abbreviated) then the command is also
- executed and its result is returned. If fBexecfR isn't specified
- then an empty string is returned as result.
- .TP
- fBhistory changefI newValuefR ?fIeventfR?
- Replaces the value recorded for an event with fInewValuefR. fIEventfR
- specifies the event to replace, and
- defaults to the fIcurrentfR event (not event fB-1fR). This command
- is intended for use in commands that implement new forms of history
- substitution and wish to replace the current event (which invokes the
- substitution) with the command created through substitution. The return
- value is an empty string.
- .TP
- fBhistory clearfR
- Erase the history list. The current keep limit is retained.
- The history event numbers are reset.
- .TP
- fBhistory eventfR ?fIeventfR?
- Returns the value of the event given by fIeventfR. fIEventfR
- defaults to fB-1fR.
- .TP
- fBhistory info fR?fIcountfR?
- Returns a formatted string (intended for humans to read) giving
- the event number and contents for each of the events in the history
- list except the current event. If fIcountfR is specified
- then only the most recent fIcountfR events are returned.
- .TP
- fBhistory keep fR?fIcountfR?
- This command may be used to change the size of the history list to
- fIcountfR events. Initially, 20 events are retained in the history
- list. If fIcountfR is not specified, the current keep limit is returned.
- .TP
- fBhistory nextidfR
- Returns the number of the next event to be recorded
- in the history list. It is useful for things like printing the
- event number in command-line prompts.
- .TP
- fBhistory redo fR?fIeventfR?
- Re-executes the command indicated by fIeventfR and returns its result.
- fIEventfR defaults to fB-1fR. This command results in history
- revision: see below for details.
- .SH "HISTORY REVISION"
- .PP
- Pre-8.0 Tcl had a complex history revision mechanism.
- The current mechanism is more limited, and the old
- history operations fBsubstitutefP and fBwordsfP have been removed.
- (As a consolation, the fBclearfP operation was added.)
- .PP
- The history option fBredofR results in much simpler ``history revision''.
- When this option is invoked then the most recent event
- is modified to eliminate the history command and replace it with
- the result of the history command.
- If you want to redo an event without modifying history, then use
- the fBeventfP operation to retrieve some event,
- and the fBaddfP operation to add it to history and execute it.
- .SH KEYWORDS
- event, history, record