From 72d751f07d28137c001f4b9d322f1631b792a1ef Mon Sep 17 00:00:00 2001 From: Minijackson Date: Fri, 24 Jan 2025 10:51:12 +0100 Subject: [PATCH] docs: add cainfo cli reference imported from CAref.html --- documentation/ca-cli.md | 1 + modules/ca/src/tools/Makefile | 1 + modules/ca/src/tools/cainfo.md | 40 ++++++++++++++++++++++++++++++++++ 3 files changed, 42 insertions(+) create mode 100644 modules/ca/src/tools/cainfo.md diff --git a/documentation/ca-cli.md b/documentation/ca-cli.md index c01e3316d..3808594a5 100644 --- a/documentation/ca-cli.md +++ b/documentation/ca-cli.md @@ -5,4 +5,5 @@ :caption: Tools caget +cainfo ``` diff --git a/modules/ca/src/tools/Makefile b/modules/ca/src/tools/Makefile index d9726c4e0..9cc05d067 100644 --- a/modules/ca/src/tools/Makefile +++ b/modules/ca/src/tools/Makefile @@ -25,5 +25,6 @@ cainfo_SRCS = cainfo.c PROD_LIBS = ca Com DOCS += caget.md +DOCS += cainfo.md include $(TOP)/configure/RULES diff --git a/modules/ca/src/tools/cainfo.md b/modules/ca/src/tools/cainfo.md new file mode 100644 index 000000000..41de40feb --- /dev/null +++ b/modules/ca/src/tools/cainfo.md @@ -0,0 +1,40 @@ +# cainfo + +``` {program} cainfo +``` + + cainfo [options] ... + +## Description + +Get and print channel and connection information for PV(s). + +All available Channel Access related information about PV(s) is printed +to stdout. + +The {option}`-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. + +## Options + +::: {option} -h +Print usage information +::: + +### CA options + +::: {option} -w +Wait time, specifies longer CA timeout, default is 1.0 second. +::: + +::: {option} -s +Call ca_client_status with the specified interest level +::: + +::: {option} -p +CA priority (0--99, default 0=lowest) +::: + +