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

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [itcl/] [itcl/] [doc/] [find.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: find.n,v 1.1.1.1 2002-01-16 10:24:46 markom Exp $
8
'\"
9
.so man.macros
10
.TH find n 3.0 itcl "[incr\ Tcl]"
11
.BS
12
'\" Note:  do not modify the .SH NAME line immediately below!
13
.SH NAME
14
find \- search for classes and objects
15
.SH SYNOPSIS
16
\fBfind \fIoption\fR ?\fIarg arg ...\fR?
17
.BE
18
 
19
.SH DESCRIPTION
20
.PP
21
The \fBfind\fR command is used to find classes and objects
22
that are available in the current context.  A class or object is
23
"available" if its access command can be found in the current
24
namespace context or in the global namespace.  Therefore,
25
classes and objects created in the global namespace are
26
available to all other namespaces in a program.  Classes and
27
objects created in one namespace can also be imported into
28
another using the \fBnamespace import\fR command.
29
.PP
30
The \fIoption\fR argument determines what action is carried out
31
by the command.  The legal \fIoptions\fR (which may be abbreviated)
32
are:
33
.TP
34
\fBfind classes ?\fIpattern\fR?
35
Returns a list of classes found in the current namespace context.
36
If the optional \fIpattern\fR is specified, then the reported names
37
are compared using the rules of the "\fBstring match\fR" command,
38
and only matching names are reported.
39
.sp
40
If a class resides in the current namespace context, this command
41
reports its simple name--without any qualifiers.  However, if the
42
\fIpattern\fR contains \fB::\fR qualifiers, or if the class resides
43
in another context, this command reports its fully-qualified name.
44
.TP
45
\fBfind objects ?\fIpattern\fR? ?\fB-class \fIclassName\fR? ?\fB-isa \fIclassName\fR?
46
Returns a list of objects found in the current namespace context.
47
If the optional \fIpattern\fR is specified, then the reported names
48
are compared using the rules of the "\fBstring match\fR" command,
49
and only matching names are reported.
50
If the optional "\fB-class\fR" parameter is specified, this list is
51
restricted to objects whose most-specific class is \fIclassName\fR.
52
If the optional "\fB-isa\fR" parameter is specified, this list is
53
further restricted to objects having the given \fIclassName\fR
54
anywhere in their heritage.
55
.sp
56
If an object resides in the current namespace context, this command
57
reports its simple name--without any qualifiers.  However, if the
58
\fIpattern\fR contains \fB::\fR qualifiers, or if the object resides
59
in another context, this command reports its fully-qualified name.
60
 
61
.SH KEYWORDS
62
class, object, search, import

powered by: WebSVN 2.1.0

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