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

   1
   2
   3
   4 Sonar(1)                                                 Sonar(1)
   5
   6
   7 N\bNA\bAM\bME\bE
   8        sonar - display a sonar scope
   9
  10 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
  11        s\bso\bon\bna\bar\br [-background _\bc_\bo_\bl_\bo_\br] [-sweep-color _\bc_\bo_\bl_\bo_\br] [-low-color
  12        _\bc_\bo_\bl_\bo_\br]   [-scope-color    _\bc_\bo_\bl_\bo_\br]    [-grid-color    _\bc_\bo_\bl_\bo_\br]
  13        [-text-color  _\bc_\bo_\bl_\bo_\br]  [-ttl  _\bi_\bn_\bt_\be_\bg_\be_\br]  [-mode ping] [-font
  14        _\bf_\bo_\bn_\bt] [-ping-timeout _\bi_\bn_\bt] [-ping-source list | file | sub-
  15        net  ] [-ping-file _\bh_\bo_\bs_\bt_\bs_\b-_\bf_\bi_\bl_\be] [-ping-list _\bh_\bo_\bs_\bt_\b-_\bn_\ba_\bm_\be_\b-_\bl_\bi_\bs_\bt]
  16        [-team-a-name _\bs_\bt_\br_\bi_\bn_\bg] [-team-b-name _\bs_\bt_\br_\bi_\bn_\bg] [-team-a-count
  17        _\bi_\bn_\bt] [-team-b-count _\bi_\bn_\bt]
  18
  19 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
  20        The _\bs_\bo_\bn_\ba_\br program displays a sonar scope on the computer's
  21        screen.  This scope polls  a  sensor  as  the  sweep  goes
  22        around  the  scope and displays what it finds as bogies on
  23        the screen.  The program is designed to support  different
  24        modes  representing different types of sensors.  Currently
  25        the only implemented sensors are a simulator, and  a  net-
  26        work  ping function that pings hosts and plots the results
  27        on the scope.
  28
  29 O\bOP\bPT\bTI\bIO\bON\bNS\bS
  30        _\bs_\bo_\bn_\ba_\br understands the following options:
  31
  32        -\b-b\bba\bac\bck\bkg\bgr\bro\bou\bun\bnd\bd _\bC_\bo_\bl_\bo_\br
  33                The background Color of the screen not covered  by
  34                the scope.
  35
  36        -\b-s\bsw\bwe\bee\bep\bp-\b-c\bco\bol\blo\bor\br _\bC_\bo_\bl_\bo_\br
  37                The color of the brightest part of the sweep.
  38
  39        -\b-s\bsc\bco\bop\bpe\be-\b-c\bco\bol\blo\bor\br _\bC_\bo_\bl_\bo_\br
  40                The color of the circular part of the scope.
  41
  42        -\b-g\bgr\bri\bid\bd-\b-c\bco\bol\blo\bor\br _\bC_\bo_\bl_\bo_\br
  43                The  color to the grid lines overlaying the scope.
  44
  45        -\b-t\bte\bex\bxt\bt-\b-c\bco\bol\blo\bor\br _\bC_\bo_\bl_\bo_\br
  46                The color of the text identifying  bogies  on  the
  47                scope.
  48
  49        -\b-t\btt\btl\bl _\bi_\bn_\bt_\be_\bg_\be_\br
  50                "Time  to live": visible time of a Bogie. Try val-
  51                ues between 10 (very short) and 100.
  52
  53        -\b-m\bmo\bod\bde\be _\bs_\bi_\bm_\bu_\bl_\ba_\bt_\bi_\bo_\bn _\b| _\bp_\bi_\bn_\bg
  54                The sensor mode to use,  the  currently  supported
  55                modes _\bs_\bi_\bm_\bu_\bl_\ba_\bt_\be (the default) and _\bp_\bi_\bn_\bg.
  56
  57        -\b-f\bfo\bon\bnt\bt _\bf_\bo_\bn_\bt
  58                The  font  used  to  display  text  on  the scope.
  59                Default "fixed".
  60
  61
  62
  63
  64 X Version 11                 3-Nov-98                           1
  65
  66
  67
  68
  69
  70 Sonar(1)                                                 Sonar(1)
  71
  72
  73        -\b-p\bpi\bin\bng\bg-\b-t\bti\bim\bme\beo\bou\but\bt _\bi_\bn_\bt
  74                The amount of time  in  milliseconds  the  program
  75                will wait for an answer to a ping.
  76
  77        -\b-p\bpi\bin\bng\bg-\b-s\bso\bou\bur\brc\bce\be l\bli\bis\bst\bt |\b| f\bfi\bil\ble\be |\b| s\bsu\bub\bbn\bne\bet\bt
  78                Th source of the list of hosts to ping. Valid val-
  79                ues are: _\bl_\bi_\bs_\bt, _\bf_\bi_\bl_\be, _\bs_\bu_\bb_\bn_\be_\bt.  The first two values
  80                are described below; and _\bs_\bu_\bb_\bn_\be_\bt indicates that the
  81                sonar should ping all hosts in the same subnet  as
  82                the  current  machine.  (All addresses are treated
  83                as class C nets, therefore this will at most  ping
  84                254 hosts.)
  85
  86        -\b-p\bpi\bin\bng\bg-\b-f\bfi\bil\ble\be _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
  87                The  path  to  a  file  listing the hosts to ping.
  88                This file can be in the format used by _\b/_\be_\bt_\bc_\b/_\bh_\bo_\bs_\bt_\bs,
  89                or  it  can be any file that has host names as the
  90                first element on each line.  If you use  ssh,  try
  91                this:
  92
  93                     sonar -mode ping -ping-file $HOME/.ssh/known_hosts
  94
  95                This  is  used only used when _\bp_\bi_\bn_\bg_\bS_\bo_\bu_\br_\bc_\be is set to
  96                f\bfi\bil\ble\be.
  97
  98        -\b-p\bpi\bin\bng\bg-\b-l\bli\bis\bst\bt _\bl_\bi_\bs_\bt
  99                A  comma   separated   list   of   hostnames,   eg
 100                _\b"_\bp_\bi_\bn_\bk_\by_\b,_\bb_\br_\ba_\bi_\bn_\b,_\bd_\bo_\bt_\b".   Only  used when _\bp_\bi_\bn_\bg_\bS_\bo_\bu_\br_\bc_\be is
 101                set to l\bli\bis\bst\bt.
 102
 103        -\b-t\bte\bea\bam\bm-\b-a\ba-\b-n\bna\bam\bme\be _\bs_\bt_\br_\bi_\bn_\bg
 104                The name of team A, in simulation-mode.
 105
 106        -\b-t\bte\bea\bam\bm-\b-b\bb-\b-n\bna\bam\bme\be _\bs_\bt_\br_\bi_\bn_\bg
 107                The name of team B, in simulation-mode.
 108
 109        -\b-t\bte\bea\bam\bm-\b-a\ba-\b-c\bco\bou\bun\bnt\bt _\bi_\bn_\bt
 110                The number of bogies on  team  A,  in  simulation-
 111                mode.
 112
 113        -\b-t\bte\bea\bam\bm-\b-b\bb-\b-c\bco\bou\bun\bnt\bt _\bi_\bn_\bt
 114                The  number  of  bogies  on team B, in simulation-
 115                mode.
 116
 117 R\bRE\bES\bSO\bOU\bUR\bRC\bCE\bES\bS
 118        Configuration of the targets to ping is best done by  set-
 119        ting X Resources.
 120
 121
 122        b\bba\bac\bck\bkg\bgr\bro\bou\bun\bnd\bd _\b(_\bC_\bo_\bl_\bo_\br_\b)
 123                See  option  -background,  above; default value is
 124                _\bb_\bl_\ba_\bc_\bk.
 125
 126
 127
 128
 129
 130 X Version 11                 3-Nov-98                           2
 131
 132
 133
 134
 135
 136 Sonar(1)                                                 Sonar(1)
 137
 138
 139        s\bsw\bwe\bee\bep\bpC\bCo\bol\blo\bor\br _\b(_\bC_\bo_\bl_\bo_\br_\b)
 140                See option -sweep-color, above; default  value  is
 141                _\b#_\b0_\b0_\bf_\bf_\b0_\b0.
 142
 143        s\bsc\bco\bop\bpe\beC\bCo\bol\blo\bor\br _\b(_\bC_\bo_\bl_\bo_\br_\b)
 144                See  option  -scope-color, above; default value is
 145                _\b#_\b0_\b0_\b3_\b3_\b0_\b0.
 146
 147        g\bgr\bri\bid\bdC\bCo\bol\blo\bor\br _\b(_\bC_\bo_\bl_\bo_\br_\b)
 148                See option -grid-color, above;  default  value  is
 149                _\b#_\b0_\b0_\ba_\ba_\b0_\b0.
 150
 151        t\bte\bex\bxt\btC\bCo\bol\blo\bor\br _\b(_\bC_\bo_\bl_\bo_\br_\b)
 152                See  option  -text-color,  above; default value is
 153                _\b#_\bf_\bf_\bf_\bf_\b0_\b0.
 154
 155        t\btt\btl\bl _\b(_\bi_\bn_\bt_\be_\bg_\be_\br_\b)
 156                See option -ttl, above; default value is _\b9_\b0 or one
 157                sweep.
 158
 159        m\bmo\bod\bde\be _\b(_\bp_\bi_\bn_\bg_\b)
 160                See  option  -mode,  above.  If set to d\bde\bef\bfa\bau\bul\blt\bt, it
 161                will ping hosts if possible, otherwise,  will  run
 162                in simulation-mode.
 163
 164        f\bfo\bon\bnt\bt _\b(_\bf_\bo_\bn_\bt_\b)
 165                See option -font, above; default value is _\bf_\bi_\bx_\be_\bd.
 166
 167        p\bpi\bin\bng\bgT\bTi\bim\bme\beo\bou\but\bt _\b(_\bI_\bn_\bt_\be_\bg_\be_\br_\b)
 168                See  option  -pingtimeout, above; default value is
 169                3000.
 170
 171        p\bpi\bin\bng\bgS\bSo\bou\bur\brc\bce\be _\bl_\bi_\bs_\bt _\b| _\bf_\bi_\bl_\be _\b| _\bs_\bu_\bb_\bn_\be_\bt
 172                See option -ping-source, above.  Default value  is
 173                _\bf_\bi_\bl_\be.
 174
 175        p\bpi\bin\bng\bgF\bFi\bil\ble\be _\bp_\ba_\bt_\bh_\bn_\ba_\bm_\be
 176                See  option  -ping-file,  above.  Default value is
 177                _\b/_\be_\bt_\bc_\b/_\bh_\bo_\bs_\bt_\bs.
 178
 179        p\bpi\bin\bng\bgL\bLi\bis\bst\bt _\bh_\bo_\bs_\bt_\b,_\bh_\bo_\bs_\bt_\b,_\bh_\bo_\bs_\bt_\b._\b._\b.
 180                See option -ping-list,  above;  default  value  is
 181                l\blo\boc\bca\bal\blh\bho\bos\bst\bt.
 182
 183        t\bte\bea\bam\bmA\bAN\bNa\bam\bme\be _\bs_\bt_\br_\bi_\bn_\bg
 184                See  option -team-a-name, above.  Default value is
 185                F\bF1\b18\b8.
 186
 187        t\bte\bea\bam\bmB\bBN\bNa\bam\bme\be _\bs_\bt_\br_\bi_\bn_\bg
 188                See option -teamBName, above.   Default  value  is
 189                M\bMI\bIG\bG.
 190
 191        t\bte\bea\bam\bmA\bAC\bCo\bou\bun\bnt\bt _\bi_\bn_\bt
 192                See  option  -teamACount, above.  Default value is
 193
 194
 195
 196 X Version 11                 3-Nov-98                           3
 197
 198
 199
 200
 201
 202 Sonar(1)                                                 Sonar(1)
 203
 204
 205                4.
 206
 207        t\bte\bea\bam\bmB\bBC\bCo\bou\bun\bnt\bt _\bi_\bn_\bt
 208                See option -teamBCount, above.  Default  value  is
 209                4.
 210
 211 N\bNO\bOT\bTE\bES\bS
 212        In  order  to  use  the  ping sensor, this program must be
 213        installed as setuid root, so that it can  create  an  ICMP
 214        socket.
 215
 216 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
 217        X\bX(1), x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1), p\bpi\bin\bng\bg(8)
 218
 219 C\bCO\bOP\bPY\bYR\bRI\bIG\bGH\bHT\bT
 220        Copyright (C) 1998 by Stephen Martin. (smartin@canada.com)
 221
 222        Permission to use, copy, modify, distribute, and sell this
 223        software  and  its documentation for any purpose is hereby
 224        granted without fee, provided  that  the  above  copyright
 225        notice  appear  in all copies and that both that copyright
 226        notice and this permission  notice  appear  in  supporting
 227        documentation.   No  representations  are  made  about the
 228        suitability of this software for any purpose.  It is  pro-
 229        vided "as is" without express or implied warranty.
 230
 231
 232 A\bAU\bUT\bTH\bHO\bOR\bRS\bS
 233        Stephen Martin <smartin@canada.com>, 3-nov-98.
 234
 235        Thanks  to  Tom Kelly for suggesting a modular approach to
 236        the sensor amoung other things.
 237
 238        Thomas Bahls  <thommy@cs.tu-berlin.de>  hacked  the  "ttl"
 239        option, 12-jul-98.
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262 X Version 11                 3-Nov-98                           4
 263
 264