From 606e98d7bd8f18b984af7dff09225af6d7ea39f4 Mon Sep 17 00:00:00 2001
From: Ariadne Conill <ariadne@dereferenced.org>
Date: Wed, 16 Dec 2020 06:31:17 -0700
Subject: [PATCH] docs: add interfaces-forward(5) manual page

---
 Makefile                   |  1 +
 doc/interfaces-forward.scd | 45 ++++++++++++++++++++++++++++++++++++++
 doc/interfaces.scd         |  3 +++
 3 files changed, 49 insertions(+)
 create mode 100644 doc/interfaces-forward.scd

diff --git a/Makefile b/Makefile
index 1c8ac95..34e2285 100644
--- a/Makefile
+++ b/Makefile
@@ -162,6 +162,7 @@ MANPAGES_5 = \
 	doc/interfaces-bond.5 \
 	doc/interfaces-batman.5 \
 	doc/interfaces-bridge.5 \
+	doc/interfaces-forward.5 \
 	doc/interfaces-ppp.5 \
 	doc/interfaces-vrf.5 \
 	doc/interfaces-vxlan.5 \
diff --git a/doc/interfaces-forward.scd b/doc/interfaces-forward.scd
new file mode 100644
index 0000000..bea793f
--- /dev/null
+++ b/doc/interfaces-forward.scd
@@ -0,0 +1,45 @@
+interfaces-forward(5)
+
+# NAME
+
+*interfaces-forward* - forwarding vocabulary for the interfaces(5) file format
+
+# DESCRIPTION
+
+Linux allows for configuration of IP packet forwarding behavior on a protocol
+and interface basis.  The following options allow for this configuration.
+
+# FORWARDING-RELATED OPTIONS
+
+*forward-ipv4* _yes|no_
+	Whether the interface should forward unicast IPv4 packets.
+
+*forward-ipv6* _yes|no_
+	Whether the interface should forward unicast IPv6 packets.
+
+*forward-ipv4-mc* _yes|no_
+	Whether the interface should forward multicast IPv4 packets.
+
+*forward-ipv6-mc* _yes|no_
+	Whether the interface should forward multicast IPv6 packets.
+
+# EXAMPLES
+
+The typical home router scenario will want to forward both IPv4 and IPv6
+packets:
+
+```
+iface WAN
+	use dhcp
+	forward-ipv4 yes
+	forward-ipv6 yes
+
+iface LAN
+	address 192.168.0.1/24
+	forward-ipv4 yes
+	forward-ipv6 yes
+```
+
+# AUTHORS
+
+Ariadne Conill <ariadne@dereferenced.org>
diff --git a/doc/interfaces.scd b/doc/interfaces.scd
index d1131ca..1aa15d6 100644
--- a/doc/interfaces.scd
+++ b/doc/interfaces.scd
@@ -158,6 +158,9 @@ most common executors are:
 	Use a DHCP client to learn the IPv4 address of an
 	interface.
 
+*forward*
+	Configures forwarding settings on the interface.
+
 *loopback*
 	Designates the interface as a loopback device.