import smartmontools 7.0

[mirror_smartmontools-debian.git] / smartd.8.in

diff --git a/smartd.8.in b/smartd.8.in
index 5d5521478a7fa04979cea486b13614cde107821a..80cb4e8263f6a323cd055b42b89518a656417cc8 100644 (file)
--- a/smartd.8.in
+++ b/smartd.8.in
@@ -1,21 +1,10 @@
 .ig
 Copyright (C) 2002-10 Bruce Allen
-Copyright (C) 2004-17 Christian Franke
+Copyright (C) 2004-18 Christian Franke
 
-$Id: smartd.8.in 4576 2017-10-29 16:41:44Z chrfranke $
+SPDX-License-Identifier: GPL-2.0-or-later
 
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2, or (at your option)
-any later version.
-
-You should have received a copy of the GNU General Public License
-(for example COPYING); If not, see <http://www.gnu.org/licenses/>.
-
-This code was originally developed as a Senior Thesis by Michael Cornwell
-at the Concurrent Systems Laboratory (now part of the Storage Systems
-Research Center), Jack Baskin School of Engineering, University of
-California, Santa Cruz. http://ssrc.soe.ucsc.edu/
+$Id: smartd.8.in 4861 2018-12-16 18:24:57Z chrfranke $
 
 ..
 .\" Macros borrowed from pages generated with Pod::Man
@@ -38,10 +27,10 @@ California, Santa Cruz. http://ssrc.soe.ucsc.edu/
 .TH SMARTD 8 "CURRENT_SVN_DATE" "CURRENT_SVN_VERSION" "SMART Monitoring Tools"
 .SH NAME
 \fBsmartd\fP \- SMART Disk Monitoring Daemon
-
+.Sp
 .SH SYNOPSIS
 .B smartd [options]
-
+.Sp
 .SH DESCRIPTION
 .\" %IF NOT OS ALL
 .\"! [This man page is generated for the OS_MAN_FILTER version of smartmontools.
@@ -108,6 +97,21 @@ To exit \fBsmartd\fP use CONTROL-\e.
 .\" %IF OS Windows
 (Windows: CONTROL-Break).
 .\" %ENDIF OS Windows
+.\" %IF ENABLE_SYSTEMD_NOTIFY
+.PP
+[Linux only]
+[NEW EXPERMIMENTAL SMARTD FEATURE]
+If \fBsmartd\fP is started as a \fBsystemd\fP(1) service and
+\*(AqType=Notify\*(Aq is specified in the service file, the service manager
+is notified after successful startup.
+Other state changes are reported via systemd notify STATUS messages.
+Notification of successful reloads (after \fBHUP\fP signal) is not supported.
+To detect this process start-up type, \fBsmartd\fP checks whether the
+environment variable \*(AqNOTIFY_SOCKET\*(Aq is set.
+Note that it is required to set the \*(Aq\-n\*(Aq (\*(Aq\-\-nofork\*(Aq)
+option in the \*(AqExecStart=/usr/local/sbin/smartd\*(Aq command line
+if \*(AqType=Notify\*(Aq is used.
+.\" %ENDIF ENABLE_SYSTEMD_NOTIFY
 .PP
 On startup, in the absence of the configuration file
 \fB/usr/local/etc/smartd.conf\fP, the \fBsmartd\fP daemon first scans for all
@@ -119,7 +123,6 @@ devices, and \fB"/dev/sd[a\-z]"\fP, \fB"/dev/sd[a\-c][a\-z]"\fP
 for ATA/SATA or SCSI/SAS devices.
 Disks behind RAID controllers are not included.
 .Sp
-[NEW EXPERIMENTAL SMARTD FEATURE]
 If directive \*(Aq\-d nvme\*(Aq
 .\" %IF ENABLE_NVME_DEVICESCAN
 or no \*(Aq\-d\*(Aq directive
@@ -164,7 +167,6 @@ ICHxR controller with RST driver.
 .Sp
 Disks behind Areca RAID controllers are not included.
 .Sp
-[NEW EXPERIMENTAL SMARTD FEATURE]
 If directive \*(Aq\-d nvme\*(Aq
 .\" %IF ENABLE_NVME_DEVICESCAN
 or no \*(Aq\-d\*(Aq directive
@@ -421,8 +423,7 @@ this option are:
 .Sp
 .\" %IF OS Darwin FreeBSD Linux NetBSD Windows Cygwin
 .I nvmeioctl
-\- [NEW EXPERIMENTAL SMARTD FEATURE]
-report only ioctl() transactions with NVMe devices.
+\- report only ioctl() transactions with NVMe devices.
 .Sp
 .\" %ENDIF OS Darwin FreeBSD Linux NetBSD Windows Cygwin
 Any argument may include a positive integer to specify the level of
@@ -808,6 +809,10 @@ Alternatively send the info to the smartmontools support mailing list:
 .br
 \fBupdate-smart-drivedb\fP(8).
 .\" %ENDIF ENABLE_UPDATE_SMART_DRIVEDB
+.\" %IF ENABLE_SYSTEMD_NOTIFY
+.br
+\fBsystemd.exec\fP(5).
+.\" %ENDIF ENABLE_SYSTEMD_NOTIFY
 .Sp
 .SH REFERENCES
 Please see the following web site for more info:
@@ -834,4 +839,4 @@ Links to these and other documents may be found on the Links page of the
 .SH PACKAGE VERSION
 CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
 .br
-$Id: smartd.8.in 4576 2017-10-29 16:41:44Z chrfranke $
+$Id: smartd.8.in 4861 2018-12-16 18:24:57Z chrfranke $