Fix an incorrect example in the man page.

[hath.git] / hath.cabal

diff --git a/hath.cabal b/hath.cabal
index 5354d423fecc0367bbee4f744f3bfafe8944929b..8eb569f410238a9c8ab9aed7c632f5e41e353d32 100644 (file)
--- a/hath.cabal
+++ b/hath.cabal
@@ -1,5 +1,5 @@
 name:           hath
-version:        0.0.1
+version:        0.0.5
 cabal-version:  >= 1.8
 author:         Michael Orlitzky
 maintainer:    Michael Orlitzky <michael@orlitzky.com>
@@ -7,6 +7,8 @@ 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.
 description:
@@ -22,7 +24,11 @@ description:
   .
     * View the result of block combination in a useful way.
   .
-  Hath has four modes to perform these functions:
+    * List them.
+  .
+    * Find their associated PTR records.
+  .
+  Hath has several modes to perform these functions:
   .
     [@Regexed@]
     This computes a (Perl-compatible) regular expression matching
@@ -41,6 +47,13 @@ description:
     [@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/:
   .
@@ -56,13 +69,53 @@ description:
   @
   $ 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:
+  @
+  .
+  The DNS lookups are usually the bottleneck for this mode, but we can
+  perform them in parallel. Simply pass the number of threads to the
+  GHC runtime on the command line; for example, the following will
+  perform 25 lookups in parallel:
+  .
+  @
+  hath reversed +RTS -N25 <<< \"198.41.0.4\/24\"
+  198.41.0.4: a.root-servers.net.
+  198.41.0.5:
+  198.41.0.6: rs.internic.net.
+  ...
+  @
 
 executable hath
   build-depends:
-    base                        == 4.*,
+    base                        >= 4.6 && < 4.7,
+    bytestring                  == 0.10.*,
+    dns                         == 1.*,
     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.*,
@@ -74,6 +127,17 @@ executable hath
   hs-source-dirs:
     src/
 
+  other-modules:
+    Bit
+    Cidr
+    CommandLine
+    DNS
+    ExitCodes
+    IPv4Address
+    Maskable
+    Maskbits
+    Octet
+
   ghc-options:
     -Wall
     -fwarn-hi-shadowing
@@ -102,10 +166,13 @@ test-suite testsuite
   hs-source-dirs: src test
   main-is: TestSuite.hs
   build-depends:
-    base                        == 4.*,
+    base                        >= 4.6 && < 4.7,
+    bytestring                  == 0.10.*,
+    dns                         == 1.*,
     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.*,