summaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorhmp <hmp@FreeBSD.org>2003-10-23 02:15:46 +0000
committerhmp <hmp@FreeBSD.org>2003-10-23 02:15:46 +0000
commit245743d500c8310cf5978128a6c2cc2ff6c3aa0a (patch)
tree303a9bff7abe531911c809bd5c722373db1ac084 /share
parent909c96e69e234d87987ecbfc63ab2d9e229da679 (diff)
downloadFreeBSD-src-245743d500c8310cf5978128a6c2cc2ff6c3aa0a.zip
FreeBSD-src-245743d500c8310cf5978128a6c2cc2ff6c3aa0a.tar.gz
Mdoc Janitor:
* Fix hard sentence breaks.
Diffstat (limited to 'share')
-rw-r--r--share/man/man9/rtalloc.924
-rw-r--r--share/man/man9/rtentry.927
2 files changed, 34 insertions, 17 deletions
diff --git a/share/man/man9/rtalloc.9 b/share/man/man9/rtalloc.9
index 1b01b74..717384d 100644
--- a/share/man/man9/rtalloc.9
+++ b/share/man/man9/rtalloc.9
@@ -47,7 +47,8 @@
.Fn rtalloc1 "struct sockaddr *sa" "int report" "u_long flags"
.Sh DESCRIPTION
The kernel uses a radix tree structure to manage routes for the
-networking subsystem. The
+networking subsystem.
+The
.Fn rtalloc
family of routines is used by protocols to query this structure for a
route corresponding to a particular end-node address, and to cause
@@ -101,7 +102,8 @@ smaller than the default
Before calling
.Fn rtalloc
for the first time, callers should ensure that unused bits of the
-structure are set to zero. On subsequent calls,
+structure are set to zero.
+On subsequent calls,
.Fn rtalloc
returns without performing a lookup if
.Fa ro->ro_rt
@@ -119,7 +121,8 @@ in the presence of the
.Dv RTF_CLONING
and
.Dv RTF_PRCLONING
-flags are undesired. The
+flags are undesired.
+The
.Fa ro
argument is the same as
.Fn rtalloc ,
@@ -146,7 +149,8 @@ Instead, it takes a
.Dq Li "struct sockaddr *"
directly as the
.Fa sa
-argument. The second argument,
+argument.
+The second argument,
.Fa report ,
controls whether
.Dv RTM_RESOLVE
@@ -154,7 +158,8 @@ requests are sent to the lower layers when an
.Dv RTF_CLONING
or
.Dv RTF_PRCLONING
-route is cloned. Ordinarily a value of one should be passed, except
+route is cloned.
+Ordinarily a value of one should be passed, except
in the processing of those lower layers which use the cloning
facility.
The third argument,
@@ -166,10 +171,12 @@ The
.Fn rtalloc
and
.Fn rtalloc_ign
-functions do not return a value. The
+functions do not return a value.
+The
.Fn rtalloc1
function returns a pointer to a routing-table entry if it succeeds,
-otherwise a null pointer. Lack of a route should in most cases be
+otherwise a null pointer.
+Lack of a route should in most cases be
translated to the
.Xr errno 2
value
@@ -182,7 +189,8 @@ The
.Nm
facility first appeared in
.Bx 4.2 ,
-although with much different internals. The
+although with much different internals.
+The
.Fn rtalloc_ign
function and the
.Fa flags
diff --git a/share/man/man9/rtentry.9 b/share/man/man9/rtentry.9
index 655a28c..6c2d517 100644
--- a/share/man/man9/rtentry.9
+++ b/share/man/man9/rtentry.9
@@ -39,7 +39,8 @@
.In net/route.h
.Sh DESCRIPTION
The kernel provides a common mechanism by which all protocols can store
-and retrieve entries from a central table of routes. Parts of this
+and retrieve entries from a central table of routes.
+Parts of this
mechanism are also used to interact with user-level processes by means
of a socket in the
.Xr route 4
@@ -56,9 +57,11 @@ which includes the following fields:
.It Xo
.Vt "struct radix_node rt_nodes[2]" ;
.Xc
-Glue used by the radix-tree routines. These members also include in
+Glue used by the radix-tree routines.
+These members also include in
their substructure the key (i.e., destination address) and mask used
-when the route was created. The
+when the route was created.
+The
.Fn rt_key \&rt
and
.Fn rt_mask \&rt
@@ -80,7 +83,8 @@ flag is set).
.Vt "long rt_refcnt" ;
.Xc
Route entries are reference-counted; this field indicates the number
-of external (to the radix tree) references. If the
+of external (to the radix tree) references.
+If the
.Dv RTF_UP
flag is not present, the
.Fn rtfree
@@ -112,7 +116,8 @@ family of functions performs a cloning operation as requested by the
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
+inserted into the table.
+If this field is a null pointer, then a host
route is generated.
.It Xo
.Vt "caddr_t rt_llinfo" ;
@@ -145,7 +150,8 @@ routes.
.Vt "struct rtentry *rt_parent" ;
.Xc
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
+pointer if this route was not generated by cloning.
+See also the
.Dv RTF_WASCLONED
flag.
.El
@@ -164,7 +170,8 @@ fields name that destination.
.It Dv RTF_HOST
This is a host route.
.It Dv RTF_REJECT
-The destination is presently unreachable. This should result in an
+The destination is presently unreachable.
+This should result in an
.Er EHOSTUNREACH
error from output routines.
.It Dv RTF_DYNAMIC
@@ -217,7 +224,8 @@ requested by the
.Dv RTF_CLONING
or
.Dv RTF_PRCLONING
-flag. When set, the
+flag.
+When set, the
.Li rt_parent
field indicates the route from which this one was generated.
.It Dv RTF_PINNED
@@ -264,7 +272,8 @@ Nominally, the bandwidth-delay product for the path
.Em from
the destination
.Em to
-this system. In practice, this value is used to set the size of the
+this system.
+In practice, this value is used to set the size of the
receive buffer (and thus the window in sliding-window protocols like
.Tn TCP ) .
.It Xo
OpenPOWER on IntegriCloud