From ec80b4403b0d2ea418a281225f7f2719a609f0d3 Mon Sep 17 00:00:00 2001
From: Siraaj Khandkar <siraaj@khandkar.net>
Date: Fri, 3 Aug 2018 17:59:59 -0400
Subject: [PATCH] Add some notes on actuator(s)

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/README.md b/README.md
index 62036c9..7ab320b 100644
--- a/README.md
+++ b/README.md
@@ -38,7 +38,42 @@ Design
                             ~~~~~~
 ```
 
+### Actuator
+By default, actuator is left disconnected from the controller's output, so if
+desired - it needs to be manually attached when starting `khatus`. For example,
+in my `.xinitrc` I have:
+
+```sh
+$BIN/khatus \
+2> >($BIN/twrap.sh >> $HOME/var/log/khatus.log) \
+| $BIN/khatus_actuator \
+    -v pid="$$" \
+    -v display=":0" \
+2> >($BIN/twrap.sh >> $HOME/var/log/khatus-actuator.log) \
+&
+```
+
+(`twrap.sh` is a simple script which prefixes a timestamp to each line)
+
+The idea is to later have multiple, (some more-general and some more-specific)
+actuators which can be selected as needed, say for example:
+
+```sh
+$BIN/khatus \
+| tee \
+>(awk '/^STATUS_BAR/ {sub("^" $1 " *", ""); system("xsetroot -name \" " $0 " \"")}') \
+>(grep '^REPORT' | actuate_report_to_email) \
+>(grep '^ALERT' | grep mpd | actuate_alert_to_email) \
+>(grep '^ALERT' | grep IntrusionAttempt | actuate_intruder_to_iptables_drop) \
+>(grep '^ALERT' | grep NewDevice | actuate_alert_to_notify_send)
+>(grep '^ALERT' | grep DiskError | actuate_call_mom)
+```
+
+... and/or any other such fun you might imagine.
+
+### Errors
 Any errors encountered by any sensor are propagated as alerts by the
 controller, which are in turn actualized as desktop notifications by the
 actuator:
+
 ![screenshot-self-error-propagation](screenshot-self-error-propagation.jpg)
-- 
2.20.1