8f9a798fca9e6a2536b84e3c28767181cca40e22
[platform/upstream/libatasmart.git] / README
1 LIBATASMART ATA S.M.A.R.T. Reading and Parsing Library
2
3 GIT:
4         git://git.0pointer.de/libatasmart.git
5
6 GITWEB:
7         http://git.0pointer.de/?p=libatasmart.git
8
9 NOTES:
10         As the name suggests libatasmart only does ATA S.M.A.R.T.,
11         there is no support for SCSI harddisks. SCSI S.M.A.R.T. is a
12         very different system, support for it should be implemented in
13         a separate library "libscsismart" if there should ever be
14         demand for it.
15
16         This library is supposed to be lean and small and thus
17         supports only a subset of the S.M.A.R.T. functionality.
18         However, I claim that it implements the relevant part of it.
19         If you need full control over all S.M.A.R.T. functionality of
20         your hardware please refer to Buce Allen's smartmontools.
21
22         This runs on Linux only. Patches to port it to other operating
23         systems are welcome, as long as they don't make the code
24         difficult to read and come with more than one or two
25         #ifdefs. I am happy to include patches for non-Linux systems
26         -- please note however that non-Linux operating systems are
27         not relevant for release management. i.e. I won't make sure
28         that libatasmart compiles fine on non-Linux systems before
29         release.
30
31         libatasmart supports classic ATA/IDE disks (i.e. /dev/hda) as
32         well as ATA disks that are connected through a SCSI layer
33         (SAT) (such as a SATA /dev/sda).
34
35         USB disks generally don't support SAT and thus generally
36         cannot be queried for S.M.A.R.T. data.
37
38 ACKNOWLEDGMENTS:
39         This library is inspired by Bruce Allen's smartmontools and by
40         Emmanuel Varagnat's hddtemp. However libatasmart is completely
41         new code, not a single line has been copied from those two
42         projects.
43
44 LICENSE:
45         LGPLv2.1+
46
47 AUTHOR:
48         Lennart Poettering
49
50 REQUIREMENTS:
51         None (except Linux with a GLibc)