Updated manpages

Thanks to David Spencer for much of this.

Signed-off-by: Robby Workman <rworkman@slackware.com>

2 files changed, 208 insertions, 124 deletions

diff --git a/manpages/rc.inet1.8 b/manpages/rc.inet1.8
index ac8ce6a..92f7cea 100644
--- a/manpages/rc.inet1.8
+++ b/manpages/rc.inet1.8
@@ -7,7 +7,7 @@
 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
 .el .TP "\\$1"
 ..
-.TH RC.INET1 8 "12 Nov 2017" "Slackware Version 15.0"
+.TH RC.INET1 8 "1 Oct 2018" "Slackware Version 15.0"
 .SH NAME
 rc.inet1 \- Slackware network configuration script.
 .SH DESCRIPTION
@@ -15,12 +15,15 @@ rc.inet1 \- Slackware network configuration script.
 This script configures network interfaces.
 Wireless interfaces are configured just like any network device
 but accept many more configuration parameters.
-.br
-rc.inet1 reads its configuration parameters from a file `rc.inet1.conf'.
-The `rc.inet1.conf' file contains a series of variable array definitions,
+.LP
+rc.inet1 reads its configuration parameters from a file
+.IR rc.inet1.conf .
+The
+.I rc.inet1.conf
+file contains a series of variable array definitions,
 with each array index corresponding to a single network interface.
 .SH OPTIONS
