server/admin.c: Remove spurious `ping' in usage message.
[tripe] / svc / tripe-ifup.8.in
index 440c284..6385d13 100644 (file)
@@ -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"
@@ -103,16 +102,15 @@ performed using the new interface name.
 .hP 2.
 Configure the interface addresses.  If
 .I laddr
-is set, it should be a space-separated list of IPv4 and IPv6 addresses:
-there may be any number of either.
-If
+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
-is set, it should be an IPv4 and/or an IPv6 address, 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.
+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 addresses were configured, and
 .I nets
@@ -126,6 +124,16 @@ the link, over the tunnel interface.  The
 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
@@ -144,8 +152,11 @@ Notify services.  A notification
 .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
 .
 .\"--------------------------------------------------------------------------