summaryrefslogtreecommitdiffstats
path: root/tkcon/docs/dump.n.man
blob: 9dbccdb627a2ee1a1f3a9c3364c9a7e9627909fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
[comment {-*- tcl -*- dump manpage}]
[manpage_begin dump n 2.5]
[copyright {Jeffrey Hobbs <jeff at hobbs.org>}]
[moddesc   {TkCon}]
[titledesc {Dump information about Tcl interpreter in TkCon}]

[description]
[para]
The dump command provides a way for the user to spit out state
information about the interpreter in a Tcl readable
(and human readable) form.
It takes the general form:

[list_begin definitions]

[call [cmd dump] [arg method]\
		 [opt [arg -nocomplain]]\
		 [opt [arg "-filter pattern"]]\
		 [opt [cmd --]]\
		 [arg pattern]\
		 [opt [arg "pattern ..."]]]

[list_end]

[para]
The patterns represent glob-style patterns (as in [cmd string] [arg {match pattern $str}]).
[arg -nocomplain] will prevent dump from throwing an error if no items
matched the pattern.
[arg -filter] is interpreted as appropriate for the method.
The various methods are:

[list_begin definitions]

[def "[cmd dump] [arg command] [arg args]"]
Outputs one or more commands.

[def "[cmd dump] [arg procedure] [arg args]"]
Outputs one or more procs in sourceable form.

[def "[cmd dump] [arg variable] [arg args]"]
Outputs the values of variables in sourceable form.
Recognizes nested arrays.
The -filter pattern is used as to filter array element
names and is interepreted as a glob pattern (defaults to {*}).
It is passed down for nested arrays.

[def "[cmd dump] [arg widget] [arg args]"]
Outputs one or more widgets by giving their configuration options.
The -filter pattern is used as to filter the config options and
is interpreted as a case insensitive regexp pattern (defaults to {.*}).

[list_end]

[see_also [cmd tkcon](1)]
[see_also [cmd tkconrc](5) [cmd tkcon](n) [cmd idebug](n)]
[see_also [cmd observe](n)]
[keywords Tk console dump]

[manpage_end]