Table of Contents Previous Chapter Appendix A: Command Usage

Appendix A: Command Usage

1. burtconvertsnap

Usage:

burtconvertsnap snap {-l logfile} {-o outfile} {-v} {-sdds or -nosdds}

Where:

snap
Snapshot filename. This is the only switch that is not optional. You must specify exactly one snapshot file. This is the snapshot file that will be converted.
-l logfile
Log filename. The name of the file where all logging messages (e.g. error messages) go. The default is stderr.
-o outfile
Output snapshot filename. This is where the newly generated converted snapshot file will be placed. The default is stdout.
-v
Verbose. This increases the amount of information displayed in the logfile.
-sdds or -nosdds
SDDS/non-SDDS snapshot file. Explicitly specifying that the gen erated snapshot file will be SDDS/non-SDDS compliant. The default is to produce whatever the input snapshot file is not.

2. burtmath

Usage:

burtmath (snap1 snap2 {-add or -sub}) or (snap1 -mult m) {-l logfile} {-o outfile} {-v} {-c ... comments ...} {-k keyword1 ... keywordn} {-sdds or -nosdds}

Where:

snap1 snap2 {-add or -sub}
Adding/subtracting snapshots. Here you wish to either add or subtract exactly two snapshot files. You must specify exactly two snapshot files when performing. either addition or subtraction. The default operation is sub (subtraction).
snap1 -mult m
Multiplying snapshots. Here you wish to multiply all the values in snap1 by multiplication factor m.
-l logfile
Log file name. The name of the file where all logging messages (e.g. error messages, reports of process variables that were not found) go. The default is stderr.
-o outfile
Result file name. The name of the file where the resulting information goes. The default is stdout.
-v
Verbose. This increases the amount of information displayed in the logfile.
-c ... comments ...
Comments. Adds comments to the header of the result file.
-k keyword1 ... keywordn
Keywords. Adds keywords to the header of the result file.
-sdds or -nosdds
SDDS/non-SDDS snapshot file. Explicitly specifying that the gen erated snapshot file will be SDDS/non-SDDS compliant. The default is to adopt the SDDS type from the input(s). If there is a heterogenous set of inputs (some SDDS and some non-SDDS), the default is to produce and SDDS compliant snapshot file.

3. burtrb

Usage:

burtrb -f req1 {req2 ...} {-l logfile} {-o outfile} {-d} {-v} {-c ... comments ...} {-k keyword1 ... keywordn} {-r retry count} {-sdds or -nosdds}

Where:

-f req1 {req2 ...}
Request file names. This is the only switch that is not optional. You must specify at least one request file.
-l logfile
Log file name. The name of the file where all logging messages (e.g. error messages, reports of process variables that were not found) go. The default is stderr.
-o outfile
Snapshot file name. The name of the file where the snapshot information goes. The default is stdout.
-d
Debug. Save the files created by processing the request files with the C preproces sor. The default is to delete these files.
-v
Verbose. This increases the amount of information displayed in the logfile.
-c ...comments ...
Comments. Adds comments to the header of the snapshot file.
-k keyword1 ... keywordn
Keywords. Adds keywords to the header of the snapshot file.
-r retry count
Number of additional attempts to wait for connections. The program will attempt to find all the process variables. If it is unsuccessful, it will try this many more times to establish connections. The default value is 0.
-sdds or -nosdds
SDDS/non-SDDS snapshot file. Explicitly specifying that the gen erated snapshot file will be SDDS/non-SDDS compliant. The default is to adopt the SDDS type from the input(s). If there is a heterogenous set of inputs (some SDDS and some non-SDDS), the default is to produce an SDDS compliant snap shot file.

4. burtset

Usage:

burtset -f req1 req2 {-union or -inter or -diff} {-l logfile} {-o outfile} {-d} {-v} {-sdds or -nosdds}

Where:

-f req1 req2
Request filenames. This is the only switch that is not optional. You must specify at least two request files.
-union or -inter or -diff
Set operation. The set operation (union, intersection, or dif ference) to be performed on the two request files. The default is union.
-l logfile
Log file name. The name of the file where all logging messages (e.g. error messages) go. The default is stderr.
-o outfile
Request file name. The name of the file where the result of the set operation goes. The default is stdout.
-d
Debug. Save the files created by processing the request files with the C preproces sor. The default is to delete these files.
-v
Verbose. This increases the amount of information displayed in the logfile.
-sdds or -nosdds
SDDS/non-SDDS snapshot file. Explicitly specifying that the gen erated snapshot file will be SDDS/non-SDDS compliant. The default is to adopt the SDDS type from the inputs. If there is a heterogenous set of inputs (one SDDS and the other non-SDDS), the default is to produce and SDDS compliant snapshot file.

5. burtwb

Usage:

burtwb -f snap1 {snap2 ...} {-l logfile} {-o outfile} {-c ... comments ...} {-k keyword1 ... keywordn} {-d} {-v} {-p dep1 ... depn} {-r retry count} {-add} {-replace} {-sdds or -nosdds}

Where:

-f snap1 {snap2 ...}
Snapshot file names. This is the only switch that is not optional. You must specify at least one snapshot file.
-l logfile
Log file name. The name of the file where all logging messages (e.g. error messages, reports of process variables that were not found) go. The default is stderr.
-o outfile
Snapshot file name. If any of the snapshot files Read Only Notify values, this file is created and those values are placed there. If none of the snapshot files have Read Only Notify values, then no file is created. The default is stdout.
-c ... comments ...
Comments. Adds comments to the header of the snapshot file.
-k keyword1 ... keywordn
Keywords. Adds keywords to the header of the snapshot file.
-d
Debug. Save the files created by processing the dependency files with the C prepro cessor. The default is to delete these files.
-v
Verbose. This increases the amount of information displayed in the logfile.
-p dep1 ... depn
Dependency file names. The names of the dependency files contain ing predicates (Boolean conditions) to be evaluated before writing the values from the snapshot files.
-r retry count
Number of additional attempts to wait for connections. The program will attempt to find all the process variables. If it is unsuccessful, it will try this many more times to establish connections. The default value is 0.
-add
Absolute snapshots written as adds. All the absolute snapshots, i.e., those taken directly off IOCs, will be written as additions to the values found on the IOCs. The default is to write the absolute snapshots as replacement values on the IOCs.
-replace
Relative snapshots written as replacements. All the relative snapshots, i.e., those generated by adding or subtracting two snapshots, will be written to replace the values on the IOCs. The default is to write the relative snapshots as additions to the values on the IOCs.
-sdds or -nosdds
SDDS/non-SDDS snapshot file. Explicitly specifying that the gen erated snapshot file will be SDDS/non-SDDS compliant. The default is to adopt the SDDS type from the input(s). If there is a heterogenous set of inputs (some SDDS and some non-SDDS), the default is to produce an SDDS compliant snap shot file.
 
Table of Contents Next Chapter