annotate contrib/splicex/README @ 736:ef7b729162fa draft

SpliceX README instructions updated.
author d3v11 <d3v11@d3v11.ano>
date Sun, 06 Nov 2011 00:40:03 -0400
parents a26ee55f8c88
children 5c86c4e82b4c
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
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
28 You may optionally install SpliceX with cython. Doing so takes
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
29 longer to install because of compile times but SpliceX will
705
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
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
31 this option if you intend on putting SpliceX to long-term use.
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
32 If your goal is simply to test, try, and/or debug SpliceX then
705
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
706
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
35 NOTES:
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
36
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
37 If you installed Python from source you can ignore
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
38 the python-dev dependency below. However, your source
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
39 install of Python must have the development files. IE:
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
40
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
41 tar xvf Python-*.tgz
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
42 cd Python-*
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
43 ./configure --with-pydebug
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
44 make install
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
45
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
46 This generates Python.h and structmember.h, which are
708
a26ee55f8c88 splicex readme update
d3v11 <d3v11@d3v11.ano>
parents: 707
diff changeset
47 needed for gcc to compile splicex.
706
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
48
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
49 "<python[version]>" as seen in the install instructions
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
50 should be typed the same way you would call a specific
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
51 Python interpreter with only the first two version
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
52 numbers. IE:
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
53
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
54 python2.6, python2.7, python3.1, python3.2
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
55
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
56 DEPENDS ON:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
57
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
58 python (>=2.6), python-dev(>=2.6), cython (>=0.12.1),
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
59 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
60
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
61 SOURCE:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
62
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
63 ./configure <python[version]>
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
64 make compile
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
65 make install
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
66
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
67 DEBIAN/UBUNTU:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
68
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
69 ./configure <python[version]>
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
70 make compile
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
71 make install-deb
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
72
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
73 UNINSTALL:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
74
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
75 SOURCE:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
76 make uninstall
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
77
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
78 DEBIAN/UBUNTU:
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
79
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
80 dpkg --remove splicex
705
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 PYTHONIC (UN)INSTALL:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
83
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
84 You make optionally install splicex as pure python.
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
85 Install times are quick but splicex will be 20% to 35%
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
86 slower than compiling an executable binary with the
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
87 cython + gcc option above. I recommend using this option
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
88 if you simply want to test, try, and/or debug splicex.
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
89
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
90 NOTES:
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
91
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
92 "<python[version]>" as seen in the install instructions
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
93 should be typed the same way you would call a specific
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
94 Python interpreter with only the first two version
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
95 numbers. For a Pythonic install "python" sans the version
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
96 will most likely work as well, and will set SpliceX to
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
97 use the default Python Interpreter. IE:
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
98
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
99 python2.6, python2.7, python3.1, python3.2
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
100
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
101 DEPENDS ON:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
102
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
103 python (>=2.6), bash (>=4.1.5), man (>=2.5.7)
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
104
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
105 SOURCE:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
106
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
107 ./configure <python[version]> --no-compile
707
67aa934958cf SpliceX `make pyinstall*` now `make install`
d3v11 <d3v11@d3v11.ano>
parents: 706
diff changeset
108 make install
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
109
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
110 DEBIAN/UBUNTU:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
111
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
112 ./configure <python[version]> --no-compile
707
67aa934958cf SpliceX `make pyinstall*` now `make install`
d3v11 <d3v11@d3v11.ano>
parents: 706
diff changeset
113 make install-deb
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
114
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
115 UNINSTALL:
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
116
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
117 SOURCE:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
118 make uninstall
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
119
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
120 DEBIAN/UBUNTU:
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
121
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
122 dpkg --remove splicex
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
123
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
124 TOOLS:
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
125
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
126 SpliceX includes brute forcing tools. Each tool will
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
127 include a README file in its respected folder(s):
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
128
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
129 ls tools/*
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
130
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
131 UPDATE:
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
132
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
133 d3v11's AnoNet(2) update for SpliceX:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
134
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
135 make update
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
136
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
137 HELP AND USAGE:
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
138
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
139 To obtain additional information on how to use SpliceX
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
140 enter either of the following commands after installation:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
141
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
142 splicex --help
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
143 splicex --rtfm
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
144
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
145