diff --git a/documentation/ca-cli.md b/documentation/ca-cli.md index 3808594a5..98ea5509d 100644 --- a/documentation/ca-cli.md +++ b/documentation/ca-cli.md @@ -6,4 +6,5 @@ caget cainfo +camonitor ``` diff --git a/modules/ca/src/tools/Makefile b/modules/ca/src/tools/Makefile index 9cc05d067..956bac912 100644 --- a/modules/ca/src/tools/Makefile +++ b/modules/ca/src/tools/Makefile @@ -26,5 +26,6 @@ PROD_LIBS = ca Com DOCS += caget.md DOCS += cainfo.md +DOCS += camonitor.md include $(TOP)/configure/RULES diff --git a/modules/ca/src/tools/camonitor.md b/modules/ca/src/tools/camonitor.md new file mode 100644 index 000000000..e058b6182 --- /dev/null +++ b/modules/ca/src/tools/camonitor.md @@ -0,0 +1,122 @@ +# camonitor + +``` {program} camonitor +``` + + camonitor [options] ... + +## Description + +Subscribe to and print value updates for PV(s). + +## Options + +::: {option} -h +Print usage information +::: + +### CA options + +::: {option} -w +Wait time, specifies longer CA timeout, default is 1.0 second. +::: + +::: {option} -m +Specify CA event mask to use. + +\ is any combination of `v` (value), `a` (alarm), `l` (log/archive), +`p` (property). + +Default event mask is `va` +::: + +::: {option} -p +CA priority (0--99, default 0=lowest) +::: + +### Timestamps + +Default: Print absolute timestamps (as reported by CA server) + +::: {option} -t +Specify timestamp source(s) and type, with \ containing: + +`s` = CA server (remote) timestamps\ +`c` = CA client (local) timestamps (shown in `()`s)\ +`n` = no timestamps\ +`r` = relative timestamps (time elapsed since start of program)\ +`i` = incremental timestamps (time elapsed since last update)\ +`I` = incremental timestamps (time since last update, by channel)\ + +`r`, `i` or `I` require `s` or `c` to select the time source. +::: + +### Enum format + +::: {option} -n +Print `DBF_ENUM` values as number (default is enum string) +::: + +### Arrays + +Array values: Print number of elements, then list of values. + +By default: request and print all elements (dynamic arrays supported). + +::: {option} -# +Request and print first \ elements of an array. +::: + +::: {option} -S +Print array of char as a string (long string). +::: + +### Floating point format + +By default: use `%g` format. + +::: {option} -e +Use `%e` format, with a precision of \ digits. +::: + +::: {option} -f +Use `%f` format, with a precision of \ digits. +::: + +::: {option} -g +Use `%g` format, with a precision of \ digits. +::: + +::: {option} -s +Get value as string (honors server-side precision). +::: + +::: {option} -lx +Round to long integer and print as hex number. +::: + +::: {option} -lo +Round to long integer and print as octal number. +::: + +::: {option} -lb +Round to long integer and print as binary number. +::: + +### Integer number format + +By default: print as decimal number. + +::: {option} -0x +Print as hex number. +::: + +::: {option} -0o +Print as octal number. +::: + +::: {option} -0b +Print as binary number. +::: + +