allow iface block without actual interface
[rrq/rrqnet.git] / rrqnet-ifupdown.sh.8.adoc
index 787b2944a26266a295e22d71f5753a40d78fd54e..90a502c1360c608cc1d2eef52382cf4463204cf0 100644 (file)
@@ -33,16 +33,19 @@ addresses.
 This script handles the special purpose "option codes" for the IFACE
 blocks that are used for declaring the +rrqnet+ daemon configuration
 to for the +tap+ interface for its virtual cabling. I.e., the IFACE
-stanza is made for the tap interface and it includes one or more of
+block is made for the tap interface and it includes one or more of
 these +rrqnet+ options.
 
 The list of IFACE options for +rrqnet+ are:
 
-*rrqnet_port* _port_::
+*rrqnet_port* [ notap ] _port_::
 
-This IFACE option is required both as way of marking that the stanza
-is for an +rrqnet+ virtual cable +tap+, and to declare which UDP port
-the +rrqnet+ daemon should listen on for incoming cabling.
+This IFACE option is required both as way of marking that the
+configuration block is for an +rrqnet+ virtual cable +tap+, and to
+declare which UDP port the +rrqnet+ daemon should listen on for
+incoming cabling. The port number may be preceded by +notap+ to
+indcate that this +rrqnet+ should not have an actual tap interface on
+the host but rather only serve to interconnect remote connections.
 
 *rrqnet_nice* _nice_::
 
@@ -109,8 +112,8 @@ iface mynet0 inet static
 The above example declares a virtual cable plug for UDP port +3636+
 tunneling through host +111.222.333.444+ port +3636+ where the local
 +tap+ +mynet0+ has ipv4 address +10.0.0.2+. The +rrqnet_port+ option
-marks the stanza as an ++rrqnet+ virtual cabling set up which then is
-duly handled by +rrqnet-ifupdown.sh+.
+marks the IFACE block as an ++rrqnet+ virtual cabling set up which
+then is duly handled by +rrqnet-ifupdown.sh+.
 
 The +rrqnet_options+ in the example tells the +rrqnet+ process to use
 an ipv4-only socket, 10 packet buffers and a single delivery thread,