examplescripts/README

   1 # Home page: http://smartmontools.sourceforge.net
   2 #
   3 # $Id: README 3728 2012-12-13 17:57:50Z chrfranke $
   4 #
   5 # Copyright (C) 2003-8 Bruce Allen <smartmontools-support@lists.sourceforge.net>
   6 #
   7 # This program is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by the Free
   9 # Software Foundation; either version 2, or (at your option) any later
  10 # version.
  11 #
  12 # You should have received a copy of the GNU General Public License (for
  13 # example COPYING); if not, write to the Free Software Foundation, Inc., 51
  14 # Franklin Street, Fifth Floor, Boston, 02110-1301 USA.
  15 #
  16 # This code was originally developed as a Senior Thesis by Michael Cornwell
  17 # at the Concurrent Systems Laboratory (now part of the Storage Systems
  18 # Research Center), Jack Baskin School of Engineering, University of
  19 # California, Santa Cruz. http://ssrc.soe.ucsc.edu/
  20
  21 This directory contains executable bash scripts, that are intended for
  22 use with the
  23   -m address -M exec /path/to/an/executable
  24 Directive in /etc/smartd.conf.
  25
  26 Details about how to use this Directive may be found in the man pages for
  27 smartd and smartd.conf.
  28   man 8 smartd
  29   man 5 smartd.conf
  30 should display those pages on your system.
  31
  32 If you wish to contribute additional scripts to this collection,
  33 please email them to <smartmontools-support@lists.sourceforge.net>,
  34 and include a brief description to use below.
  35
  36 The files contained in this directory are:
  37
  38 Example1: appends values of $SMARTD_* environment variables and the output
  39           of smartctl -a to the normal email message, and sends that
  40           to the email address listed as the argument to the -m
  41           Directive.
  42
  43 Example2: Appends output of smartctl -a to the normal email message
  44           and sends that to the email address listed as the argument
  45           to the -m Directive.
  46
  47 Example3: Uses wall(1) to send a warning message to all users, then powers
  48           down the machine.
  49
  50 Example4: Uses powersave-notify to issue a desktop neutral warning.