svc/connect.in (Peer.get): Don't apply filter to default value.

[tripe] / svc / conntrack.8.in

diff --git a/svc/conntrack.8.in b/svc/conntrack.8.in
index 9c0fe1b..713a70b 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).
 .\"
 .\"
 .\" 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
 .\"
 .\" 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@@@
 .
 .\"--------------------------------------------------------------------------
 .
 .\"--------------------------------------------------------------------------
 .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"
 .
 .\"--------------------------------------------------------------------------
 .SH "NAME"


@@ -56,7 +55,9 @@ conntrack \- tripe service to start/stop peers depending on external connectivit
 The
 .B conntrack
 service watches D-Bus network management services like
 The
 .B conntrack
 service watches D-Bus network management services like

-.BR NetworkManager (8)
+.BR NetworkManager (8),
+.BR ConnMan
+.RB ( connmand (8)),

 and Nokia's
 .BR ICd ,
 bringing peers up and down automatically.  It's designed to be useful on
 and Nokia's
 .BR ICd ,
 bringing peers up and down automatically.  It's designed to be useful on


@@ -101,6 +102,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,30 +190,59 @@ 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
 .TP
 .I reason
 is one of the following.
 .RS
 .TP

-.B "nm initially-connected"
-NetworkManager was detected on startup, and has an active network
-connection.
+.BI "connman initially-" state
+ConnMan was detected on startup, and is in the given
+.I state
+\(en see below.

 .TP
 .TP

-.B "nm initially-disconnected"
-NetworkManager was detected on startup, and has no active network
-connection.
+.BI "connman " state
+ConnMan has transitioned to
+.IR state .
+The possible states are:
+.B offline
+(the network is turned off by user request);
+.B idle
+(no network interfaces are active);
+.B ready
+(an interface is up but not fully configured); and
+.B online
+(an interface is up and configured).

 .TP
 .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
 .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
 .TP
 .BI "icd initially-connected " iap
 Maemo ICd was detected on startup, and has an active network connection


@@ -214,13 +252,6 @@ identified by
 .B "icd initially-disconnected"
 Maemo ICd was detected on startup, and has no active network connection.
 .TP
 .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
 .B interval-timer
 A change was detected during
 .BR conntrack 's


@@ -234,6 +265,23 @@ The connection status was changed manually, using the
 or
 .B down
 service command.
 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
 .
 .\"--------------------------------------------------------------------------
 .RE
 .
 .\"--------------------------------------------------------------------------


@@ -251,6 +299,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"