svc/conntrack.8.in: Sort the notification strings.

[tripe] / svc / conntrack.8.in

diff --git a/svc/conntrack.8.in b/svc/conntrack.8.in
index 3221742..a1e9491 100644 (file)
--- a/svc/conntrack.8.in
+++ b/svc/conntrack.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 <https://www.gnu.org/licenses/>.
 .
 .\"--------------------------------------------------------------------------
 .so ../common/defs.man \"@@@PRE@@@
 .
 .\"--------------------------------------------------------------------------
-.TH connect 8 "8 January 2007" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
+.TH conntrack 8tripe "8 January 2007" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
 .
 .\"--------------------------------------------------------------------------
 .SH "NAME"
@@ -101,6 +100,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
+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
@@ -198,31 +205,24 @@ 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 " " reason\fR...
+.BI "USER conntrack " up \fR| down " " group = peer\fR... " " reason\fR...
 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
 .TP
-.B "nm initially-connected"
-NetworkManager was detected on startup, and has an active network
-connection.
-.TP
-.B "nm initially-disconnected"
-NetworkManager was detected on startup, and has no active network
-connection.
-.TP
-.B "nm connected"
-NetworkManager has acquired an active network connection.
-.TP
-.B "nm disconnected"
-NetworkManager has lost its active network connection.
+.BI "icd connected " iap
+Maemo ICd has acquired an active network connection, identified by
+.IR iap .
 .TP
-.B "nm default-connection-change"
-NetworkManager has changed its default route.
+.B "icd idle"
+Maemo ICd has lost its active network connection.
 .TP
 .BI "icd initially-connected " iap
 Maemo ICd was detected on startup, and has an active network connection
@@ -232,13 +232,6 @@ identified by
 .B "icd initially-disconnected"
 Maemo ICd was detected on startup, and has no active network connection.
 .TP
-.BI "icd connected " iap
-Maemo ICd has acquired an active network connection, identified by
-.IR iap .
-.TP
-.B "icd idle"
-Maemo ICd has lost its active network connection.
-.TP
 .B interval-timer
 A change was detected during
 .BR conntrack 's
@@ -252,6 +245,23 @@ The connection status was changed manually, using the
 or
 .B down
 service command.
+.TP
+.B "nm connected"
+NetworkManager has acquired an active network connection.
+.TP
+.B "nm default-connection-change"
+NetworkManager has changed its default route.
+.TP
+.B "nm disconnected"
+NetworkManager has lost its active network connection.
+.TP
+.B "nm initially-connected"
+NetworkManager was detected on startup, and has an active network
+connection.
+.TP
+.B "nm initially-disconnected"
+NetworkManager was detected on startup, and has no active network
+connection.
 .RE
 .
 .\"--------------------------------------------------------------------------
@@ -269,6 +279,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.
+.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"