Skip to content

Commit 732bf79

Browse files
committed
man: update iio_attr man page
with some details and help about the various options. Signed-off-by: Robin Getz <[email protected]>
1 parent ac92604 commit 732bf79

File tree

1 file changed

+46
-9
lines changed

1 file changed

+46
-9
lines changed

man/iio_attr.1.in

Lines changed: 46 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,25 +50,51 @@ iio_attr \- list IIO devices, and read/write device attributes
5050
.I options
5151
]
5252
-C [attr]
53+
.br
54+
.B iio_attr
55+
-S <arg>
56+
.br
57+
.B iio_attr
58+
-h
59+
5360
.SH DESCRIPTION
5461
.B iio_attr
5562
is a utility for displaying information about local or remote IIO devices.
5663
By providing an optional value,
5764
.B iio_attr
5865
will attempt to write the new value to the attribute.
5966

60-
.SH OPTIONS
67+
.SH COMMANDS
68+
.TP
69+
The iio_attr utility has a few main options, which control what the main utility of the application is.
70+
.TP
71+
.B \-d, \-\-device-attr
72+
Read and Write IIO device attributes
73+
.TP
74+
.B \-c \-\-channel-attr
75+
Read and Write IIO channel attributes
76+
.TP
77+
.B \-B \-\-buffer-attr
78+
Read and Write IIO Buffer attributes
79+
.TP
80+
.B \-C \-\-context-attr
81+
Read and Write IIO Context attributes
82+
.TP
83+
.B \-D \-\-debug-attr
84+
Read and Write IIO Debug attributes
85+
.TP
86+
.B \-S, \-\-Scan
87+
Scan for available IIO contexts, optional arg of specific backend(s) 'ip', 'usb' or 'ip:usb'. If no argument is given, it checks all that are availble.
6188
.TP
6289
.B \-h, \-\-help
6390
Tells
6491
.I iio_attr
6592
to display some help, and then quit.
66-
.TP
67-
.B \-I, \-\-ignore-case
68-
When pattern matching devices, channels or attributes, ignore case
93+
94+
.SH OPTIONS
6995
.TP
7096
.B \-a, \-\-auto
71-
Look around for devices (locally, and usb), and if there is only one device
97+
Look around for devices (locally, ip, and usb), and if there is only one device
7298
found, connect to it.
7399
.TP
74100
.B \-u, \-\-uri
@@ -77,14 +103,19 @@ The Uniform Resource Identifier
77103
for connecting to devices, can be one of:
78104
.RS
79105
.IP ip:[address]
80-
network address, either numeric (192.168.0.1) or network hostname
106+
network address, either numeric (192.168.0.1) or network hostname (pluto.local)
81107
.IP ip:
82108
blank, if compiled with zeroconf support, will find an IIO device on network
83109
.IP usb:[device:port:instance]
84110
normally returned from
85111
.B iio_info -s
86-
.IP serial:[port]
87-
.IP local
112+
or
113+
.B iio_attr -S
114+
.IP usb:
115+
blank, if there is only one IIO device plugged into USB, find it, and attach to it.
116+
.IP serial:[port],[baud],[config]
117+
serial configuration, serial:/dev/ttyUSB0,115200,8n1 115200 baud, 8 data bits, no partity, one stop bit
118+
.IP local:
88119
with no address part
89120
.RE
90121
.TP
@@ -96,7 +127,13 @@ Filters channels by output channels only
96127
.TP
97128
.B \-s, \-\-scan-channel
98129
Filters channels by scan channels only
99-
130+
.TP
131+
.B \-I, \-\-ignore-case
132+
When pattern matching devices, channels or attributes, ignore case
133+
.TP
134+
.B \-g, \-\-generate-code <arg>
135+
Generate small C or python snippets that emulate what you are doing on the command line. Argument is a file name 'foo.c' or 'foo.py'
136+
.TP
100137
.SH RETURN VALUE
101138
If the specified device is not found, a non-zero exit code is returned.
102139

0 commit comments

Comments
 (0)