summaryrefslogtreecommitdiff
path: root/contrib/splicex/README
blob: b8513348732cff8d09e1bebc213d56644e0ea524 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
                    __________        _ _         __  __    ______
                   / / / / ___| _ __ | (_) ___ ___\ \/ /   / / / /
                  / / / /\___ \| '_ \| | |/ __/ _ \\  /   / / / / 
                 / / / /  ___) | |_) | | | (_|  __//  \  / / / /  
                /_/_/_/  |____/| .__/|_|_|\___\___/_/\_\/_/_/_/   
                               |_|

                     .:Brute Force Utilities For GNU/Linux:.

       SpliceX is free software: you can redistribute it and/or modify it under
       the terms of the GNU General Public License as published by the Free 
       Software Foundation, either version 3 of the License, or (at your option)
       any later version.

       SpliceX is distributed in the hope that it will be useful, but WITHOUT
       ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
       FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
       for more details. http://www.gnu.org/licenses/

AUTHOR:

	d3v11 <d3v11@d3v11.ano>



(UN)INSTALL:

	You may optionally install splicex with cython. Doing so takes
	longer to install because of compile times but splicex will
	also be 20% to 35% faster, depending on your system. I recommend
	this option if you intend on putting splicex to long-term use.
	If your goal is simply to test, try, and/or debug splicex then
	using the pythonic install will be more practical.

	NOTES:

		If you installed Python from source you can ignore
		the python-dev dependency below. However, your source
		install of Python must have the development files. IE:

		tar xvf Python-*.tgz
		cd Python-*
		./configure --with-pydebug
		make install

		This generates Python.h and structmember.h, which are
		needed for gcc to compile splicex.

	DEPENDS ON:

		python (>=2.6), python-dev(>=2.6), cython (>=0.12.1), 
		gcc (>=4.4.3), bash (>=4.1.5), man (>=2.5.7)

		SOURCE:

			./configure <python[version]>
			make compile
			make install

		DEBIAN/UBUNTU:

			./configure <python[version]>
			make compile
			make install-deb

		UNINSTALL:
	
			SOURCE:
		 		make uninstall

			DEBIAN/UBUNTU:
		 		apt-get remove splicex

PYTHONIC (UN)INSTALL:

	You make optionally install splicex as pure python.
	Install times are quick but splicex will be 20% to 35%
	slower than compiling an executable binary with the
	cython + gcc option above. I recommend using this option
	if you simply want to test, try, and/or debug splicex.

	DEPENDS ON:

		python (>=2.6), bash (>=4.1.5), man (>=2.5.7)

		SOURCE:

			./configure <python[version]> --no-compile
			make install

		DEBIAN/UBUNTU:

			./configure <python[version]> --no-compile
			make install-deb

		UNINSTALL:
	
			SOURCE:
		 		make uninstall

			DEBIAN/UBUNTU:
		 		apt-get remove splicex

TOOLS:

	SpliceX includes brute forcing tools. Each tool will
	include a README file in its respected folder(s):

	ls tools/*

UPDATE:

	d3v11's AnoNet(2) update for splicex:
 
	make update

HELP AND USAGE:

	To obtain additional information on how to use splicex
	enter either of the following commands after installation:

	splicex --help
	splicex --rtfm