RETURN VALUES is for function return values only. FreeBSD has an own
[dragonfly.git] / usr.sbin / ndp / ndp.8
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.4 2006/03/01 08:08:45 swildner 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
84 The
85 .Nm
86 utility manipulates the address mapping table
87 used by Neighbor Discovery Protocol (NDP).
88 .Bl -tag -width Ds
89 .It Fl a
90 Dump the currently existing NDP entries.
91 .It Fl A Ar wait
92 Repeat
93 .Fl a
94 (dump NDP entries)
95 every
96 .Ar wait
97 seconds.
98 .It Fl c
99 Erase all the NDP entries.
100 .It Fl d
101 Delete specified NDP entry.
102 .It Fl f
103 Parse the file specified by
104 .Ar filename .
105 .It Fl H
106 Harmonize consistency between the routing table and the default router
107 list; install the top entry of the list into the kernel routing table.
108 .It Fl I Op Cm delete | Ar interface
109 Shows or specifies the default interface used as the default route when
110 there is no default router.
111 If no argument is given to the option,
112 the current default interface will be shown.
113 If an
114 .Ar interface
115 is specified, the interface will be used as the default.
116 If a special keyword
117 .Ic delete
118 is specified, the current default interface will be deleted from the kernel.
119 .It Fl i Ar interface Op Ar flags...
120 View ND information for the specified interface.
121 If additional arguments
122 .Ar flags
123 are given,
124 .Nm
125 sets or clears the specified flags for the interface.
126 Possible flags are as follows.
127 All of the flags can begin with the
128 special character
129 .Ql - ,
130 which means the flag should be cleared.
131 .\"
132 .Bl -tag -width Ds -compact
133 .It Xo
134 .Ic nud
135 .Xc
136 turn on or off NUD (Neighbor Unreachability Detection) on the
137 interface.
138 NUD is usually turned on by default.
139 .It Xo
140 .Ic accept_rtadv
141 .Xc
142 Specify whether or not to accept Router Advertisement messages
143 received on the
144 .Ar interface .
145 Note that the kernel does not accept Router Advertisement messages
146 unless the
147 .Li net.inet6.ip6.accept_rtadv
148 variable is non-0, even if the flag is on.
149 This flag is set to 1 by default.
150 .El
151 .It Fl n
152 Do not try to resolve numeric address to hostname.
153 .It Fl p
154 Show prefix list.
155 .It Fl P
156 Flush all the entries in the prefix list.
157 .It Fl r
158 Show default router list.
159 .It Fl R
160 Flush all the entries in the default router list.
161 .It Fl s
162 Register an NDP entry for a node.
163 The entry will be permanent unless the word
164 .Li temp
165 is given in the command.
166 If the word
167 .Li proxy
168 is given, this system will act as a proxy NDP server,
169 responding to requests for
170 .Ar hostname
171 even though the host address is not its own.
172 .It Fl t
173 Print timestamp on each entries,
174 to make it possible to merge output with
175 .Xr tcpdump 1 .
176 Most useful when used with
177 .Fl A .
178 .El
179 .\"
180 .Sh DIAGNOSTICS
181 The
182 .Nm
183 utility will exit with 0 on success, and non-zero on errors.
184 .\"
185 .Sh SEE ALSO
186 .Xr arp 8
187 .\"
188 .Sh HISTORY
189 The
190 .Nm
191 utility first appeared in WIDE Hydrangea IPv6 protocol stack kit.
192 .\"
193 .\" .Sh BUGS
194 .\" (to be written)