server/admin.c: Remove spurious `ping' in usage message.

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

diff --git a/uslip/tripe-uslip.1.in b/uslip/tripe-uslip.1.in
index 16b0a7e..0f4bc56 100644 (file)
--- a/uslip/tripe-uslip.1.in
+++ b/uslip/tripe-uslip.1.in
@@ -4,30 +4,29 @@
 .\"
 .\" (c) 2008 Straylight/Edgeware.
 .\"
-
+.
 .\"----- Licensing notice ---------------------------------------------------
 .\"
 .\" 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-uslip 1 "7 April 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
+.TH tripe-uslip 1tripe "7 April 2008" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
 .
 .\"--------------------------------------------------------------------------
 .SH "NAME"
@@ -38,7 +37,7 @@ tripe-uslip \- fake SLIP interface for testing tripe
 .SH "SYNOPSIS"
 .
 .B tripe-uslip
-.RB [ \-gp ]
+.RB [ \-fgps ]
 .I socket
 .
 .\"--------------------------------------------------------------------------
@@ -174,6 +173,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 +202,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