d705fcbae6c0ca042b6013493e54477c8822c6c9
[dragonfly.git] / usr.sbin / mld6query / mld6query.8
1 .\"     $KAME: mld6query.8,v 1.5 2000/12/04 06:28:23 itojun Exp $
2 .\"
3 .\" Copyright (C) 1995, 1996, 1997, and 1998 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: src/usr.sbin/mld6query/mld6query.8,v 1.1.1.1.2.5 2003/03/11 21:13:51 trhodes Exp $
31 .\"     $DragonFly: src/usr.sbin/mld6query/mld6query.8,v 1.2 2003/06/17 04:29:57 dillon Exp $
32 .\"
33 .Dd May 17, 1998
34 .Dt MLD6QUERY 8
35 .Os
36 .\"
37 .Sh NAME
38 .Nm mld6query
39 .Nd send multicast listener query
40 .\"
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl dr
44 .Ar intface
45 .Op Ar maddr
46 .\"
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility sends an IPv6 multicast listener discovery (MLD) query packet toward
51 the specified multicast address,
52 .Ar maddr ,
53 toward interface
54 .Ar intface .
55 If you omit
56 .Ar maddr ,
57 linklocal all nodes multicast address(ff02::1) is used.
58 .Pp
59 After sending a query,
60 .Nm
61 waits for replies for at most 10 seconds.
62 If a reply is returned,
63 .Nm
64 prints it with its type and then waits for another reply.
65 .Pp
66 This program is provided only for debugging.
67 It is not necessary for normal use.
68 .Pp
69 With
70 .Fl d ,
71 .Nm
72 will transmit MLD done packet instead of MLD query packet.
73 With
74 .Fl r ,
75 similarly, MLD report packet will be transmitted.
76 .Fl dr
77 options are for debugging purposes only.
78 .\"
79 .Sh RETURN VALUES
80 The program exits with 0 on success, non-zero on failures.
81 .\"
82 .\" .Sh SEE ALSO
83 .\"
84 .Sh HISTORY
85 The
86 .Nm
87 utility first appeared in WIDE/KAME IPv6 protocol stack kit.
88 .Sh BUGS
89 The
90 .Nm
91 utility does not take care of multicast addresses which have non link-local
92 scope.