dumper

Name

dumper -- Produce a formatted dump of event data.

Synopsis

dumper ?options?

DESCRIPTION

The dumper command produces formatted dumps of data produced by the NSCL DAQ system. The format of the dump, and some of the basic principles of operation are described in the chapter Dumping events from ringbuffer or from file.

The command line parameters for the dumper are all options. These are described in OPTIONS below. The command dumper --help will also provide brief help.

OPTIONS

The description below provides only the long (double dashed) forms of each option. Single letter (single dashed) forms exist. Use the --help option to get a table of options that shows those.

--count=int

Requests that the program exit after it has printed int items.

--exclude=type-list

Requests that any items in the type-list be supressed from the output. In the case of ring buffer data, this determines how the ring filter predicate is constructed. In the case of a file data source, the data source must read and skip the data.

The type-list is a comma separated list of item types. Any mix of integer and symbolic types can be used. See DataFormat.h for a list of the symbolic and integer type codes known to the NSCLDAQ. User generated types can be excluded as well by specifying their integer type codes.

--help

Provides a quick help on the program options.

--skip=int

Skips int items before starting to print items. The items skipped must have been printable in the first place (e.g. not on the --exclude list nor, in the on-line case, would have been omitted due to sampling).

--sample=type-list

Requests that the item types in type-list be sampled. This is only legal for ring buffer data sources. Sampled item types are only presented if receiving them would leave the ring empty of other items.

The type-list is a comma separated list of item types. Any mix of integer and symbolic types can be used. See DataFormat.h for a list of the symbolic and integer type codes known to the NSCLDAQ. User generated types can be excluded as well by specifying their integer type codes.

--scaler-width=bits

Specifies the width of scaler counters in bits. Unused bits will be masked off prior to output. This is useful for some CAMAC readout systems where scaler values can hav additional bits at the top end that are not meaningful. bits must be a positive number that is at most 32.

--source=URL

Specifies the data source. If omitted, the ring buffer named after the current user is used. If the URL is a file protocol, the file specified by the path string is opened and dumped. If the URl is a tcp protocol, the host and path refer to a ring buffer and that ring buffer is the source of the data.

--version

Prints out the version of the program.