xref: /freebsd/usr.sbin/ndp/ndp.8 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
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
78.Nm
79command manipulates the address mapping table
80used by Neighbor Discovery Protocol (NDP).
81.Bl -tag -width Ds
82.It Fl a
83Dump the currently existing NDP entries.
84.It Fl A Ar wait
85Repeat
86.Fl a
87.Pq dump NDP entries
88every
89.Ar wait
90seconds.
91.It Fl c
92Erase all the NDP entries.
93.It Fl d
94Delete specified NDP entry.
95.It Fl f
96Parse the file specified by
97.Ar filename .
98.It Fl H
99Harmonize consistency between the routing table and the default router
100list; install the top entry of the list into the kernel routing table.
101.It Fl i
102view ND information for specified interface.
103.It Fl l
104Do not truncate numeric IPv6 address.
105.It Fl n
106Do not try to resolve numeric address to hostname.
107.It Fl p
108Show prefix list.
109.It Fl P
110Flush all the entries in the prefix list.
111.It Fl r
112Show default router list.
113.It Fl R
114Flush all the entries in the default router list.
115.It Fl s
116Register a NDP entry for a node.
117.It Fl t
118Print timestamp on each entries,
119to make it possible to merge output with
120.Xr tcpdump 1 .
121Most useful when used with
122.Fl A .
123.El
124.\"
125.Sh RETURN VALUES
126.Nm Ndp
127will exit with 0 on success, and non-zero on errors.
128.\"
129.Sh SEE ALSO
130.Xr arp 8
131.\"
132.Sh HISTORY
133The
134.Nm
135command first appeared in WIDE Hydrangea IPv6 protocol stack kit.
136.\"
137.\" .Sh BUGS
138.\" (to be written)
139