source: branches/sandbox/tkcon/docs/dump.html @ 1142

Last change on this file since 1142 was 931, checked in by toby, 12 years ago

include rest of files
File size: 3.4 KB
Line 
1<HTML>
2<HEAD>
3<TITLE>tkcon: dump procedure</TITLE>
4<LINK REL="STYLESHEET" TYPE="text/css" HREF="./style.css">
5</HEAD>
6
7<BODY BGCOLOR=#FFFFFF>
8
9<TABLE WIDTH=100% BORDER=0 CELLSPACING=2 CELLPADDING=0 BGCOLOR=#000000><TR><TD>
10<!-- start header info -->
11<TABLE WIDTH=100% BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=#FFFFFF>
12<TR>
13<TH><FONT SIZE=+3>tkcon: <CODE>dump</CODE> procedure</FONT></TH>
14<TD align=right>
15<A href="http://tkcon.sourceforge.net/"> 
16<IMG src="http://sourceforge.net/sflogo.php?group_id=11462&type=1" width="88"
17height="31" border="0" alt="SourceForge Logo"></A>
18</TD>
19</TR>
20</TABLE>
21<!-- end header info -->
22
23</TD></TR><TR><TD>
24<!-- start main navigation table -->
25<TABLE BORDER=1 CELLPADDING=2 CELLSPACING=2 BGCOLOR=#CCCCCC width=100%>
26<TR>
27<TH CLASS="hi"><A HREF="index.html" CLASS="hi">Documentation</A></TH>
28<TH><A HREF="purpose.html">Purpose &amp; Features</A></TH>
29<TH><A HREF="limits.html">Limitations</A></TH>
30<TH><A HREF="todo.html">To&nbsp;Do</A></TH>
31<TH><A HREF="license.terms">License</A></TH>
32</TR><TR>
33<TH COLSPAN=2><A HREF="plugin.html">Online Demo</A>
34(requires <A HREF="http://tcl.activestate.com/software/plugin/">Tk plugin</A>)</TH>
35<TH COLSPAN=3><A HREF="nontcl.html">Using TkCon with other Tk Languages</A></TH>
36</TR>
37</TABLE>
38<!-- end main navigation table -->
39</TD></TR><TR><TD>
40<!-- start secondary navigation table -->
41<TABLE BORDER=1 CELLPADDING=2 CELLSPACING=2 BGCOLOR=#BBBBBB width=100%>
42<TR>
43<TH><A HREF="start.html">Getting Started</A></TH>
44<TH><A HREF="bindings.html">Special Bindings</A></TH>
45<TH><A HREF="procs.html">Procedures</A></TH>
46<TH><A HREF="demopic.gif">Screenshot</A></TH>
47</TR>
48<TR>
49<TH CLASS="hi2"><A HREF="dump.html" CLASS="hi2"><CODE>dump</CODE></A></TH>
50<TH><A HREF="tkcon.html"><CODE>tkcon</CODE></A></TH>
51<TH><A HREF="idebug.html"><CODE>idebug</CODE></A></TH>
52<TH><A HREF="observe.html"><CODE>observe</CODE></A></TH>
53</TR>
54</TABLE>
55<!-- end secondary navigation table -->
56</TD></TR><TR><TD BGCOLOR=#FFFFFF>
57<DIV CLASS="indent">
58 <P>
59The <CODE>dump</CODE> command provides a way for the user to spit out
60state information about the interpreter in a Tcl readable (and human
61readable) form.  It takes the general form:
62
63<BLOCKQUOTE>
64<code>dump</code> <b>method</b> <i>?-nocomplain? ?-filter pattern? ?--?
65pattern ?pattern ...?</i>
66</BLOCKQUOTE>
67
68The patterns represent glob-style patterns (as in <code>string match pattern
69$str</code>).  <i>-nocomplain</i> will prevent <code>dump</code> from
70throwing an error if no items matched the pattern.  <i>-filter</i> is
71interpreted as appropriate for the method.  The various methods are:
72
73<DL>
74
75<DT> <CODE>dump <b>command</b></CODE> <i>args</i>
76<DD> Outputs one or more commands.
77
78<DT> <CODE>dump <b>procedure</b></CODE> <i>args</i>
79<DD> Outputs one or more procs in sourceable form.
80
81<DT> <CODE>dump <b>variable</b></CODE> <i>args</i>
82<DD> Outputs the values of variables in sourceable form.  Recognizes nested
83arrays.  The <i>-filter</i> pattern is used as to filter array element
84names and is interepreted as a glob pattern (defaults to {*}).
85It is passed down for nested arrays.
86
87<DT> <CODE>dump <b>widget</b></CODE> <i>args</i>
88<DD> Outputs one or more widgets by giving their configuration options.
89The <i>-filter</i> pattern is used as to filter the config options and
90is interpreted as a case insensitive regexp pattern (defaults to {.*})
91
92</DL>
93</DIV>
94</TD></TR></TABLE>
95
96<HR NOSHADE SIZE=1>
97<ADDRESS><FONT SIZE=2>&copy;
98<A HREF="mailto:jeff.hobbs@acm.org">Jeffrey Hobbs</A></FONT></ADDRESS>
99
100</BODY>
101</HTML>
Note: See TracBrowser for help on using the repository browser.