From 170e01d3bb1fafda6c1e1b6f588989af735aaff5 Mon Sep 17 00:00:00 2001 From: Joe Hunkeler Date: Wed, 13 Aug 2014 03:07:40 +0000 Subject: README.md edited online with Bitbucket --- README.md | 44 +++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index e79c9f0..a391631 100644 --- a/README.md +++ b/README.md @@ -30,30 +30,13 @@ python setup.py install --user # What is cidrchk? -`cidrchk` is a simple Python script with only one purpose: To inform a user whether or not their computer is connected to a particular network. For example, on your "work" laptop, let's assume you depend on autofs to automatically mount NFS directories at-will. +`cidrchk` is a simple Python script with only one purpose: To inform a user whether or not their computer is connected to a particular network. -However, when you are off-site or not connected to your institution's VPN, you quickly realize attempting to access these data areas causes significant delays (i.e. a *five minute* default timeout) - -# Options - -``` -usage: cidrchk [-h] [--ignore IGNORE] [--debug] [--verbose] cidr [cidr ...] - -Detects whether or not any ethernet devices match to a defined CIDR range. - -positional arguments: - cidr IP range(s) to detect +# How do I use it? -optional arguments: - -h, --help show this help message and exit - --ignore IGNORE, -i IGNORE - IP range(s) to ignore (Default: link-local and - localhost) - --debug, -d - --verbose, -v -``` +Let's assume you depend on autofs to automatically mount NFS directories at-will. -# How do I use it? +However, when you are off-site or not connected to your institution's VPN, you quickly realize attempting to access these data areas causes significant delays (i.e. a *five minute* default timeout) Consider the following **.cshrc** example: @@ -120,6 +103,25 @@ if (( ${OFFSITE} )); then fi ``` +# Options + +``` +usage: cidrchk [-h] [--ignore IGNORE] [--debug] [--verbose] cidr [cidr ...] + +Detects whether or not any ethernet devices match to a defined CIDR range. + +positional arguments: + cidr IP range(s) to detect + +optional arguments: + -h, --help show this help message and exit + --ignore IGNORE, -i IGNORE + IP range(s) to ignore (Default: link-local and + localhost) + --debug, -d + --verbose, -v +``` + # Bug Reporting Submit bug reports via this project's issue tracker: https://bitbucket.org/jhunkeler/cidrchk/issues -- cgit