From: Ralph Ronnquist <ralph.ronnquist@gmail.com>
Date: Mon, 5 Oct 2020 13:03:19 +0000 (+1100)
Subject: editorial
X-Git-Tag: 0.3~1
X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;h=9e5edbcfd86721168d8f3dcde603d42323e875e1;p=rrq%2Frrqnet.git

editorial
---

diff --git a/rrqnet-ifupdown.sh.8.adoc b/rrqnet-ifupdown.sh.8.adoc
index bcca6a0..1b83f84 100644
--- a/rrqnet-ifupdown.sh.8.adoc
+++ b/rrqnet-ifupdown.sh.8.adoc
@@ -5,20 +5,20 @@ rrqnet-ifupdown.sh(8)
 
 NAME
 ----
-rrqnet-ifupdown.sh - an ifupdown script to uphold *rrqnet* cables by
-configuration in +/etc/network/interfaces+.
+rrqnet-ifupdown.sh - an ifupdown script to uphold rrqnet cables with
+iup and ifdown
 
 SYNOPSIS
 --------
-/etc/network/if-post-down.d/rrqnet -> /etc/rrqnet/ifupdown.sh
-/etc/network/if-pre-up.d/rrqnet -> /etc/rrqnet/ifupdown.sh
+ ln -s /etc/rrqnet/ifupdown.sh /etc/network/if-post-down.d/rrqnet
+ ln -s /etc/rrqnet/ifupdown.sh /etc/network/if-pre-up.d/rrqnet
 
 DESCRIPTION
 -----------
 
 */etc/rrqnet/ifupdown.sh* is a utility script for upholding +rrqnet+
 virtual cables via +/etc/network/interfaces+. The script is set up
-both as "pre-up" and "post-down" scripts for handling the associated
+as both "pre-up" and "post-down" scripts for handling the associated
 +rrqnet+ configurations to bring up and tear down virtual cable plugs
 over +tap+ interfaces.
 
@@ -84,7 +84,9 @@ for UDP tunneling through host +111.222.333.444+, port +3636+, where
 the local +tap+, named +mynet0+, has ipv4 address +10.0.0.2+. The
 +rrqnet_port+ option is understood to identify the stanza as a virtual
 cabling set up which then is duly handled by +rrqnet-ifupdown.sh+, and
-all its options are used for declaring that tunneling.
+all its options are used for declaring that tunneling. The
++rrqnet_options+ in the example tells the +rrqnet+ process to use an
+ipv4-only socket.
 
 NOTES
 -----
@@ -104,10 +106,10 @@ configured with that much smaller MTU than the real traffic.
 SEE ALSO
 --------
 
-*interfaces(5)* - network interface configuration for ifup and ifdown
-*rrqnet(8)* - packet tunneling over UDP, multiple channels
-*brctl(8)* - ethernet bridge administration
-*daemon(1)* - turns other processes into daemons
+ *interfaces(5)* - network interface configuration for ifup and ifdown
+ *rrqnet(8)* - packet tunneling over UDP, multiple channels
+ *brctl(8)* - ethernet bridge administration
+ *daemon(1)* - turns other processes into daemons
 
 AUTHOR
 ------