keys/tripe-keys.8.in: Mention the `pathmtu' utility.

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

diff --git a/keys/tripe-keys.8.in b/keys/tripe-keys.8.in
index ce3c1ec1eeebd25ee1727cb29e81357464a13366..353028e8627eefb3acb83c95db4ead8399414838 100644 (file)
--- a/keys/tripe-keys.8.in
+++ b/keys/tripe-keys.8.in
@@ -24,10 +24,10 @@
 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 .
 .\"--------------------------------------------------------------------------
 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 .
 .\"--------------------------------------------------------------------------

-.so ../defs.man.in \" @@@PRE@@@
+.so ../common/defs.man \" @@@PRE@@@

 .
 .\"--------------------------------------------------------------------------
 .
 .\"--------------------------------------------------------------------------

-.TH tripe-keys 8 "14 September 2005" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
+.TH tripe-keys 8tripe "14 September 2005" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"

 .
 .\"--------------------------------------------------------------------------
 .SH "NAME"
 .
 .\"--------------------------------------------------------------------------
 .SH "NAME"


@@ -56,6 +56,8 @@ tripe-keys \- simple centralized key management for tripe
 .br
 .B "clean"
 .br
 .br
 .B "clean"
 .br

+.B "check"
+.br

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


@@ -166,8 +168,12 @@ file.  Copy the results to the places named by
 .IR sig-file ,
 and
 .I conf-file
 .IR sig-file ,
 and
 .I conf-file

-respectively.  (This command is currently misnamed.  It only copies
-stuff about the local filesystem.  Some day it'll really upload stuff.)
+respectively.  Remove unexpected files from the
+.IR base-dir ,
+since these tend to be signatures made by old master keys which don't
+work any more.  Run the
+.I upload-hook
+to copy things into the right places.

 .TP
 .BI "generate " tag
 Generate a peer key for the peer named
 .TP
 .BI "generate " tag
 Generate a peer key for the peer named


@@ -218,13 +224,23 @@ and their associated
 .B .old
 files.
 .TP
 .B .old
 files.
 .TP

+.B check
+Checks the various keyrings.  Currently, it checks the
+.B master
+and
+.B keyring.pub
+files, and prints a report warning of keys which will expire soon.  It
+is expected that this command be run against the master repository by
+.BR cron (8).
+Additional checking may added in the future.
+.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 "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).
+.BR pathmtu (1).

 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
 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