tools/tools/mctest/mcgrab.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 July 9, 2008
  28 .Dt mcgrab 1
  29 .Os
  30 .Sh NAME
  31 .Nm mcgrab
  32 .Nd "multicast filter overload test"
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl i Ar interface
  36 .Op Fl g Ar group
  37 .Op Fl n Ar number
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 command implements a multicast test which grabs and holds
  42 N multicast addresses.  The purpose of the test is to see what
  43 happens when a network interface is no longer able to filter
  44 multicasts in hardware and has to switch to promiscious or
  45 multicast promiscious mode.  A successful test does not have any
  46 result, but an unsuccessful test will have deleterious side effects.
  47 Packet size in bytes.
  48 The options are as follows:
  49 .Bl -tag -width ".Fl d Ar argument"
  50 .It Fl i Ar interface
  51 Network interface, which can be found with ifconfig(1).
  52 .It Fl i Ar group
  53 Multicast group
  54 .It Fl n Ar number
  55 Number of groups to join.
  56 .Sh EXAMPLES
  57 The following is an example of a typical usage
  58 of the
  59 .Nm
  60 command:
  61 .Pp
  62 .Dl "mcgrab -i em0 -g 239.255.255.1 -n 1024"
  63 .Sh SEE ALSO
  64 .Xr mctest 1 ,
  65 .Xr ifconfig 8 ,
  66 .Xr netstat 1 ,
  67 .Xr nanosleep 2 .
  68 .Sh HISTORY
  69 The
  70 .Nm
  71 program first appeared in
  72 .Fx 7.0 .
  73 .Sh AUTHORS
  74 This
  75 manual page was written by
  76 .An George V. Neville-Neil Aq gnn@FreeBSD.org .
  77 .Sh BUGS
  78 Should be reported to the author or to net@freebsd.org.