- sort struct rtentry fields in man page in some order as they are in struct

- remove RTF_PRCLONING
- add rt_mtx field
- rename rt_metrics -> rt_metrics_lite
- mention that only 3 metrics are really used in rt_metrics_lite

Reviewed by:	ru, andre

1 files changed, 32 insertions, 32 deletions

diff --git a/share/man/man9/rtentry.9 b/share/man/man9/rtentry.9
index a86d5b4..b1af4dd 100644
--- a/share/man/man9/rtentry.9
+++ b/share/man/man9/rtentry.9
@@ -28,7 +28,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd October 8, 1996
+.Dd October 7, 2004
 .Os
 .Dt RTENTRY 9
 .Sh NAME
@@ -76,15 +76,6 @@ right (some protocols will put a link-layer address here), or some
 intermediate stop on the way to that destination (if the
 .Dv RTF_GATEWAY
 flag is set).
-.It Vt "long rt_refcnt" ;
-Route entries are reference-counted; this field indicates the number
-of external (to the radix tree) references.
-If the
-.Dv RTF_UP
-flag is not present, the
-.Fn rtfree
-function will delete the route from the radix tree when the last
-reference drops.
 .It Vt "u_long rt_flags" ;
 See below.
 .It Vt "struct ifnet *rt_ifp" ;
@@ -95,13 +86,22 @@ as it were, to the question posed by a route lookup; that is, they
 name the interface and interface address to be used in sending a
 packet to the destination or set of destinations which this route
 represents.
+.It Vt "struct rt_metrics_lite rt_rmx" ;
+See below.
+.It Vt "long rt_refcnt" ;
+Route entries are reference-counted; this field indicates the number
+of external (to the radix tree) references.
+If the
+.Dv RTF_UP
+flag is not present, the
+.Fn rtfree
+function will delete the route from the radix tree when the last
+reference drops.
 .It Vt "struct sockaddr *rt_genmask" ;
 When the
 .Fn rtalloc
 family of functions performs a cloning operation as requested by the
 .Dv RTF_CLONING
-or
-.Dv RTF_PRCLONING
 flag, this field is used as the mask for the new route which is
 inserted into the table.
 If this field is a null pointer, then a host
@@ -118,26 +118,24 @@ Protocols such as
 .Xr arp 4
 use this field to reference per-destination state internal to that
 protocol.
-.It Vt "struct rt_metrics rt_rmx" ;
-See below.
 .It Vt "struct rtentry *rt_gwroute" ;
 This member is a reference to a route whose destination is
 .Va rt_gateway .
 It is only used for
 .Dv RTF_GATEWAY
 routes.
-.\" .It Vt "int (*rt_output)();"
-.\" See below.
 .It Vt "struct rtentry *rt_parent" ;
 A reference to the route from which this route was cloned, or a null
 pointer if this route was not generated by cloning.
 See also the
 .Dv RTF_WASCLONED
 flag.
+.It Vt "struct mtx rt_mtx" ;
+Mutex to lock this routing entry.
 .El
 .Pp
 The following flag bits are defined:
-.Bl -tag -offset indent -width ".Dv RTF_PRCLONING" -compact
+.Bl -tag -offset indent -width ".Dv RTF_BLACKHOLE" -compact
 .It Dv RTF_UP
 The route is not deleted.
 .It Dv RTF_GATEWAY
@@ -192,20 +190,11 @@ Requests that output sent via this route be discarded.
 .It Dv RTF_PROTO3
 Protocol-specific.
 .It Dv RTF_PRCLONING
-Like
-.Dv RTF_CLONING ,
-only managed by an entire protocol.
-(E.g.,
-.Tn IP
-uses this flag to manage a per-host cache integrated with the routing
-table, for those destinations which do not have a link layer
-performing this function.)
+This flag is obsolete and simply ignored by facility.
 .It Dv RTF_WASCLONED
 Indicates that this route was generated as a result of cloning
 requested by the
 .Dv RTF_CLONING
-or
-.Dv RTF_PRCLONING
 flag.
 When set, the
 .Va rt_parent
@@ -222,7 +211,22 @@ Indicates that the destination is a broadcast address.
 Indicates that the destination is a multicast address.
 .El
 .Pp
-Every route has associated with it a set of metrics, defined by
+Every route has associated with it a set of metrics, stored in
+.Vt "struct rt_metrics_lite" .
+Metrics are supplied in
+.Vt "struct rt_metrics"
+passed with routing control messages via
+.Xr route 4
+API.
+Currently only
+.Vt rmx_mtu , rmx_expire ,
+and
+.Vt rmx_pksent
+metrics are used in
+.Vt "struct rt_metrics_lite" .  
+All others are ignored.
+.Pp
+The following metrics are defined by
 .Vt "struct rt_metrics" :
 .Bl -tag -offset indent -width 6n
 .It Vt "u_long rmx_locks" ;
@@ -282,10 +286,6 @@ The radix-tree representation of the routing table and the
 .Vt rt_metrics
 structure first appeared in
 .Bx 4.3 reno .
-The
-.Dv RTF_PRCLONING
-mechanism first appeared in
-.Fx 2.0 .
 .Sh BUGS
 There are a number of historical relics remaining in this interface.
 The