emonti-rbkb 0.6.1.1 → 0.6.1.2
Sign up to get free protection for your applications and to get access to all the features.
- data/README.rdoc +54 -6
- metadata +1 -1
data/README.rdoc
CHANGED
|
@@ -25,15 +25,63 @@ Along the way, some of tools in the blackbag spirit make their way into 'rbkb'
|
|
|
25
25
|
that may or may not make it to 'bkb' right away (or ever). Similarly some of
|
|
26
26
|
the things in 'bkb' have not yet made it to 'rbkb' (and may not).
|
|
27
27
|
|
|
28
|
-
===
|
|
28
|
+
=== Command Line Tools
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
The tools almost all support '-h', but I'll admit this only goes so far.
|
|
31
|
+
See usage.txt for a bit of extra info on the various tools.
|
|
31
32
|
|
|
32
|
-
|
|
33
|
+
When I get some spare time, I'll try and do up some examples of using all
|
|
34
|
+
the tools.
|
|
33
35
|
|
|
34
|
-
* For the plug based network stuff, you'll need EventMachine >= 0.12.0
|
|
35
36
|
|
|
36
|
-
|
|
37
|
+
== Installation
|
|
38
|
+
|
|
39
|
+
==== Pre-Requirements Note
|
|
40
|
+
|
|
41
|
+
For the plug based network stuff, you'll need EventMachine >= 0.12.2
|
|
42
|
+
Installing the rbkb gem usually takes care of this automatically, but
|
|
43
|
+
if you're doing a manual installation, run:
|
|
44
|
+
|
|
45
|
+
gem install eventmachine
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
=== Gem Installation
|
|
49
|
+
|
|
50
|
+
RBkB is available as a gem from github:
|
|
51
|
+
|
|
52
|
+
gem sources -a http://gems.github.com #(you only have to do this once)
|
|
53
|
+
gem install emonti-rbkb
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
==== Install Note
|
|
57
|
+
|
|
58
|
+
Installing as root may be risky depending on your rubygems configuration so I
|
|
59
|
+
don't really recommend using 'sudo gem install'. Worst case scenario I know
|
|
60
|
+
of is I blew away my OS X shipped '/usr/bin/crc32' this way. It was written in
|
|
61
|
+
perl, so I considered this providence and didn't look back. But you may feel
|
|
62
|
+
differently about 'rubygems' arbitrarily clobbering your files.
|
|
63
|
+
|
|
64
|
+
When installing as a regular user, however, rubygems may stick rbkb's
|
|
65
|
+
executable bin/* files somewhere unexpected. To find out where these are and
|
|
66
|
+
either add them to your PATH or copy/symlink them somewhere else (like
|
|
67
|
+
/usr/local/bin/) do this:
|
|
68
|
+
|
|
69
|
+
gem contents emonti-rbkb
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
=== Manual installation:
|
|
73
|
+
|
|
74
|
+
... or ... you can also install manually without rubygems.
|
|
75
|
+
|
|
76
|
+
You can access the rbkb project at github. You'll want git installed:
|
|
77
|
+
|
|
78
|
+
git clone git://github.com/emonti/rbkb.git
|
|
79
|
+
cd rbkb
|
|
80
|
+
cp -r wxirb/lib/* /usr/lib/ruby/1.8/site_ruby/1.8 # or another ruby libdir
|
|
81
|
+
cp bin/* ~/bin # or wherever else in your PATH
|
|
82
|
+
|
|
83
|
+
Run this to generate docs with rdoc the same way the gem would have:
|
|
84
|
+
|
|
85
|
+
rdoc --main README.rdoc README.rdoc usage.txt lib
|
|
37
86
|
|
|
38
|
-
* Some of the plug stuff also requires ruby pcap available from: http://raa.ruby-lang.org/project/pcap
|
|
39
87
|
|