git.hungrycats.org Git - xscreensaver/blob - hacks/glx/sonar.man

   1 .de EX          \"Begin example
   2 .ne 5
   3 .if n .sp 1
   4 .if t .sp .5
   5 .nf
   6 .in +.5i
   7 ..
   8 .de EE
   9 .fi
  10 .in -.5i
  11 .if n .sp 1
  12 .if t .sp .5
  13 ..
  14 .TH Sonar 1 "12-Aug-08" "X Version 11"
  15 .SH NAME
  16 sonar - display a sonar scope
  17 .SH SYNOPSIS
  18 .B sonar
  19 [\-ping \fIhosts-or-subnets\fP]
  20 [\-ping\-timeout \fIint\fP]
  21 [\-delay \fIusecs\fP]
  22 [\-speed \fIratio\fP]
  23 [\-sweep-size \fIratio\fP]
  24 [\-font-size \fIpoints\fP]
  25 [\-team-a-name \fIstring\fP]
  26 [\-team-b-name \fIstring\fP]
  27 [\-team-a-count \fIint\fP]
  28 [\-team-b-count \fIint\fP]
  29 [\-no\-dns]
  30 [\-no\-times]
  31 [\-no\-wobble]
  32 [\-debug]
  33 [\-fps]
  34 .SH DESCRIPTION
  35 This draws a sonar screen that pings (get it?) the hosts on
  36 your local network, and plots their distance (response time) from you.
  37 The three rings represent ping times of approximately 2.5, 70 and 2,000
  38 milliseconds respectively.
  39
  40 Alternately, it can run a simulation that doesn't involve hosts.
  41 .SH OPTIONS
  42 .I sonar
  43 understands the following options:
  44 .TP 8
  45 .B \-ping \fIhosts-or-subnets\fP
  46 The list of things to ping, separated by commas or spaces.
  47 Elements of this list may be:
  48 .RS 8
  49 .TP 12
  50 .B simulation
  51 Run in simulation mode instead of pinging real hosts.
  52 .TP 12
  53 .I hostname
  54 Ping the given host.
  55 .TP 12
  56 .I A.B.C.D
  57 Ping the given IP address.
  58 .TP 12
  59 .B subnet
  60 Ping the local class C subnet (the nearest 255 addresses).
  61 .TP 12
  62 .B subnet/\fINN\fP
  63 Ping a different-sized local subnet: e.g., \fBsubnet/28\fP would ping
  64 a 4-bit subnet (the nearest 15 addresses).
  65 .TP 12
  66 .I A.B.C.D/NN
  67 Ping an arbitrary other subnet.  The IP address specifies the base address,
  68 and the part after the slash is how wide the subnet is.  Typical values
  69 are /24 (for 255 addresses) and /28 (for 15 addresses).
  70 .TP 12
  71 .I filename
  72 Ping the hosts listed in the given file.  This file can be in the
  73 format used by \fI/etc/hosts\fP, or it can be any file that has host
  74 names as the first or second element on each line.  If you use ssh,
  75 try this:
  76
  77   sonar -ping $HOME/.ssh/known_hosts
  78 .RE
  79 .TP 8
  80 .B \-ping\-timeout \fIint\fP
  81 The amount of time in milliseconds the program will wait for an answer
  82 to a ping.
  83 .TP 8
  84 .B \-delay \fIint\fP
  85 Delay between frames, in microseconds.  Default 20000.
  86 .TP 8
  87 .B \-speed \fIratio\fP
  88 Less than 1 for slower, greater than 1 for faster.  Default 1.
  89 .TP 8
  90 .B \-sweep-size \fIratio\fP
  91 How big the glowing sweep area should be. Default 0.3.
  92 .TP 8
  93 .B \-font-size \fIpoints\fP
  94 How large the text should be.  Default 10 points.
  95 .TP 8
  96 .B \-no\-wobble
  97 Keep the display stationary instead of very slowly wobbling back and forth.
  98 .TP 8
  99 .B \-no\-dns
 100 Do not attempt to resolve IP addresses to hostnames.
 101 .TP 8
 102 .B \-no\-times
 103 Do not display ping times beneath the host names.
 104 .TP 8
 105 .B \-team-a-name \fIstring\fP
 106 In simulation mode, the name of team A.
 107 .TP 8
 108 .B \-team-b-name \fIstring\fP
 109 In simulation mode, the name of team B.
 110 .TP 8
 111 .B \-team-a-count \fIint\fP
 112 In simulation mode, the number of bogies on team A.
 113 .TP 8
 114 .B \-team-b-count \fIint\fP
 115 In simulation mode, the number of bogies on team B.
 116 .TP 8
 117 .B \-fps
 118 Display the current frame rate, polygon count, and CPU load.
 119 .SH NOTES
 120 On most Unix systems, this program must be installed as setuid root
 121 in order to ping hosts.  This is because root privileges are needed
 122 to create an ICMP RAW socket.  Privileges are disavowed shortly after
 123 startup (just after connecting to the X server) so this is believed
 124 to be safe:
 125 .EX
 126 chown root:root sonar
 127 chmod u+s sonar
 128 .EE
 129 It is not necessary to make it setuid on MacOS systems, because on
 130 MacOS, unprivileged programs can ping by using ICMP DGRAM sockets
 131 instead of ICMP RAW.
 132
 133 In ping-mode, the display is a logarithmic scale, calibrated so that the
 134 three rings represent ping times of approximately 2.5, 70 and 2,000
 135 milliseconds respectively.
 136
 137 This means that if any the hosts you are pinging take longer than 2
 138 seconds to respond, they won't show up; and if you are pinging several
 139 hosts with very fast response times, they will all appear close to the
 140 center of the screen (making their names hard to read.)
 141 .SH SEE ALSO
 142 .BR X (1),
 143 .BR xscreensaver (1),
 144 .BR ping (8)
 145 .SH COPYRIGHT
 146 Copyright \(co 2000-2008 by Jamie Zawinski <jwz@jwz.org>
 147 .RE
 148 Copyright \(co 1998 by Stephen Martin. <smartin@canada.com>
 149
 150 Permission to use, copy, modify, distribute, and sell this software and its
 151 documentation for any purpose is hereby granted without fee, provided that
 152 the above copyright notice appear in all copies and that both that
 153 copyright notice and this permission notice appear in supporting
 154 documentation.  No representations are made about the suitability of this
 155 software for any purpose.  It is provided "as is" without express or
 156 implied warranty.
 157
 158 .SH AUTHORS
 159 Stephen Martin <smartin@canada.com>, 3-nov-1998.
 160
 161 Subnet support, etc. added by Jamie Zawinski, 17-Jul-2000.
 162
 163 Rewritten using OpenGL instead of X11 by Jamie Zawinski, 12-Aug-2008.