Simplify Read instance code.

[hath.git] / hath.cabal

diff --git a/hath.cabal b/hath.cabal
index 12f811a229bf19ec18e891ab6a7994483bae2ceb..48db071634c5a31763ef2d78cad6e69a0042067b 100644 (file)
--- a/hath.cabal
+++ b/hath.cabal
@@ -1,19 +1,104 @@
 name:           hath
-version:        0.0.1
+version:        0.0.4
 cabal-version:  >= 1.8
 author:         Michael Orlitzky
 maintainer:    Michael Orlitzky <michael@orlitzky.com>
+category:       Utils
+license:        GPL-3
+license-file:   doc/LICENSE
+build-type:     Simple
+extra-source-files:
+  doc/man1/hath.1
 synopsis:
   Hath manipulates network blocks in CIDR notation.
-build-type:     Simple
-
+description:
+  Hath is a Haskell program for working with network blocks in CIDR
+  notation. When dealing with blocks of network addresses, there are a
+  few things that one usually wants to do with them:
+  .
+    * Create a regular expression matching the CIDR block(s). This is
+      because grep will throw up if you feed it CIDR.
+  .
+    * Combine small blocks into larger ones. For example, if you have two
+      consecutive \/24s, they might combine into a larger \/23.
+  .
+    * View the result of block combination in a useful way.
+  .
+  Hath has several modes to perform these functions:
+  .
+    [@Regexed@]
+    This computes a (Perl-compatible) regular expression matching
+    the input CIDR blocks. It's the default mode of operation.
+  .
+    [@Reduced@]
+    This combines small blocks into larger ones where possible, and
+    eliminates redundant blocks. The output should be equivalent to
+    the input, though.
+  .
+    [@Duped@]
+    Shows only the blocks that would be removed by reduce; that is, it
+    shows the ones that would get combined into larger blocks or are
+    simply redundant.
+  .
+    [@Diffed@]
+    Shows what would change if you used reduce. Uses diff-like
+    notation.
+  .
+    [@Listed@]
+    List the IP addresses contained within the given CIDRs.
+  .
+    [@Reversed@]
+    Perform reverse DNS (PTR) lookups on the IP addresses contained
+    within the given CIDRs.
+  .
+  /Examples/:
+  .
+  Combine two \/24s into a \/23:
+  .
+  @
+  $ hath reduced <<< \"10.0.0.0\/24 10.0.1.0\/24\"
+  10.0.0.0/23
+  @
+  .
+  Create a perl-compatible regex to be fed to grep:
+  .
+  @
+  $ grep -P `hath regexed -i cidrs.txt` mail.log
+  @
+  .
+  List the addresses in 192.168.0.240\/29:
+  .
+  @
+  $ hath listed <<< \"192.168.0.240\/29\"
+  192.168.0.240
+  192.168.0.241
+  192.168.0.242
+  192.168.0.243
+  192.168.0.244
+  192.168.0.245
+  192.168.0.246
+  192.168.0.247
+  @
+  .
+  Perform PTR lookups on all of 198.41.0.4\/30:
+  .
+  @
+  hath reversed <<< \"198.41.0.4\/30\"
+  198.41.0.4: a.root-servers.net.
+  198.41.0.5:
+  198.41.0.6: rs.internic.net.
+  198.41.0.7:
+  @
 
 executable hath
   build-depends:
-    base                        == 4.*,
+    base                        >= 4.6.0,
+    bytestring                  == 0.10.*,
+    dns                         == 0.3.*,
     HUnit                       == 1.2.*,
     QuickCheck                  == 2.6.*,
     MissingH                    == 1.2.*,
+    parallel-io                 == 0.3.*,
     split                       == 0.2.*,
     test-framework              == 0.8.*,
     test-framework-hunit        == 0.3.*,
@@ -25,6 +110,17 @@ executable hath
   hs-source-dirs:
     src/
 
+  other-modules:
+    Bit
+    Cidr
+    CommandLine
+    DNS
+    ExitCodes
+    IPv4Address
+    Maskable
+    Maskbits
+    Octet
+
   ghc-options:
     -Wall
     -fwarn-hi-shadowing
@@ -53,10 +149,13 @@ test-suite testsuite
   hs-source-dirs: src test
   main-is: TestSuite.hs
   build-depends:
-    base                        == 4.*,
+    base                        >= 4.6.0,
+    bytestring                  == 0.10.*,
+    dns                         == 0.3.*,
     HUnit                       == 1.2.*,
     QuickCheck                  == 2.6.*,
     MissingH                    == 1.2.*,
+    parallel-io                 == 0.3.*,
     split                       == 0.2.*,
     test-framework              == 0.8.*,
     test-framework-hunit        == 0.3.*,