annotate contrib/splicex/README @ 705:dc8f88270f6a draft

SpliceX update: pyinstall added
author d3v11 <d3v11@d3v11.ano>
date Sat, 29 Oct 2011 10:17:30 -0400
parents a554ba2c1e81
children de6fd9fc14e5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
1 __________ _ _ __ __ ______
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
2 / / / / ___| _ __ | (_) ___ ___\ \/ / / / / /
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
3 / / / /\___ \| '_ \| | |/ __/ _ \\ / / / / /
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
4 / / / / ___) | |_) | | | (_| __// \ / / / /
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
5 /_/_/_/ |____/| .__/|_|_|\___\___/_/\_\/_/_/_/
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
6 |_|
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
7
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
8 .:Brute Force Utilities For GNU/Linux:.
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
9
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
10 SpliceX is free software: you can redistribute it and/or modify it under
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
11 the terms of the GNU General Public License as published by the Free
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
12 Software Foundation, either version 3 of the License, or (at your option)
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
13 any later version.
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
14
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
15 SpliceX is distributed in the hope that it will be useful, but WITHOUT
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
17 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
18 for more details. http://www.gnu.org/licenses/
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
19
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
20 AUTHOR:
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
21
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
22 d3v11 <d3v11@d3v11.ano>
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
23
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
24
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
25
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
26 (UN)INSTALL:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
27
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
28 You may optionally install splicex with cython. Doing so takes
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
29 longer to install because of compile times but splicex will
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
30 also be 20% to 35% faster, depending on your system. I recommend
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
31 this option if you intend on putting splicex to long-term use.
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
32 If your goal is simply to test, try, and/or debug splicex then
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
33 using the pythonic install will be more practical.
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
34
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
35 DEPENDS ON:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
36
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
37 python (>=2.6), python-dev(>=2.6), cython (>=0.12.1),
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
38 gcc (>=4.4.3), bash (>=4.1.5), man (>=2.5.7)
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
39
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
40 SOURCE:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
41
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
42 ./configure <python[version]>
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
43 make compile
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
44 make install
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
45
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
46 DEBIAN/UBUNTU:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
47
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
48 ./configure <python[version]>
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
49 make compile
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
50 make install-deb
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
51
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
52 UNINSTALL:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
53
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
54 SOURCE:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
55 make uninstall
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
56
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
57 DEBIAN/UBUNTU:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
58 apt-get remove splicex
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
59
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
60 PYTHONIC (UN)INSTALL:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
61
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
62 You make optionally install splicex as pure python.
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
63 Install times are quick but splicex will be 20% to 35%
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
64 slower than compiling an executable binary with the
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
65 cython + gcc option above. I recommend using this option
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
66 if you simply want to test, try, and/or debug splicex.
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
67
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
68 DEPENDS ON:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
69
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
70 python (>=2.6), bash (>=4.1.5), man (>=2.5.7)
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
71
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
72 SOURCE:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
73
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
74 ./configure <python[version]> --no-compile
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
75 make pyinstall
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
76
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
77 DEBIAN/UBUNTU:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
78
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
79 ./configure <python[version]> --no-compile
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
80 make pyinstall-deb
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
81
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
82 UNINSTALL:
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
83
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
84 SOURCE:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
85 make uninstall
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
86
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
87 DEBIAN/UBUNTU:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
88 apt-get remove splicex
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
89
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
90 TOOLS:
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
91
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
92 SpliceX includes brute forcing tools. Each tool will
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
93 include a README file in its respected folder(s):
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
94
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
95 ls tools/*
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
96
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
97 UPDATE:
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
98
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
99 d3v11's AnoNet(2) update for splicex:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
100
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
101 make update
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
102
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
103 HELP AND USAGE:
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
104
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
105 To obtain additional information on how to use splicex
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
106 enter either of the following commands after installation:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
107
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
108 splicex --help
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
109 splicex --rtfm
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
110
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
111