X-Git-Url: https://git.distorted.org.uk/~mdw/tripe/blobdiff_plain/a62f8e8a94bf56194539f7140a1215bc74309b36..HEAD:/svc/tripe-ifup.8.in

diff --git a/svc/tripe-ifup.8.in b/svc/tripe-ifup.8.in
index 0fe89d82..6385d131 100644
--- a/svc/tripe-ifup.8.in
+++ b/svc/tripe-ifup.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 ../defs.man.in \"@@@PRE@@@
+.so ../common/defs.man \"@@@PRE@@@
 .
 .\"--------------------------------------------------------------------------
-.TH tripe-ifup 8 "20 December 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
+.TH tripe-ifup 8tripe "20 December 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
 .
 .\"--------------------------------------------------------------------------
 .SH "NAME"
@@ -101,43 +100,63 @@ a
 command is issued to keep the server informed.  Further configuration is
 performed using the new interface name.
 .hP 2.
-The point-to-point interface is configured.  If
+Configure the interface addresses.  If
 .I laddr
-and
+is set, it should be a space-separated list of IPv4 and IPv6 addresses
+with optional prefix lengths; there may be any number of either.  If
 .I raddr
-are set, then the interface is configured to be a point-to-point link
-from
-.I laddr
-to
-.IR raddr .
-Both are expected to be network addresses in dotted-quad form.  The
-interface MTU is configured based on the path MTU to the peer's external
-address and the cryptographic algorithms in use by the
-.BR tripe (8)
-server; this can be overridden by setting the
-.I mtu
-key.
+is set, it should be a list IPv4 and/or an IPv6 addresses, with optional
+prefix lengths, separated by space: these are the addresses to
+configure as the remote end point of the point-to-point link.  (Further
+remote addresses can be configured as host routes: see below.)  IPv4
+addresses are expected to be in dotted-quad form; IPv6 addresses should
+be in RFC4291 hex-and-colons form.
 .hP 3.
-Establish routes.  If the interface was configured, and
+Establish routes.  If addresses were configured, and
 .I nets
 is set, then
 .I nets
 is split into space-separated networks.  For each network, of the form
 .IB address / mask \fR,
 a route is configured to the given network, via the remote address of
-the link, over the tunnel interface.
+the link, over the tunnel interface.  The
+.IR address es
+may be IPv4 or IPv6 addresses.  If the interface has only an IPv4
+address then IPv6 routes will be ignored, and
+.IR "vice versa" .
+.RS
+.PP
+If any configuration commands fail, a warning
+.IP
+.B USER tripe-ifup command-failed
+.BI rc= rc
+.I command
+.PP
+is issued.
+.RE
 .hP 4.
+Configure the interface MTU and bring it up.  The
+interface MTU is configured based on the path MTU to the peer's external
+address and the cryptographic algorithms in use by the
+.BR tripe (8)
+server; this can be overridden by setting the
+.I mtu
+key.
+.hP 5.
 Invoke user hook.  If
 .I ifupextra
 is set, it is interpreted as a Bourne shell command and evaluated.
-.hP 5.
+.hP 6.
 Notify services.  A notification
 .RS
 .IP
 .B USER tripe-ifup configured
 .I peer
+.RB [ failed ]
 .PP
-is issued.
+is issued: the
+.B failed
+token is included if any of the configuration commands failed.
 .RE
 .
 .\"--------------------------------------------------------------------------