summaryrefslogtreecommitdiff
path: root/share
diff options
context:
space:
mode:
authorMartin Pieuchot <mpi@cvs.openbsd.org>2014-10-15 11:58:14 +0000
committerMartin Pieuchot <mpi@cvs.openbsd.org>2014-10-15 11:58:14 +0000
commitbfce7bd99a824f73aeda1716b89493f43097d386 (patch)
treeed5caae3fd5c3e9a06e1232d99f5b2ada3a93f7f /share
parent74d02ae20fac0fb6a6187064848a292ba37ad83e (diff)
Use the terms "routing entry" or simply "entry" when talking about the
kernel representation of a network route. While here add some missing headers in the SYNOPSIS.
Diffstat (limited to 'share')
-rw-r--r--share/man/man9/rt_ifa_add.932
-rw-r--r--share/man/man9/rtlabel_id2name.99
-rw-r--r--share/man/man9/rtrequest1.945
3 files changed, 46 insertions, 40 deletions
diff --git a/share/man/man9/rt_ifa_add.9 b/share/man/man9/rt_ifa_add.9
index a7df00bbde1..05849d692c1 100644
--- a/share/man/man9/rt_ifa_add.9
+++ b/share/man/man9/rt_ifa_add.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: rt_ifa_add.9,v 1.2 2014/04/25 11:49:47 mpi Exp $
+.\" $OpenBSD: rt_ifa_add.9,v 1.3 2014/10/15 11:58:13 mpi Exp $
.\"
.\" Copyright (c) 2014 Martin Pieuchot
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: April 25 2014 $
+.Dd $Mdocdate: October 15 2014 $
.Dt RT_IFA_ADD 9
.Os
.Sh NAME
@@ -22,8 +22,9 @@
.Nm rt_ifa_del ,
.Nm rt_ifa_addloop ,
.Nm rt_ifa_delloop
-.Nd add or delete routes associated with an address
+.Nd add or delete routing entries associated with an address
.Sh SYNOPSIS
+.In sys/types.h
.In sys/socket.h
.In net/if.h
.In net/route.h
@@ -36,14 +37,15 @@
.Ft void
.Fn rt_ifa_delloop "struct ifaddr *ifa"
.Sh DESCRIPTION
-These functions create and delete routes required by the network stack
-and managed by the kernel.
+These functions create and delete routing entries required by the network
+stack and managed by the kernel.
.Bl -tag -width rt_ifa_addloopxx
.It Fn rt_ifa_add
-Creates and associates a connected route with
+Creates and associates a connected routing entry with
.Fa ifa .
.Pp
-Connected routes are mostly routes to prefixes and should be created with
+Connected routing entries represent routes to prefixes and should be created
+with
.Dv RTF_CLONING
in
.Fa flags
@@ -51,26 +53,26 @@ and the address of
.Fa ifa
in
.Fa dst .
-But for Point-to-Point interfaces, connected routes are routes to hosts and
-should be created
+But for Point-to-Point interfaces, connected routing entries represent routes
+to hosts and should be created
with
.Dv RTF_HOST
in
.Fa flags
and the destination address in
.Fa dst .
-Connected routes have a priority of
+Connected routing entries have a priority of
.Dv RTP_CONNECTED .
.It Fn rt_ifa_del
-Removes the connected route associated with
+Removes the connected routing entry associated with
.Fa ifa .
.It Fn rt_ifa_addloop
-Creates and associates a local route
+Creates and associates a local routing entry
with
.Fa ifa .
.Pp
-Local routes are used to not send packets destined to a local address on the
-wire and instead redirect them to
+Local routing entries are used to not send packets destined to a local
+address on the wire and instead redirect them to
.Xr lo 4 .
They have the lowest priority available,
.Dv RTP_LOCAL ,
@@ -78,7 +80,7 @@ and contain a special flag,
.Dv RTF_LOCAL ,
that can be checked to determine if the address is configured on the system.
.It Fn rt_ifa_delloop
-Removes the local route associated with
+Removes the local routing entry associated with
.Fa ifa .
.El
.Sh CONTEXT
diff --git a/share/man/man9/rtlabel_id2name.9 b/share/man/man9/rtlabel_id2name.9
index 36514821b96..a2acba1c54b 100644
--- a/share/man/man9/rtlabel_id2name.9
+++ b/share/man/man9/rtlabel_id2name.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: rtlabel_id2name.9,v 1.3 2014/03/26 14:50:30 mpi Exp $
+.\" $OpenBSD: rtlabel_id2name.9,v 1.4 2014/10/15 11:58:13 mpi Exp $
.\"
.\" Copyright (c) 2011 Bret S. Lambert <blambert@openbsd.org>
.\" All rights reserved.
@@ -15,7 +15,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: March 26 2014 $
+.Dd $Mdocdate: October 15 2014 $
.Dt RTLABEL_ID2NAME 9
.Os
.Sh NAME
@@ -25,6 +25,8 @@
.Nm rtlabel_unref
.Nd manipulate route labels
.Sh SYNOPSIS
+.In sys/types.h
+.In sys/socket.h
.In net/route.h
.Ft const char *
.Fn rtlabel_id2name "u_int16_t id"
@@ -35,7 +37,8 @@
.Ft void
.Fn rtlabel_unref "u_int16_t id"
.Sh DESCRIPTION
-Route labels are arbitrary data appended to routes and can be acted upon by
+Route labels are arbitrary data appended to route entries and can be acted
+upon by
.Xr pf 4 .
.Bl -tag -width Ds
.It Fn rtlabel_name2id "char *name"
diff --git a/share/man/man9/rtrequest1.9 b/share/man/man9/rtrequest1.9
index a97740b1f4f..177ca8e68b2 100644
--- a/share/man/man9/rtrequest1.9
+++ b/share/man/man9/rtrequest1.9
@@ -1,4 +1,4 @@
-.\" $OpenBSD: rtrequest1.9,v 1.2 2014/04/25 11:49:47 mpi Exp $
+.\" $OpenBSD: rtrequest1.9,v 1.3 2014/10/15 11:58:13 mpi Exp $
.\"
.\" Copyright (c) 2011 Bret S. Lambert <blambert@openbsd.org>
.\" All rights reserved.
@@ -15,13 +15,14 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: April 25 2014 $
+.Dd $Mdocdate: October 15 2014 $
.Dt RTREQUEST1 9
.Os
.Sh NAME
.Nm rtrequest1
-.Nd add or remove routes from a routing table
+.Nd add or remove entries from a routing table
.Sh SYNOPSIS
+.In sys/types.h
.In net/route.h
.Ft int
.Fn rtrequest1 "int req" "struct rt_addrinfo *info" "u_int8_t prio" \
@@ -51,26 +52,26 @@ struct rt_addrinfo {
.Sh DESCRIPTION
The
.Fn rtrequest1
-function is used to add or remove routes from a specific routing table.
+function is used to add or remove entries from a specific routing table.
It takes the following arguments:
.Bl -tag -width rtableid
.It Fa req
One of the following actions to perform:
.Bl -tag -width RTM_RESOLVE -offset indent
.It Dv RTM_ADD
-Add a route to a given routing table.
+Add an entry to a given routing table.
.It Dv RTM_DELETE
-Remove a route from a given routing table.
-In case of a cloning route, all its children are deleted.
+Remove an entry from a given routing table.
+In case of a cloning entry, all its children are deleted.
.It Dv RTM_RESOLVE
-Add a cloned route, based on the parent cloning route pointed by
+Add a cloned entry, based on the parent cloning entry pointed by
.Fa rtp ,
to a given routing table.
.El
.It Fa info
-Describes the route to add or remove.
+Describes the routing entry to add or remove.
.It Fa prio
-Specifies the priority of the route described by
+Specifies the priority of the routing entry described by
.Fa info .
If it is
.Dv 0
@@ -79,12 +80,12 @@ and the requested action is
then a default priority based on the priority of the associated
interface is chosen.
.It Fa rtp
-Points to the cloning route if the action is
+Points to the cloning entry if the action is
.Dv RTM_RESOLVE
or, if the action is
.Dv RTM_DELETE
-and it is non-NULL, a pointer to the removed route is placed there.
-In this case, the caller must take care of releasing the returned route by
+and it is non-NULL, a pointer to the removed entry is placed there.
+In this case, the caller must take care of releasing the returned entry by
calling
.Xr rtfree 9 .
.It Fa rtableid
@@ -104,32 +105,32 @@ The routing table with ID of
does not exist or it does not support the protocol specified in
.Fa info .
.It Bq Er ESRCH
-No route corresponding to
+No routing entry corresponding to
.Fa info
could be found.
.It Bq Er ESRCH
-Multipath route with no gateway provided in
+Multipath routing entry with no gateway provided in
.Fa info .
.It Bq Er ESRCH
-The route could not be found in the routing table of ID
+The entry could not be found in the routing table of ID
.Fa rtableid .
specified
.It Bq Er EINVAL
-The route pointed by
+The entry pointed by
.Fa rtp
-is not valid or does not point to a cloning route in the
+is not valid or does not point to a cloning entry in the
.Dv RTM_RESOLVE
case.
.It Bq Er EEXIST
-Multipath route conflicts with existing multipath route.
+Multipath routing entry conflicts with an existing one.
.It Bq Er EEXIST
-The route could not be entered into the routing table.
+The entry could not be entered into the routing table.
.It Bq Er ENOMEM
Space for MPLS protocol data could not be allocated.
.It Bq Er ENOBUFS
-Space for a new route could not be allocated.
+Space for a new routing entry could not be allocated.
.It Bq Er ENETUNREACH
-An interface address corresponding to the route described by
+An interface address corresponding to the routing entry described by
.Fa info
could not be found.
.El