diff options
Diffstat (limited to 'doc/info.n')
| -rw-r--r-- | doc/info.n | 185 |
1 files changed, 0 insertions, 185 deletions
diff --git a/doc/info.n b/doc/info.n deleted file mode 100644 index 79afb72..0000000 --- a/doc/info.n +++ /dev/null @@ -1,185 +0,0 @@ -'\" -'\" Copyright (c) 1993 The Regents of the University of California. -'\" Copyright (c) 1994-1997 Sun Microsystems, Inc. -'\" Copyright (c) 1993-1997 Bell Labs Innovations for Lucent Technologies -'\" -'\" See the file "license.terms" for information on usage and redistribution -'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: info.n,v 1.2 1998/09/14 18:39:53 stanton Exp $ -'\" -.so man.macros -.TH info n 7.5 Tcl "Tcl Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -info \- Return information about the state of the Tcl interpreter -.SH SYNOPSIS -\fBinfo \fIoption \fR?\fIarg arg ...\fR? -.BE - -.SH DESCRIPTION -.PP -This command provides information about various internals of the Tcl -interpreter. -The legal \fIoption\fR's (which may be abbreviated) are: -.TP -\fBinfo args \fIprocname\fR -Returns a list containing the names of the arguments to procedure -\fIprocname\fR, in order. \fIProcname\fR must be the name of a -Tcl command procedure. -.TP -\fBinfo body \fIprocname\fR -Returns the body of procedure \fIprocname\fR. \fIProcname\fR must be -the name of a Tcl command procedure. -.TP -\fBinfo cmdcount\fR -Returns a count of the total number of commands that have been invoked -in this interpreter. -.TP -\fBinfo commands \fR?\fIpattern\fR? -If \fIpattern\fR isn't specified, -returns a list of names of all the Tcl commands in the current namespace, -including both the built-in commands written in C and -the command procedures defined using the \fBproc\fR command. -If \fIpattern\fR is specified, -only those names matching \fIpattern\fR are returned. -Matching is determined using the same rules as for \fBstring match\fR. -\fIpattern\fR can be a qualified name like \fBFoo::print*\fR. -That is, it may specify a particular namespace -using a sequence of namespace names separated by \fB::\fRs, -and may have pattern matching special characters -at the end to specify a set of commands in that namespace. -If \fIpattern\fR is a qualified name, -the resulting list of command names has each one qualified with the name -of the specified namespace. -.TP -\fBinfo complete \fIcommand\fR -Returns 1 if \fIcommand\fR is a complete Tcl command in the sense of -having no unclosed quotes, braces, brackets or array element names, -If the command doesn't appear to be complete then 0 is returned. -This command is typically used in line-oriented input environments -to allow users to type in commands that span multiple lines; if the -command isn't complete, the script can delay evaluating it until additional -lines have been typed to complete the command. -.TP -\fBinfo default \fIprocname arg varname\fR -\fIProcname\fR must be the name of a Tcl command procedure and \fIarg\fR -must be the name of an argument to that procedure. If \fIarg\fR -doesn't have a default value then the command returns \fB0\fR. -Otherwise it returns \fB1\fR and places the default value of \fIarg\fR -into variable \fIvarname\fR. -.TP -\fBinfo exists \fIvarName\fR -Returns \fB1\fR if the variable named \fIvarName\fR exists in the -current context (either as a global or local variable), returns \fB0\fR -otherwise. -.TP -\fBinfo globals \fR?\fIpattern\fR? -If \fIpattern\fR isn't specified, returns a list of all the names -of currently-defined global variables. -Global variables are variables in the global namespace. -If \fIpattern\fR is specified, only those names matching \fIpattern\fR -are returned. Matching is determined using the same rules as for -\fBstring match\fR. -.TP -\fBinfo hostname\fR -Returns the name of the computer on which this invocation is being -executed. -.TP -\fBinfo level\fR ?\fInumber\fR? -If \fInumber\fR is not specified, this command returns a number -giving the stack level of the invoking procedure, or 0 if the -command is invoked at top-level. If \fInumber\fR is specified, -then the result is a list consisting of the name and arguments for the -procedure call at level \fInumber\fR on the stack. If \fInumber\fR -is positive then it selects a particular stack level (1 refers -to the top-most active procedure, 2 to the procedure it called, and -so on); otherwise it gives a level relative to the current level -(0 refers to the current procedure, -1 to its caller, and so on). -See the \fBuplevel\fR command for more information on what stack -levels mean. -.TP -\fBinfo library\fR -Returns the name of the library directory in which standard Tcl -scripts are stored. -This is actually the value of the \fBtcl_library\fR -variable and may be changed by setting \fBtcl_library\fR. -See the \fBtclvars\fR manual entry for more information. -.TP -\fBinfo loaded \fR?\fIinterp\fR? -Returns a list describing all of the packages that have been loaded into -\fIinterp\fR with the \fBload\fR command. -Each list element is a sub-list with two elements consisting of the -name of the file from which the package was loaded and the name of -the package. -For statically-loaded packages the file name will be an empty string. -If \fIinterp\fR is omitted then information is returned for all packages -loaded in any interpreter in the process. -To get a list of just the packages in the current interpreter, specify -an empty string for the \fIinterp\fR argument. -.TP -\fBinfo locals \fR?\fIpattern\fR? -If \fIpattern\fR isn't specified, returns a list of all the names -of currently-defined local variables, including arguments to the -current procedure, if any. -Variables defined with the \fBglobal\fR and \fBupvar\fR commands -will not be returned. -If \fIpattern\fR is specified, only those names matching \fIpattern\fR -are returned. Matching is determined using the same rules as for -\fBstring match\fR. -.TP -\fBinfo nameofexecutable\fR -Returns the full path name of the binary file from which the application -was invoked. If Tcl was unable to identify the file, then an empty -string is returned. -.TP -\fBinfo patchlevel\fR -Returns the value of the global variable \fBtcl_patchLevel\fR; see -the \fBtclvars\fR manual entry for more information. -.TP -\fBinfo procs \fR?\fIpattern\fR? -If \fIpattern\fR isn't specified, returns a list of all the -names of Tcl command procedures in the current namespace. -If \fIpattern\fR is specified, -only those procedure names in the current namespace -matching \fIpattern\fR are returned. -Matching is determined using the same rules as for -\fBstring match\fR. -.TP -\fBinfo script\fR -If a Tcl script file is currently being evaluated (i.e. there is a -call to \fBTcl_EvalFile\fR active or there is an active invocation -of the \fBsource\fR command), then this command returns the name -of the innermost file being processed. Otherwise the command returns an -empty string. -.TP -\fBinfo sharedlibextension\fR -Returns the extension used on this platform for the names of files -containing shared libraries (for example, \fB.so\fR under Solaris). -If shared libraries aren't supported on this platform then an empty -string is returned. -.TP -\fBinfo tclversion\fR -Returns the value of the global variable \fBtcl_version\fR; see -the \fBtclvars\fR manual entry for more information. -.TP -\fBinfo vars\fR ?\fIpattern\fR? -If \fIpattern\fR isn't specified, -returns a list of all the names of currently-visible variables. -This includes locals and currently-visible globals. -If \fIpattern\fR is specified, only those names matching \fIpattern\fR -are returned. Matching is determined using the same rules as for -\fBstring match\fR. -\fIpattern\fR can be a qualified name like \fBFoo::option*\fR. -That is, it may specify a particular namespace -using a sequence of namespace names separated by \fB::\fRs, -and may have pattern matching special characters -at the end to specify a set of variables in that namespace. -If \fIpattern\fR is a qualified name, -the resulting list of variable names -has each matching namespace variable qualified with the name -of its namespace. - -.SH KEYWORDS -command, information, interpreter, level, namespace, procedure, variable |