From 833d3c4255bb149c4cd61e3cac0ee0b557723977 Mon Sep 17 00:00:00 2001 From: Tom Ryder Date: Tue, 10 Jul 2018 15:26:50 +1200 Subject: Rename README to .md --- README.markdown | 37 ------------------------------------- README.md | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 37 deletions(-) delete mode 100644 README.markdown create mode 100644 README.md diff --git a/README.markdown b/README.markdown deleted file mode 100644 index f1c5a3a..0000000 --- a/README.markdown +++ /dev/null @@ -1,37 +0,0 @@ -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/cache/nwatch/mynet - -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/cache/nwatch/mynet - -I recommend you use -[Mail::Run::Crypt](https://metacpan.org/pod/Mail::Run::Crypt), so you don't -leak your network information in plain text in your email. - -Please also consider whether your scan actually requires root privileges, and -could not instead be run by a dedicated user with appropriately limited -privileges. - -License -------- - -Copyright (c) [Tom Ryder](https://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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1c5a3a --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +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/cache/nwatch/mynet + +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/cache/nwatch/mynet + +I recommend you use +[Mail::Run::Crypt](https://metacpan.org/pod/Mail::Run::Crypt), so you don't +leak your network information in plain text in your email. + +Please also consider whether your scan actually requires root privileges, and +could not instead be run by a dedicated user with appropriately limited +privileges. + +License +------- + +Copyright (c) [Tom Ryder](https://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. -- cgit v1.2.3