Menu
▾
▴
[Nscldaq-cvscommits] clients/Scaler sclclient.1,1.1.2.2,1.1.2.3
|
From: Ron F. <ro...@us...> - 2004-08-19 14:07:30
|
Update of /cvsroot/nscldaq/clients/Scaler In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10754/Scaler Modified Files: Tag: daqclients-7_4_development sclclient.1 Log Message: Debug the sclclient man page. Index: sclclient.1 =================================================================== RCS file: /cvsroot/nscldaq/clients/Scaler/Attic/sclclient.1,v retrieving revision 1.1.2.2 retrieving revision 1.1.2.3 diff -C2 -d -r1.1.2.2 -r1.1.2.3 *** sclclient.1 19 Aug 2004 13:32:02 -0000 1.1.2.2 --- sclclient.1 19 Aug 2004 14:06:50 -0000 1.1.2.3 *************** *** 26,42 **** .TP \-h tclserver_host ! Defines the system on which the tcl server is running. It is possible for ! sclclient to run in a system remote from tclserver. By default, however ! the host connected to is localhost. .TP \-p port_number ! Defines the number of the TCP/IP port on which tclserver is listening. By ! default and convention, scaler display tclservers listen on port 2700. ! \-s spectrodaq_url ! Defines the url of the spectrodaq buffer manager from which data wil be acquired. ! This is of the form tcp://hostname:2602/. By default this is tcp://localhost:2602/ ! causing data to be taken from the system sclclient is running on. .SH VARIABLES --- 26,42 ---- .TP \-h tclserver_host ! Defines the system on which the tcl server is running. It is possible for ! sclclient to run in a system remote from tclserver. By default, however ! the host connected to is localhost. .TP \-p port_number ! Defines the number of the TCP/IP port on which tclserver is listening. By ! default and convention, scaler display tclservers listen on port 2700. ! .TP \-s spectrodaq_url ! Defines the url of the spectrodaq buffer manager from which data will. be acquired. ! This is of the form tap://hostname:2602/. By default this is tcp://localhost:2602/ ! causing data to be taken from the system sclclient is running on. .SH VARIABLES *************** *** 51,81 **** Scaler\_Totals \- This is a TCL array indexed by scaler channel number (channels start at ! 0. Each element of the array is the total number of counts in that channel either ! since the scaler program started up or the run began, whichever happened latest. .TP Scaler\_Increments \- ! This is a TCL array indexed by channel number. The value of each element is the number of ! counts in that channel since the latest of the beginning of the run, starting sclclient, and ! the previous scaler buffer. .TP ScalerDeltaTime \- ! This variable maintains the number of seconds in the most recently received set of ! scaler increments in seconds. If no scaler increments have been received, this variable ! is 0. ScalerDeltaTime can be used to calculate scaler rates. .TP ElapsedRunTime \- ! This variable contains the number of seconds since the start of run, or when the scaler ! client program started, whichever is latest. .TP RunNumber \- ! This variable contains he number of the current run. If not yet known, it has the ! value >Unknown< instead. .TP RunState \- ! This variable has the known run state. It is any of HALTED, ACTIVE, or PAUSED, or lastly ! >Unknown< if the run state is not yet known. .TP RunTitle \- ! Contains the title of the current run if known or the text ">Unknown<" if not. --- 51,81 ---- Scaler\_Totals \- This is a TCL array indexed by scaler channel number (channels start at ! 0. Each element of the array is the total number of counts in that channel either ! since the scaler program started up or the run began, whichever happened latest. .TP Scaler\_Increments \- ! This is a TCL array indexed by channel number. The value of each element is the number of ! counts in that channel since the latest of the beginning of the run, starting sclclient, and ! the previous scaler buffer. .TP ScalerDeltaTime \- ! This variable maintains the number of seconds in the most recently received set of ! scaler increments in seconds. If no scaler increments have been received, this variable ! is 0. ScalerDeltaTime can be used to calculate scaler rates. .TP ElapsedRunTime \- ! This variable contains the number of seconds since the start of run, or when the scaler ! client program started, whichever is latest. .TP RunNumber \- ! This variable contains he number of the current run. If not yet known, it has the ! value >Unknown< instead. .TP RunState \- ! This variable has the known run state. It is any of HALTED, ACTIVE, or PAUSED, or lastly ! >Unknown< if the run state is not yet known. .TP RunTitle \- ! Contains the title of the current run if known or the text ">Unknown<" if not. *************** *** 87,114 **** even if only as empty procedures. .PP ! Procedures are not passsed any parameters. The procedures sclclient requires are: .TP Update \- ! Called whenever variables have been updated. The tclserver code here will usually refersh the ! display picture. .TP BeginRun \- ! Called when a begin run is detected. .TP EndRun \- ! Called when an end run is detected. .TP PauseRun \- ! Called when a pause run is detected. .TP ResumeRun \- ! Called when a resume run is detected. ! .TP RunInProgress \- ! Called when the first data to come in is not a begin run. This indicates that sclclient ! started while a run is in progress. .SH EXAMPLES --- 87,115 ---- even if only as empty procedures. .PP ! Procedures are not passed any parameters. The procedures sclclient requires are: .TP Update \- ! Called whenever variables have been updated. The tclserver code here will ! usually refresh the display picture. .TP BeginRun \- ! Called when a begin run is detected. .TP EndRun \- ! Called when an end run is detected. .TP PauseRun \- ! Called when a pause run is detected. .TP ResumeRun \- ! Called when a resume run is detected. ! .TP ! RunInProgress \- ! Called when the first data to come in is not a begin run. This indicates that sclclient ! started while a run is in progress. .SH EXAMPLES |