X-Git-Url: https://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=doc%2Fman1%2Fhath.1;h=6e4ef3700b669ae7d4e69c00e0bebd36fd07cdb3;hb=2744428b39c7f253d6629335b9cb4122e224e177;hp=c0d6bc004f8eb5f552049e75004ef6aa562cce8b;hpb=b60a55a3e5ed9b9c3fa58405832bda095bb89d60;p=hath.git diff --git a/doc/man1/hath.1 b/doc/man1/hath.1 index c0d6bc0..6e4ef37 100644 --- a/doc/man1/hath.1 +++ b/doc/man1/hath.1 @@ -4,12 +4,12 @@ hath \- Manipulate network blocks in CIDR notation .SH SYNOPSIS -\fBhath\fR [\fBregexed|reduced|duped|diffed\fR] [\fB\-h\fR] [\fB-i \fIFILE\fR] \fI\fR +\fBhath\fR [\fBregexed|reduced|duped|diffed|listed|reversed\fR] [\fB\-hb\fR] \fI\fR .SH INPUT .P -The \fIinput\fR (default: stdin) should be a list of CIDR blocks, -separated by whitespace. Empty lines will be ignored, but otherwise, -malformed entries will cause an error to be displayed. +The \fIinput\fR (stdin) should be a list of CIDR blocks, separated by +whitespace. Empty lines will be ignored, but otherwise, malformed +entries will cause an error to be displayed. .SH DESCRIPTION .P Hath is a Haskell program for working with network blocks in CIDR @@ -28,8 +28,8 @@ List them. .IP \(bu Find their associated PTR records. .P -Hath does just that. It takes as its input (via stdin, or a file with -the -i parameter) a list of CIDR blocks. +Hath does just that. It takes as its input (via stdin) a list of CIDR +blocks. .SH MODES .P Hath has several modes: @@ -40,8 +40,8 @@ This computes a (Perl-compatible) regular expression matching the input CIDR blocks. It's the default mode of operation. .P .nf -.I $ hath <<< \(dq10.0.0.0/29 10.0.0.8/29\(dq -((10)\.(0)\.(0)\.(0|1|2|3|4|5|6|7|8|9|10|11|12|13|14|15)) +.I $ echo \(dq10.0.0.0/29 10.0.0.8/29\(dq | hath +((10)\.(0)\.(0)\.(15|14|13|12|11|10|9|8|7|6|5|4|3|2|1|0)) .fi .IP \(bu 2 \fBReduced\fR @@ -51,7 +51,7 @@ eliminates redundant blocks. The output should be equivalent to the input, though. .P .nf -.I $ hath reduced <<< \(dq10.0.0.0/24 10.0.1.0/24\(dq +.I $ echo \(dq10.0.0.0/24 10.0.1.0/24\(dq | hath reduced 10.0.0.0/23 .fi .IP \(bu 2 @@ -62,7 +62,7 @@ shows the ones that would get combined into larger blocks or are simply redundant. .P .nf -.I $ hath duped <<< \(dq10.0.0.0/24 10.0.1.0/24\(dq +.I $ echo \(dq10.0.0.0/24 10.0.1.0/24\(dq | hath duped 10.0.0.0/24 10.0.1.0/24 .fi @@ -73,7 +73,7 @@ Shows what would change if you used reduce. Uses diff-like notation. .P .nf -.I $ hath diffed <<< \(dq10.0.0.0/24 10.0.1.0/24\(dq +.I $ echo \(dq10.0.0.0/24 10.0.1.0/24\(dq | hath diffed -10.0.0.0/24 -10.0.1.0/24 +10.0.0.0/23 @@ -84,7 +84,7 @@ notation. List the IP addresses contained within the given CIDRs. .P .nf -.I $ hath listed <<< \(dq192.168.0.240/29\(dq +.I $ echo 192.168.0.240/29 | hath listed 192.168.0.240 192.168.0.241 192.168.0.242 @@ -101,7 +101,7 @@ Perform reverse DNS (PTR) lookups on the IP addresses contained within the given CIDRs. .P .nf -.I $ hath reversed <<< \(dq198.41.0.4/30\(dq +.I $ echo 198.41.0.4/30 | hath reversed 198.41.0.4: a.root-servers.net. 198.41.0.5: 198.41.0.6: rs.internic.net. @@ -114,19 +114,43 @@ runtime on the command line; for example, the following will perform 25 lookups in parallel: .P .nf -.I $ hath reversed +RTS -N25 <<< \(dq198.41.0.4/24\(dq +.I $ echo 198.41.0.4/24 | hath reversed +RTS -N25 198.41.0.4: a.root-servers.net. 198.41.0.5: 198.41.0.6: rs.internic.net. \(pc\(pc\(pc .fi -.P -Each of the modes also supports a present-tense flavor; the following -are equivalent to their counterparts: \fBregex\fR, \fBreduce\fR, -\fBdupe\fR, \fBdiff\fR, \fBlist\fR, \fBreverse\fR. .SH OPTIONS -.IP \fB\-\-input\fR,\ \fB\-i\fR -Specify the input file containing a list of CIDRs, rather than using -stdin (the default). +.IP \fB\-\-barriers\fR,\ \fB\-b\fR +(regexed mode only) place barriers in front/back of the regex to +prevent e.g. '127.0.0.1' from matching '127.0.0.100'. The downside is +that the resulting regexp will match something that is not an IP +address, and this messes up e.g. \fIgrep -o\fR. + +.P +Without \fB\-\-barriers\fR, you can match things you shouldn't: + +.nf +.I $ echo 127.0.0.100 | grep -P $(echo 127.0.0.1/32 | hath) +127.0.0.100 +.fi + +.P +Using \fB\-\-barriers\fR can prevent this: + +.nf +.I $ echo 127.0.0.100 | grep -P $(echo 127.0.0.1/32 | hath -b) +.I $ echo $? +1 +.fi + +.P +But, this may also cause the regex to match something that isn't an IP +address: + +.nf +.I $ echo x127.0.0.1x | grep -Po $(echo 127.0.0.1/32 | hath -b) +x127.0.0.1x +.fi