1 files changed, 57 insertions, 0 deletions
diff --git a/examplescripts/README b/examplescripts/README
new file mode 100644
index 0000000..bf67b54
--- /dev/null
+++ b/examplescripts/README
@@ -0,0 +1,57 @@
+# Home page: http://www.smartmontools.org
+#
+# $Id: README 4937 2019-08-04 15:29:43Z chrfranke $
+#
+# Copyright (C) 2003-08 Bruce Allen
+# Copyright (C) 2009-18 Christian Franke
+# 
+# SPDX-License-Identifier: GPL-2.0-or-later
+#
+
+This directory contains executable shell scripts, that are intended for
+use with the
+  -m address -M exec /path/to/an/executable
+Directive in /etc/smartd.conf.
+
+Details about how to use this Directive may be found in the man pages for
+smartd and smartd.conf.
+  man 8 smartd
+  man 5 smartd.conf
+should display those pages on your system.
+
+If you wish to contribute additional scripts to this collection,
+please email them to <smartmontools-support@listi.jpberlin.de>,
+and include a brief description to use below.
+
+The files contained in this directory are:
+
+Example1: Appends values of $SMARTD_* environment variables and the output
+          of smartctl -a to the normal email message, and sends that
+          to the email address listed as the argument to the -m
+          Directive.
+
+Example2: Appends output of smartctl -a to the normal email message
+          and sends that to the email address listed as the argument
+          to the -m Directive.
+
+Example3: Uses wall(1) to send a warning message to all users, then powers
+          down the machine.
+
+Example4: Uses powersave-notify to issue a desktop neutral warning.
+          (/etc/smartmontools/run.d/10powersave-notify from Debian package)
+
+Example5: Uses run-parts(8) to run scripts from /etc/smartmontools/run.d/.
+          (/usr/share/smartmontools/smartd-runner from Debian package)
+
+Example6: Sends a warning mail and then notifies the users by direct write
+          to terminals.
+          (/usr/libexec/smartmontools/smartdnotify from Fedora package)
+
+Example7: Sends an email using /usr/sbin/sendmail mail transfer agent.
+          May be useful if there is no other mail(1) compatible mailer
+          available.
+
+Example8: Sends an email using mail, mailx or sendmail mail transfer agent,
+          whichever is found first.  This script uses SMARTD_* environment
+          variables and could therefore also be used in a run-parts(8)
+          context like Example5.