60dd8da775
* Build with or without INET, INET6, or KVM features.
* When built without KVM, the sysctl-based getifmaddrs() function
is used as the back-end for the utility.
* Reflect the fact that FreeBSD now uses the in_multi refcount as
a true refcount.
* Style.
The utility may now be run without super-user privilege, albeit with
a less detailed display, equivalent to that of the soon-to-be-retired
netstat -g host-mode output.
MFC after: 3 weeks
116 lines
3.5 KiB
Groff
116 lines
3.5 KiB
Groff
.\" $KAME: ifmcstat.8,v 1.6 2002/10/31 04:23:43 suz Exp $
|
|
.\"
|
|
.\" Copyright (C) 1995, 1996, 1997, 1998, and 1999 WIDE Project.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. Neither the name of the project nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd April 10, 2007
|
|
.Dt IFMCSTAT 8
|
|
.Os
|
|
.Sh NAME
|
|
.Nm ifmcstat
|
|
.Nd dump multicast group management statistics per interface
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl i Ar interface
|
|
.Op Fl f Ar address-family
|
|
.Op Fl M Ar core
|
|
.Op Fl N Ar system
|
|
.Nm
|
|
.Op Ar kernel
|
|
.\"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
command dumps multicast group information from the kernel.
|
|
.Pp
|
|
The following options are supported:
|
|
.Bl -tag -width Fl
|
|
.It Fl i Ar interface
|
|
specifies the interface to be displayed.
|
|
.Pp
|
|
.It Fl f Ar address-family
|
|
specifies the address-family to be displayed; currently only
|
|
.Ar inet
|
|
and
|
|
.Ar inet6
|
|
are supported.
|
|
.El
|
|
.Pp
|
|
The following options are only available if
|
|
.Nm
|
|
has been built with support for
|
|
.Xr kvm 3 .
|
|
.Bl -tag -width Fl
|
|
.It Fl M Ar core
|
|
extracts values associated with the name list from the specified core,
|
|
instead of the default
|
|
.Pa /dev/kmem .
|
|
.It Fl N Ar system
|
|
extracts the name list from the specified kernel instead of the
|
|
default, which is the kernel image the system has booted from.
|
|
.It Nm Ar system
|
|
This is the same as specifying
|
|
.Nm
|
|
.Fl N Ar system .
|
|
This usage is deprecated; it is supported only for backwards compatibility.
|
|
.Sh IMPLEMENTATION NOTES
|
|
When built without
|
|
.Xr kvm 3
|
|
support, the information displayed by
|
|
.Nm
|
|
is more limited.
|
|
This support is recommended for debugging purposes.
|
|
It requires superuser privilege if used to inspect a running kernel.
|
|
.Pp
|
|
When run without using
|
|
.Xr kvm 3
|
|
support,
|
|
.Nm
|
|
may print multicast MAC addresses twice if they are
|
|
referenced by a layer 3 protocol.
|
|
.Pp
|
|
When run with
|
|
.Xr kvm 3
|
|
support,
|
|
the names of all interfaces configured in the system will be
|
|
printed in the first column of output, even if no multicast
|
|
addresses are configured on those interfaces.
|
|
.Sh SEE ALSO
|
|
.Xr getifaddrs 3 ,
|
|
.Xr getifmaddrs 3 ,
|
|
.Xr kvm 3 ,
|
|
.Xr netstat 8
|
|
.Sh BUGS
|
|
.Nm
|
|
does not support the
|
|
.Ar link
|
|
argument to the
|
|
.Ar address-family
|
|
option.
|