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