xref: /dragonfly/usr.sbin/ndp/ndp.8 (revision e1acdbad)
1.\"	$FreeBSD: src/usr.sbin/ndp/ndp.8,v 1.1.2.8 2003/08/12 16:27:57 ume Exp $
2.\"	$DragonFly: src/usr.sbin/ndp/ndp.8,v 1.3 2004/12/30 02:44:10 hsu Exp $
3.\"	$KAME: ndp.8,v 1.15 2001/02/08 07:17:03 itojun Exp $
4.\"
5.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
6.\" All rights reserved.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the project nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.Dd May 17, 1998
33.Dt NDP 8
34.Os
35.\"
36.Sh NAME
37.Nm ndp
38.Nd control/diagnose IPv6 neighbor discovery protocol
39.\"
40.Sh SYNOPSIS
41.Nm
42.Fl a
43.Op Fl nt
44.Nm
45.Fl A Ar wait
46.Op Fl nt
47.Nm
48.Fl c
49.Op Fl nt
50.Nm
51.Fl d
52.Op Fl nt
53.Ar hostname
54.Nm
55.Fl f
56.Op Fl nt
57.Ar filename
58.Nm
59.Fl H
60.Nm
61.Fl I
62.Op Cm delete | Ar interface
63.Nm
64.Fl i
65.Ar interface
66.Op Ar flags...
67.Nm
68.Fl p
69.Nm
70.Fl P
71.Nm
72.Fl r
73.Nm
74.Fl R
75.Nm
76.Fl s
77.Op Fl nt
78.Ar nodename
79.Ar ether_addr
80.Op Li temp
81.Op Li proxy
82.\"
83.Sh DESCRIPTION
84The
85.Nm
86utility manipulates the address mapping table
87used by Neighbor Discovery Protocol (NDP).
88.Bl -tag -width Ds
89.It Fl a
90Dump the currently existing NDP entries.
91.It Fl A Ar wait
92Repeat
93.Fl a
94(dump NDP entries)
95every
96.Ar wait
97seconds.
98.It Fl c
99Erase all the NDP entries.
100.It Fl d
101Delete specified NDP entry.
102.It Fl f
103Parse the file specified by
104.Ar filename .
105.It Fl H
106Harmonize consistency between the routing table and the default router
107list; install the top entry of the list into the kernel routing table.
108.It Fl I Op Cm delete | Ar interface
109Shows or specifies the default interface used as the default route when
110there is no default router.
111If no argument is given to the option,
112the current default interface will be shown.
113If an
114.Ar interface
115is specified, the interface will be used as the default.
116If a special keyword
117.Ic delete
118is specified, the current default interface will be deleted from the kernel.
119.It Fl i Ar interface Op Ar flags...
120View ND information for the specified interface.
121If additional arguments
122.Ar flags
123are given,
124.Nm
125sets or clears the specified flags for the interface.
126Possible flags are as follows.
127All of the flags can begin with the
128special character
129.Ql - ,
130which means the flag should be cleared.
131.\"
132.Bl -tag -width Ds -compact
133.It Xo
134.Ic nud
135.Xc
136turn on or off NUD (Neighbor Unreachability Detection) on the
137interface.
138NUD is usually turned on by default.
139.It Xo
140.Ic accept_rtadv
141.Xc
142Specify whether or not to accept Router Advertisement messages
143received on the
144.Ar interface .
145Note that the kernel does not accept Router Advertisement messages
146unless the
147.Li net.inet6.ip6.accept_rtadv
148variable is non-0, even if the flag is on.
149This flag is set to 1 by default.
150.El
151.It Fl n
152Do not try to resolve numeric address to hostname.
153.It Fl p
154Show prefix list.
155.It Fl P
156Flush all the entries in the prefix list.
157.It Fl r
158Show default router list.
159.It Fl R
160Flush all the entries in the default router list.
161.It Fl s
162Register an NDP entry for a node.
163The entry will be permanent unless the word
164.Li temp
165is given in the command.
166If the word
167.Li proxy
168is given, this system will act as a proxy NDP server,
169responding to requests for
170.Ar hostname
171even though the host address is not its own.
172.It Fl t
173Print timestamp on each entries,
174to make it possible to merge output with
175.Xr tcpdump 1 .
176Most useful when used with
177.Fl A .
178.El
179.\"
180.Sh RETURN VALUES
181The
182.Nm
183utility will exit with 0 on success, and non-zero on errors.
184.\"
185.Sh SEE ALSO
186.Xr arp 8
187.\"
188.Sh HISTORY
189The
190.Nm
191utility first appeared in WIDE Hydrangea IPv6 protocol stack kit.
192.\"
193.\" .Sh BUGS
194.\" (to be written)
195