Skip to content

Commit 15b0704

Browse files
committed
Rename and convert to Markdown
Signed-off-by: Joachim Wiberg <[email protected]>
1 parent a9e77e6 commit 15b0704

File tree

2 files changed

+107
-51
lines changed

2 files changed

+107
-51
lines changed

README

-51
This file was deleted.

README.md

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
dhcp-probe
2+
==========
3+
4+
dhcp-probe is intended to be used by network administrators to locate
5+
unknown BootP and DHCP servers on a directly-attached network.
6+
7+
dhcp-probe is intended for use by a network administrator. Before
8+
running the program on any network other than one for which you are
9+
responsible, contact that network's administrator to learn if it is
10+
acceptable for you to run this software on that network. Running this
11+
software on a network where you don't have permission to do so may
12+
violate that network's acceptable use policy.
13+
14+
For help, see the [dhcp_probe(8)][] and [dhcp_probe.cf(5)][] man pages.
15+
16+
17+
Build & Install
18+
---------------
19+
20+
The program depends on libpcap and libnet (>1.3), patched earlier
21+
versions of libnet, compatible with dhcp-probe, are available in
22+
most Linux distributions. On Debian/Ubuntu derived systems:
23+
24+
sudo apt install libpcap-dev libnet1-dev
25+
26+
The dhcp-probe configure script and Makefile supports de facto standard
27+
settings and environment variables such as `--prefix=PATH` and `DESTDIR=`
28+
for the install process. For example, to install dhcp-probe to `/usr`,
29+
instead of the default `/usr/local`, and redirect install to a package
30+
directory in `/tmp`:
31+
32+
./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var
33+
make
34+
make DESTDIR=/tmp/dhcp-probe-1.4.0 install-strip
35+
36+
37+
Building from GIT
38+
-----------------
39+
40+
If you want to contribute, or simply just try out the latest but
41+
unreleased features, then you need to know a few things about the
42+
[GNU build system][buildsystem]:
43+
44+
- `configure.ac` and a per-directory `Makefile.am` are key files
45+
- `configure` and `Makefile.in` are generated from `autogen.sh`
46+
- `Makefile` is generated by `configure` script
47+
48+
To build from GIT you first need to clone the repository and run the
49+
`autogen.sh` script. This requires `automake` and `autoconf` to be
50+
installed on your system (not required when you build from released
51+
tarballs):
52+
53+
git clone https://github.com/libnet/dhcp-probe.git
54+
cd dhcp-probe/
55+
./autogen.sh
56+
./configure && make
57+
58+
GIT sources are a moving target and are not recommended for production
59+
systems, unless you know what you are doing!
60+
61+
62+
Contributing
63+
------------
64+
65+
The basic functionality has been tested thoroughly over the years, but
66+
that does not mean the program is bug free. Please report bugs, feature
67+
requests, patches and pull requests at [GitHub][repo].
68+
69+
70+
Origin & References
71+
-------------------
72+
73+
This software was created by the Network Systems Group at Princeton
74+
University's Office of Information Technology, <networking at princeton
75+
dot edu>. With Irwin Tillman as the principal author. The project is
76+
now maintained by the [Libnet project](https://github.com/libnet/).
77+
78+
`dhcp_probe` was intended for our use at Princeton University, so was
79+
written to operate on the platform(s) we use, with the features we need.
80+
As others have asked for the software, we've made it generally available,
81+
however, we do not have the resources available to port it to additional
82+
platforms or add features.
83+
84+
The product is free, however, it includes code that was published in
85+
other programs; those parts are subject to the copyright and license
86+
restrictions listed in these files:
87+
88+
- `src/report.c`
89+
- `src/daemonize.c`
90+
- `src/get_myeaddr.c`
91+
- `src/get_myipaddr.c`
92+
93+
This software is provided "as is" and any express or implied warranties,
94+
including, but not limited to, the implied warranties of merchantability
95+
and fitness for a particular purpose are disclaimed. In no event shall
96+
the authors or Princeton University be liable for any direct, indirect,
97+
incidental, special exemplary, or consequential damages (including, but
98+
not limited to, procurement of substitute goods or services; loss of
99+
use, data, or profits; or business interruption) however caused and on
100+
any theory of liability, whether in contract, strict liability, or tort
101+
(including negligence or otherwise) arising in any way out of the use of
102+
this software, even if advised of the possibility of such damage.
103+
104+
[repo]: https://github.com/libnet/dhcp-probe/
105+
[buildsystem]: https://airs.com/ian/configure/
106+
[dhcp_probe(8)]: https://manpages.debian.org/unstable/dhcp-probe/dhcp_probe.8.en.html
107+
[dhcp_probe.cf(5)]: https://manpages.debian.org/unstable/dhcp-probe/dhcp_probe.cf.5.en.html

0 commit comments

Comments
 (0)