usr.sbin/ndp/ndp.8

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