.de EX \"Begin example .ne 5 .if n .sp 1 .if t .sp .5 .nf .in +.5i .. .de EE .fi .in -.5i .if n .sp 1 .if t .sp .5 .. .TH Sonar 1 "3-Nov-98" "X Version 11" .SH NAME sonar - display a sonar scope .SH SYNOPSIS .B sonar [\-background \fIcolor\fP] [\-sweep\-color \fIcolor\fP] [\-low\-color \fIcolor\fP] [\-scope\-color \fIcolor\fP] [\-grid\-color \fIcolor\fP] [\-text\-color \fIcolor\fP] [\-ttl \fIinteger\fP] [\-mode ping] [\-font \fIfont\fP] [\-ping\-timeout \fIint\fP] [\-ping\-source list | file | subnet ] [\-ping\-file \fIhosts-file\fP] [\-ping\-list \fIhost-name-list\fP] [\-team-a-name \fIstring\fP] [\-team-b-name \fIstring\fP] [\-team-a-count \fIint\fP] [\-team-b-count \fIint\fP] .SH DESCRIPTION The \fIsonar\fP program displays a sonar scope on the computer's screen. This scope polls a sensor as the sweep goes around the scope and displays what it finds as bogies on the screen. The program is designed to support different modes representing different types of sensors. Currently the only implemented sensors are a simulator, and a network ping function that pings hosts and plots the results on the scope. .SH OPTIONS .I sonar understands the following options: .TP 8 .B \-background \fIColor\fP The background Color of the screen not covered by the scope. .TP 8 .B \-sweep\-color \fIColor\fP The color of the brightest part of the sweep. .TP 8 .B \-scope\-color \fIColor\fP The color of the circular part of the scope. .TP 8 .B \-grid\-color \fIColor\fP The color to the grid lines overlaying the scope. .TP 8 .B \-text\-color \fIColor\fP The color of the text identifying bogies on the scope. .TP 8 .B \-ttl \fIinteger\fP "Time to live": visible time of a Bogie. Try values between 10 (very short) and 100. .TP 8 .B \-mode \fIsimulation | ping\fP The sensor mode to use, the currently supported modes \fIsimulate\fP (the default) and \fIping\fP. .TP 8 .B \-font \fIfont\fP The font used to display text on the scope. Default "fixed". .TP 8 .B \-ping\-timeout \fIint\fP The amount of time in milliseconds the program will wait for an answer to a ping. .TP 8 .B \-ping\-source list | file | subnet Th source of the list of hosts to ping. Valid values are: \fIlist\fP, \fIfile\fP, \fIsubnet\fP. The first two values are described below; and \fIsubnet\fP indicates that the sonar should ping all hosts in the same subnet as the current machine. (All addresses are treated as class C nets, therefore this will at most ping 254 hosts.) .TP 8 .B \-ping\-file \fIfilename\fP The path to a file listing the hosts to ping. This file can be in the format used by \fI/etc/hosts\fP, or it can be any file that has host names as the first element on each line. If you use ssh, try this: .EX sonar -mode ping -ping-file $HOME/.ssh/known_hosts .EE This is used only used when \fIpingSource\fP is set to \fBfile\fP. .TP 8 .B \-ping\-list \fIlist\fP A comma separated list of hostnames, eg \fI"pinky,brain,dot"\fP. Only used when \fIpingSource\fP is set to \fBlist\fP. .TP 8 .B \-team-a-name \fIstring\fP The name of team A, in simulation-mode. .TP 8 .B \-team-b-name \fIstring\fP The name of team B, in simulation-mode. .TP 8 .B \-team-a-count \fIint\fP The number of bogies on team A, in simulation-mode. .TP 8 .B \-team-b-count \fIint\fP The number of bogies on team B, in simulation-mode. .SH RESOURCES Configuration of the targets to ping is best done by setting X Resources. .PP .TP 8 .B background \fI(Color)\fP See option \-background, above; default value is \fIblack\fP. .TP 8 .B sweepColor \fI(Color)\fP See option \-sweep\-color, above; default value is \fI#00ff00\fP. .TP 8 .B scopeColor \fI(Color)\fP See option \-scope\-color, above; default value is \fI#003300\fP. .TP 8 .B gridColor \fI(Color)\fP See option \-grid\-color, above; default value is \fI#00aa00\fP. .TP 8 .B textColor \fI(Color)\fP See option \-text\-color, above; default value is \fI#ffff00\fP. .TP 8 .B ttl \fI(integer)\fP See option \-ttl, above; default value is \fI90\fP or one sweep. .TP 8 .B mode \fI(ping)\fP See option \-mode, above. If set to \fBdefault\fP, it will ping hosts if possible, otherwise, will run in simulation-mode. .TP 8 .B font \fI(font)\fP See option \-font, above; default value is \fIfixed\fP. .TP 8 .B pingTimeout \fI(Integer)\fP See option \-pingtimeout, above; default value is 3000. .TP 8 .B pingSource \fIlist | file | subnet\fP See option \-ping\-source, above. Default value is \fIfile\fP. .TP 8 .B pingFile \fIpathname\fP See option \-ping\-file, above. Default value is \fI/etc/hosts\fP. .TP 8 .B pingList \fIhost,host,host...\fP See option \-ping\-list, above; default value is \fBlocalhost\fP. .TP 8 .B teamAName \fIstring\fP See option \-team\-a\-name, above. Default value is \fBF18\fP. .TP 8 .B teamBName \fIstring\fP See option \-teamBName, above. Default value is \fBMIG\fP. .TP 8 .B teamACount \fIint\fP See option \-teamACount, above. Default value is 4. .TP 8 .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. .SH SEE ALSO .BR X (1), .BR xscreensaver (1), .BR ping (8) .SH COPYRIGHT Copyright \(co 1998 by Stephen Martin. (smartin@canada.com) Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. No representations are made about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. .SH AUTHORS Stephen Martin , 3-nov-98. Thanks to Tom Kelly for suggesting a modular approach to the sensor amoung other things. Thomas Bahls hacked the "ttl" option, 12-jul-98.