aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2014-05-26 11:11:55 +1200
committerTom Ryder <tom@sanctum.geek.nz>2014-05-26 11:11:55 +1200
commit64ff240537623fb4648b790b6b78044401446529 (patch)
tree75aa33648755b58160eb64e37f3ae82ad9fcc733 /README.markdown
downloadnwatch-64ff240537623fb4648b790b6b78044401446529.tar.gz
nwatch-64ff240537623fb4648b790b6b78044401446529.zip
First commit of project
Just the script, a man page, a README, and a LICENSE. Probably doesn't need much else.
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..a7af74d
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,32 @@
+Nwatch
+======
+
+Slightly friendlier version of the suggested script in the manual page for
+[`ndiff(1)`](http://linux.die.net/man/1/ndiff) from the
+[Nmap](http://nmap.org/) suite, implemented in Bash.
+
+Usage:
+
+ $ nwatch HOSTLIST CACHEDIR
+
+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
+
+I recommend you use [croncrypt](https://github.com/tejr/croncrypt), so you
+don't leak your network information in plain text in your email.
+
+License
+-------
+
+Copyright (c) [Tom Ryder](http://sanctum.geek.nz/). Distributed under
+[GPLv2](https://www.gnu.org/licenses/gpl-2.0.html), same as Nmap itself; see
+`LICENSE`.
+
+Nmap is a registered trademark of Insecure.Com LLC, and this project is not
+affiliated with it.
+