Penguin
Recent Changes
Annotated edit history of sonar(1) version 4, including all changes. View license author blame.
Rev Author # Line
1 perry 1 Sonar
2 !!!Sonar
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 RESOURCES
8 NOTES
9 SEE ALSO
10 COPYRIGHT
11 AUTHORS
12 ----
13 !!NAME
14
15
16 sonar - display a sonar scope
17 !!SYNOPSIS
18
19
20 __sonar__ [[-ping ''hosts-or-subnets''] [[-background
21 ''color''] [[-sweep-color ''color''] [[-low-color
22 ''color''] [[-scope-color ''color''] [[-grid-color
23 ''color''] [[-text-color ''color''] [[-ttl
24 ''integer''] [[-font ''font''] [[-ping-timeout
25 ''int''] [[-team-a-name ''string''] [[-team-b-name
26 ''string''] [[-team-a-count ''int''] [[-team-b-count
27 ''int''] [[-debug]
28 !!DESCRIPTION
29
30
31 The ''sonar'' program displays a sonar scope on the
32 computer's screen. This scope polls a sensor as the sweep
33 goes around the scope and displays what it finds as bogies
34 on the screen. The program is designed to support different
35 modes representing different types of sensors. Currently the
36 only implemented sensors are a simulator, and a network ping
37 function that pings hosts and plots the results on the
38 scope.
39 !!OPTIONS
40
41
42 ''sonar'' understands the following options:
43
44
45 __-background__ ''Color''
46
47
48 The background Color of the screen not covered by the
49 scope.
50
51
52 __-sweep-color__ ''Color''
53
54
55 The color of the brightest part of the sweep.
56
57
58 __-scope-color__ ''Color''
59
60
61 The color of the circular part of the scope.
62
63
64 __-grid-color__ ''Color''
65
66
67 The color to the grid lines overlaying the
68 scope.
69
70
71 __-text-color__ ''Color''
72
73
74 The color of the text identifying bogies on the
75 scope.
76
77
78 __-ttl__ ''integer''
79
80
81
82
83 __-font__ ''font''
84
85
86 The font used to display text on the scope. Default
87
88
89 __-ping-timeout__ ''int''
90
91
92 The amount of time in milliseconds the program will wait for
93 an answer to a ping.
94
95
96 __-ping__ ''hosts-or-subnets''
97
98
99 The list of things to ping, separated by commas or spaces.
100 Elements of this list may be:
101
102
103 __simulation__
104
105
106 to run in simulation mode, instead of pinging real hosts
107 (this is the default if the program is not installed
108 setuid);
109
110
111 ''hostname''
112
113
114 to ping the given host;
115
116
117 ''A.B.C.D''
118
119
120 to ping the given IP address;
121
122
123 __subnet__
124
125
126 to ping the local class C subnet (the nearest 255
127 addresses);
128
129
130 __subnet/__''NN''
131
132
133 to ping a different-sized local subnet: e.g.,
134 __subnet/28__ would ping a 4-bit subnet (the nearest 15
135 addresses);
136
137
138 ''A.B.C.D/NN''
139
140
141 to ping an arbitrary other subnet: the IP address specifies
142 the base address, and the part after the slash is how wide
143 the subnet is. Typical values are /24 (for 255 addresses)
144 and /28 (for 15 addresses.)
145
146
147 ''filename''
148
149
150 to ping the hosts listed in the given file. This file can be
151 in the format used by ''/etc/hosts'', or it can be any
152 file that has host names as the first element on each line.
153 If you use ssh, try this:
154
155
156 sonar -ping $HOME/.ssh/known_hosts
157
158
159 __-team-a-name__ ''string''
160
161
162 In simulation mode, the name of team A.
163
164
165 __-team-b-name__ ''string''
166
167
168 In simulation mode, the name of team B.
169
170
171 __-team-a-count__ ''int''
172
173
174 In simulation mode, the number of bogies on team
175 A.
176
177
178 __-team-b-count__ ''int''
179
180
181 In simulation mode, the number of bogies on team
182 B.
183 !!RESOURCES
184
185
186 Configuration of the targets to ping is best done by setting
187 X Resources.
188
189
190 __background__ ''(Color)''
191
192
193 See option -background, above; default value is
194 ''black''.
195
196
197 __sweepColor__ ''(Color)''
198
199
200 See option -sweep-color, above; default value is
201 ''#00ff00''.
202
203
204 __scopeColor__ ''(Color)''
205
206
207 See option -scope-color, above; default value is
208 ''#003300''.
209
210
211 __gridColor__ ''(Color)''
212
213
214 See option -grid-color, above; default value is
215 ''#00aa00''.
216
217
218 __textColor__ ''(Color)''
219
220
221 See option -text-color, above; default value is
222 ''#ffff00''.
223
224
225 __ttl__ ''(integer)''
226
227
228 See option -ttl, above; default value is ''90'' or one
229 sweep.
230
231
232 __ping__ ''(string)''
233
234
235 See option -ping, above. If set to __default__, it will
236 ping the contents of /etc/hosts if possible, otherwise, will
237 run in simulation-mode.
238
239
240 __font__ ''(font)''
241
242
243 See option -font, above; default value is
244 ''fixed''.
245
246
247 __pingTimeout__ ''(Integer)''
248
249
250 See option -pingtimeout, above; default value is
251 3000.
252
253
254 __teamAName__ ''string''
255
256
257 See option -team-a-name, above. Default value is
258 __F18__.
259
260
261 __teamBName__ ''string''
262
263
264 See option -teamBName, above. Default value is
265 __MIG__.
266
267
268 __teamACount__ ''int''
269
270
271 See option -teamACount, above. Default value is
272 4.
273
274
275 __teamBCount__ ''int''
276
277
278 See option -teamBCount, above. Default value is
279 4.
280 !!NOTES
281
282
283 In order to use the ping sensor, this program must be
284 installed as setuid root, so that it can create an ICMP
285 socket. Root privileges are disavowed shortly after startup
286 (just after connecting to the X server and reading the
287 resource database) so this is ''believed'' to be a safe
288 thing to do, but it is usually recommended that you have as
289 few setuid programs around as possible, on general
290 principles.
291
292
293 chown root.root sonar
294 chmod u+s sonar
295 !!SEE ALSO
296
297
4 perry 298 X(1), xscreensaver(1),
1 perry 299 ping(8)
300 !!COPYRIGHT
301
302
303 Copyright 1998 by Stephen Martin.
304 (smartin@canada.com)
305
306
307 Permission to use, copy, modify, distribute, and sell this
308 software and its documentation for any purpose is hereby
309 granted without fee, provided that the above copyright
310 notice appear in all copies and that both that copyright
311 notice and this permission notice appear in supporting
312 documentation. No representations are made about the
313 suitability of this software for any purpose. It is provided
314 !!AUTHORS
315
316
317 Stephen Martin
318
319
320 Thanks to Tom Kelly for suggesting a modular approach to the
321 sensor amoung other things.
322
323
324 Thomas Bahls
325
326
327 Better subnet support and command-line processing by Jamie
328 Zawinski, 17-Jul-00.
329 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.