14 .TH Sonar 1 "12-Aug-08" "X Version 11"
16 sonar - display a sonar scope
19 [\-ping \fIhosts-or-subnets\fP]
20 [\-ping\-timeout \fIint\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]
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.
40 Alternately, it can run a simulation that doesn't involve hosts.
43 understands the following options:
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:
51 Run in simulation mode instead of pinging real hosts.
57 Ping the given IPv4 address.
60 Ping the local subnet. On systems where we can determine the local
61 network mask, we use that; otherwise, we assume Class C (254 hosts).
64 Ping a different-sized local subnet: e.g., \fBsubnet/28\fP would ping
65 a 4-bit subnet (the nearest 14 addresses). On systems where we can
66 determine the local network mask, we always use that.
69 Ping an arbitrary other IPv4 subnet. The address specifies
70 the base address, and the part after the slash is how wide the
71 subnet is. Typical values are /24 (for 254 addresses) and /28 (for
75 Ping the hosts listed in the given file. This file can be in the
76 format used by \fI/etc/hosts\fP, or it can be any file that has host
77 names as the first or second element on each line. If you use ssh,
80 sonar -ping $HOME/.ssh/known_hosts
83 .B \-ping\-timeout \fIint\fP
84 The amount of time in milliseconds the program will wait for an answer
88 Delay between frames, in microseconds. Default 20000.
90 .B \-speed \fIratio\fP
91 Less than 1 for slower, greater than 1 for faster. Default 1.
93 .B \-sweep-size \fIratio\fP
94 How big the glowing sweep area should be. Default 0.3.
96 .B \-font-size \fIpoints\fP
97 How large the text should be. Default 10 points.
100 Keep the display stationary instead of very slowly wobbling back and forth.
103 Do not attempt to resolve IP addresses to hostnames.
106 Do not display ping times beneath the host names.
108 .B \-team-a-name \fIstring\fP
109 In simulation mode, the name of team A.
111 .B \-team-b-name \fIstring\fP
112 In simulation mode, the name of team B.
114 .B \-team-a-count \fIint\fP
115 In simulation mode, the number of bogies on team A.
117 .B \-team-b-count \fIint\fP
118 In simulation mode, the number of bogies on team B.
121 Display the current frame rate, polygon count, and CPU load.
123 On most Unix systems, this program must be installed as setuid root
124 in order to ping hosts. This is because root privileges are needed
125 to create an ICMP RAW socket. Privileges are disavowed shortly after
126 startup (just after connecting to the X server) so this is believed
129 chown root:root sonar
132 It is not necessary to make it setuid on MacOS systems, because on
133 MacOS, unprivileged programs can ping by using ICMP DGRAM sockets
136 In ping-mode, the display is a logarithmic scale, calibrated so that the
137 three rings represent ping times of approximately 2.5, 70 and 2,000
138 milliseconds respectively.
140 This means that if any the hosts you are pinging take longer than 2
141 seconds to respond, they won't show up; and if you are pinging several
142 hosts with very fast response times, they will all appear close to the
143 center of the screen (making their names hard to read.)
145 Does not support IPv6.
148 .BR xscreensaver (1),
152 Copyright \(co 2000-2012 by Jamie Zawinski <jwz@jwz.org>
154 Copyright \(co 1998 by Stephen Martin. <smartin@canada.com>
156 Permission to use, copy, modify, distribute, and sell this software and its
157 documentation for any purpose is hereby granted without fee, provided that
158 the above copyright notice appear in all copies and that both that
159 copyright notice and this permission notice appear in supporting
160 documentation. No representations are made about the suitability of this
161 software for any purpose. It is provided "as is" without express or
165 Stephen Martin <smartin@canada.com>, 3-nov-1998.
167 Subnet support, etc. added by Jamie Zawinski, 17-Jul-2000.
169 Rewritten using OpenGL instead of X11 by Jamie Zawinski, 12-Aug-2008.