summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRoy Marples <roy@marples.name>2017-03-10 20:45:11 +0000
committerRoy Marples <roy@marples.name>2017-03-10 20:45:11 +0000
commitac1459a3fe8c07dab6025a8d566bbc2405fc570b (patch)
tree9979700cc862ef54d570b4a981172bd3f44d35d0
parentd013e0966f55c512970fcb39975f127ef8ab15e7 (diff)
downloadparpd-ac1459a3fe8c07dab6025a8d566bbc2405fc570b.tar.xz
Add an initial README.md
-rw-r--r--README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9d2a21b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# parpd
+
+parpd is a Proxy ARP Daemon and complies with [RFC 1027][RFC1027].
+parpd is released under the [2 clause BSD license][BSD2].
+
+## Installing parpd
+
+Change the version as required.
+
+```
+cd /tmp
+tar xvjpf /path/to/parpd-1.5.tar.bz2
+cd parpd-1.5
+make install
+```
+
+### Configuring
+
+Configuration is found in the file `/etc/parpd.conf`
+Comment lines should start with `#` or `;`
+Each line compromises of two or three words:
+`<command> <inet address> [<hardware address>]`
+
+Here are some examples:
+
+```
+# parpd.conf example
+
+# These two do the same thing
+proxy 192.168.0.0/24
+proxy 192.168.0.0/255.255.255.0
+
+# Send this hardware address to this host
+proxy 192.168.0.5 aa:bb:cc:dd:ee:ff
+
+# Ignore a host
+ignore 192.168.0.8
+```
+
+```
+# another parpd.conf example
+
+# This one is more interesting - it tells parpd to proxy all ARP requests
+# except for a specific subnet.
+proxy 0.0.0.0
+ignore 10.0.0.0/24
+```
+
+[rfc1027]: http://tools.ietf.org/html/rfc1027
+[BSD2]: http://www.freebsd.org/copyright/freebsd-license.html