Refer to ZED's scripts as ZEDLETs

The executables invoked by the ZED in response to a given zevent
have been generically referred to as "scripts".  By convention,
these scripts have aimed to be /bin/sh compatible for reasons of
portability and comprehensibility.  However, the ZED only requires
they be executable and (ideally) capable of reading environment
variables.  As such, these scripts are now referred to as ZEDLETs
(ZFS Event Daemon Linkage for Executable Tasks).

Signed-off-by: Chris Dunlap <[email protected]>
Signed-off-by: Brian Behlendorf <[email protected]>
Closes #2735

1 files changed, 42 insertions, 41 deletions

diff --git a/man/man8/zed.8.in b/man/man8/zed.8.in
index b853d86e5..71a1dce60 100644
--- a/man/man8/zed.8.in
+++ b/man/man8/zed.8.in
@@ -24,13 +24,13 @@
 .TH ZED 8 "Octember 1, 2013" "ZFS on Linux" "System Administration Commands"
 
 .SH NAME
-zed \- ZFS Event Daemon
+ZED \- ZFS Event Daemon
 
 .SH SYNOPSIS
 .HP
 .B zed
 .\" [\fB\-c\fR \fIconfigfile\fR]
-[\fB\-d\fR \fIscriptdir\fR]
+[\fB\-d\fR \fIzedletdir\fR]
 [\fB\-f\fR]
 [\fB\-F\fR]
 [\fB\-h\fR]
@@ -44,9 +44,10 @@ zed \- ZFS Event Daemon
 
 .SH DESCRIPTION
 .PP
-\fBzed\fR (ZFS Event Daemon) monitors events generated by the ZFS kernel
-module.  When a ZFS event (zevent) is posted, \fBzed\fR will run any scripts
-that have been enabled for the corresponding zevent class.
+\fBZED\fR (ZFS Event Daemon) monitors events generated by the ZFS kernel
+module.  When a zevent (ZFS Event) is posted, \fBZED\fR will run any ZEDLETs
+(ZFS Event Daemon Linkage for Executable Tasks) that have been enabled for the
+corresponding zevent class.
 
 .SH OPTIONS
 .TP
@@ -81,8 +82,8 @@ to be reprocessed.
 .\" .BI \-c\  configfile
 .\" Read the configuration from the specified file.
 .TP
-.BI \-d\  scriptdir
-Read the enabled scripts from the specified directory.
+.BI \-d\  zedletdir
+Read the enabled ZEDLETs from the specified directory.
 .TP
 .BI \-p\  pidfile
 Write the daemon's process ID to the specified file.
@@ -92,7 +93,7 @@ Write the daemon's state to the specified file.
 
 .SH ZEVENTS
 .PP
-A zevent is comprised of a list of name/value pairs (nvpairs).  Each zevent
+A zevent is comprised of a list of nvpairs (name/value pairs).  Each zevent
 contains an EID (Event IDentifier) that uniquely identifies it throughout
 the lifetime of the loaded ZFS kernel module; this EID is a monotonically
 increasing integer that resets to 1 each time the kernel module is loaded.
@@ -105,29 +106,29 @@ their associated lists of nvpairs) using the "\fBzpool events \-v\fR" command.
 
 .SH CONFIGURATION
 .PP
-The scripts to be invoked in response to zevents are located in the
-enabled-scripts directory.  These can be symlinked or copied from the
-installed-scripts directory; symlinks allow for automatic updates from the
-installed scripts, whereas copies preserve local modifications.  As a security
-measure, scripts must be owned by root.  They must have execute permissions
-for the user, but they must not have write permissions for group or other.
-Dotfiles are ignored.
+ZEDLETs to be invoked in response to zevents are located in the
+\fIenabled-zedlets\fR directory.  These can be symlinked or copied from the
+\fIinstalled-zedlets\fR directory; symlinks allow for automatic updates
+from the installed ZEDLETs, whereas copies preserve local modifications.
+As a security measure, ZEDLETs must be owned by root.  They must have
+execute permissions for the user, but they must not have write permissions
+for group or other.  Dotfiles are ignored.
 .PP
-Scripts are named after the zevent class for which they should be invoked.
-In particular, a script will be invoked for a given zevent if either its
+ZEDLETs are named after the zevent class for which they should be invoked.
+In particular, a ZEDLET will be invoked for a given zevent if either its
 class or subclass string is a prefix of its filename (and is followed by
 a non-alphabetic character).  As a special case, the prefix "all" matches
-all zevents.  Multiple scripts may be invoked for a given zevent.
+all zevents.  Multiple ZEDLETs may be invoked for a given zevent.
 
-.SH SCRIPTS
+.SH ZEDLETS
 .PP
