X-Git-Url: https://git.distorted.org.uk/~mdw/tripe/blobdiff_plain/51113adb98c4d82ab799ab38ea463427d0780daa..6aa21132b259c53b0cba8e9edc95a848339b73d9:/svc/connect.8.in diff --git a/svc/connect.8.in b/svc/connect.8.in index 7021c6b6..86945ce4 100644 --- a/svc/connect.8.in +++ b/svc/connect.8.in @@ -9,25 +9,24 @@ .\" .\" This file is part of Trivial IP Encryption (TrIPE). .\" -.\" TrIPE is free software; you can redistribute it and/or modify -.\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation; either version 2 of the License, or -.\" (at your option) any later version. +.\" TrIPE is free software: you can redistribute it and/or modify it under +.\" the terms of the GNU General Public License as published by the Free +.\" Software Foundation; either version 3 of the License, or (at your +.\" option) any later version. .\" -.\" TrIPE is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. +.\" TrIPE is distributed in the hope that it will be useful, but WITHOUT +.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +.\" for more details. .\" .\" You should have received a copy of the GNU General Public License -.\" along with TrIPE; if not, write to the Free Software Foundation, -.\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +.\" along with TrIPE. If not, see . . .\"-------------------------------------------------------------------------- -.so ../defs.man.in \"@@@PRE@@@ +.so ../common/defs.man \"@@@PRE@@@ . .\"-------------------------------------------------------------------------- -.TH connect 8 "11 December 2007" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption" +.TH connect 8tripe "11 December 2007" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption" . .\"-------------------------------------------------------------------------- .SH "NAME" @@ -370,7 +369,30 @@ The parameters are as follows. .TP .B every A time interval: how often to ping the peer to ensure that it's still -alive. The default is 2 minutes. +alive. The default is 30 seconds for active dynamic peers, and 5 +minutes for passive peers. +.IP +The period for dynamic peers should be no longer than +.I timeout +\(mu +.RI ( retries +\- 1). Consider an idle mobile peer which has its IP address changed +just before its passive peer begins pinging. The static peer's pings +will go to the old address until it receives a ping back from the mobile +peer. Therefore, the static peer has to keep pinging until it would +definitely have received an unsolicited ping from the mobile peer, and +therefore be informed of the change of address. And it's no use +learning about the change of address just after sending the last ping to +the old address, so the last retry doesn't count for the purposes of +this calculation. +.IP +Besides, the consequences of failed pinging differ between dynamic and +passive peers. In the former case, a failure provokes a reconnection +attempt, after which (hopefully) things will work again: it's probably a +good thing to check frequently and fail fast. In the latter case, the +dynamic peer will certainly have to notice that it's been abandoned and +arrange to retry, causing a communication failure where maybe there +wasn't really one before. .TP .B timeout A time interval: how long to wait for a reply before retrying or giving @@ -501,7 +523,7 @@ provided about each peer, in the form of subsequent tokens. Clients should be prepared to ignore such tokens.) .SP .BI "info " peer -Lists the database record for the named +Lists the database record and additional information about the named .IR peer . For each key/value pair, a line .RS @@ -510,6 +532,67 @@ For each key/value pair, a line .IB key = value .PP is output. The key/value pairs are output in an arbitrary order. +.PP +In addition to the fields of the peer's database record, the following +additional keys are defined. +.TP +.B failures +The number of failed pings in the current or most recent batch, in +decimal. +.TP +.B last-ping +The round-trip time of the most recent ping in milliseconds, in the form +.IB nn.n ms\fR, +or +.B timeout +if the most recent ping timed out, +or +.B \- +if no pings have yet completed. +.TP +.B max-ping +The maximum successful ping time so far in milliseconds, in the form +.IB nn.n ms\fR, +or +.B \- +if no pings have yet succeeded. +.TP +.B mean-ping +The average successful ping time so far in milliseconds, in the form +.IB nn.n ms\fR, +or +.B \- +if no pings have yet succeeded. +.TP +.B min-ping +The minimum successful ping time so far in milliseconds, in the form +.IB nn.n ms\fR, +or +.B \- +if no pings have yet succeeded. +.TP +.B n-lost +The number of pings which have been declared timed out so far, in +decimal. +.TP +.B n-ping +The number of successful pings so far, in decimal. +.TP +.B sd-ping +The standard deviation of ping times so far in milliseconds, in the form +.IB nn.n ms\fR, +or +.B \- +if no pings have yet succeeded. +.TP +.B state +One of the strings: +.B idle +if the peer has responded to a ping recently, and we are waiting for the +.B every +delay before we try again; or +.B check +if we are currently waiting for a ping to return. .RE .SP .BI "kick " peer @@ -574,6 +657,17 @@ seconds are assumed. .\"-opts .RE .SP +.BI "sabotage " peer +Sabotage the +.I peer +so that +.B connect +thinks that it can't respond to pings. This will usually provoke a +reconnection attempt. Use +.B kick +instead unless you're trying to test +.BR connect . +.SP .BI "userpeer " user Output a single .B INFO