xref: /freebsd/usr.sbin/ndp/ndp.8 (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
1.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the project nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     $Id: ndp.8,v 1.2 1999/10/07 05:26:13 itojun Exp $
29.\"     $FreeBSD$
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 ndp
41.Fl a
42.Op Fl ntl
43.Nm ndp
44.Fl A Ar wait
45.Op Fl ntl
46.Nm ndp
47.Fl c
48.Op Fl nt
49.Nm ndp
50.Fl d
51.Op Fl nt
52.Ar hostname
53.Nm ndp
54.Fl f
55.Op Fl nt
56.Ar filename
57.Nm ndp
58.Fl H
59.Nm ndp
60.Fl i
61.Ar interface
62.Nm ndp
63.Fl p
64.Nm ndp
65.Fl P
66.Nm ndp
67.Fl r
68.Nm ndp
69.Fl R
70.Nm ndp
71.Fl s
72.Op Fl nt
73.Ar nodename
74.Ar ether_addr
75.Op temp
76.\"
77.Sh DESCRIPTION
78The
79.Nm
80command manipulates the address mapping table
81used by Neighbor Discovery Protocol (NDP).
82.Bl -tag -width Ds
83.It Fl a
84Dump the currently existing NDP entries.
85.It Fl A Ar wait
86Repeat
87.Fl a
88.Pq dump NDP entries
89every
90.Ar wait
91seconds.
92.It Fl c
93Erase all the NDP entries.
94.It Fl d
95Delete specified NDP entry.
96.It Fl f
97Parse the file specified by
98.Ar filename .
99.It Fl H
100Harmonize consistency between the routing table and the default router
101list; install the top entry of the list into the kernel routing table.
102.It Fl i
103view ND information for specified interface.
104.It Fl l
105Do not truncate numeric IPv6 address.
106.It Fl n
107Do not try to resolve numeric address to hostname.
108.It Fl p
109Show prefix list.
110.It Fl P
111Flush all the entries in the prefix list.
112.It Fl r
113Show default router list.
114.It Fl R
115Flush all the entries in the default router list.
116.It Fl s
117Register a NDP entry for a node.
118.It Fl t
119Print timestamp on each entries,
120to make it possible to merge output with
121.Xr tcpdump 1 .
122Most useful when used with
123.Fl A .
124.El
125.\"
126.Sh RETURN VALUES
127The
128.Nm
129command will exit with 0 on success, and non-zero on errors.
130.\"
131.Sh SEE ALSO
132.Xr arp 8
133.\"
134.Sh HISTORY
135The
136.Nm
137command first appeared in WIDE Hydrangea IPv6 protocol stack kit.
138.\"
139.\" .Sh BUGS
140.\" (to be written)
141