README

   1  liboping – Library to ping IPv4 and IPv6 hosts in parallel
   2 ════════════════════════════════════════════════════════════
   3 http://noping.cc/
   4
   5 About
   6 ━━━━━
   7
   8   liboping was inspired by ping, libping and fping: It differs from these
   9   existing solutions in that it can “ping” multiple hosts in parallel using
  10   IPv4 or IPv6 transparently. Other design principles were an object oriented
  11   interface, simplicity and extensibility.
  12
  13   On top of liboping two command line applications have been built. “oping” is
  14   a drop-in replacement for ping(1) with very similar output. “noping” is an
  15   ncurses-based application which displays statistics while pinging and
  16   highlights aberrant round-trip times.
  17
  18
  19 Features
  20 ━━━━━━━━
  21
  22   • Support for multiple hosts.
  23
  24   • Support for IPv4 and IPv6.
  25
  26   • Object oriented interface.
  27
  28
  29 Perl bindings
  30 ━━━━━━━━━━━━━
  31
  32   Included in the source package of liboping are bindings for Perl. The code
  33   resides in the bindings/ subdirectory and is compiled and installed by
  34   default. To disable building the Perl bindings, call “configure” with
  35   “--without-perl-bindings”.
  36
  37
  38 Permissions
  39 ━━━━━━━━━━━━━
  40
  41   On UNIX, special permissions are required to open raw sockets (raw(7)). If
  42   you compile and install the “oping” and “noping” binaries as normal user
  43   (which is strongly suggested), you won't be able to use the binaries as a
  44   normal user, because you won't have the permission to open raw sockets.
  45
  46   The “install” target will automatically try fix this, if it is run with UID~0
  47   (as user root).  When on Linux, the capabilities described below will be
  48   added. On other UNIXes the traditional Set-UID method (also described below)
  49   is used instead. The build system will not abort if this fails, because there
  50   are file systems which do not support either method. Also, the Debian
  51   packaging system and possibly other scenarios only act as if they were
  52   running as root.
  53
  54   Linux
  55   ━━━━━
  56   On Linux, the preferred method is to assign the required “capability” to the
  57   binaries. This will allow the binary to open raw sockets, but doesn't give
  58   any other permissions such as reading other users' files or shutting down the
  59   system. The downside is that this mechanism is comparatively new: Assigning
  60   capabilities to files is available since Linux 2.6.24.
  61
  62   To set the required capabilities, run (as user root):
  63
  64     # setcap cap_net_raw=ep /opt/oping/bin/oping
  65     # setcap cap_net_raw=ep /opt/oping/bin/noping
  66
  67   Other UNIX
  68   ━━━━━━━━━━
  69   Capabilities are a nice but Linux-specific solution. To make “oping” and
  70   “noping” available to unprivileged users on other UNIX systems, use the
  71   traditional set-UID root solution. If your system supports “saved set-UIDs”
  72   (basically all systems do), the applications will drop the privileges during
  73   initialization and only regain them when actually opening the socket(s).
  74
  75   To set the set-UID bit, run (as user root):
  76
  77     # chown root: /opt/oping/bin/{,n}oping
  78     # chmod u+s   /opt/oping/bin/{,n}oping
  79
  80
  81 Licensing terms
  82 ━━━━━━━━━━━━━━━
  83
  84   liboping is licensed under the “GNU Lesser General Public License” (LGPL),
  85   version 2.1 or later. The exact licensing terms can be found in the file
  86   “COPYING” included in the source distribution of liboping.
  87
  88   The “oping” and “noping” utilities included in this package are licensed
  89   under the “GNU General Public License” (GPL), version 2. The full licensing
  90   terms can be found online at <http://www.gnu.org/licenses/gpl-2.0.html>.
  91
  92
  93 Author
  94 ━━━━━━
  95
  96   Florian “octo” Forster <ff at octo.it>
  97