From b760fbdf954bd144f109fbdfa2082e001e03c49a Mon Sep 17 00:00:00 2001 From: Ralph Lange Date: Fri, 28 May 2004 12:20:16 +0000 Subject: [PATCH] += Doc for commandline tools added in 3.14.6 --- src/ca/CAref.html | 267 +++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 238 insertions(+), 29 deletions(-) diff --git a/src/ca/CAref.html b/src/ca/CAref.html index 1eef4f878..96d758851 100644 --- a/src/ca/CAref.html +++ b/src/ca/CAref.html @@ -72,18 +72,14 @@ height="31" width="88">

data type to the console -

Command Line Tools (under development)

+

Command Line Tools

Troubleshooting

@@ -867,16 +863,7 @@ of the PV is converted to each of the many external data type that can be specified at the CA client library interface, and each of these is formated and then output to the console.

-

Command Line Tools (under development)

- -

Note: The CA Command Line Tools are currently -under development. Thus only the first of the tools is included in EPICS Base -R3.14.5, while the others are still being worked on. These tools have not yet -proven to be stable and reliable. The user interface might still change, so -please be careful relying on these early versions in scripts and other -crucial places. Please report any bugs or unexpected behaviour to the author: -Ralph.Lange@bessy.de

+

Command Line Tools

caget

caget [options] <PV name> ...
@@ -890,6 +877,9 @@ DBR_... format in which the data is read, the output format, and a number of details of how integer and float values are represented can be controlled using command line options.

+

When getting multiple PVs, their order on the command line is retained in +the output.

+ @@ -934,8 +924,7 @@ using command line options.

- + @@ -1084,13 +1073,17 @@ using command line options.

+ + + + - - + + @@ -1122,18 +1115,199 @@ using command line options.

Subscribe to and print value updates for PV(s).

-

Not implemented yet. Under -development.

+
-nPrint DBF_ENUM values as number (default are enum string - values)Print DBF_ENUM values as number (default are enum strings)
-d <type> Default: Use %g format
-e <nr>Use %e format, with <nr> digits after the decimal point
-f <nr> Use %f format, with <nr> digits after the decimal point
-e <nr>Use e format, with <nr> digits after the decimal point-g <nr>Use %g format, with <nr> digits after the decimal point
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
-hPrint usage information
CA options:
-w <sec>Wait time, specifies longer CA timeout, default is 1.0 second
-m <mask>Specify CA event mask to use, with <mask> being any + combination of 'v' (value), 'a' (alarm), 'l' (log). Default: va
Timestamps:
Default:Print absolute timestamps (as reported by CA)
-rRelative timestamps (time elapsed since start of program)
-iIncremental timestamps (time elapsed since last update)
-IIncremental timestamps (time elapsed since last update for this + channel)
Enum Format:
-nPrint DBF_ENUM values as number (default are enum strings)
Arrays:
Value format: Print number of requested values, then list of + values
Default:Print all values
-# <count>Print first <count> elements of an array
Floating point type format:
Default:Use %g format
-e <nr>Use %e format, with <nr> digits after the decimal point
-f <nr>Use %f format, with <nr> digits after the decimal point
-g <nr>Use %g format, with <nr> digits after the decimal + pointDefault:
Integer number format:
Default:Print as decimal number
-0xPrint as hex number
-0oPrint as octal number
-0bPrint as binary number

caput

-
caput [options] <PV name> <value>
+
caput [options] <PV name> <value>
+caput -a [options] <PV name> <no of elements> <value> ...

Description

Put value to a PV.

-

Not implemented yet. Under -development.

+

The specified value is written to the PV (as a string). The PV value is +read before and after the write operation and printed as "Old" and "new" +values on stdout.

+ +

The array variant writes an array to the specified PV. The first numeric +argument specifying the number of array elements is kept for compatibility +with the array data format of caget - the actual number of values specified +on the command line is used.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
-hPrint usage information
CA options:
-w <sec>Wait time, specifies longer CA timeout, default is 1.0 second
Format options:
-tTerse mode - print only sucessfully written value, without name
Enum Format:
Auto - try value as ENUM string, then as index number
-nForce interpretation of values as numbers
-sForce interpretation of values as strings
Arrays:
-aPut array data
Value format: Print number of requested values, then list of + values

cainfo

cainfo [options] <PV name> ...
@@ -1142,8 +1316,43 @@ development.

Get and print channel and connection information for PV(s).

-

Not implemented yet. Under -development.

+

All available Channel Access related information about PV(s) is printed to +stdout.

+ +

The -s option allows to specify an interest level for calling Channel +Access' internal report function ca_client_status(), that prints lots of +internal informations on stdout, including environment settings, used CA +ports etc.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
OptionDescription
-hPrint usage information
CA options:
-w <sec>Wait time, specifies longer CA timeout, default is 1.0 second
-s <level>Call ca_client_status with the specified interest level
+ +

Troubleshooting