start documenting routing tables and routing domains

general acceptance of the room

2 files changed, 83 insertions, 2 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 5815b47fff2..68c2a2a8fa1 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.588 2015/01/10 17:17:48 kettenis Exp $
+#	$OpenBSD: Makefile,v 1.589 2015/02/05 08:58:10 phessler Exp $
 
 MAN=	aac.4 ac97.4 acphy.4 \
 	acpi.4 acpiac.4 acpiasus.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \
@@ -45,7 +45,7 @@ MAN=	aac.4 ac97.4 acphy.4 \
 	pf.4 pflog.4 pflow.4 pfsync.4 pgt.4 piixpm.4 pim.4 pipex.4 \
 	pms.4 ppb.4 ppp.4 pppoe.4 pppx.4 pty.4 puc.4 pwdog.4 \
 	qla.4 qle.4 qlw.4 qsphy.4 radio.4 \
-	ral.4 random.4 rd.4 rdac.4 re.4 rdcphy.4 rgephy.4 ricohrtc.4 \
+	ral.4 random.4 rdomain.4 rd.4 rdac.4 re.4 rdcphy.4 rgephy.4 ricohrtc.4 \
 	rl.4 rlphy.4 route.4 rsu.4 rt.4 rtsx.4 rum.4 run.4 \
 	rtfps.4 rtii.4 rtw.4 safe.4 safte.4 san.4 sbus.4 schsio.4 \
 	scsi.4 sd.4 \
@@ -86,6 +86,7 @@ MLINKS+=pcmcia.4 pcic.4
 MLINKS+=pty.4 ptm.4
 MLINKS+=random.4 arandom.4
 MLINKS+=random.4 srandom.4 random.4 urandom.4
+MLINKS+=rdomain4 rtable.4
 MLINKS+=scsi.4 scsibus.4
 MLINKS+=sk.4 skc.4 msk.4 mskc.4
 MLINKS+=speaker.4 spkr.4
diff --git a/share/man/man4/rdomain.4 b/share/man/man4/rdomain.4
new file mode 100644
index 00000000000..002b202a39f
--- /dev/null
+++ b/share/man/man4/rdomain.4
@@ -0,0 +1,80 @@
+.\"	$OpenBSD: rdomain.4,v 1.1 2015/02/05 08:58:10 phessler Exp $
+.\"
+.\" Copyright (c) 2015 Peter Hessler <phessler@openbsd.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: February 5 2015 $
+.Dt RDOMAIN 4
+.Os
+.Sh NAME
+.Nm rtable ,
+.Nm rdomain
+.Nd routing tables and routing domains
+.Sh DESCRIPTION
+The traditional kernel routing system had a single table for routes and
+allowed for non-conflicting IP address assignments.
+.Em rtable
+and
+.Em rdomain
+allows us to have seperate lookup tables for routes,
+and assign IP addresses independantly from other interfaces.
+.Pp
+.Sh rtable
+.Em rtable
+allows one to set a different route table for outbound network packets.
+As with the traditional routing system, IP addresses cannot overlap.
+You can have multiple
+.Em rtable
+within the same routing domain.
+Commonly used to set Policy Based Routing.
+.Sh rdomain
+.Em rdomain
+are completely seperate seperate routing domains and tables in the kernel.
+An IP address (e.g. 10.0.0.1/16) can be assigned in multple
+.Em rdomains ,
+but
+cannot be assigned more than once per
+.Em rdomain .
+An interface belongs to one and only one
+.Em rdomain .
+The interface's
+.Em rdomain
+determines which rdomain an incoming packet will
+be in.
+Virtual interfaces do not need to belong to the same
+.Em rdomain
+as the parent.
+An
+.Em rdomain
+contains at least one routing table.
+.\" .Sh EXAMPLES
+.\" make some
+.\" ifconfig em0 rdomain 4
+.\" ifconfig em0 192.0.2.100/24
+.\" route -T4 -n add default 192.0.2.1
+.Sh SEE ALSO
+.Xr route 4 ,
+.Xr pf.conf 5 ,
+.Xr ifconfig 8 ,
+.Xr route 8
+.Sh HISTORY
+.Ox
+support for
+.\" XXX - rdomains, not 'rtable'
+.\" .Nm
+rdomains
+first appeared in
+.Ox 4.9
+and IPv6 support first appeared in
+.Ox 5.5 .