Name

inspect — Introspection command for Rivet configuration

Synopsis

inspect ?configuration_section? ?configuration_parameter?

Description

::rivet::inspect provides introspection into the running configuration of Rivet. Rivet's debug command uses it in order to gain insight into the configuration, but it can be used in any script.

::rivet::inspect can be called in three forms

  • Passing one of the configuration directive definitions to ::rivet::inspect the current value read from the configuration record is returned
  • Passing simply the switch ?-all? a dictionary is returned carrying the whole configuration
  • With no argument the command returns a dictionary with 3 keys: server, dir, user. Each key is associated to a subdictionary where configuration lines explicitly set in the conf files are stored. The configuration directives are used as keys in the second level dictionary in order to retrieve a configuration value. In this form the command is meant to provide a way to create the global arrays RivetServerConf, RivetDirConf and RivetUserConf which are internally used by ::rivet::debug