-
Notifications
You must be signed in to change notification settings - Fork 312
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
man: manage common parts of man pages in one place
and stitch them together at build time, rather than using copy/paste everywhere, and forcing mutliple updates. Update a tiny bit the man pages, to be a little more pedanitic about serial ports, and a few other minor updates. Signed-off-by: Robin Getz <rgetz@mathworks.com> Signed-off-by: Paul Cercueil <paul@crapouillou.net>
- Loading branch information
Showing
10 changed files
with
123 additions
and
260 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
.TP | ||
.B \-h, \-\-help | ||
Tells | ||
.I ##APP_NAME## | ||
to display some help, and then quit. | ||
.TP | ||
.B \-S, \-\-scan [backends] | ||
Scan for available IIO contexts, optional arg of specific backend(s) 'ip', 'usb' or 'ip:usb'. | ||
Specific options for USB include Vendor ID, Product ID to limit scanning to specific devices 'usb=0456,b673'. | ||
vid,pid are hexadecimal numbers (no prefix needed), "*" (match any for pid only) | ||
If no argument is given, it checks all that are availble. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
.SH "SEE ALSO" | ||
.ad l | ||
.BR iio_attr (1), | ||
.BR iio_info (1), | ||
.BR iio_readdev (1), | ||
.BR iio_reg (1), | ||
.BR iio_writedev (1), | ||
.BR libiio (3) | ||
.PP | ||
libiio home page: | ||
.BR \%https://wiki.analog.com/resources/tools-software/linux-software/libiio | ||
.PP | ||
libiio code: | ||
.BR \%https://github.com/analogdevicesinc/libiio | ||
.PP | ||
Doxygen for libiio | ||
.BR \%https://analogdevicesinc.github.io/libiio/ | ||
.SH BUGS | ||
All bugs are tracked at: | ||
.BR \%https://github.com/analogdevicesinc/libiio/issues |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
.TP | ||
.B \-u, \-\-uri | ||
The Uniform Resource Identifier | ||
.I (uri) | ||
for connecting to devices, can be one of: | ||
.RS | ||
.IP ip:[address] | ||
network address, either numeric (192.168.0.1) or network hostname | ||
.IP ip: | ||
blank, if compiled with zeroconf support, will find an IIO device on network | ||
.IP usb:[device:port:instance] | ||
normally returned from | ||
.B ##APP_NAME## -S | ||
.IP serial:[port],[baud],[settings] | ||
which are controlled, and need to match the iiod (or tinyiiod) on the other end of the serial port. | ||
.RS | ||
.IP [port] | ||
is something like '/dev/ttyUSB0' on Linux, and 'COM4' on Windows. | ||
.IP [baud] | ||
is is normally one of 110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200 [default], 128000 or 256000, but can vary system to system. | ||
.IP [settings] | ||
would normally be configured as '8n1' this is controlled by: | ||
.RS | ||
.IP data_bits: | ||
(5, 6, 7, 8 [default], or 9) | ||
.IP parity_bits: | ||
('n' none [default], 'o' odd, 'e' even, 'm' mark, or 's' space) | ||
.IP stop_bits: | ||
(1 [default, or 2) | ||
.IP flow_control: | ||
('0' none [default], 'x' Xon Xoff, 'r' RTSCTS, or 'd' DTRDSR) | ||
.RE | ||
.RE | ||
.IP local: | ||
with no address part. | ||
.RE |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.