aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2014-05-26 12:29:39 +1200
committerTom Ryder <tom@sanctum.geek.nz>2014-05-26 12:29:39 +1200
commit4953174161b0ce317404c639930b95497531f200 (patch)
treeeb02d3153f20687e6d1d794aab9a432e908a27b3
parentFirst commit of project (diff)
downloadnwatch-4953174161b0ce317404c639930b95497531f200.tar.gz
nwatch-4953174161b0ce317404c639930b95497531f200.zip
Clarify a little what it does
-rw-r--r--README.markdown3
-rwxr-xr-xbin/nwatch4
2 files changed, 4 insertions, 3 deletions
diff --git a/README.markdown b/README.markdown
index a7af74d..1ec172f 100644
--- a/README.markdown
+++ b/README.markdown
@@ -13,7 +13,8 @@ Example with root privileges:
# nwatch /etc/nwatch.mynet /var/cachedir/nwatch/mynet
-Prints the results of the diff to stdout; intended to be called from cron(8):
+Prints the results of an `ndiff(1)` call against the last known scan to stdout;
+intended to be called from `cron(8)`:
0 0 * * 0 nwatch /etc/nwatch.mynet /var/log/nwatch/mynet
diff --git a/bin/nwatch b/bin/nwatch
index 2dcad63..5a6bb23 100755
--- a/bin/nwatch
+++ b/bin/nwatch
@@ -9,8 +9,8 @@
# Example with root privileges:
# # nwatch /etc/nwatch.mynet /var/cachedir/nwatch/mynet
#
-# Prints the results of the diff to stdout; intended to be called from cron(8):
-# 0 0 * * 0 nwatch /etc/nwatch.mynet /var/log/nwatch/mynet
+# Prints the results of an ndiff(1) call against the last known scan to stdout;
+# intended to be called from cron(8):
#
# I recommend you use croncrypt, so you don't leak your network information in
# plain text in your email: <https://github.com/tejr/croncrypt>