From 3c36ca3e2bebf5568c97954f1e1e5a19b72a8eb1 Mon Sep 17 00:00:00 2001 From: Eric Karge Date: Fri, 11 Oct 2024 16:59:59 +0200 Subject: [PATCH] Add documentation for macOS vmnet devices --- doc/tinc.conf.5.in | 6 +++++- doc/tinc.texi | 8 +++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/doc/tinc.conf.5.in b/doc/tinc.conf.5.in index 31c0bea8..75f5f403 100644 --- a/doc/tinc.conf.5.in +++ b/doc/tinc.conf.5.in @@ -273,8 +273,12 @@ followed by an IP header. This mode should support both IPv4 and IPv6 packets. .It utun Pq OS X Set type to utun. -This is only supported on OS X version 10.6.8 and higher, but doesn't require the tuntaposx module. This mode should support both IPv4 and IPv6 packets. +.It vmnet Pq OS X +Set type to vmnet. +Like with tap, Tinc will expect packets read from the virtual network device +to start with an Ethernet header. +Use VmnetAddr and VmnetNetmask settings to configure the device address/network .It tap Pq BSD and Linux Set type to tap. Tinc will expect packets read from the virtual network device diff --git a/doc/tinc.texi b/doc/tinc.texi index 81283e4a..7fe8e503 100644 --- a/doc/tinc.texi +++ b/doc/tinc.texi @@ -308,10 +308,16 @@ Tinc also supports the driver from @uref{http://tuntaposx.sourceforge.net/}, which supports both tun and tap style devices, By default, tinc expects the tuntaposx driver to be installed. -To use the utun driver, set add @samp{Device = utunX} to @file{tinc.conf}, +To use the utun driver, add @samp{Device = utunX} to @file{tinc.conf}, where X is the desired number for the utun interface. You can also omit the number, in which case the first free number will be chosen. +On OS X version 14 and above tinc supports the build-in "vmnet" driver. +Use this driver if you need to run Tinc in "switch" mode on more recent Macs. +To use the vmnet driver add @samp{DeviceType = vmnet} to @file{tinc.conf}. +"vmnet" devices have a fixed network configuration and cannot be configured with the +@file{tinc-up} script. Use @samp{VmnetAddr = X.X.X.X} and @samp{VmnetNetmask = X.X.X.X} +to configure the host side of a vmnet device. @c ================================================================== @node Configuration of Windows -- 2.47.3