hath.cabal

   1 cabal-version:  3.4
   2 name:           hath
   3 version:        0.5.5
   4 author:         Michael Orlitzky
   5 maintainer:     Michael Orlitzky <michael@orlitzky.com>
   6 homepage:       http://michael.orlitzky.com/code/hath.xhtml
   7 category:       Utils
   8 license:        AGPL-3.0-only
   9 license-file:   doc/LICENSE
  10 build-type:     Simple
  11 extra-source-files:
  12   doc/man1/hath.1
  13   test/shell/*.test
  14 synopsis:
  15   Hath manipulates network blocks in CIDR notation.
  16 description:
  17   Hath is a Haskell program for working with network blocks in CIDR
  18   notation. When dealing with blocks of network addresses, there are a
  19   few things that one usually wants to do with them:
  20
  21     * Create a regular expression matching the CIDR block(s). This is
  22       because grep will throw up if you feed it CIDR.
  23
  24     * Combine small blocks into larger ones. For example, if you have two
  25       consecutive \/24s, they might combine into a larger \/23.
  26
  27     * View the result of block combination in a useful way.
  28
  29     * List them.
  30
  31   Hath has several modes to perform these functions:
  32
  33     * __Regexed__
  34       This computes a (Perl-compatible) regular expression matching
  35       the input CIDR blocks. It's the default mode of operation.
  36
  37     * __Reduced__
  38       This combines small blocks into larger ones where possible, and
  39       eliminates redundant blocks. The output should be equivalent to
  40       the input, though.
  41
  42     * __Duped__
  43       Shows only the blocks that would be removed by reduce; that is, it
  44       shows the ones that would get combined into larger blocks or are
  45       simply redundant.
  46
  47     * __Diffed__
  48       Shows what would change if you used reduce. Uses diff-like
  49       notation.
  50
  51     * __Listed__
  52       List the IP addresses contained within the given CIDRs.
  53
  54   /Examples/:
  55
  56   Compute a (Perl-compatible) regular expression matching
  57   the input CIDR blocks. It's the default mode of operation.
  58
  59   @
  60   $ echo \"10.0.0.0\/29 10.0.0.8\/29\" | hath
  61   ((10)\.(0)\.(0)\.(15|14|13|12|11|10|9|8|7|6|5|4|3|2|1|0))
  62   @
  63
  64   Combine two \/24s into a \/23:
  65
  66   @
  67   $ echo \"10.0.0.0\/24 10.0.1.0\/24\" | hath reduced
  68   10.0.0.0/23
  69   @
  70
  71   List the addresses in 192.168.0.240\/29:
  72
  73   @
  74   $ echo 192.168.0.240\/29 | hath listed
  75   192.168.0.240
  76   192.168.0.241
  77   192.168.0.242
  78   192.168.0.243
  79   192.168.0.244
  80   192.168.0.245
  81   192.168.0.246
  82   192.168.0.247
  83   @
  84
  85   The command-line syntax and complete set of options are documented in
  86   the man page.
  87
  88
  89 executable hath
  90   main-is:
  91     Main.hs
  92
  93   hs-source-dirs:
  94     src/
  95
  96   other-modules:
  97     Bit
  98     Cidr
  99     CommandLine
 100     ExitCodes
 101     IPv4Address
 102     Maskable
 103     Maskbits
 104     Octet
 105     Paths_hath
 106
 107   autogen-modules:
 108     Paths_hath
 109
 110   build-depends:
 111     base                        >= 4.15,
 112     cmdargs                     >= 0.10,
 113     split                       >= 0.2,
 114     tasty                       >= 0.8,
 115     tasty-hunit                 >= 0.8,
 116     tasty-quickcheck            >= 0.8.1
 117
 118
 119 test-suite testsuite
 120   type: exitcode-stdio-1.0
 121   hs-source-dirs: src test
 122   main-is: TestSuite.hs
 123
 124   other-modules:
 125     Bit
 126     Cidr
 127     IPv4Address
 128     Maskable
 129     Maskbits
 130     Octet
 131
 132   build-depends:
 133     base                        >= 4.15,
 134     split                       >= 0.2,
 135     tasty                       >= 0.8,
 136     tasty-hunit                 >= 0.8,
 137     tasty-quickcheck            >= 0.8.1
 138
 139
 140 -- These won't work without shelltestrunner installed in your
 141 -- $PATH. Maybe there is some way to tell Cabal that.
 142 test-suite shelltests
 143   type: exitcode-stdio-1.0
 144   hs-source-dirs: test
 145   main-is: ShellTests.hs
 146
 147   build-depends:
 148     base                        >= 4.15,
 149     process                     >= 1.1
 150
 151
 152 source-repository head
 153   type: git
 154   location: http://gitweb.michael.orlitzky.com/hath.git
 155   branch: master