about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--README7
1 files changed, 7 insertions, 0 deletions
diff --git a/README b/README
index 69ad0ef..5f19bec 100644
--- a/README
+++ b/README
@@ -5,6 +5,13 @@ Creates a TUN or TAP device on a specified file descriptor, sets an
 environment variable indicating its name, and then execs into the rest
 of argv.
 
+Unlike programs like tunctl, since mktuntap execs into the next
+program with the created device available on a file descriptor, the
+devices it creates don't need to have the IFF_PERSIST flag set, and
+will therefore automatically be destroyed by the kernel when the file
+descriptor is closed.  It works very well with, but is in no way
+coupled to, the execline scripting language.
+
 mktuntap makes use of example code from the Linux kernel, and as such is
 licensed under (only) version 2 of the GNU General Public License as
 published by the Free Software Foundation.