tripe-keys: Add a subcommand to print the correct tunnel MTU.

[tripe] / keys / tripe-keys.8.in

diff --git a/keys/tripe-keys.8.in b/keys/tripe-keys.8.in
index eb2604b8c67ee4e55991497a95fb7fa6beca5cc0..ce3c1ec1eeebd25ee1727cb29e81357464a13366 100644 (file)
--- a/keys/tripe-keys.8.in
+++ b/keys/tripe-keys.8.in
@@ -55,6 +55,8 @@ tripe-keys \- simple centralized key management for tripe
 .B "rebuild"
 .br
 .B "clean"
 .B "rebuild"
 .br
 .B "clean"

+.br
+.BR "mtu " [ \fIpath-mtu ]

 .
 .\"--------------------------------------------------------------------------
 .SH "DESCRIPTION"
 .
 .\"--------------------------------------------------------------------------
 .SH "DESCRIPTION"


@@ -215,6 +217,18 @@ might have written to a directory.  In particular, it deletes
 and their associated
 .B .old
 files.
 and their associated
 .B .old
 files.

+.TP
+.BR "mtu " [ \fIpath-mtu ]
+Write, as a decimal number on standard output, the recommended MTU for a
+TrIPE tunnel interface, given that the
+.I path-mtu
+between two peers is as specified.  The default is 1500, which is very
+commonly correct, but you should check using a tool such as
+.BR tracepath (8).
+Getting the MTU too big will lead to unnecessary fragmentation of
+TrIPE's UDP datagrams; getting it too small will fail to utilize the
+underlying network effectively.  If in doubt, it's therefore better to
+underestimate.

 .
 .\"--------------------------------------------------------------------------
 .SH "SEE ALSO"
 .
 .\"--------------------------------------------------------------------------
 .SH "SEE ALSO"