← Back to branch summary

~mmach/netext73/smartmontools

« back to all changes in this revision

Viewing changes to README

  • Committer: mmach
  • Date: 2019-11-14 13:22:36 UTC
  • Revision ID: netbit73@gmail.com-20191114132236-5pl3bwkmwrwqjk5u
test

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
 
1
==========================================================
 
2
smartmontools - S.M.A.R.T. utility toolset for Darwin/Mac
 
3
OSX, FreeBSD, Linux, NetBSD, OpenBSD, Solaris, and Windows.
 
4
==========================================================
 
5
 
 
6
$Id: README 4760 2018-08-19 18:45:53Z chrfranke $
 
7
 
 
8
== HOME ==
 
9
The home for smartmontools is located at:
 
10
    
 
11
    http://www.smartmontools.org/
 
12
 
 
13
Please see this web site for updates, documentation, and for submitting
 
14
patches and bug reports.
 
15
 
 
16
You will find a mailing list for support and other questions at:
 
17
 
 
18
    https://listi.jpberlin.de/mailman/listinfo/smartmontools-support
 
19
 
 
20
 
 
21
== COPYING ==
 
22
Copyright (C) 2002-9 Bruce Allen
 
23
Copyright (C) 2004-18 Christian Franke
 
24
 
 
25
This program is free software; you can redistribute it and/or modify it
 
26
under the terms of the GNU General Public License as published by the Free
 
27
Software Foundation; either version 2, or (at your option) any later
 
28
version.
 
29
 
 
30
You should have received a copy of the GNU General Public License (for
 
31
example COPYING).  If not, see <http://www.gnu.org/licenses/>.
 
32
 
 
33
SPDX-License-Identifier: GPL-2.0-or-later
 
34
 
 
35
 
 
36
== CREDITS ==
 
37
See AUTHORS file.
 
38
 
 
39
 
 
40
== OVERVIEW ==
 
41
smartmontools contains utilities that control and monitor storage
 
42
devices using the Self-Monitoring, Analysis and Reporting Technology
 
43
(SMART) system build into ATA/SATA and SCSI/SAS hard drives and
 
44
solid-state drives.  This is used to check the reliability of the
 
45
drive and to predict drive failures.
 
46
 
 
47
 
 
48
== CONTENTS ==
 
49
The suite contains two utilities:
 
50
 
 
51
smartctl is a command line utility designed to perform S.M.A.R.T. tasks
 
52
         such as disk self-checks, and to report the S.M.A.R.T. status of
 
53
         the disk.
 
54
 
 
55
smartd   is a daemon that periodically monitors S.M.A.R.T. status and
 
56
         reports errors and changes in S.M.A.R.T. attributes to syslog.
 
57
 
 
58
 
 
59
== OBTAINING SMARTMONTOOLS ==
 
60
 
 
61
Source tarballs
 
62
---------------
 
63
 
 
64
http://sourceforge.net/projects/smartmontools/files/
 
65
 
 
66
SVN
 
67
---
 
68
 
 
69
svn co http://svn.code.sf.net/p/smartmontools/code/trunk/smartmontools smartmontools
 
70
 
 
71
This will create a subdirectory called smartmontools containing the code.
 
72
 
 
73
To instead get the 5.38 release:
 
74
 
 
75
svn co http://svn.code.sf.net/p/smartmontools/code/tags/RELEASE_5_38/sm5 smartmontools
 
76
 
 
77
You can see what the different tags are by looking at
 
78
http://sourceforge.net/p/smartmontools/code/HEAD/tree/tags/
 
79
 
 
80
== BUILDING/INSTALLING SMARTMONTOOLS ==
 
81
 
 
82
Refer to the "INSTALL" file for detailed installation instructions.
 
83
 
 
84
== GETTING STARTED ==
 
85
 
 
86
To examine SMART data from a disk, try:
 
87
  smartctl -a /dev/sda
 
88
See the manual page 'man smartctl' for more information.
 
89
 
 
90
To start automatic monitoring of your disks with the smartd daemon,
 
91
try:
 
92
  smartd -d
 
93
to start the daemon in foreground (debug) mode, or
 
94
  smartd
 
95
to start the daemon in background mode.  This will log messages to
 
96
SYSLOG.  If you would like to get email warning messages, please set
 
97
up the configuration file smartd.conf with the '-m' mail warning
 
98
Directive.  See the manual page 'man smartd' for more information.