X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=hath.cabal;h=7799a7e3914251a5311a35ad496bcfbabf9da103;hb=7622c66d1bb0592ae6cd5b9c6092ff2e0490c4a1;hp=12f811a229bf19ec18e891ab6a7994483bae2ceb;hpb=e1d16438b44ecd962565756a828c9ed8014cf894;p=hath.git

diff --git a/hath.cabal b/hath.cabal
index 12f811a..7799a7e 100644
--- a/hath.cabal
+++ b/hath.cabal
@@ -1,12 +1,61 @@
 name:           hath
-version:        0.0.1
+version:        0.0.2
 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
 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 four 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.
+  .
+  /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
+  @
 
 executable hath
   build-depends:
@@ -25,6 +74,16 @@ executable hath
   hs-source-dirs:
     src/
 
+  other-modules:
+    Bit
+    Cidr
+    CommandLine
+    ExitCodes
+    IPv4Address
+    Maskable
+    Maskbits
+    Octet
+
   ghc-options:
     -Wall
     -fwarn-hi-shadowing