X-Git-Url: https://git.distorted.org.uk/~mdw/userv-utils/blobdiff_plain/bc79a75c2bd7600387d3cca68b9fb4f073c6b6db..5edd18879555ca5e6c7017703f777fd7c9f1300b:/ipif/INSTALL

diff --git a/ipif/INSTALL b/ipif/INSTALL
index b18e413..6f23ec6 100644
--- a/ipif/INSTALL
+++ b/ipif/INSTALL
@@ -1,6 +1,20 @@
-NB that this is a very bare set of installation instructions !  It
-describes a `default' configuration; you can do more esoteric things
-if you wish.
+This directory contains:
+
+* A userv service (`ipif') for allowing users to create network
+interfaces and handle the traffic for them.  For instructions, see the
+comment at the top of service.c.
+
+* A VPN tunnelling system based on that userv service, which does
+encryption and can be used to join two networks.  It uses its own
+nonstandard protocols, not IPSEC.  Key setup is done via an ssh
+connection.  For installation instructions, read this file.
+
+These tools have only been tested on GNU/Linux, and the ipif service
+in particular uses the Linux-specific `slattach' utility.
+
+NB that this is a very bare set of installation instructions for the
+VPN system !  It describes a fairly `default' configuration; you can
+do more esoteric things if you wish.
 
 
 In any case, on each tunnel endpoint system (not the eventual