Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 95 lines (62 sloc) 2.592 kB
1ca156b @CodeGnome Fix README display issues on RubyGems.
authored
1 = OUI_Lookup
2
2f8b006 @CodeGnome Add code status badges.
authored
3 == Code Status
4
5 {<img src="https://travis-ci.org/CodeGnome/oui_lookup.png" alt="Travis
6 CI Build Status" />}[https://travis-ci.org/CodeGnome/oui_lookup]
7 {<img src="https://codeclimate.com/github/CodeGnome/oui_lookup.png"
8 alt="CodeClimate Status"
9 />}[https://codeclimate.com/github/CodeGnome/oui_lookup]
2d8290f @CodeGnome Add Travis-CI build status icon to README.
authored
10
1ca156b @CodeGnome Fix README display issues on RubyGems.
authored
11 == Copyright and Licensing
12
13 === Copyright Notice
14
08613b5 @CodeGnome Update copyright dates.
authored
15 Copyright 2011, 2013 Todd A. Jacobs
1ca156b @CodeGnome Fix README display issues on RubyGems.
authored
16 All rights reserved.
17
18 === Software License
19
20 http://www.gnu.org/graphics/gplv3-88x31.png
21
22 The software is licensed under the
23 GPLv3[http://www.gnu.org/copyleft/gpl.html].
24 The LICENSE is also included in the source tree.
25
26 === README License
27
28 http://i.creativecommons.org/l/by-nc-sa/3.0/us/88x31.png
29
30 {Creative Commons Attribution-NonCommercial-ShareAlike 3.0 United States
31 License}[http://creativecommons.org/licenses/by-nc-sa/3.0/us/]
32
33 == Purpose
34
35 The IEEE hands out Organizationally Unique Identifiers to companies for
36 use in such things as manufacturing NIC cards. The first three octets of
37 a MAC address should be the manufacturer's prefix, so this gem may be
38 useful in identifyng NIC cards or constructing valid MAC addresses.
39
40 == Installation and Usage
41
22dcff6 @CodeGnome Mention supported Ruby versions.
authored
42 The install instructons assume RVM with Ruby 1.9.2, but the code is also
43 tested with Ruby 2.0.0. The dependencies aren't heavy, and it would
44 probably take less time to backport the tests and syntax to
45 1.8.7 than it did to write this sentence, but life is like that
46 sometimes. Don't file a bug about it; just make sure you are using the
47 correct Ruby within RVM.
1ca156b @CodeGnome Fix README display issues on RubyGems.
authored
48
49 === Installing the OUI_Lookup Gem
50
51 gem install oui_lookup
52
53 === Running the CLI
54
55 oui_lookup <mac_address_or_prefix>
56
57 === Using the Library
58
59 require 'oui_lookup'
60
61 == Sample Output
62
63 No screenshots here, just samples of what you can expect from running
64 this thing.
65
66 [NOTE]
67 The input format is pretty flexible. It will take both a three-octet
68 prefix, as well as a full MAC address with six octets. It's also
69 pretty agnostic about separators (or the lack thereof).
70
71 === Looking up a valid prefix
72
73 $ oui_lookup 000000
74 Searching...
75
76 00-00-00 (hex) XEROX CORPORATION
77 000000 (base 16) XEROX CORPORATION
78 M/S 105-50C
79 800 PHILLIPS ROAD
80 WEBSTER NY 14580
81 UNITED STATES
82
83 === Looking up a MAC address with an unregistered prefix
84
85 $ oui_lookup FF:FF:FF:FF:FF:FF
86 Searching...
87
88 OUI not found: FF-FF-FF
89
90 == Further Reading
91
92 1. {Ruby Version Manager (RVM)}[http://beginrescueend.com/]
93 2. RubyGems[http://rubygems.org/]
94 3. {IEEE OUIs}[http://standards.ieee.org/develop/regauth/oui/index.html]
Something went wrong with that request. Please try again.