-Scripts should be written under the presumption they can be invoked
-concurrently, and they should use appropriate locking to access any shared
-resources.  Common variables used by the scripts can be stored in the default
-rc file which is sourced by the scripts; these variables should be prefixed
-with "ZED_".
+ZEDLETs are executables invoked by the ZED in response to a given zevent.
+They should be written under the presumption they can be invoked concurrently,
+and they should use appropriate locking to access any shared resources.
+Common variables used by ZEDLETs can be stored in the default rc file which
+is sourced by scripts; these variables should be prefixed with "ZED_".
 .PP
-The zevent nvpairs are passed to the scripts as environment variables.
+The zevent nvpairs are passed to ZEDLETs as environment variables.
 Each nvpair name is converted to an environment variable in the following
 manner: 1) it is prefixed with "ZEVENT_", 2) it is converted to uppercase,
 and 3) each non-alphanumeric character is converted to an underscore.
@@ -171,12 +172,12 @@ ZED_PID
 The daemon's process ID.
 .TP
 .B
-ZED_SCRIPT_DIR
-The daemon's current enabled-scripts directory.
+ZED_ZEDLET_DIR
+The daemon's current \fIenabled-zedlets\fR directory.
 .TP
 .B
 ZFS_ALIAS
-The ZFS alias (name-ver-rel) string used to build the daemon.
+The ZFS alias (\fIname-version-release\fR) string used to build the daemon.
 .TP
 .B
 ZFS_VERSION
@@ -186,10 +187,10 @@ The ZFS version used to build the daemon.
 ZFS_RELEASE
 The ZFS release used to build the daemon.
 .PP
-Scripts may need to call other ZFS commands.  The installation paths of
+ZEDLETs may need to call other ZFS commands.  The installation paths of
 the following executables are defined: \fBZDB\fR, \fBZED\fR, \fBZFS\fR,
 \fBZINJECT\fR, and \fBZPOOL\fR.  These variables can be overridden in the
-zed.rc if needed.
+rc file if needed.
 
 .SH FILES
 .\" .TP
@@ -197,13 +198,13 @@ zed.rc if needed.
 .\" The default configuration file for the daemon.
 .TP
 .I @sysconfdir@/zfs/zed.d
-The default directory for enabled scripts.
+The default directory for enabled ZEDLETs.
 .TP
 .I @sysconfdir@/zfs/zed.d/zed.rc
-The default rc file for common variables used by the scripts.
+The default rc file for common variables used by ZEDLETs.
 .TP
 .I @libexecdir@/zfs/zed.d
-The default directory for installed scripts.
+The default directory for installed ZEDLETs.
 .TP
 .I @runstatedir@/zed.pid
 The default file containing the daemon's process ID.
@@ -214,14 +215,14 @@ The default file containing the daemon's state.
 .SH SIGNALS
 .TP
 .B HUP
-Reconfigure the daemon and rescan the directory for enabled scripts.
+Reconfigure the daemon and rescan the directory for enabled ZEDLETs.
 .TP
 .B TERM
 Terminate the daemon.
 
 .SH NOTES
 .PP
-\fBzed\fR requires root privileges.
+\fBZED\fR requires root privileges.
 .\" Do not taunt zed.
 
 .SH BUGS
@@ -229,16 +230,16 @@ Terminate the daemon.
 Events are processed synchronously by a single thread.  This can delay the
 processing of simultaneous zevents.
 .PP
-There is no maximum timeout for script execution.  Consequently, a misbehaving
-script can delay the processing of subsequent zevents.
+There is no maximum timeout for ZEDLET execution.  Consequently, a misbehaving
+ZEDLET can delay the processing of subsequent zevents.
 .PP
-The ownership and permissions of the enabled-scripts directory (along
+The ownership and permissions of the \fIenabled-zedlets\fR directory (along
 with all parent directories) are not checked.  If any of these directories
 are improperly owned or permissioned, an unprivileged user could insert a
-script to be executed as root.  The requirement that scripts be owned by
+ZEDLET to be executed as root.  The requirement that ZEDLETs be owned by
 root mitigates this to some extent.
 .PP
-Scripts are unable to return state/status information to the kernel.
+ZEDLETs are unable to return state/status information to the kernel.
 .PP
 Some zevent nvpair types are not handled.  These are denoted by zevent
 environment variables having a "_NOT_IMPLEMENTED_" value.
@@ -257,7 +258,7 @@ Copyright (C) 2013\-2014 Lawrence Livermore National Security, LLC.
 
 .SH LICENSE
 .PP
-\fBzed\fR (ZFS Event Daemon) is distributed under the terms of the
+\fBZED\fR (ZFS Event Daemon) is distributed under the terms of the
 Common Development and Distribution License (CDDL\-1.0).
 
 .SH SEE ALSO