server/peer.c, server/admin.c: Introduce `p_destroyall'.

[tripe] / proxy / tripe-mitm.8.in

diff --git a/proxy/tripe-mitm.8.in b/proxy/tripe-mitm.8.in
index 0d883da..e939919 100644 (file)
--- a/proxy/tripe-mitm.8.in
+++ b/proxy/tripe-mitm.8.in
@@ -9,19 +9,18 @@
 .\"
 .\" 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@@@


@@ -59,6 +58,9 @@ The command line contains a sequence of directives, each of which has
 the form
 .IB command : arg \c
 .BR : ...
 the form
 .IB command : arg \c
 .BR : ...

+(The delimiter character can be changed using the
+.B \-d
+command-line option.)

 A list of directives can be stored in a file, one per line, and included
 using the
 .B include
 A list of directives can be stored in a file, one per line, and included
 using the
 .B include


@@ -77,6 +79,12 @@ successfully.
 .B "\-u, \-\-usage"
 Write a usage message to standard output, and exit successfully.
 .TP
 .B "\-u, \-\-usage"
 Write a usage message to standard output, and exit successfully.
 .TP

+.BI "\-d, \-\-delimiter=" char
+Use
+.I char
+as the delimiter to separate argument names in directives, rather than
+.RB ` : '.
+.TP

 .BI "\-k, \-\-keyring=" file
 Read keys from
 .IR file .
 .BI "\-k, \-\-keyring=" file
 Read keys from
 .IR file .


@@ -86,6 +94,14 @@ in the current directory.
 .SS "Directives"
 A directive is ignored if it is empty, or if its first character is a
 .RB ` # '.
 .SS "Directives"
 A directive is ignored if it is empty, or if its first character is a
 .RB ` # '.

+Directives consist of a name followed by zero or more arguments,
+separated by a delimiter character.  The default delimiter is
+.RB ` : ',
+but this can be overridden using the
+.B \-d
+option (see above); this manual uses
+.RB ` : '
+consistently as the delimiter character.

 The following directives are recognized.
 .TP
 .BI peer: name : local-port : remote-addr : remote-port
 The following directives are recognized.
 .TP
 .BI peer: name : local-port : remote-addr : remote-port


@@ -98,13 +114,16 @@ on
 The
 .I name
 identifies the public key which that peer uses to authenticate itself.
 The
 .I name
 identifies the public key which that peer uses to authenticate itself.

+(Currently this is checked, but not used for anything.)

 Both
 .I local-port
 and
 .I remote-port
 Both
 .I local-port
 and
 .I remote-port

-must be numbers;
+may be numbers or UDP service names;

 .I remote-addr
 .I remote-addr

-may be a hostname or an IP address in dotted-quad format.  Exactly two
+may be a hostname, an IPv4 address in dotted-quad format, or an IPv6
+address in hex-and-colons format (this last obviously requires selecting
+a different delimeter character).  Exactly two

 .B peer
 directives must be present.  The one first registered is the
 .I left
 .B peer
 directives must be present.  The one first registered is the
 .I left


@@ -114,6 +133,16 @@ peer.  The two peers must use
 .I different
 local ports.
 .TP
 .I different
 local ports.
 .TP

+.BI peer4: name : local-port : remote-addr : remote-port
+As for
+.I peer
+(see above), but force the use of IPv4.
+.TP
+.BI peer6: name : local-port : remote-addr : remote-port
+As for
+.I peer
+(see above), but force the use of IPv6.
+.TP

 .BI include: file
 Read more directives from
 .IR file .
 .BI include: file
 Read more directives from
 .IR file .


@@ -129,7 +158,7 @@ description of filters below for more details.
 .BI lfilt: filter : args : \fR...
 Apply a given filter to packets received from the left peer.
 .TP
 .BI lfilt: filter : args : \fR...
 Apply a given filter to packets received from the left peer.
 .TP

-.BI lfilt: filter : args :\fR...
+.BI rfilt: filter : args :\fR...

 Apply a given filter to packets received from the right peer.
 .TP
 .BI next: tag :\fR...
 Apply a given filter to packets received from the right peer.
 .TP
 .BI next: tag :\fR...