Browse Source

Updated MANIFEST for new unit tests. Copied POD over to README

Paul Trost 11 years ago
parent
commit
45542b4f5a
2 changed files with 49 additions and 25 deletions
  1. 3 1
      MANIFEST
  2. 46 24
      README

+ 3 - 1
MANIFEST

@@ -2,9 +2,11 @@ Changes
 lib/Disk/SMART.pm
 Makefile.PL
 MANIFEST			This list of files
-README
+INSTALL
 README.md
 t/00-load.t
+t/01-instantiation.t
+t/02_get_functions.t
 t/manifest.t
 t/pod-coverage.t
 t/pod.t

+ 46 - 24
README

@@ -1,39 +1,61 @@
-Disk-SMART
+Disk::SMART(3)        User Contributed Perl Documentation       Disk::SMART(3)
 
-This module requires that smartctl be accessed as root. If you do not wish to install the module as root then you will need to make smartctl SETUID as root with "chmod u+s <path/to/smartctl>"
 
-To install this module, run the following commands:
 
-	perl Makefile.PL
-	make
-	sudo make test
-	sudo make install
+NNAAMMEE
+       Disk::SMART - Provides an interface to smartctl
 
-SUPPORT AND DOCUMENTATION
+VVEERRSSIIOONN
+       Version 0.01
 
-After installing, you can find documentation for this module with the
-perldoc command.
+SSYYNNOOPPSSIISS
+       Disk::SMART is an object ooriented module that provides an interface to
+       get SMART disk info from a device as well as initiate testing.
 
-    perldoc Disk::SMART
+           use Disk::SMART;
 
-You can also look for information at:
+           my $smart = Disk::SMART->new('/dev/sda');
 
-    RT, CPAN's request tracker (report bugs here)
-        http://rt.cpan.org/NoAuth/Bugs.html?Dist=Disk-SMART
+MMEETTHHOODDSS
+   nneeww ((DDEEVVIICCEE))
+       Instantiates the Disk::SMART object
 
-    AnnoCPAN, Annotated CPAN documentation
-        http://annocpan.org/dist/Disk-SMART
+       "DEVICE" - Device identifier of SSD / Hard Drive
 
-    CPAN Ratings
-        http://cpanratings.perl.org/d/Disk-SMART
+           my $smart = Disk::SMART->new( 'dev/sda', '/dev/sdb' );
 
-    Search CPAN
-        http://search.cpan.org/dist/Disk-SMART/
+GGeettttiinngg iinnffoorrmmaattiioonn ffrroomm ssmmaarrttccttll
+   ggeett__ddiisskk__tteemmpp ((DDEEVVIICCEE))
+       Returns an array with the temperature of the device in Celsius and
+       Farenheit, or N/A.
 
+       "DEVICE" - Device identifier of SSD / Hard Drive
 
-LICENSE AND COPYRIGHT
+           my ($temp_c, $temp_f) = $smart->get_disk_temp('/dev/sda');
 
-Copyright 2014 Paul Trost
-This script is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License v2, or at your option any later version.
-<http://gnu.org/licenses/gpl.html>
+   ggeett__ddiisskk__hheeaalltthh ((DDEEVVIICCEE))
+       Returns the health of the disk. Output is "PASSED", "FAILED", or "N/A".
 
+       "DEVICE" - Device identifier of SSD / Hard Drive
+
+           my $disk_health = $smart->get_disk_health('/dev/sda');
+
+   ggeett__ddiisskk__mmooddeell ((DDEEVVIICCEE))
+       Returns the model of the device. Output is "<device>: <model>" or
+       "N/A". eg. "/dev/sda: ST3250410AS"
+
+       "DEVICE" - Device identifier of SSD / Hard Drive
+
+           my $disk_model = $smart->get_disk_model('/dev/sda');
+
+AAUUTTHHOORR
+        Paul Trost <paul.trost@trostfamily.org>
+
+LLIICCEENNSSEE AANNDD CCOOPPYYRRIIGGHHTT
+        Copyright 2014.
+        This script is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License v2, or at your option any later version.
+        <http://gnu.org/licenses/gpl.html>
+
+
+
+perl v5.14.2                      2014-10-03                    Disk::SMART(3)