]> gitweb.michael.orlitzky.com - hath.git/blob - hath.cabal
hath.cabal: bump to v0.5.3.
[hath.git] / hath.cabal
1 name: hath
2 version: 0.5.3
3 cabal-version: >= 1.12
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 default-language:
91 Haskell2010
92
93 main-is:
94 Main.hs
95
96 hs-source-dirs:
97 src/
98
99 other-modules:
100 Bit
101 Cidr
102 CommandLine
103 ExitCodes
104 IPv4Address
105 Maskable
106 Maskbits
107 Octet
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 default-language: Haskell2010
123 main-is: TestSuite.hs
124
125 other-modules:
126 Bit
127 Cidr
128 IPv4Address
129 Maskable
130 Maskbits
131 Octet
132
133 build-depends:
134 base >= 4.15,
135 split >= 0.2,
136 tasty >= 0.8,
137 tasty-hunit >= 0.8,
138 tasty-quickcheck >= 0.8.1
139
140
141 -- These won't work without shelltestrunner installed in your
142 -- $PATH. Maybe there is some way to tell Cabal that.
143 test-suite shelltests
144 type: exitcode-stdio-1.0
145 hs-source-dirs: test
146 default-language: Haskell2010
147 main-is: ShellTests.hs
148
149 build-depends:
150 base >= 4.15,
151 process >= 1.1
152
153
154 source-repository head
155 type: git
156 location: http://gitweb.michael.orlitzky.com/hath.git
157 branch: master