Readout -- Start an event readout program.


Readout options...


Starts the Readout program.



Enables the Tcl server component to listen on the specified port. If the value of this option is managed, the port manager is contacted to allocate a port. Otherwise the value must be the integer port number on which to listen.


Provides the name of the local ring into which data will be placed. If this switch is omitted, the ring name will be the username running the program.


Sets the default source id for events that have timestamps. Events without timestamp have an abbreviated body header. A call to setSourceId from within the event processor overrides the value of this switch for this event only.


After initialization, executes the script designated by file-path in the main thread's interpreter.


Outputs a summary of the command line options and exits without doing anything else useful.


Outputs the program version number and exists without doing anything else useful.


The Readout program runs a Tcl interpreter. The Tcl set command can set some variables that have meaning to the Readout program. See VARIABLES below for a list of those. This section describes commands that have been added to the base Tcl interpreter for the Readout program.


Starts a data taking run.


Ends a data taking run.


Pauses a data taking run.


Resumes a data taking run that was paused.

runvar varname

Designates varname as a Tcl variable that will be written out to the event stream in a documentation ring item. Normally the values of these variables are set either by the users's experiment specific code, or via external programs interacting with Readout's Tcl server. One example of this is the use of the controlpush program to push the values of Tcl variables into the interpreter.

serverauth subcommand ?parameters?

This controls access to the Tcl server embedded in the Readout program. By default only connections from localhost (the host Reaout is running in) are allowed. Note that this command must be issued to the Tcl server not to the main command interpreter.

Subcommands are as follows:

add host-or-ip

Adds a new host-or-ip to the list of hosts that are allowed to connect. host-or-ip is either the DNS name of a host (e.g. u6pc3) or the IP address of that host in dotted numeric form (e.g.


Lists the hosts that are allowed to connect to the Tcl server. The returned value is a list of hosts. Each host is a two element hostname/IP address list.

delete host-or-ip

Removes the specified host-or-ip from the list of hosts authorized to connect.


Besides the variables that have been defined via the runvar command to put in documentation ring items, some variables have special meaning for Readout:


This variable contains the run title string that appears in run state transition events.


This variable contains the run number as it appears in the run state transition events. run must be a positive integer. The ReadoutGUI enforces this restriction.