summaryrefslogtreecommitdiffstats
path: root/usr.sbin/ndp/ndp.8
diff options
context:
space:
mode:
authorume <ume@FreeBSD.org>2003-11-13 16:02:44 +0000
committerume <ume@FreeBSD.org>2003-11-13 16:02:44 +0000
commit59af8d55c7f5cc534f1685da36373c3445ef7954 (patch)
tree3e0528436ece4d58e7b145e6ab35ea51b175f8dc /usr.sbin/ndp/ndp.8
parent650f540b8d6f1e889ef3f8bd86211668f13343dc (diff)
downloadFreeBSD-src-59af8d55c7f5cc534f1685da36373c3445ef7954.zip
FreeBSD-src-59af8d55c7f5cc534f1685da36373c3445ef7954.tar.gz
- make command line argument parsing POSIX compliant. comment from
deraadt NOTE: -I needs to take an arg (there's no way we can take no arg/an arg with a single option) - sscanf overrun - no variable name on prototype. - u_int32_t may not be u_long. - skipped non-host route when printing neighbor cache entries. - valid and preferred lifetimes are unsigned. - wording. Obtained from: KAME
Diffstat (limited to 'usr.sbin/ndp/ndp.8')
-rw-r--r--usr.sbin/ndp/ndp.8163
1 files changed, 109 insertions, 54 deletions
diff --git a/usr.sbin/ndp/ndp.8 b/usr.sbin/ndp/ndp.8
index e9b75dd..c74e139 100644
--- a/usr.sbin/ndp/ndp.8
+++ b/usr.sbin/ndp/ndp.8
@@ -1,5 +1,5 @@
.\" $FreeBSD$
-.\" $KAME: ndp.8,v 1.15 2001/02/08 07:17:03 itojun Exp $
+.\" $KAME: ndp.8,v 1.28 2002/07/17 08:46:33 itojun Exp $
.\"
.\" Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
.\" All rights reserved.
@@ -37,60 +37,97 @@
.Nd control/diagnose IPv6 neighbor discovery protocol
.\"
.Sh SYNOPSIS
-.Nm
-.Fl a
+.Nm ndp
.Op Fl nt
-.Nm
-.Fl A Ar wait
+.Ar hostname
+.Nm ndp
.Op Fl nt
-.Nm
-.Fl c
+.Fl a | Fl c | Fl p
+.Nm ndp
.Op Fl nt
-.Nm
-.Fl d
+.Fl r
+.Nm ndp
.Op Fl nt
-.Ar hostname
-.Nm
-.Fl f
+.Fl H | Fl P | Fl R
+.Nm ndp
+.Op Fl nt
+.Fl A Ar wait
+.Nm ndp
+.Op Fl nt
+.Fl d Ar hostname
+.Nm ndp
+.Op Fl nt
+.Fl f Ar filename
+.Nm ndp
.Op Fl nt
-.Ar filename
-.Nm
-.Fl H
-.Nm
-.Fl I
-.Op Cm delete | Ar interface
-.Nm
.Fl i
.Ar interface
-.Op Ar flags...
-.Nm
-.Fl p
-.Nm
-.Fl P
-.Nm
-.Fl r
-.Nm
-.Fl R
-.Nm
-.Fl s
+.Op Ar flags ...
+.Nm ndp
.Op Fl nt
-.Ar nodename
-.Ar ether_addr
+.Fl I Op Ar interface | Li delete
+.Nm ndp
+.Op Fl nt
+.Fl s Ar nodename etheraddr
.Op Li temp
.Op Li proxy
.\"
.Sh DESCRIPTION
The
.Nm
-utility manipulates the address mapping table
-used by Neighbor Discovery Protocol (NDP).
+command manipulates the address mapping table
+used by the Neighbor Discovery Protocol (NDP).
.Bl -tag -width Ds
.It Fl a
Dump the currently existing NDP entries.
+The following information will be printed:
+.Bl -tag -width NeighborXX
+.It Neighbor
+IPv6 address of the neighbor.
+.It Linklayer Address
+Linklayer address of the neighbor.
+It could be
+.Dq Li (incomplete)
+when the address is not available.
+.It Netif
+Network interface associated with the neighbor cache entry.
+.It Expire
+The time until expiry of the entry.
+The entry could become
+.Dq Li permanent ,
+in which case it will never expire.
+.It S
+State of the neighbor cache entry, as a single letter:
+.Pp
+.Bl -tag -width indent -compact
+.It N
+Nostate
+.It W
+Waitdelete
+.It I
+Incomplete
+.It R
+Reachable
+.It S
+Stale
+.It D
+Delay
+.It P
+Probe
+.It ?
+Unknown state (should never happen).
+.El
+.It Flags
+Flags on the neighbor cache entry, in a single letter.
+They are: Router, proxy neighbor advertisement
+.Pq Dq p .
+The field could be followed by a decimal number,
+which means the number of NS probes the node has sent during the current state.
+.El
.It Fl A Ar wait
Repeat
.Fl a
-(dump NDP entries)
+.Pq dump NDP entries
every
.Ar wait
seconds.
@@ -104,35 +141,42 @@ Parse the file specified by
.It Fl H
Harmonize consistency between the routing table and the default router
list; install the top entry of the list into the kernel routing table.
-.It Fl I Op Cm delete | Ar interface
-Shows or specifies the default interface used as the default route when
+.It Fl I
+Shows the default interface used as the default route when
+there is no default router.
+.It Fl I Ar interface
+Specifies the default interface used as the default route when
there is no default router.
-If no argument is given to the option,
-the current default interface will be shown.
-If an
+The
.Ar interface
-is specified, the interface will be used as the default.
-If a special keyword
-.Ic delete
-is specified, the current default interface will be deleted from the kernel.
-.It Fl i Ar interface Op Ar flags...
+will be used as the default.
+.It Fl I Li delete
+The current default interface will be deleted from the kernel.
+.It Fl i Ar interface Op Ar flags ...
View ND information for the specified interface.
If additional arguments
.Ar flags
are given,
.Nm
sets or clears the specified flags for the interface.
+Each flag should be separated by white spaces or tab characters.
Possible flags are as follows.
All of the flags can begin with the
special character
.Ql - ,
which means the flag should be cleared.
+Note that you need
+.Fl -
+before
+.Fl foo
+in this case.
.\"
+.Pp
.Bl -tag -width Ds -compact
.It Xo
.Ic nud
.Xc
-turn on or off NUD (Neighbor Unreachability Detection) on the
+Turn on or off NUD (Neighbor Unreachability Detection) on the
interface.
NUD is usually turned on by default.
.It Xo
@@ -146,9 +190,20 @@ unless the
.Li net.inet6.ip6.accept_rtadv
variable is non-0, even if the flag is on.
This flag is set to 1 by default.
+.It Xo
+.Ic prefer_source
+.Xc
+Prefer addresses on the
+.Ar interface
+as candidates of the source address for outgoing packets.
+The default value of this flag is off.
+For more details about the entire algorithm of source address
+selection, see the
+.Pa IMPLEMENTATION
+file supplied with the KAME kit.
.El
.It Fl n
-Do not try to resolve numeric address to hostname.
+Do not try to resolve numeric addresses to hostnames.
.It Fl p
Show prefix list.
.It Fl P
@@ -158,20 +213,20 @@ Show default router list.
.It Fl R
Flush all the entries in the default router list.
.It Fl s
-Register an NDP entry for a node.
+Register a NDP entry for a node.
The entry will be permanent unless the word
.Li temp
is given in the command.
If the word
.Li proxy
-is given, this system will act as a proxy NDP server,
+is given, this system will act as an proxy NDP server,
responding to requests for
.Ar hostname
even though the host address is not its own.
.It Fl t
-Print timestamp on each entries,
-to make it possible to merge output with
-.Xr tcpdump 1 .
+Print timestamp on each entry,
+making it possible to merge output with
+.Xr tcpdump 8 .
Most useful when used with
.Fl A .
.El
@@ -179,7 +234,7 @@ Most useful when used with
.Sh RETURN VALUES
The
.Nm
-utility will exit with 0 on success, and non-zero on errors.
+command will exit with 0 on success, and non-zero on errors.
.\"
.Sh SEE ALSO
.Xr arp 8
@@ -187,7 +242,7 @@ utility will exit with 0 on success, and non-zero on errors.
.Sh HISTORY
The
.Nm
-utility first appeared in WIDE Hydrangea IPv6 protocol stack kit.
+command first appeared in the WIDE Hydrangea IPv6 protocol stack kit.
.\"
.\" .Sh BUGS
.\" (to be written)
OpenPOWER on IntegriCloud