src/tripe-ifup.in: Hack IPv6 up on VPN interfaces.

[tripe] / uslip / tripe-uslip.1.in

diff --git a/uslip/tripe-uslip.1.in b/uslip/tripe-uslip.1.in
index 16b0a7e555913f5a2c831cc5b9b5c6157c4b4ad2..b607c39466134379003e35314725b35524e1c0d3 100644 (file)
--- a/uslip/tripe-uslip.1.in
+++ b/uslip/tripe-uslip.1.in
@@ -24,7 +24,7 @@
 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 .
 .\"--------------------------------------------------------------------------
-.so ../defs.man.in \" @@@PRE@@@
+.so ../common/defs.man \" @@@PRE@@@
 .
 .\"--------------------------------------------------------------------------
 .TH tripe-uslip 1 "7 April 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
@@ -38,7 +38,7 @@ tripe-uslip \- fake SLIP interface for testing tripe
 .SH "SYNOPSIS"
 .
 .B tripe-uslip
-.RB [ \-gp ]
+.RB [ \-fgps ]
 .I socket
 .
 .\"--------------------------------------------------------------------------
@@ -174,6 +174,24 @@ read a packet from the socket and write it to standard output.
 Connect to
 .IR socket ,
 read a packet from standard input and write it to the socket.
+.TP
+.B \-f, \-\-flood
+Connect to
+.IR socket ,
+and send packets as fast as possible.  The packets sent aren't very
+interesting, and there's no way to configure their contents.
+.TP
+.B \-s, \-\-sink
+Connect to
+.IR socket
+and read packets as the become available.  The packets are discarded,
+though if stdout is a terminal, a simple spinning-baton animation is
+updated once for each group of packets.  If you are flooding one end of
+a TrIPE connection, it's advisable to attach a sink to the other:
+otherwise the destination
+.B tripe-uslip
+will attempt to consume all available memory, storing incoming packets
+until someone retrieves them.
 .
 .\"--------------------------------------------------------------------------
 .SH "BUGS"
@@ -185,7 +203,10 @@ program is intended as a tool for testing the
 server.  It is not expected to be useful in production environments.  In
 particular, it intentionally imposes no limits on queue lengths or
 packet sizes, and its internals and interface (one packet per client
-connection) are not well-suited for high performance.
+connection) are not well-suited for high performance.  That said, the
+flood option has worked well enough to expose bugs in
+.BR tripe 's
+behaviour under heavy loads.
 .PP
 If
 .B tripe-uslip