-The way to start your network (the configuration of your nics and
+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
@@ -31,8 +34,8 @@ is done in a similar fashion:
 .LP
 .B /etc/rc.d/rc.inet1 restart
 .LP
-More generically speaking, you can start/stop/restart any network
-interface yourself by running one of the commands:
+More generally speaking, you can start/stop/restart any network
+interface by running one of the commands:
 .LP
 .B /etc/rc.d/rc.inet1 INTERFACE_start
 .LP
@@ -40,8 +43,8 @@ interface yourself by running one of the commands:
 .LP
 .B /etc/rc.d/rc.inet1 INTERFACE_restart
 .LP
-where 
-.I `INTERFACE'
+where
+.B INTERFACE
 is the name of an existing network interface (eth0, wlan0, ...)
 .SH WIRELESS
 The script
@@ -50,11 +53,11 @@ takes care of configuring the wireless parameters for a network
 interface. This script does not run independently.  Instead, it is executed
 by the generic network configuration script
 .IR rc.inet1 .
-.br
+.LP
 If a wireless interface is detected,
 .I rc.wireless
 will use
-.I iwconfig ,
+.IR iwconfig ,
 .I iwpriv
 and possibly
 .I wpa_supplicant
@@ -78,7 +81,7 @@ parameter definition file (
 .SH DIAGNOSTICS
 If you remove the executable bit from the
 .I rc.wireless
-script, it will never be executed.  This can be beneficial if you have 
+script, it will never be executed.  This can be beneficial if you have
 written your own wireless script and don't want Slackware to mess it up.
 .SH CAVEATS
 The network interface definitions are stored in variable
@@ -103,8 +106,11 @@ to a value that is larger than the largest index value you use.
 The /etc/rc.d/rc.wireless script is not meant to be run on its own by the user!
 .SH AUTHORS
 Patrick J. Volkerding <volkerdi@slackware.com>
+.br
 Eric Hameleers <alien@slackware.com>
+.br
 Robby Workman <rworkman@slackware.com>
+.br
 Darren 'Tadgy' Austin <darren@afterdark.org.uk>
 .SH "SEE ALSO"
 .BR rc.inet1.conf(5),
diff --git a/manpages/rc.inet1.conf.5 b/manpages/rc.inet1.conf.5
index 2868317..c3380ea 100644
--- a/manpages/rc.inet1.conf.5
+++ b/manpages/rc.inet1.conf.5
@@ -7,26 +7,27 @@
 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
 .el .TP "\\$1"
 ..
-.TH RC.INET1.CONF 5 "12 Nov 2017" "Slackware Version 15.0"
+.TH RC.INET1.CONF 5 "1 Oct 2018" "Slackware Version 15.0"
 .SH NAME
 rc.inet1.conf \- Slackware network configuration file.
 .SH DESCRIPTION
-.B rc.inet1.conf
-\. This file contains the configuration settings for network interfaces.
-It consists basically of a series of variable array definitions.
-Array elements with the same index number will all belong to the same
-network interface.
+This file contains the configuration settings for network interfaces.
+It consists of a series of shell variable array definitions.  The
+convention in this man page is to refer to these shell variable array
+definitions as "parameters".
 .LP
-By default, index number `0' is used for the configuration of interface
-.I eth0,
+Parameters with the same index number will all belong to the same network
+interface.  By default, index number `0' is used for the configuration of
+interface
+.IR eth0 ,
 index number `1' is used for
 .I eth1
-and so forth. The default interface name can be overruled by the use of
-the variable
+and so forth.  The default interface name can be overruled by the use of
+the parameter
 .B IFNAME.
 .LP
-This is what a typical section of the file looks like for a card that is
-configured to use DHCP, showing all array variables with the index number [0]:
+This is what a typical section of the file looks like for an interface that is
+configured to use DHCP, showing all parameters with the index number `0':
 .LP
 # Config information for eth0:
 .br
@@ -37,55 +38,61 @@ NETMASK[0]=""
 IPALIASES[0]=""
 .br
 USE_DHCP[0]="yes"
-.br
-DHCP_HOSTNAME[0]=""
-.br
-DHCP_TIMEOUT[0]=""
 .LP
-Alternatively, here is an example for a card that uses a static IP address and
-has a non-default name (
-.I ath0
+Alternatively, here is an example for an interface that uses a static
+IPv4 address, an autoconfigured IPv6 address, and a non-default name
+.RI ( ath0
 instead of
-.I eth1
-), as well as an additional IP address configured on the interface.
-The array index is [1] in this case.
+.IR eth1 ),
+as well as additional IPv4 and IPv6 alias addresses.
+The parameter index is `1' in this case.
 .LP
-# Config information for ath0 (using static IP address):
+# Config information for ath0:
 .br
 IFNAME[1]="ath0"
 .br
 IPADDR[1]="192.168.3.11"
 .br
-NETMASK[1]="255.255.255.0"
+NETMASK[1]="24"
 .br
 IPALIASES[1]="192.168.3.100/24"
 .br
 USE_DHCP[1]=""
 .br
-DHCP_HOSTNAME[1]=""
-.br
 GATEWAY="192.168.3.1"
 .br
+IP6ADDR[1]=""
+.br
+PREFIXLEN[1]=""
+.br
+IP6ALIASES[1]="fc00:51ac:15::100"
+.br
+USE_SLAAC[1]="yes"
+.br
+USE_DHCP6[1]=""
+.br
+GATEWAY6=""
+.br
 .SH EXAMPLE VIRTUAL INTERFACE CREATION AND SETUP
-Virtual interfaces are created before any address configuration or bridge 
+Virtual interfaces are created before any address configuration or bridge
 setup is done, so you may use these interfaces as IFNAME or BRNICS values.
 These can be tun or tap interfaces: adjust VIRTIFNAME and VIRTIFTYPE as
 needed.
 .LP
 # Virtual tap interface example
 .br
-#VIRTIFNAME[0]="tap0"
+VIRTIFNAME[0]="tap0"
 .br
-#VIRTIFTYPE[0]="tap"
+VIRTIFTYPE[0]="tap"
 .br
-#VIRTIFUSER[0]="root"
+VIRTIFUSER[0]="root"
 .br
-#VIRTIFGROUP[0]="root"
+VIRTIFGROUP[0]="root"
 .br
 .SH EXAMPLE BRIDGE CREATION AND SETUP
-Note the added "BRNICS" variable which contains a space-separated list
+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 array index can not be a duplicate of that defined for some
+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[0]="br0"
@@ -94,7 +101,7 @@ BRNICS[0]="eth0 eth1 tun0"
 .br
 IPADDR[0]="192.168.0.1"
 .br
-NETMASK[0]="255.255.255.0"
+NETMASK[0]="24"
 .br
 IPALIASES[0]=""
 .br
@@ -103,140 +110,208 @@ USE_DHCP[0]=""
 DHCP_HOSTNAME[0]=""
 .br
 .SH GENERAL PARAMETERS
-This is a list of network parameters you can set for any card (wired as well
-as wired).  The example section is for `eth0' by default, i.e.
-the array variables all have the array index [0]:
+This is a list of parameters you can set for any interface.
+The example section is for `eth0' by default, i.e.
+the parameters all have the array index `0':
 .LP
 # Config information for eth0:
 .TP 25
 IPADDR[0]=""
-# Set this value to an actual IP address if you want static IP
-address assignment
+# Set this parameter to an actual IPv4 address if you want static IPv4
+address assignment.  This is ignored if the USE_DHCP[0] parameter is set
+to "yes".
 .TP
 NETMASK[0]=""
-# With a static IP address, you are required to also set a netmask
-(255.255.255.0 is common)
+# The netmask for the IPv4 address set in IPADDR[0].  This should be in
+CIDR format with an optional leading /, e.g. "24" or "/16" - though the
+traditional dotted-quad format (e.g. "255.255.255.0") is still accepted.
+If this parameter is unset or empty, a netmask of "24" will be assumed.
 .TP
 IPALIASES[0]=""
-# Space separated list of additional IP addresses to bind to the
-interface after initial configuration is complete. An optional
-netmask may be specified after the IP in the form 1.2.3.4/24.  If no
-netmask is specified the default of /32 will be used. If USE_DHCP
-is set to `yes' then additional addresses will only be added if the
-dhcp client invocation is successful in obtaining a primary address.
+# Space separated list of additional IPv4 addresses to bind to the
+interface after initial configuration is complete.  An optional
+netmask may be specified after the address in the form "1.2.3.4/24".  If no
+netmask is specified the default of "/24" will be used.  If USE_DHCP[0]
+is set to `yes' then additional IPv4 addresses will only be added if the
+DHCP client invocation is successful in obtaining a primary IPv4 address.
 .TP
-USE_DHCP[0]="yes"
-# If set to "yes", we will run a DHCP client and have the IP address
-dynamically assigned
+USE_DHCP[0]=""
+# If set to "yes", we will run a DHCP client and have the IPv4 address
+dynamically assigned.
 .TP
-DHCP_HOSTNAME[0]="mybox"
-# Tell the DHCP server what hostname to register
+DHCP_HOSTNAME[0]=""
+# Tell the DHCP server what hostname to register, e.g. "darkstar".
 .TP
-DHCP_TIMEOUT[0]=15
+DHCP_TIMEOUT[0]=""
 # The default timeout for the DHCP client to wait for server response is
-30 seconds, but you might want a shorter wait.
+15 seconds, but you might want a shorter or longer wait.
+.TP
+IP6ADDR[0]=""
+# Set this value to an actual IPv6 address if you want static IPv6
+address assignment.  This is ignored if either the USE_DHCP6[0] or
+USE_SLAAC[0] parameters is set to "yes".
+.TP
+PREFIXLEN[0]=""
+# The prefix length for the IPv6 address set in IP6ADDR[0].  This should
+be in CIDR format with an optional leading /, e.g. "64" or "/48".  If this
+parameter is unset or empty, a prefix length of 64 will be assumed.
 .TP
-IFNAME[0]="usb0"
+IP6ALIASES[0]=""
+# Space separated list of additional IPv6 addresses to bind to the
+interface after initial configuration is complete.  An optional
+netmask may be specified after the address in the form
+"fe80::4a2c:8a9c:fe31:365a/64".  If no prefix length is specified the
+default of "/64" will be used.  If USE_DHCP6[0] is set to `yes' then
+additional IPv6 addresses will only be added if the DHCP client
+invocation is successful in obtaining a primary IPv6 address.
+.TP
+USE_SLAAC[0]=""
+# With this parameter set to "yes", the interface's IPv6 address will be
+configured via SLAAC (also known as autoconfig), even if RA indicates
+DHCP6 is available on the network.  If SLAAC is not available on the
+network, no IPv6 address will be assigned.  If this parameter is unset or
+empty, the interface will not be autoconfigured -- note that this is
+changed behaviour from Slackware 14.2 and earlier.
+.TP
+USE_DHCP6[0]=""
+# When set to "yes", use DHCP6 to configure the interface.  This will
+bring up the interface using DHCP6 if RA indicates DHCP6 support is
+available on the network, falling back to SLAAC (if available on the
+network), or will leave the interface unconfigured after a timeout.  When
+this parameter is set to "yes", USE_SLAAC[0] is ignored.
+.TP
+SLAAC_TIMEOUT[0]=""
+# The default timeout for autoconfiguration to wait for the interface
+to come up is 15 sec.  Increase the timeout if a longer period is required
+on your network.
+.TP
+USE_RA[0]=""
+# If set to "yes", accept Router Advertisements even when SLAAC is disabled
+on the interface.  This parameter should almost never be required.
+.TP
+IFNAME[0]=""
 # Use this to define configuration blocks for interfaces with non-standard
-names (this should be rare these days)
+names.
 .TP
-HWADDR[0]="00:01:23:45:67:89"
-# Overrule the card's hardware MAC address
+HWADDR[0]=""
+# Overrule the hardware MAC address (if supported by the network card) by
+setting a new value here, e.g. "00:01:23:45:67:89".
 .TP
 MTU[0]=""
 # The default MTU is 1500, but you might need 1360 when you use NAT'ed
-IPSec traffic. IPv6 will likely require smaller MTUs as well
+IPSec traffic.
 .TP
-PROMISCUOUS[0]="yes"
-# Set promiscuous mode on the interface.
+PROMISCUOUS[0]=""
+# If set to "yes", enable promiscuous mode on the interface.
 .TP
-DHCP_KEEPRESOLV[0]="yes"
+DHCP_KEEPRESOLV[0]=""
 # If you do
 .B not
-want `/etc/resolv.conf' overwritten by the DHCP client
+want
+.I /etc/resolv.conf
+overwritten by the DHCP client, set this parameter to "yes".
 .TP
-DHCP_KEEPNTP[0]="yes"
+DHCP_KEEPNTP[0]=""
 # If you do
 .B not
-want `/etc/ntp.conf' overwritten by the DHCP client
+want
+.I /etc/ntp.conf
+overwritten by the DHCP client, set this parameter to "yes".
 .TP
-DHCP_KEEPGW[0]="yes"
+DHCP_KEEPGW[0]=""
 # If you do
 .B not
-want the DHCP client to change your default gateway
+want the DHCP client to change your default gateway, set this parameter
+to "yes".
 .TP
-DHCP_DEBUG[0]="yes"
-# Make dhcpcd show verbose diagnostics
-.TP
-DHCP_NOIPV4LL[0]="yes"
-# Do not assign an
-.I `ipv4ll'
-address when a DHCP server is not found (ipv4 link-local addressing in the IP range 169.254.0.0/16 is also known as
+DHCP_NOIPV4LL[0]=""
+# When set to "yes", do
+.B not
+assign an IPv4 Link Local (IPv4LL) address when a DHCP server is not found.
+IPv4LL addresses are in the range 169.254.0.0/16, and is also known as
 .I `zeroconf'
-address assignment)
+address assignment.
 .TP
 DHCP_IPADDR[0]=""
