root/lm-sensors/trunk/prog/detect/i2cdetect.8 @ 4213

Revision 4213, 2.5 KB (checked in by khali, 7 years ago)

i2cdetect: Make the output clearer, by replacing "XX" for missed
probed by "--". That way the successful probes will be more visible.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1.TH I2CDETECT 8 "October 2006"
2.SH NAME
3i2cdetect \- detect I2C chips
4
5.SH SYNOPSIS
6.B i2cdetect
7.RI [ -y ]
8.RI [ -a ]
9.RI [ -q | -r ]
10.I i2cbus
11.br
12.B i2cdetect
13.I -F
14.I i2cbus
15.br
16.B i2cdetect
17.I -V
18.br
19.B i2cdetect
20.I -l
21
22.SH DESCRIPTION
23i2cdetect is a userspace program to scan an I2C bus for devices. It
24outputs a table with the list of detected devices on the specified bus.
25\fIi2cbus\fR indicates the number of the I2C bus to be scanned, and
26should correspond to one of the busses listed by \fIi2cdetect -l\fR.
27.PP
28i2cdetect can also be used to query the functionalities of an I2C bus
29(see option \fB-F\fP.)
30
31.SH WARNING
32This program can confuse your I2C bus, cause data loss and worse!
33
34.SH INTERPRETING THE OUTPUT
35Each cell in the output table will contain one of the following symbols:
36.IP \(bu "\w'\(bu'u+1n"
37"--". The address was probed but no chip answered.
38.IP \(bu
39"UU". Probing was skipped, because this address is currently in use by
40a driver. This strongly suggests that there is a chip at this address.
41.IP \(bu
42An address number in hexadecimal, e.g. "2d" or "4e". A chip
43was found at this address.
44
45.SH OPTIONS
46.TP
47.B "\-y"
48Disable interactive mode. By default, i2cdetect will wait for a confirmation
49from the user before messing with the I2C bus. When this flag is used, it
50will perform the operation directly. This is mainly meant to be used in
51scripts.
52.TP
53.B "\-a"
54Force scanning of non-regular addresses. Not recommended.
55.TP
56.B "\-q"
57Use SMBus "quick write" commands for probing (by default, the command
58used is the one believed to be the safest for each address).
59Not recommended. This is known to corrupt the Atmel AT24RF08 EEPROM
60found on many IBM Thinkpad laptops.
61.TP
62.B "\-r"
63Use SMBus "read byte" commands for probing (by default, the command
64used is the one believed to be the safest for each address).
65Not recommended. This is known to lock SMBus on various write-only
66chips (most notably clock chips at address 0x69).
67.TP
68.B "\-F"
69Display the list of functionalities implemented by the adapter and exit.
70.TP
71.B "\-V"
72Display the version and exit.
73.TP
74.B "\-l"
75Output a list of installed busses.
76
77.SH CONFORMING TO
78lm_sensors-2.x
79
80.SH SEE ALSO
81i2cdump(8), sensors-detect(8)
82
83.SH AUTHOR
84Frodo Looijaard, Mark D. Studebaker, and the lm_sensors group
85http://www.lm-sensors.org/
86This manual page was written by Aurelien Jarno <aurel32@debian.org>, for
87the Debian GNU/Linux system. It was then reviewed by the lm_sensors team and
88is now part of the lm_sensors source distribution.
Note: See TracBrowser for help on using the browser.