http://slackware.bholcomb.com/slackware/slackware-11.0/source/xap/xscreensaver/xscree...

[xscreensaver] / hacks / sonar.man

diff --git a/hacks/sonar.man b/hacks/sonar.man
index 1db5982abd20a6bf760a5f3e1a1f1214621119ce..5868acc0762e7c36f91af222d092dfd97b1697f0 100644 (file)
--- a/hacks/sonar.man
+++ b/hacks/sonar.man
@@ -30,6 +30,8 @@ sonar - display a sonar scope
 [\-team-b-name \fIstring\fP]
 [\-team-a-count \fIint\fP]
 [\-team-b-count \fIint\fP]
+[\-no\-dns] 
+[\-no\-times] 
 [\-debug] 
 .SH DESCRIPTION
 The \fIsonar\fP program displays a sonar scope on the computer's screen.
@@ -103,6 +105,12 @@ names as the first element on each line.  If you use ssh, try this:
   sonar -ping $HOME/.ssh/known_hosts
 .RE
 .TP 8
+.B \-no\-dns
+Do not attempt to resolve IP addresses to hostnames.
+.TP 8
+.B \-no\-times
+Do not display ping times beneath the host names.
+.TP 8
 .B \-team-a-name \fIstring\fP
 In simulation mode, the name of team A.
 .TP 8
@@ -159,14 +167,36 @@ See option \-teamACount, above.  Default value is 4.
 .B teamBCount \fIint\fP
 See option \-teamBCount, above.  Default value is 4.
 .SH NOTES
-In order to use the ping sensor, this program must be installed as 
-setuid root, so that it can create an ICMP socket.
+In order to use the ping sensor on most systems, this program must be
+installed as setuid root, so that it can create an ICMP RAW socket.
+Root privileges are disavowed shortly after startup (just after
+connecting to the X server and reading the resource database) so this
+is \fIbelieved\fP to be a safe thing to do, but it is usually
+recommended that you have as few setuid programs around as possible,
+on general principles.
+.EX
+chown root:root sonar
+chmod u+s sonar
+.EE
+It is not necessary to make it setuid on MacOS systems, because on
+those systems, unprivileged programs can ping by using ICMP DGRAM
+sockets instead of ICMP RAW.
+
+In ping-mode, the display is a logarithmic scale, calibrated so that the
+three rings represent ping times of approximately 2.5, 70 and 2,000
+milliseconds respectively.  
+
+This means that if any the hosts you are pinging take longer than 2
+seconds to respond, they won't show up; and if you are pinging several
+hosts with very fast response times, they will all appear close to the
+center of the screen (making their names hard to read.)
 .SH SEE ALSO
 .BR X (1),
 .BR xscreensaver (1),
 .BR ping (8)
 .SH COPYRIGHT
-Copyright \(co 1998 by Stephen Martin. (smartin@canada.com)
+Copyright \(co 1998 by Stephen Martin. <smartin@canada.com>
+Copyright \(co 2000-2004 by Jamie Zawinski <jwz@jwz.org>
 
 Permission to use, copy, modify, distribute, and sell this software and its
 documentation for any purpose is hereby granted without fee, provided that
@@ -180,7 +210,7 @@ implied warranty.
 Stephen Martin <smartin@canada.com>, 3-nov-98.
 
 Thanks to Tom Kelly for suggesting a modular approach to the sensor
-amoung other things.
+among other things.
 
 Thomas Bahls <thommy@cs.tu-berlin.de> hacked the "ttl" option, 12-jul-98.