1sonar(6x) XScreenSaver manual sonar(6x)
2
6 sonar - display a sonar scope
7
9 sonar [-ping hosts-or-subnets] [-background color] [-sweep-color color]
10 [-low-color color] [-scope-color color] [-grid-color color]
11 [-text-color color] [-ttl integer] [-font font] [-ping-timeout int]
12 [-team-a-name string] [-team-b-name string] [-team-a-count int] [-team-
13 b-count int] [-no-dns] [-no-times] [-debug]
14
16 The sonar program displays a sonar scope on the computer's screen.
17 This scope polls a sensor as the sweep goes around the scope and dis‐
18 plays what it finds as bogies on the screen. The program is designed
19 to support different modes representing different types of sensors.
20 Currently the only implemented sensors are a simulator, and a network
21 ping function that pings hosts and plots the results on the scope.
22
24 sonar understands the following options:
25 -background Color
27 The background Color of the screen not covered by the scope.
28 -sweep-color Color
30 The color of the brightest part of the sweep.
31 -scope-color Color
33 The color of the circular part of the scope.
34 -grid-color Color
36 The color to the grid lines overlaying the scope.
37 -text-color Color
39 The color of the text identifying bogies on the scope.
40 -ttl integer
42 "Time to live": visible time of a Bogie. Try values between 10
43 (very short) and 100.
44 -font font
46 The font used to display text on the scope. Default "fixed".
47 -ping-timeout int
49 The amount of time in milliseconds the program will wait for an
50 answer to a ping.
51 -ping hosts-or-subnets
53 The list of things to ping, separated by commas or spaces.
54 Elements of this list may be:
55 simulation to run in simulation mode, instead of pinging real
57 hosts (this is the default if the program is not
58 installed setuid);
59 hostname to ping the given host;
61 A.B.C.D to ping the given IP address;
63 subnet to ping the local class C subnet (the nearest 255
65 addresses);
66 subnet/NN to ping a different-sized local subnet: e.g., sub‐
68 net/28 would ping a 4-bit subnet (the nearest 15
69 addresses);
70 A.B.C.D/NN to ping an arbitrary other subnet: the IP address
72 specifies the base address, and the part after the
73 slash is how wide the subnet is. Typical values
74 are /24 (for 255 addresses) and /28 (for 15
75 addresses.)
76 filename to ping the hosts listed in the given file. This
78 file can be in the format used by /etc/hosts, or it
79 can be any file that has host names as the first
80 element on each line. If you use ssh, try this:
81 sonar -ping $HOME/.ssh/known_hosts
83 -no-dns Do not attempt to resolve IP addresses to hostnames.
85 -no-times
87 Do not display ping times beneath the host names.
88 -team-a-name string
90 In simulation mode, the name of team A.
91 -team-b-name string
93 In simulation mode, the name of team B.
94 -team-a-count int
96 In simulation mode, the number of bogies on team A.
97 -team-b-count int
99 In simulation mode, the number of bogies on team B.
100
102 Configuration of the targets to ping is best done by setting X
103 Resources.
104 background (Color)
106 See option -background, above; default value is black.
107 sweepColor (Color)
109 See option -sweep-color, above; default value is #00ff00.
110 scopeColor (Color)
112 See option -scope-color, above; default value is #003300.
113 gridColor (Color)
115 See option -grid-color, above; default value is #00aa00.
116 textColor (Color)
118 See option -text-color, above; default value is #ffff00.
119 ttl (integer)
121 See option -ttl, above; default value is 90 or one sweep.
122 ping (string)
124 See option -ping, above. If set to default, it will ping the
125 contents of /etc/hosts if possible, otherwise, will run in sim‐
126 ulation-mode.
127 font (font)
129 See option -font, above; default value is fixed.
130 pingTimeout (Integer)
132 See option -pingtimeout, above; default value is 3000.
133 teamAName string
135 See option -team-a-name, above. Default value is F18.
136 teamBName string
138 See option -teamBName, above. Default value is MIG.
139 teamACount int
141 See option -teamACount, above. Default value is 4.
142 teamBCount int
144 See option -teamBCount, above. Default value is 4.
145
147 In order to use the ping sensor on most systems, this program must be
148 installed as setuid root, so that it can create an ICMP RAW socket.
149 Root privileges are disavowed shortly after startup (just after con‐
150 necting to the X server and reading the resource database) so this is
151 believed to be a safe thing to do, but it is usually recommended that
152 you have as few setuid programs around as possible, on general princi‐
153 ples.
154 chown root:root sonar
155 chmod u+s sonar
156 It is not necessary to make it setuid on MacOS systems, because on
157 those systems, unprivileged programs can ping by using ICMP DGRAM sock‐
158 ets instead of ICMP RAW.
159 In ping-mode, the display is a logarithmic scale, calibrated so that
161 the three rings represent ping times of approximately 2.5, 70 and 2,000
162 milliseconds respectively.
163 This means that if any the hosts you are pinging take longer than 2
165 seconds to respond, they won't show up; and if you are pinging several
166 hosts with very fast response times, they will all appear close to the
167 center of the screen (making their names hard to read.)
168
170 X(1), xscreensaver(1), ping(8)
171
173 Copyright © 1998 by Stephen Martin. <smartin@canada.com> Copyright ©
174 2000-2004 by Jamie Zawinski <jwz@jwz.org>
175 Permission to use, copy, modify, distribute, and sell this software and
177 its documentation for any purpose is hereby granted without fee, pro‐
178 vided that the above copyright notice appear in all copies and that
179 both that copyright notice and this permission notice appear in sup‐
180 porting documentation. No representations are made about the suitabil‐
181 ity of this software for any purpose. It is provided "as is" without
182 express or implied warranty.
183
186 Stephen Martin <smartin@canada.com>, 3-nov-98.
187 Thanks to Tom Kelly for suggesting a modular approach to the sensor
189 among other things.
190 Thomas Bahls <thommy@cs.tu-berlin.de> hacked the "ttl" option,
192 12-jul-98.
193 Better subnet support and command-line processing by Jamie Zawinski,
195 17-Jul-00.
196X Version 11 5.05-3 (06-Apr-2008) sonar(6x)