tools/tools/mctest/mctest.1

   1 .\" Copyright (c) 2008 George V. Neville-Neil
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd April 3, 2008
  28 .Dt mctest 1
  29 .Os
  30 .Sh NAME
  31 .Nm mctest
  32 .Nd "multicast test"
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl i Ar interface
  36 .Op Fl n Ar number
  37 .Op Fl s Ar size
  38 .Op Fl t Ar inter-packet gap
  39 .Op Fl M Ar number of clients (source only)
  40 .Op Fl m Ar my client number (sink only)
  41 .Op Fl r
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 command implements a multicast test which involved a source
  46 and a sink.  The source sends packets to a pre-configured
  47 multicast address over the interface given as a command line
  48 argument. The sink listens for multicast packets, records
  49 the time at which they're received and then reflects them back
  50 over unicast to the source.  When the source has captured all
  51 the reflected packets it prints out the round trip time of each.
  52 .Pp
  53 The source prints out the round trip time of packets sent to the
  54 sinks.  The sink prints out the time between the packets received.
  55 .Pp
  56 The options are as follows:
  57 .Bl -tag -width ".Fl d Ar argument"
  58 .It Fl i Ar interface
  59 Network interface, which can be found with ifconfig(1).
  60 .It Fl s Ar size
  61 Packet size in bytes.
  62 .It Fl n Ar number
  63 Number of packets.
  64 .It Fl t Ar gap
  65 Inter-packet gap in nanoseconds.
  66 .It Fl M Ar clients
  67 The number of clients that are listening
  68 .It Fl m Ar my number
  69 The client's number 0, 1, etc.
  70 .It Fl r
  71 This version of
  72 .Nm
  73 is the receiver aka the sink.  This option MUST
  74 only be used with one copy of the program at a time.
  75 .El
  76 .Sh EXAMPLES
  77 The following is an example of a typical usage
  78 of the
  79 .Nm
  80 command:
  81 .Pp
  82 Source
  83 .Dl "mctest -i em0 -M 1 -s 1024 -n 100 -t 1"
  84 Sink
  85 .Dl "mctest -i em0 -m 0 -s 1024 -n 100 -r"
  86 .Pp
  87 Send 100 packets of 1024 bytes, with an inter-packet gap of 1 nanosecond.
  88 .Pp
  89 Gaps are measured with
  90 .Xr nanosleep 2 ,
  91 and so are not accurate down to nanoseconds
  92 but depend on the setting of kern.hz.
  93 .Sh SEE ALSO
  94 .Xr ifconfig 8 ,
  95 .Xr netstat 1 ,
  96 .Xr nanosleep 2 .
  97 .Sh HISTORY
  98 The
  99 .Nm
 100 program first appeared in
 101 .Fx 7.0 .
 102 .Sh AUTHORS
 103 This
 104 manual page was written by
 105 .An George V. Neville-Neil Aq gnn@FreeBSD.org .
 106 .Sh BUGS
 107 Should be reported to the author or to net@freebsd.org.