docs: add cainfo cli reference imported from CAref.html

This commit is contained in:
Minijackson
2025-01-24 10:51:12 +01:00
committed by Andrew Johnson
parent d279897181
commit 72d751f07d
3 changed files with 42 additions and 0 deletions

View File

@@ -25,5 +25,6 @@ cainfo_SRCS = cainfo.c
PROD_LIBS = ca Com
DOCS += caget.md
DOCS += cainfo.md
include $(TOP)/configure/RULES

View File

@@ -0,0 +1,40 @@
# cainfo
``` {program} cainfo
```
cainfo [options] <PV name> ...
## 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 <sec>
Wait time, specifies longer CA timeout, default is 1.0 second.
:::
::: {option} -s <level>
Call ca_client_status with the specified interest level
:::
::: {option} -p <prio>
CA priority (0--99, default 0=lowest)
:::