annotate contrib/splicex/README @ 1054:1bd7b953bdd3 draft

[quicktun.socks4a] pep008 :-)
author d3v11 <d3v11@d3v11.ano>
date Sun, 04 Nov 2012 14:51:09 +0000
parents 5c86c4e82b4c
children
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 AUTHOR:
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
11
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
12 d3v11 <d3v11@d3v11.ano>
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
13
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
14
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
15
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
16 (UN)INSTALL:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
17
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
18 You may optionally install SpliceX with cython. Doing so takes
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
19 longer to install because of compile times but SpliceX will
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
20 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
21 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
22 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
23 using the pythonic install will be more practical.
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
24
706
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
25 NOTES:
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
26
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
27 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
28 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
29 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
30
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
31 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
32 cd Python-*
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
33 ./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
34 make install
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
35
de6fd9fc14e5 SpliceX patched compiler for /path/to/Python.h and /path/to/structmember.h
d3v11 <d3v11@d3v11.ano>
parents: 705
diff changeset
36 This generates Python.h and structmember.h, which are
708
a26ee55f8c88 splicex readme update
d3v11 <d3v11@d3v11.ano>
parents: 707
diff changeset
37 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
38
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
39 "<python[version]>" as seen in the install instructions
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
40 should be typed the same way you would call a specific
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
41 Python interpreter with only the first two version
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
42 numbers. IE:
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
43
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
44 python2.6, python2.7, python3.1, python3.2
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
45
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
46 DEPENDS ON:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
47
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
48 python (>=2.6), python-dev(>=2.6), cython (>=0.12.1),
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
49 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
50
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
51 SOURCE:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
52
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
53 ./configure <python[version]>
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
54 make compile
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
55 make install
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
56
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
57 DEBIAN/UBUNTU:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
58
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
59 ./configure <python[version]>
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
60 make compile
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
61 make install-deb
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
62
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
63 UNINSTALL:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
64
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
65 SOURCE:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
66 make uninstall
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
67
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
68 DEBIAN/UBUNTU:
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
69
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
70 dpkg --remove splicex
705
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 PYTHONIC (UN)INSTALL:
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 You make optionally install splicex as pure python.
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
75 Install times are quick but splicex will be 20% to 35%
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
76 slower than compiling an executable binary with the
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
77 cython + gcc option above. I recommend using this option
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
78 if you simply want to test, try, and/or debug splicex.
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
79
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
80 NOTES:
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
81
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
82 "<python[version]>" as seen in the install instructions
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
83 should be typed the same way you would call a specific
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
84 Python interpreter with only the first two version
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
85 numbers. For a Pythonic install "python" sans the version
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
86 will most likely work as well, and will set SpliceX to
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
87 use the default Python Interpreter. IE:
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
88
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
89 python2.6, python2.7, python3.1, python3.2
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
90
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
91 DEPENDS ON:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
92
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
93 python (>=2.6), bash (>=4.1.5), man (>=2.5.7)
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
94
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
95 SOURCE:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
96
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
97 ./configure <python[version]> --no-compile
707
67aa934958cf SpliceX `make pyinstall*` now `make install`
d3v11 <d3v11@d3v11.ano>
parents: 706
diff changeset
98 make install
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
99
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
100 DEBIAN/UBUNTU:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
101
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
102 ./configure <python[version]> --no-compile
707
67aa934958cf SpliceX `make pyinstall*` now `make install`
d3v11 <d3v11@d3v11.ano>
parents: 706
diff changeset
103 make install-deb
705
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 UNINSTALL:
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
106
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
107 SOURCE:
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
108 make uninstall
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
109
705
dc8f88270f6a SpliceX update: pyinstall added
d3v11 <d3v11@d3v11.ano>
parents: 697
diff changeset
110 DEBIAN/UBUNTU:
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
111
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
112 dpkg --remove splicex
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
113
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
114 TOOLS:
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
115
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
116 SpliceX includes brute forcing tools. Each tool will
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
117 include a README file in its respected folder(s):
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
118
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
119 ls tools/*
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
120
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
121 UPDATE:
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
122
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
123 d3v11's AnoNet(2) update for SpliceX:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
124
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
125 make update
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
126
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
127 HELP AND USAGE:
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
128
736
ef7b729162fa SpliceX README instructions updated.
d3v11 <d3v11@d3v11.ano>
parents: 708
diff changeset
129 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
130 enter either of the following commands after installation:
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
131
697
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
132 splicex --help
a554ba2c1e81 SpliceX now compiles to true binary
d3v11 <d3v11@d3v11.ano>
parents: 692
diff changeset
133 splicex --rtfm
692
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
134
070666f04505 SpliceX fix
d3v11 <d3v11@d3v11.ano>
parents:
diff changeset
135