ip.7: Document IP_MULTICAST_ALL

This commit adds documentation for the IP_MULTICAST_ALL socket
option.

The option was added to the Linux kernel in 2.6.31:

    Author Nivedita Singhvi <niv@us.ibm.com>
    Commit f771bef98004d9d141b085d987a77d06669d4f4f

The description is based on a previous one [3] posted by the
original author of the code -- Nivedita, but it is slightly
re-worded.

I tested it myself and it works as described.

References:
    [1] http://lxr.free-electrons.com/source/net/ipv4/ip_sockglue.c#L972
    [2] http://lxr.free-electrons.com/source/net/ipv4/igmp.c#L2267
    [3] http://patchwork.ozlabs.org/patch/28902/

Signed-off-by: Radek Pazdera <rpazdera@redhat.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Radek Pazdera 2013-04-16 05:43:06 +02:00 committed by Michael Kerrisk
parent 72d34312e8
commit 95e1ffd564
1 changed files with 12 additions and 4 deletions

View File

@ -29,14 +29,11 @@
.\" MCAST_JOIN_SOURCE_GROUP (2.4.22 / 2.6)
.\" MCAST_LEAVE_SOURCE_GROUP (2.4.22 / 2.6)
.\" MCAST_MSFILTER (2.4.22 / 2.6)
.\" IP_MULTICAST_ALL (2.6.31)
.\" commit f771bef98004d9d141b085d987a77d06669d4f4f
.\" Author: Nivedita Singhvi <niv@us.ibm.com>
.\" IP_UNICAST_IF (3.4)
.\" commit 76e21053b5bf33a07c76f99d27a74238310e3c71
.\" Author: Erich E. Hoover <ehoover@mines.edu>
.\"
.TH IP 7 2013-02-12 "Linux" "Linux Programmer's Manual"
.TH IP 7 2013-04-16 "Linux" "Linux Programmer's Manual"
.SH NAME
ip \- Linux IPv4 protocol implementation
.SH SYNOPSIS
@ -525,6 +522,17 @@ This is also particularly useful for diagnostic tools such as
that wish to deliberately send probe packets larger than
the observed Path MTU.
.TP
.BR IP_MULTICAST_ALL " (since Linux 2.6.31)"
This option can be used to modify the delivery policy of multicast messages
to sockets bound to the wildcard
.B INADDR_ANY
address. The argument is a boolean integer (defaults to 1). If set to 1,
the socket will receive messages from all the groups that have been joined
globally on the whole system. Otherwise, it will deliver only messages from
the groups that have been explicitly joined (for example via the
.B IP_ADD_MEMBERSHIP
option) on this particular socket.
.TP
.BR IP_MULTICAST_IF " (since Linux 1.2)"
Set the local device for a multicast socket.
Argument is an