ndp.tproj/ndp.8

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