examplescripts/README

   1 # Home page: http://www.smartmontools.org
   2 #
   3 # $Id: README 4760 2018-08-19 18:45:53Z chrfranke $
   4 #
   5 # Copyright (C) 2003-08 Bruce Allen
   6 # Copyright (C) 2009-18 Christian Franke
   7 #
   8 # SPDX-License-Identifier: GPL-2.0-or-later
   9 #
  10
  11 This directory contains executable shell scripts, that are intended for
  12 use with the
  13   -m address -M exec /path/to/an/executable
  14 Directive in /etc/smartd.conf.
  15
  16 Details about how to use this Directive may be found in the man pages for
  17 smartd and smartd.conf.
  18   man 8 smartd
  19   man 5 smartd.conf
  20 should display those pages on your system.
  21
  22 If you wish to contribute additional scripts to this collection,
  23 please email them to <smartmontools-support@listi.jpberlin.de>,
  24 and include a brief description to use below.
  25
  26 The files contained in this directory are:
  27
  28 Example1: Appends values of $SMARTD_* environment variables and the output
  29           of smartctl -a to the normal email message, and sends that
  30           to the email address listed as the argument to the -m
  31           Directive.
  32
  33 Example2: Appends output of smartctl -a to the normal email message
  34           and sends that to the email address listed as the argument
  35           to the -m Directive.
  36
  37 Example3: Uses wall(1) to send a warning message to all users, then powers
  38           down the machine.
  39
  40 Example4: Uses powersave-notify to issue a desktop neutral warning.
  41           (/etc/smartmontools/run.d/10powersave-notify from Debian package)
  42
  43 Example5: Uses run-parts(8) to run scripts from /etc/smartmontools/run.d/.
  44           (/usr/share/smartmontools/smartd-runner from Debian package)
  45
  46 Example6: Sends a warning mail and then notifies the users by direct write
  47           to terminals.
  48           (/usr/libexec/smartmontools/smartdnotify from Fedora package)