git.hungrycats.org Git - xscreensaver/blob - hacks/sonar.man

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