summaryrefslogtreecommitdiff
path: root/commandline/man
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2013-10-03 19:43:35 +0200
committerDaniel Friesel <derf@finalrewind.org>2013-10-03 19:43:35 +0200
commitc041a6eae368a11c97e1ce83e02716ab190de0d3 (patch)
treed7b0fa35789aca3de21e4d2b987a92d528110620 /commandline/man
parent910e732b05b01eff02283e9a19f405deb1b060b4 (diff)
i2cget / i2cset: Accept hexadecimal input, document exit codes
Diffstat (limited to 'commandline/man')
-rw-r--r--commandline/man/vusb-i2cget.126
-rw-r--r--commandline/man/vusb-i2cset.111
2 files changed, 37 insertions, 0 deletions
diff --git a/commandline/man/vusb-i2cget.1 b/commandline/man/vusb-i2cget.1
index 0210f18..5125783 100644
--- a/commandline/man/vusb-i2cget.1
+++ b/commandline/man/vusb-i2cget.1
@@ -32,6 +32,32 @@ It first writes
to the device, then starts a new read connection and reads one byte.
This byte is printed to stdout as an unsigned char.
.
+.Ar address
+and
+.Ar register
+are decimal by default, use the
+.Qq 0x
+prefix for hexadecimal numbers
+.
+.
+.Sh EXIT STATUS
+.
+.Bl -tag -width indent
+.
+.It 0
+.
+Device queried successfully (ACK after address byte)
+.
+.It 1
+.
+Device did not respond (NAK after address byte)
+.
+.It 2
+.
+Bad input (not a number)
+.
+.El
+.
.
.Sh AUTHOR
.
diff --git a/commandline/man/vusb-i2cset.1 b/commandline/man/vusb-i2cset.1
index 7f24941..795345b 100644
--- a/commandline/man/vusb-i2cset.1
+++ b/commandline/man/vusb-i2cset.1
@@ -30,6 +30,12 @@ sends bytes to an I2C device. It transmits a START condition, then the
.Ar address
with the R/W bit set to write, and then all specified bytes.
.
+.Ar address
+and
+.Ar data
+are decimal by default, use the
+.Qq 0x
+prefix for hexadecimal numbers
.
.Sh EXIT STATUS
.
@@ -47,9 +53,14 @@ after transmitting the
.Ar address ,
a NAK was received
.
+.It 2
+.
+Bad input (not a number)
+.
.El
.
.
+
.Sh AUTHOR
.
Copyright (C) 2013 by Daniel Friesel