OpenCores
URL https://opencores.org/ocsvn/or1k/or1k/trunk

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [itcl/] [itcl/] [doc/] [delete.n] - Blame information for rev 1773

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 578 markom
'\"
2
'\" Copyright (c) 1993-1998  Lucent Technologies, Inc.
3
'\"
4
'\" See the file "license.terms" for information on usage and redistribution
5
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
6
'\"
7
'\" RCS: $Id: delete.n,v 1.1.1.1 2002-01-16 10:24:46 markom Exp $
8
'\"
9
.so man.macros
10
.TH delete n 3.0 itcl "[incr\ Tcl]"
11
.BS
12
'\" Note:  do not modify the .SH NAME line immediately below!
13
.SH NAME
14
delete \- delete things in the interpreter
15
.SH SYNOPSIS
16
\fBdelete \fIoption\fR ?\fIarg arg ...\fR?
17
.BE
18
 
19
.SH DESCRIPTION
20
.PP
21
The \fBdelete\fR command is used to delete things in the interpreter.
22
It is implemented as an ensemble, so extensions can add their own
23
options and extend the behavior of this command.  By default, the
24
\fBdelete\fR command handles the destruction of namespaces.
25
.PP
26
The \fIoption\fR argument determines what action is carried out
27
by the command.  The legal \fIoptions\fR (which may be abbreviated)
28
are:
29
.TP
30
\fBdelete class \fIname\fR ?\fIname...\fR?
31
Deletes one or more \fB[incr\ Tcl]\fR classes called \fIname\fR.
32
This deletes all objects in the class, and all derived classes
33
as well.
34
.sp
35
If an error is encountered while destructing an object, it will
36
prevent the destruction of the class and any remaining objects.
37
To destroy the entire class without regard for errors, use the
38
"\fBdelete namespace\fR" command.
39
.TP
40
\fBdelete object \fIname\fR ?\fIname...\fR?
41
Deletes one or more \fB[incr\ Tcl]\fR objects called \fIname\fR.
42
An object is deleted by invoking all destructors in its class
43
hierarchy, in order from most- to least-specific.  If all destructors
44
are successful, data associated with the object is deleted and
45
the \fIname\fR is removed as a command from the interpreter.
46
.sp
47
If the access command for an object resides in another namespace,
48
then its qualified name can be used:
49
.CS
50
delete object foo::bar::x
51
.CE
52
If an error is encountered while destructing an object, the
53
\fBdelete\fR command is aborted and the object remains alive.
54
To destroy an object without regard for errors, use the
55
"\fBrename\fR" command to destroy the object access command.
56
.TP
57
\fBdelete namespace \fIname\fR ?\fIname...\fR?
58
Deletes one or more namespaces called \fIname\fR.  This deletes
59
all commands and variables in the namespace, and deletes all
60
child namespaces as well.  When a namespace is deleted, it is
61
automatically removed from the import lists of all other namespaces.
62
 
63
.SH KEYWORDS
64
namespace, proc, variable, ensemble

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.