-# Request a specific IP address from the DHCP server
+# Request a specific IPv4 address from the DHCP server.  Note that this is only
+a request - the DHCP server may offer a completely different address.
+.TP
+DHCP_DEBUG[0]="yes"
+# Make dhcpcd show verbose diagnostics.
 .SH WIRELESS PARAMETERS
-For wireless cards, several additional parameter definitions are available.
-All these parameters (or better, variables) start with the prefix
+For wireless interfaces, several additional parameter definitions are available.
+All these parameters start with the prefix
 .B WLAN_ .
 .LP
 .TP 25
-WLAN_ESSID[4]=DARKSTAR
-# Your Wireless Access Point's name
+WLAN_ESSID[4]=""
+# Your Wireless Access Point's name, e.g. "darkstar".
 .TP
-WLAN_MODE[4]=Managed
-# "Managed" mode for use with Access Points.  "Ad-Hoc" is for
-peer-to-peer connections.
+WLAN_MODE[4]=""
+# Set to "Managed" for use with Access Points.  For a peer-to-peer connection
+set this parameter to "Ad-Hoc".
 .TP
-WLAN_RATE[4]="54M auto"
-# The transmission rates you want the driver to try ("auto" means
-that bandwidth can be variable)
+WLAN_RATE[4]=""
+# The transmission rates you want the driver to try, e.g. "54M auto".
+("auto" means that bandwidth can be variable).
 .TP
-WLAN_CHANNEL[4]="auto"
-# The channel to which the Access Point is tuned ("auto" to let the
-driver find out the correct channel) 
+WLAN_CHANNEL[4]=""
+# The channel to which the Access Point is tuned, or "auto" to let the
+driver find the correct channel.
 .TP
-WLAN_KEY[4]="D5A31F54ACF0487C2D0B1C10D2"
-# Definition of a WEP key
+WLAN_KEY[4]=""
+# Definition of a WEP key, e.g. "D5A31F54ACF0487C2D0B1C10D2".
 .TP
-WLAN_IWPRIV[4]="set AuthMode=WPAPSK | set EncrypType=TKIP | set WPAPSK=the_64_character_key"
-# Some drivers require a private ioctl to be set through the iwpriv command.
+WLAN_IWPRIV[4]=""
+# Some drivers require a private ioctl to be set through the iwpriv command. e.g.
+"set AuthMode=WPAPSK | set EncrypType=TKIP | set WPAPSK=the_64_character_key".
 If more than one is required, you can place them in the
-.I IWPRIV
-parameter (separated with the pipe (|) character, see the example).
-.TP 
-WLAN_WPA[4]="wpa_supplicant"
-# Run wpa_supplicant for WPA support
+.I WLAN_IWPRIV
+parameter separated with the pipe (|) character.  Ssee the example.
+.TP
+WLAN_WPA[4]=""
+# The name of the application that should be executed for WPA support.  This
+will usually be "wpa_supplicant".
 .TP
-WLAN_WPADRIVER[4]="ndiswrapper"
-# Tell wpa_supplicant to specifically use the ndiswrapper driver.
-If you leave this empty the `wext' driver is used by default; most
-modern wireless drivers use 'wext'.
+WLAN_WPADRIVER[4]=""
+# Tell wpa_supplicant to specifically use this driver, e.g. "ndiswrapper".
+If you leave this empty the "wext" driver is used by default - most modern
+wireless drivers use wext.
 .TP
 WLAN_WPAWAIT[4]=30
 # In case it takes long for the WPA association to finish, you can
-increase the wait time before rc.wireless decides that association
-failed (defaults to 10 seconds)
+use this parameter to increase the wait time before rc.wireless decides
+that association failed.  The default is 10 seconds.
+.SH DEFAULT GATEWAY PARAMETERS
+These parameters, to set an IPv4 and IPv6 default gateway, are not
+interface-specific and must not have an index number.
+.TP 25
+GATEWAY=""
+# The IPv4 default gateway, e.g. "192.168.1.1".  This parameter should be left
+empty when interfaces are configured via DHCP.
+.TP
+GATEWAY6=""
+# The IPv6 default gateway, e.g. "fe80::1".  This parameter should be left
+empty when interfaces are configured via DHCP6 or RA.
 .SH FILES
 .TP 25
 .I /etc/rc.d/rc.inet1
-network configuration script
+network configuration script.
 .TP
 .I /etc/rc.d/rc.inet1.conf
-configuration parameter file (is being read by rc.inet1 and rc.wireless)
+configuration parameter file (read by rc.inet1 and rc.wireless).
 .TP
 .I /etc/rc.d/rc.wireless
-wireless configuration script
+wireless configuration script.
 .TP
 .I /etc/rc.d/rc.wireless.conf
-configuration parameter file (
-.B deprecated
-)
+wireless configuration parameter file
+.B (deprecated)
+\.
 .SH CAVEATS
-The network interface definitions are stored in variable
-.I arrays.
+The network interface definitions are stored in shell variable
+.I arrays
+\.
 The bash shell has no facilities to retrieve the largest array index used.
 Therefore, the
 .I rc.inet1
@@ -252,8 +327,11 @@ and change the value `6' in the line
 to the number of network interfaces you wish to use.
 .SH AUTHORS
 Patrick J. Volkerding <volkerdi@slackware.com>
+.br
 Eric Hameleers <alien@slackware.com>
+.br
 Robby Workman <rworkman@slackware.com>
+.br
 Darren 'Tadgy' Austin <darren@afterdark.org.uk>
 .SH "SEE ALSO"
 .BR rc.inet1(8)