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