1sonar(6x)                     XScreenSaver manual                    sonar(6x)
2
3
4

NAME

6       sonar - display a sonar scope
7

SYNOPSIS

9       sonar  [-ping  hosts-or-subnets]  [-ping-timeout  int]  [-delay  usecs]
10       [-speed ratio] [-sweep-size ratio]  [-font-size  points]  [-team-a-name
11       string]  [-team-b-name  string] [-team-a-count int] [-team-b-count int]
12       [-no-dns] [-no-times] [-no-wobble] [-debug] [-fps]
13

DESCRIPTION

15       This draws a sonar screen that pings (get it?) the hosts on your  local
16       network,  and plots their distance (response time) from you.  The three
17       rings represent ping times of approximately 2.5, 70 and 2,000 millisec‐
18       onds respectively.
19
20       Alternately, it can run a simulation that doesn't involve hosts.
21

OPTIONS

23       sonar understands the following options:
24
25       -ping hosts-or-subnets
26               The  list  of  things  to  ping, separated by commas or spaces.
27               Elements of this list may be:
28
29               simulation  Run in simulation  mode  instead  of  pinging  real
30                           hosts.
31
32               hostname    Ping the given host.
33
34               A.B.C.D     Ping the given IPv4 address.
35
36               subnet      Ping  the  local  subnet.   On systems where we can
37                           determine the local network mask, we use that; oth‐
38                           erwise, we assume Class C (254 hosts).
39
40               subnet/NN   Ping  a  different-sized  local  subnet: e.g., sub‐
41                           net/28 would ping a 4-bit subnet  (the  nearest  14
42                           addresses).   On systems where we can determine the
43                           local network mask, we always use that.
44
45               A.B.C.D/NN  Ping an arbitrary other IPv4 subnet.   The  address
46                           specifies  the base address, and the part after the
47                           slash is how wide the subnet  is.   Typical  values
48                           are  /24  (for  254  addresses)  and  /28  (for  14
49                           addresses).
50
51               filename    Ping the hosts listed in the given file.  This file
52                           can  be in the format used by /etc/hosts, or it can
53                           be any file that has host names  as  the  first  or
54                           second  element  on each line.  If you use ssh, try
55                           this:
56
57                             sonar -ping $HOME/.ssh/known_hosts
58
59       -ping-timeout int
60               The amount of time in milliseconds the program will wait for an
61               answer to a ping.
62
63       -delay int
64               Delay between frames, in microseconds.  Default 20000.
65
66       -speed ratio
67               Less than 1 for slower, greater than 1 for faster.  Default 1.
68
69       -sweep-size ratio
70               How big the glowing sweep area should be. Default 0.3.
71
72       -font-size points
73               How large the text should be.  Default 10 points.
74
75       -no-wobble
76               Keep  the  display  stationary  instead of very slowly wobbling
77               back and forth.
78
79       -no-dns Do not attempt to resolve IP addresses to hostnames.
80
81       -no-times
82               Do not display ping times beneath the host names.
83
84       -team-a-name string
85               In simulation mode, the name of team A.
86
87       -team-b-name string
88               In simulation mode, the name of team B.
89
90       -team-a-count int
91               In simulation mode, the number of bogies on team A.
92
93       -team-b-count int
94               In simulation mode, the number of bogies on team B.
95
96       -fps    Display the current frame rate, polygon count, and CPU load.
97

NOTES

99       On most Unix systems, this program must be installed as setuid root  in
100       order  to  ping  hosts.   This is because root privileges are needed to
101       create an ICMP RAW socket.   Privileges  are  disavowed  shortly  after
102       startup  (just after connecting to the X server) so this is believed to
103       be safe:
104       chown root:root sonar
105       chmod u+s sonar
106       It is not necessary to make it setuid on MacOS systems, because on Mac‐
107       OS,  unprivileged programs can ping by using ICMP DGRAM sockets instead
108       of ICMP RAW.
109
110       In ping-mode, the display is a logarithmic scale,  calibrated  so  that
111       the three rings represent ping times of approximately 2.5, 70 and 2,000
112       milliseconds respectively.
113
114       This means that if any the hosts you are pinging  take  longer  than  2
115       seconds  to respond, they won't show up; and if you are pinging several
116       hosts with very fast response times, they will all appear close to  the
117       center of the screen (making their names hard to read.)
118

BUGS

120       Does not support IPv6.
121

SEE ALSO

123       X(1), xscreensaver(1), ping(8), ping6(8)
124
126       Copyright © 2000-2012 by Jamie Zawinski <jwz@jwz.org>
127       Copyright © 1998 by Stephen Martin. <smartin@canada.com>
128
129       Permission to use, copy, modify, distribute, and sell this software and
130       its documentation for any purpose is hereby granted without  fee,  pro‐
131       vided  that  the  above  copyright notice appear in all copies and that
132       both that copyright notice and this permission notice  appear  in  sup‐
133       porting documentation.  No representations are made about the suitabil‐
134       ity of this software for any purpose.  It is provided "as  is"  without
135       express or implied warranty.
136
137

AUTHORS

139       Stephen Martin <smartin@canada.com>, 3-nov-1998.
140
141       Subnet support, etc. added by Jamie Zawinski, 17-Jul-2000.
142
143       Rewritten using OpenGL instead of X11 by Jamie Zawinski, 12-Aug-2008.
144
145
146
147X Version 11               5.44-2.fc32 (16-Apr-2020)                 sonar(6x)
Impressum