X-Git-Url: https://www.tinc-vpn.org/git/browse?p=tinc;a=blobdiff_plain;f=doc%2Ftinc.conf.5.in;h=750e0cf2b77fd7cc7603d5fa792b0095c26568c3;hp=1797aa7c1d06ac75a504ebc8c32c88dcb1279246;hb=2077451e07f93edc520cf5bc31815624a2b03fdd;hpb=4fe7aff4d1b8605d4997b842481cc78bd062fe2a diff --git a/doc/tinc.conf.5.in b/doc/tinc.conf.5.in index 1797aa7c..750e0cf2 100644 --- a/doc/tinc.conf.5.in +++ b/doc/tinc.conf.5.in @@ -1,7 +1,7 @@ .Dd 2002-04-09 .Dt TINC.CONF 5 .\" Manual page created by: -.\" Ivo Timmermans +.\" Ivo Timmermans .\" Guus Sliepen .Sh NAME .Nm tinc.conf @@ -120,13 +120,6 @@ will by default listen on all of them for incoming connections. It is possible to bind only to a single interface with this variable. .Pp This option may not work on all platforms. -.It Va BlockingTCP Li = yes | no Po no Pc Bq experimental -This options selects whether TCP connections, when established, should use blocking writes. -When turned off, tinc will never block when a TCP connection becomes congested, but will have to terminate that connection instead. -If turned on, tinc will not terminate connections but will block, thereby unable to process data to/from other connections. -Turn this option on if you also use -.Va TCPOnly -and tinc terminates connections frequently. .It Va ConnectTo Li = Ar name Specifies which other tinc daemon to connect to on startup. Multiple @@ -206,11 +199,13 @@ while no routing table is managed. .It Va Name Li = Ar name Bq required This is the name which identifies this tinc daemon. It must be unique for the virtual private network this daemon will connect to. -.It Va PingTimeout Li = Ar seconds Pq 60 +.It Va PingInterval Li = Ar seconds Pq 60 The number of seconds of inactivity that .Nm tinc will wait before sending a probe to the other end. -If that other end doesn't answer within that same amount of time, +.It Va PingTimeout Li = Ar seconds Pq 5 +The number of seconds to wait for a response to pings or to allow meta +connections to block. If the other end doesn't respond within this time, the connection is terminated, and the others will be notified of this. .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental @@ -351,6 +346,15 @@ becomes reachable. This script is started when the tinc daemon with name .Ar HOST becomes unreachable. +.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-up +This script is started when any host becomes reachable. +.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-down +This script is started when any host becomes unreachable. +.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-up +This script is started when a Subnet becomes reachable. +The Subnet and the node it belongs to are passed in environment variables. +.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-down +This script is started when a Subnet becomes unreachable. .El .Pp The scripts are started without command line arguments, but can make use of certain environment variables. @@ -375,10 +379,13 @@ This should be used for commands like .Pa ifconfig . .It Ev NODE When a host becomes (un)reachable, this is set to its name. +If a subnet becomes (un)reachable, this is set to the owner of that subnet. .It Ev REMOTEADDRESS When a host becomes (un)reachable, this is set to its real address. .It Ev REMOTEPORT When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons. +.It Ev SUBNET +When a subnet becomes (un)reachable, this is set to the subnet. .El .Sh FILES The most important files are: