From 393f2f7b3ad53fae7b34c9efc6c8eabcf713466d Mon Sep 17 00:00:00 2001
From: Darren 'Tadgy' Austin <darren@afterdark.org.uk>
Date: Fri, 15 Nov 2019 21:38:59 +0000
Subject: Update manpages with new interface configurations.

---
 manpages/rc.inet1.8      | 11 ++++---
 manpages/rc.inet1.conf.5 | 85 ++++++++++++++++++++++++++++++++++++------------
 2 files changed, 71 insertions(+), 25 deletions(-)

diff --git a/manpages/rc.inet1.8 b/manpages/rc.inet1.8
index 92f7cea..4102eec 100644
--- a/manpages/rc.inet1.8
+++ b/manpages/rc.inet1.8
@@ -17,7 +17,7 @@ Wireless interfaces are configured just like any network device
 but accept many more configuration parameters.
 .LP
 rc.inet1 reads its configuration parameters from a file
-.IR rc.inet1.conf .
+.IR /etc/rc.d/rc.inet1.conf .
 The
 .I rc.inet1.conf
 file contains a series of variable array definitions,
@@ -27,7 +27,7 @@ The way to start your network (configuring your nics and
 bringing the interfaces up, and creating a default route if required)
 is by running the command:
 .LP
-.B /etc/rc.d/rc.inet1
+.B /etc/rc.d/rc.inet1 start
 .LP
 Restarting the whole network (all available network interfaces)
 is done in a similar fashion:
@@ -96,12 +96,13 @@ rc.inet1.conf by default.
 .LP
 If you want to configure more than six network interfaces, you will
 have to edit the file
-.I /etc/rc.d/rc.inet1
+.I /etc/rc.d/rc.inet1.conf
 and change the value `6' in the line:
 .br
-.B \ \ MAXNICS=${MAXNICS:-6}
+.B \ \ #MAXNICS="6"
 .br
-to a value that is larger than the largest index value you use.
+(at the very bottom of the file) to a value that is larger than the largest
+index value you use, and uncomment the line.
 .LP
 The /etc/rc.d/rc.wireless script is not meant to be run on its own by the user!
 .SH AUTHORS
diff --git a/manpages/rc.inet1.conf.5 b/manpages/rc.inet1.conf.5
index 52695de..e966eb7 100644
--- a/manpages/rc.inet1.conf.5
+++ b/manpages/rc.inet1.conf.5
@@ -7,7 +7,7 @@
 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
 .el .TP "\\$1"
 ..
-.TH RC.INET1.CONF 5 "6 Nov 2019" "Slackware Version 15.0"
+.TH RC.INET1.CONF 5 "16 Nov 2019" "Slackware Version 15.0"
 .SH NAME
 rc.inet1.conf \- Slackware network configuration file.
 .SH DESCRIPTION
@@ -85,26 +85,39 @@ VIRTIFUSER[0]="root"
 .br
 VIRTIFGROUP[0]="root"
 .br
-.SH EXAMPLE BRIDGE CREATION AND SETUP
-Note the added BRNICS parameter which contains a space-separated list
-of the physical or virtual network interfaces you want to add to the bridge.
-Note that the parameter index can not be a duplicate of that defined for some
-other interface (e.g. eth0 will be index 0 by default).
+.SH EXAMPLE BRIDGE INTERFACE CREATION
+Link aggregation (bond) interfaces can be configured with the use of 3 new
+parameters for use in rc.inet1.conf.  The BONDNICS parameter should contain
+the (space delimited) list of interfaces to include in the bond.  The type
+of bond is configured with the BONDMODE parameter, which can be any of the
+supported mode types as found in the bonding kernel documentation found at
+/usr/src/linux/Documentation/networking/bonding.txt.
 .LP
-IFNAME[0]="br0"
-.br
-BRNICS[0]="eth0 eth1 tun0"
-.br
-IPADDR[0]="192.168.0.1"
+The final parameter is a new generic IFOPTS parameter, which takes a list
+of interface specific configuration options in a pipe (|) delimited list.
+There are several module specific options which can be set with this
+parameter, and they can be found in the kernel source documentation from
+above.  Note: it is
+.B highly
+recommended that you use at least the
+.B miimon
+option.  Certain bonding modes will require other options to operate correctly.
+.LP
+Here is a complete configuration for a load balancing, fault tolerant
+interface, with two ethernet devices:
+.LP
+IFNAME[0]="bond0"
 .br
-NETMASK[0]="24"
+BONDNICS[0]="eth0 eth1"
 .br
-IPALIASES[0]=""
+BONDMODE[0]="balance-rr"
 .br
-USE_DHCP[0]=""
+IFOPTS[0]="xmit_hash_policy layer2+3 | miimon 100"
 .br
-DHCP_HOSTNAME[0]=""
+IPADDR[0]="192.168.0.10"
 .br
+NETMASK[0]="24"
+.LP
 .SH EXAMPLE VLAN INTERFACE CREATION
 VLAN interfaces can be configured in rc.inet1.conf, in the standard Slackware
 way of defining an interface.  The key to the configuration is to use the
@@ -116,6 +129,8 @@ interface, configured with a static IPv4 address:
 .LP
 IFNAME[0]="eth0.100"
 .br
+IFOPTS[0]=""
+.br
 IPADDR[0]="192.168.100.10"
 .br
 NETMASK[0]="24"
@@ -124,8 +139,38 @@ The IFNAME of the interface contains the underlying ethernet device name
 (eth0), a period (.), and the VLAN ID to be exposed.
 .LP
 Note that the underlying ethernet (or bond) interface does not need to have an
-IP address to be used with the VLAN.
+IP address to be used with the VLAN, but it can have an IP address if you are
+also using an untagged VLAN.
+.LP
+The new generic IFOPTS parameter takes a pipe (|) delimited list of interface
+type specific options, but does not need any options in order for a VLAN
+interface to be configured.  However, there are several VLAN specific options
+which can be configured if required - these are documented in the ip-link(8)
+man page (search for "VLAN Type Support").
+.br
+.SH EXAMPLE BRIDGE CREATION AND SETUP
+Note the added BRNICS parameter which contains a space-separated list
+of the physical or virtual network interfaces you want to add to the bridge.
+Note that the parameter index can not be a duplicate of that defined for some
+other interface (e.g. eth0 will be index 0 by default).
+.LP
+IFNAME[5]="br0"
 .br
+BRNICS[5]="eth0 eth1 tun0"
+.br
+IFOPTS[5]=""
+.br
+IPADDR[5]="192.168.0.10"
+.br
+NETMASK[5]="24"
+.LP
+The new generic IFOPTS parameter takes a pipe (|) delimited list of interface
+type specific options, but does not need any options in order for a bridge
+interface to be configured.  However, there are several bridge specific options
+which can be configured if required - these are documented in the ip-link(8)
+man page (search for "BRIDGE Type Support").
+.br
+
 .SH GENERAL PARAMETERS
 This is a list of parameters you can set for any interface.
 The example section is for `eth0' by default, i.e.
@@ -327,10 +372,10 @@ script makes the assumption that array indexes stay below the value of
 .LP
 If you want to configure more than six network interfaces, you will
 have to edit the file
-.I /etc/rc.d/rc.inet1
-and change the value `6' in the line
-.B MAXNICS=${MAXNICS:-6}
-to the number of network interfaces you wish to use.
+.I /etc/rc.d/rc.inet1.conf
+and uncomment, and change the value `6' in the line
+.B #MAXNICS="6"
+(at the very bottom of the file) to the number of network interfaces you wish to use.
 .SH AUTHORS
 Patrick J. Volkerding <volkerdi@slackware.com>
 .br
-- 
cgit v1.2.3