git.hungrycats.org Git - xscreensaver/blob - local/man/man.1/sonar.1

   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 "3-Nov-98" "X Version 11"
  15 .SH NAME
  16 sonar - display a sonar scope
  17 .SH SYNOPSIS
  18 .B sonar
  19 [\-background \fIcolor\fP]
  20 [\-sweep\-color \fIcolor\fP]
  21 [\-low\-color \fIcolor\fP]
  22 [\-scope\-color \fIcolor\fP]
  23 [\-grid\-color \fIcolor\fP]
  24 [\-text\-color \fIcolor\fP]
  25 [\-ttl \fIinteger\fP]
  26 [\-mode ping]
  27 [\-font \fIfont\fP]
  28 [\-ping\-timeout \fIint\fP]
  29 [\-ping\-source list | file | subnet ]
  30 [\-ping\-file \fIhosts-file\fP]
  31 [\-ping\-list \fIhost-name-list\fP]
  32 [\-team-a-name \fIstring\fP]
  33 [\-team-b-name \fIstring\fP]
  34 [\-team-a-count \fIint\fP]
  35 [\-team-b-count \fIint\fP]
  36 .SH DESCRIPTION
  37 The \fIsonar\fP program displays a sonar scope on the computer's screen.
  38 This scope polls a sensor as the sweep goes around the scope and displays
  39 what it finds as bogies on the screen.  The program is designed to support
  40 different modes representing different types of sensors.  Currently the
  41 only implemented sensors are a simulator, and a network ping function that
  42 pings hosts and plots the results on the scope.
  43 .SH OPTIONS
  44 .I sonar
  45 understands the following options:
  46 .TP 8
  47 .B \-background \fIColor\fP
  48 The background Color of the screen not covered by the scope.
  49 .TP 8
  50 .B \-sweep\-color \fIColor\fP
  51 The color of the brightest part of the sweep.
  52 .TP 8
  53 .B \-scope\-color \fIColor\fP
  54 The color of the circular part of the scope.
  55 .TP 8
  56 .B \-grid\-color \fIColor\fP
  57 The color to the grid lines overlaying the scope.
  58 .TP 8
  59 .B \-text\-color \fIColor\fP
  60 The color of the text identifying bogies on the scope.
  61 .TP 8
  62 .B \-ttl \fIinteger\fP
  63 "Time to live": visible time of a Bogie. Try values between 10 (very short)
  64 and 100.
  65 .TP 8
  66 .B \-mode \fIsimulation | ping\fP
  67 The sensor mode to use, the currently supported modes \fIsimulate\fP (the
  68 default) and \fIping\fP.
  69 .TP 8
  70 .B \-font \fIfont\fP
  71 The font used to display text on the scope.  Default "fixed".
  72 .TP 8
  73 .B \-ping\-timeout \fIint\fP
  74 The amount of time in milliseconds the program will wait for an answer
  75 to a ping.
  76 .TP 8
  77 .B \-ping\-source list | file | subnet
  78 Th source of the list of hosts to ping. Valid values are: \fIlist\fP,
  79 \fIfile\fP, \fIsubnet\fP.  The first two values are described below;
  80 and \fIsubnet\fP indicates that the sonar should ping all hosts in the
  81 same subnet as the current machine.  (All addresses are treated
  82 as class C nets, therefore this will at most ping 254 hosts.)
  83 .TP 8
  84 .B \-ping\-file \fIfilename\fP
  85 The path to a file listing the hosts to ping.  This file can be in the
  86 format used by \fI/etc/hosts\fP, or it can be any file that has host
  87 names as the first element on each line.  If you use ssh, try this:
  88 .EX
  89 sonar -mode ping -ping-file $HOME/.ssh/known_hosts
  90 .EE
  91 This is used only used when \fIpingSource\fP is set to \fBfile\fP.
  92 .TP 8
  93 .B \-ping\-list \fIlist\fP
  94 A comma separated list of hostnames, eg \fI"pinky,brain,dot"\fP.
  95 Only used when \fIpingSource\fP is set to \fBlist\fP.
  96 .TP 8
  97 .B \-team-a-name \fIstring\fP
  98 The name of team A, in simulation-mode.
  99 .TP 8
 100 .B \-team-b-name \fIstring\fP
 101 The name of team B, in simulation-mode.
 102 .TP 8
 103 .B \-team-a-count \fIint\fP
 104 The number of bogies on team A, in simulation-mode.
 105 .TP 8
 106 .B \-team-b-count \fIint\fP
 107 The number of bogies on team B, in simulation-mode.
 108 .SH RESOURCES
 109 Configuration of the targets to ping is best done by setting X Resources.
 110 .PP
 111 .TP 8
 112 .B background \fI(Color)\fP
 113 See option \-background, above; default value is \fIblack\fP.
 114 .TP 8
 115 .B sweepColor \fI(Color)\fP
 116 See option \-sweep\-color, above; default value is \fI#00ff00\fP.
 117 .TP 8
 118 .B scopeColor \fI(Color)\fP
 119 See option \-scope\-color, above; default value is \fI#003300\fP.
 120 .TP 8
 121 .B gridColor \fI(Color)\fP
 122 See option \-grid\-color, above; default value is \fI#00aa00\fP.
 123 .TP 8
 124 .B textColor \fI(Color)\fP
 125 See option \-text\-color, above; default value is \fI#ffff00\fP.
 126 .TP 8
 127 .B ttl \fI(integer)\fP
 128 See option \-ttl, above; default value is \fI90\fP or one sweep.
 129 .TP 8
 130 .B mode \fI(ping)\fP
 131 See option \-mode, above.  If set to \fBdefault\fP, it will ping hosts if
 132 possible, otherwise, will run in simulation-mode.
 133 .TP 8
 134 .B font \fI(font)\fP
 135 See option \-font, above; default value is \fIfixed\fP.
 136 .TP 8
 137 .B pingTimeout \fI(Integer)\fP
 138 See option \-pingtimeout, above; default value is 3000.
 139 .TP 8
 140 .B pingSource \fIlist | file | subnet\fP
 141 See option \-ping\-source, above.  Default value is \fIfile\fP.
 142 .TP 8
 143 .B pingFile \fIpathname\fP
 144 See option \-ping\-file, above.  Default value is \fI/etc/hosts\fP.
 145 .TP 8
 146 .B pingList \fIhost,host,host...\fP
 147 See option \-ping\-list, above; default value is \fBlocalhost\fP.
 148 .TP 8
 149 .B teamAName \fIstring\fP
 150 See option \-team\-a\-name, above.  Default value is \fBF18\fP.
 151 .TP 8
 152 .B teamBName \fIstring\fP
 153 See option \-teamBName, above.  Default value is \fBMIG\fP.
 154 .TP 8
 155 .B teamACount \fIint\fP
 156 See option \-teamACount, above.  Default value is 4.
 157 .TP 8
 158 .B teamBCount \fIint\fP
 159 See option \-teamBCount, above.  Default value is 4.
 160 .SH NOTES
 161 In order to use the ping sensor, this program must be installed as
 162 setuid root, so that it can create an ICMP socket.
 163 .SH SEE ALSO
 164 .BR X (1),
 165 .BR xscreensaver (1),
 166 .BR ping (8)
 167 .SH COPYRIGHT
 168 Copyright \(co 1998 by Stephen Martin. (smartin@canada.com)
 169
 170 Permission to use, copy, modify, distribute, and sell this software and its
 171 documentation for any purpose is hereby granted without fee, provided that
 172 the above copyright notice appear in all copies and that both that
 173 copyright notice and this permission notice appear in supporting
 174 documentation.  No representations are made about the suitability of this
 175 software for any purpose.  It is provided "as is" without express or
 176 implied warranty.
 177
 178 .SH AUTHORS
 179 Stephen Martin <smartin@canada.com>, 3-nov-98.
 180
 181 Thanks to Tom Kelly for suggesting a modular approach to the sensor
 182 amoung other things.
 183
 184 Thomas Bahls <thommy@cs.tu-berlin.de> hacked the "ttl" option, 12-jul-98.
 185