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

diff --git a/hath.cabal b/hath.cabal
index 12f811a..8660a81 100644
--- a/hath.cabal
+++ b/hath.cabal
@@ -1,23 +1,92 @@
 name:           hath
-version:        0.0.1
-cabal-version:  >= 1.8
+version:        0.5.1
+cabal-version:  >= 1.10
 author:         Michael Orlitzky
 maintainer:	Michael Orlitzky <michael@orlitzky.com>
+homepage:       http://michael.orlitzky.com/code/hath.xhtml
+category:       Utils
+license:        AGPL-3
+license-file:   doc/LICENSE
+build-type:     Simple
+extra-source-files:
+  doc/man1/hath.1
+  test/shell/*.test
 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.
+  .
+    * List them.
+  .
+  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.
+  .
+  /Examples/:
+  .
+  Compute a (Perl-compatible) regular expression matching
+  the input CIDR blocks. It's the default mode of operation.
+  .
+  @
+  $ echo \"10.0.0.0\/29 10.0.0.8\/29\" | hath
+  ((10)\.(0)\.(0)\.(15|14|13|12|11|10|9|8|7|6|5|4|3|2|1|0))
+  @
+  .
+  Combine two \/24s into a \/23:
+  .
+  @
+  $ echo \"10.0.0.0\/24 10.0.1.0\/24\" | hath reduced
+  10.0.0.0/23
+  @
+  .
+  List the addresses in 192.168.0.240\/29:
+  .
+  @
+  $ echo 192.168.0.240\/29 | hath listed
+  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
+  @
+  .
+  The command-line syntax and complete set of options are documented in
+  the man page.
 
 
 executable hath
-  build-depends:
-    base                        == 4.*,
-    HUnit                       == 1.2.*,
-    QuickCheck                  == 2.6.*,
-    MissingH                    == 1.2.*,
-    split                       == 0.2.*,
-    test-framework              == 0.8.*,
-    test-framework-hunit        == 0.3.*,
-    test-framework-quickcheck2  == 0.3.*
 
   main-is:
     Main.hs
@@ -25,62 +94,60 @@ executable hath
   hs-source-dirs:
     src/
 
-  ghc-options:
-    -Wall
-    -fwarn-hi-shadowing
-    -fwarn-missing-signatures
-    -fwarn-name-shadowing
-    -fwarn-orphans
-    -fwarn-type-defaults
-    -fwarn-tabs
-    -fwarn-incomplete-record-updates
-    -fwarn-monomorphism-restriction
-    -fwarn-unused-do-bind
-    -rtsopts
-    -threaded
-    -optc-O3
-    -optc-march=native
-    -O2
+  other-modules:
+    Bit
+    Cidr
+    CommandLine
+    ExitCodes
+    IPv4Address
+    Maskable
+    Maskbits
+    Octet
+    Paths_hath
 
-  ghc-prof-options:
-    -prof
-    -auto-all
-    -caf-all
+  build-depends:
+    base                        >= 4.15,
+    cmdargs                     >= 0.10,
+    split                       >= 0.2,
+    tasty                       >= 0.8,
+    tasty-hunit                 >= 0.8,
+    tasty-quickcheck            >= 0.8.1
 
 
 test-suite testsuite
   type: exitcode-stdio-1.0
   hs-source-dirs: src test
   main-is: TestSuite.hs
+
+  other-modules:
+    Bit
+    Cidr
+    IPv4Address
+    Maskable
+    Maskbits
+    Octet
+
+  build-depends:
+    base                        >= 4.15,
+    split                       >= 0.2,
+    tasty                       >= 0.8,
+    tasty-hunit                 >= 0.8,
+    tasty-quickcheck            >= 0.8.1
+
+
+-- These won't work without shelltestrunner installed in your
+-- $PATH. Maybe there is some way to tell Cabal that.
+test-suite shelltests
+  type: exitcode-stdio-1.0
+  hs-source-dirs: test
+  main-is: ShellTests.hs
+
   build-depends:
-    base                        == 4.*,
-    HUnit                       == 1.2.*,
-    QuickCheck                  == 2.6.*,
-    MissingH                    == 1.2.*,
-    split                       == 0.2.*,
-    test-framework              == 0.8.*,
-    test-framework-hunit        == 0.3.*,
-    test-framework-quickcheck2  == 0.3.*
+    base                        >= 4.15,
+    process                     >= 1.1
 
-  -- It's not entirely clear to me why I have to reproduce all of this.
-  ghc-options:
-    -Wall
-    -fwarn-hi-shadowing
-    -fwarn-missing-signatures
-    -fwarn-name-shadowing
-    -fwarn-orphans
-    -fwarn-type-defaults
-    -fwarn-tabs
-    -fwarn-incomplete-record-updates
-    -fwarn-monomorphism-restriction
-    -fwarn-unused-do-bind
-    -rtsopts
-    -threaded
-    -optc-O3
-    -optc-march=native
-    -O2
 
 source-repository head
   type: git
-  location: http://michael.orlitzky.com/git/hath.git
+  location: http://gitweb.michael.orlitzky.com/hath.git
   branch: master