xref: /freebsd/usr.sbin/ifmcstat/ifmcstat.8 (revision 39beb93c)
1.\"	$KAME: ifmcstat.8,v 1.6 2002/10/31 04:23:43 suz Exp $
2.\"
3.\" Copyright (c) 2007-2009 Bruce Simpson.
4.\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
5.\" All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the project nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\" $FreeBSD$
32.\"
33.Dd February 15, 2009
34.Dt IFMCSTAT 8
35.Os
36.Sh NAME
37.Nm ifmcstat
38.Nd dump multicast group management statistics per interface
39.Sh SYNOPSIS
40.Nm
41.Op Fl i Ar interface
42.Op Fl f Ar address-family
43.Op Fl v
44.Op Fl M Ar core
45.Op Fl N Ar system
46.\"
47.Sh DESCRIPTION
48The
49.Nm
50command dumps multicast group information from the kernel.
51.Pp
52The following options are supported:
53.Bl -tag -width Fl
54.It Fl i Ar interface
55specifies the interface to be displayed.
56.Pp
57.It Fl f Ar address-family
58specifies the address family to be displayed;
59.Ar inet ,
60.Ar inet6
61and
62.Ar link
63are supported.
64.It Fl v
65specifies that link-layer memberships should be printed;
66they are suppressed by default.
67It may not be specified for
68.Fl f Ar link .
69.El
70.Pp
71The following options are only available if
72.Nm
73has been built with support for
74.Xr kvm 3 :
75.Bl -tag -width Fl
76.It Fl M Ar core
77extracts values associated with the name list from the specified core,
78instead of the default
79.Pa /dev/kmem .
80.It Fl N Ar system
81extracts the name list from the specified kernel instead of the
82default, which is the kernel image the system has booted from.
83.El
84.Sh IMPLEMENTATION NOTES
85When run with the
86.Fl v
87option,
88.Nm
89may print multicast MAC addresses twice if they are
90referenced by a layer 3 protocol.
91.Pp
92When run with
93.Xr kvm 3
94support,
95the names of all interfaces configured in the system will be
96printed in the first column of output, even if no multicast
97group memberships are present on those interfaces.
98The output may also be slightly different, as the kernel
99data structures are being traversed with minimal post-processing
100of the output.
101.Pp
102When built without
103.Xr kvm 3
104support, the information displayed by
105.Nm
106is more limited.
107This support is recommended for debugging purposes.
108It requires super-user privilege if used to inspect a running kernel.
109.Xr kvm 3
110will be used by default if
111.Nm
112is run with super-user privileges.
113.Sh SEE ALSO
114.Xr getifaddrs 3 ,
115.Xr getifmaddrs 3 ,
116.Xr kvm 3 ,
117.Xr netstat 8
118