hath.cabal

   1 name:           hath
   2 version:        0.3.1
   3 cabal-version:  >= 1.8
   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
   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
  91   main-is:
  92     Main.hs
  93
  94   hs-source-dirs:
  95     src/
  96
  97   other-modules:
  98     Bit
  99     Cidr
 100     CommandLine
 101     ExitCodes
 102     IPv4Address
 103     Maskable
 104     Maskbits
 105     Octet
 106
 107   build-depends:
 108     base                        == 4.*,
 109     cmdargs                     >= 0.10,
 110     MissingH                    >= 1.2,
 111     split                       >= 0.2,
 112     tasty                       >= 0.8,
 113     tasty-hunit                 >= 0.8,
 114     tasty-quickcheck            >= 0.8.1
 115
 116   ghc-options:
 117     -Weverything
 118     -Wno-implicit-prelude
 119     -Wno-safe
 120     -Wno-unsafe
 121     -Wno-all-missed-specialisations
 122     -rtsopts
 123     -threaded
 124     -optc-O3
 125     -optc-march=native
 126     -O2
 127
 128   ghc-prof-options:
 129     -prof
 130     -auto-all
 131     -caf-all
 132
 133
 134 test-suite testsuite
 135   type: exitcode-stdio-1.0
 136   hs-source-dirs: src test
 137   main-is: TestSuite.hs
 138
 139   build-depends:
 140     base                        == 4.*,
 141     cmdargs                     >= 0.10,
 142     MissingH                    >= 1.2,
 143     split                       >= 0.2,
 144     tasty                       >= 0.8,
 145     tasty-hunit                 >= 0.8,
 146     tasty-quickcheck            >= 0.8.1
 147
 148
 149   -- It's not entirely clear to me why I have to reproduce all of this.
 150   ghc-options:
 151     -Weverything
 152     -Wno-implicit-prelude
 153     -Wno-safe
 154     -Wno-unsafe
 155     -Wno-all-missed-specialisations
 156     -rtsopts
 157     -threaded
 158     -optc-O3
 159     -optc-march=native
 160     -O2
 161
 162
 163 -- These won't work without shelltestrunner installed in your
 164 -- $PATH. Maybe there is some way to tell Cabal that.
 165 test-suite shelltests
 166   type: exitcode-stdio-1.0
 167   hs-source-dirs: test
 168   main-is: ShellTests.hs
 169
 170   build-depends:
 171     base                        == 4.*,
 172     cmdargs                     >= 0.10,
 173     MissingH                    >= 1.2,
 174     process                     >= 1.1,
 175     split                       >= 0.2,
 176     tasty                       >= 0.8,
 177     tasty-hunit                 >= 0.8,
 178     tasty-quickcheck            >= 0.8.1
 179
 180   -- It's not entirely clear to me why I have to reproduce all of this.
 181   ghc-options:
 182     -Wall
 183     -fwarn-hi-shadowing
 184     -fwarn-missing-signatures
 185     -fwarn-name-shadowing
 186     -fwarn-orphans
 187     -fwarn-type-defaults
 188     -fwarn-tabs
 189     -fwarn-incomplete-record-updates
 190     -fwarn-monomorphism-restriction
 191     -fwarn-unused-do-bind
 192     -rtsopts
 193     -threaded
 194     -optc-O3
 195     -optc-march=native
 196     -O2
 197
 198 source-repository head
 199   type: git
 200   location: http://gitweb.michael.orlitzky.com/hath.git
 201   branch: master