Document new proxy types.
[oweals/tinc.git] / doc / tinc.texi
index 3decca0..8cf157f 100644 (file)
@@ -1051,23 +1051,31 @@ When this option is used the priority of the tincd process will be adjusted.
 Increasing the priority may help to reduce latency and packet loss on the VPN.
 
 @cindex Proxy
-@item Proxy = <@var{type}> <@var{address}> <@var{port}> [<@var{username}>] [experimental]
-Use the proxy at the given @var{address} and @var{port} when making outgoing connections.
+@item Proxy = socks4 | socks4 | http | exec @var{...} [experimental]
+Use a proxy when making outgoing connections.
 The following proxy types are currently supported:
 
 @table @asis
 @cindex socks4
-@item socks4
+@item socks4 <@var{address}> <@var{port}> [<@var{username}>]
 Connects to the proxy using the SOCKS version 4 protocol.
 Optionally, a @var{username} can be supplied which will be passed on to the proxy server.
 
+@cindex socks5
+@item socks4 <@var{address}> <@var{port}> [<@var{username}> <@var{password}>]
+Connect to the proxy using the SOCKS version 5 protocol.
+If a @var{username} and @var{password} are given, basic username/password authentication will be used,
+otherwise no authentication will be used.
+
 @cindex http
-@item http
+@item http <@var{address}> <@var{port}>
 Connects to the proxy and sends a HTTP CONNECT request.
-@end table
-
-No authentication methods are currently supported.
 
+@cindex exec
+@item exec <@var{command}>
+Executes the given command which should set up the outgoing connection.
+The environment variables @env{NAME}, @env{NODE}, @env{REMOTEADDRES} and @env{REMOTEPORT} are available.
+@end table
 
 @cindex ReplayWindow
 @item ReplayWindow = <bytes> (16)