1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>inspect</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="Apache Rivet"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="incr0.html" title="incr0"><link rel="next" href="lempty.html" title="lempty"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">inspect</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="incr0.html"><img src="images/prev.png" alt="Prev"></a> </td><th width="60%" align="center">Rivet Tcl Commands and Variables</th><td width="20%" align="right"> <a accesskey="n" href="lempty.html"><img src="images/next.png" alt="Next"></a></td></tr></table></div><div class="refentry" title="inspect"><div class="refentry.separator"><hr></div><a name="inspect"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>inspect — Introspection command for Rivet configuration</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="background:#ccccff ; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">inspect</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>configuration_section</code></em></span>? ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>configuration_parameter</code></em></span>?</div></div></div><div class="refsect1" title="Description"><a name="idp6195104"></a><h2>Description</h2><p style="width:90%">
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>inspect</title><link rel="stylesheet" type="text/css" href="rivet.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"><link rel="home" href="index.html" title="Apache Rivet"><link rel="up" href="commands.html" title="Rivet Tcl Commands and Variables"><link rel="prev" href="incr0.html" title="incr0"><link rel="next" href="lempty.html" title="lempty"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">inspect</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="incr0.html"><img src="images/prev.png" alt="Prev"></a> </td><th width="60%" align="center">Rivet Tcl Commands and Variables</th><td width="20%" align="right"> <a accesskey="n" href="lempty.html"><img src="images/next.png" alt="Next"></a></td></tr></table></div><div class="refentry" title="inspect"><div class="refentry.separator"><hr></div><a name="inspect"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>inspect — Introspection command for Rivet configuration</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis" style="width:80%"><div style="background:#ccccff ; margin:1ex ; padding:.4ex; padding-left: 0.8ex; word-spacing:1ex "><span style="font-weight:bold ; font-family:monospace">inspect</span> ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>configuration_section</code></em></span>? ?<span style="font-family:monospace; font-weight: bold;"><em class="replaceable"><code>configuration_parameter</code></em></span>?</div></div></div><div class="refsect1" title="Description"><a name="idp3469880"></a><h2>Description</h2><p style="width:90%">
2
2
<span style="font-family:monospace"><span class="command"><strong>::rivet::inspect</strong></span></span> provides introspection into the running
3
3
configuration of Rivet. Rivet's debug command uses it in order to gain insight
4
4
into the configuration, but it can be used in any script.
5
5
</p><p style="width:90%">
6
6
<span style="font-family:monospace"><span class="command"><strong>::rivet::inspect</strong></span></span> can be called in three forms
7
7
</p><div class="itemizedlist"><ul class="itemizedlist" type="square"><li class="listitem" style="list-style-type: square">
8
Passing one of the configuration directive definitions to
9
<span style="font-family:monospace"><span class="command"><strong>::rivet::inspect</strong></span></span> the current value
10
read from the configuration record is returned
11
</li><li class="listitem" style="list-style-type: square">
12
Passing simply the switch ?<span style="font-family:monospace; font-weight: bold;">-all</span>? a dictionary is returned
13
carrying the whole configuration
14
</li><li class="listitem" style="list-style-type: square">
8
Passing as argument the switch ?<span style="font-family:monospace; font-weight: bold;">-all</span>? a dictionary
9
carrying the whole configuration is returned
10
</li><li class="listitem" style="list-style-type: square">
11
With one argument (one of the Rivet configuration directives)
12
<span style="font-family:monospace"><span class="command"><strong>::rivet::inspect</strong></span></span> returns the current value
13
in the configuration record
14
</li><li class="listitem" style="list-style-type: square">
15
15
With no argument the command returns a dictionary with 3
16
16
keys: server, dir, user. Each key is associated to a subdictionary
17
where configuration lines explicitly set in the conf files
18
are stored. The configuration directives are used as keys in
19
the second level dictionary in order to retrieve a configuration
20
value. In this form the command is meant to provide a way to create
21
the global arrays RivetServerConf, RivetDirConf and RivetUserConf
22
which are internally used by ::rivet::debug
23
</li></ul></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="incr0.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="lempty.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">incr0 </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a></td><td width="40%" align="right" valign="top"> lempty</td></tr></table></div></body></html>
17
carrying the configuration lines actually set. Configuration directives
18
are the keys in the second level dictionary. In this form the command is
19
meant to provide a way to create global arrays RivetServerConf,
20
RivetDirConf and RivetUserConf which are internally used by ::rivet::debug
21
</li></ul></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="incr0.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="commands.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="lempty.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">incr0 </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a></td><td width="40%" align="right" valign="top"> lempty</td></tr></table></div></body></html>
added
removed
doc/html/inspect.html
