svc/connect.in (cmd_kick): Call the right function.

[tripe] / svc / conntrack.8.in

diff --git a/svc/conntrack.8.in b/svc/conntrack.8.in
index 9c0fe1b..dd146f2 100644 (file)
--- a/svc/conntrack.8.in
+++ b/svc/conntrack.8.in
@@ -27,7 +27,7 @@
 .so ../common/defs.man \"@@@PRE@@@
 .
 .\"--------------------------------------------------------------------------
 .so ../common/defs.man \"@@@PRE@@@
 .
 .\"--------------------------------------------------------------------------

-.TH connect 8 "8 January 2007" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
+.TH conntrack 8 "8 January 2007" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"

 .
 .\"--------------------------------------------------------------------------
 .SH "NAME"
 .
 .\"--------------------------------------------------------------------------
 .SH "NAME"


@@ -101,6 +101,14 @@ connecting the new one.  If no match is found in a particular group,
 then no peers in the group are connected.  Strange and unhelpful things
 will happen if you put the same peer in several different groups.
 .PP
 then no peers in the group are connected.  Strange and unhelpful things
 will happen if you put the same peer in several different groups.
 .PP

+The tags
+.B down
+and
+.BI down/ anything
+are special and mean that no peer from the group should be active.  This
+is useful for detecting a `home' network, where a VPN is unnecessary
+(or, worse, break routing completely).
+.PP

 The notion of `current IP address' is somewhat vague.  The
 .B conntrack
 service calculates it as the source address that the host would put on
 The notion of `current IP address' is somewhat vague.  The
 .B conntrack
 service calculates it as the source address that the host would put on


@@ -181,10 +189,31 @@ All notifications issued by
 begin with the tokens
 .BR "USER conntrack" .
 .SP
 begin with the tokens
 .BR "USER conntrack" .
 .SP

-.BI "USER conntrack " up \fR| down " " reason\fR...
+.BI "USER conntrack dbus-connection " status
+The service's connection to D-Bus has changed state.  The
+.I status
+is one of the following.
+.RS
+.TP
+.B startup
+Initially trying to connect.
+.TP
+.B connected
+Successfully established a connection to the bus.
+.TP
+.B lost
+A connection has been lost.
+.TP
+.BI state= label
+The service's internal state machine is confused.
+.RE
+.SP
+.BI "USER conntrack " up \fR| down " " group = peer\fR... " " reason\fR...

 The network connection has apparently gone up or down, and
 .B conntrack
 The network connection has apparently gone up or down, and
 .B conntrack

-is about to kill and/or connect peers accordingly.  The
+is about to kill and/or connect peers accordingly: for each group, the
+selected peer is listed; if a group is not listed, then either the group
+is to be brought down, or no matching peer was found.  The

 .I reason
 is one of the following.
 .RS
 .I reason
 is one of the following.
 .RS


@@ -251,6 +280,12 @@ The configuration file is invalid.  The
 token names a Python exception; the
 .I error-text
 describes the problem encountered, though it may not be very useful.
 token names a Python exception; the
 .I error-text
 describes the problem encountered, though it may not be very useful.

+.SP
+.BI "USER conntrack connect-failed " peer " " tokens\fR...
+An attempt to connect the named
+.I peer
+failed; the error message is given by the
+.IR tokens .

 .
 .\"--------------------------------------------------------------------------
 .SH "SUMMARY"
 .
 .\"--------------------------------------------------------------------------
 .SH "SUMMARY"