make man page links work got the git store

[rrq/rrqnet.git] / rrqnet-ifupdown.sh.8.adoc

diff --git a/rrqnet-ifupdown.sh.8.adoc b/rrqnet-ifupdown.sh.8.adoc
index 39fc4d04decfbe87be10119e407969a90cb442a1..536cbc7a4cdd3fa2bbd479a1ce024b734bbf58a5 100644 (file)
--- a/rrqnet-ifupdown.sh.8.adoc
+++ b/rrqnet-ifupdown.sh.8.adoc
@@ -6,12 +6,13 @@ rrqnet-ifupdown.sh(8)
 NAME
 ----
 rrqnet-ifupdown.sh - script for managing rrqnet virtual cables with
-iup and ifdown
+ifup and ifdown
 
 SYNOPSIS
 --------
- 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
+ for HOOKD in down post-down pre-up up ; do
+     ln -s /etc/rrqnet/ifupdown.sh /etc/network/if-$HOOKD.d/rrqnet
+ done
 
 DESCRIPTION
 -----------
@@ -45,10 +46,10 @@ 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.
 
-*rrqnet_renice* _nice_::
+*rrqnet_nice* _nice_::
 
 This IFACE option is used for adjusting the +rrqnet+ process
-scheduling priority. Refer the +renice+ man page for full details.
+scheduling priority. Refer the +nice+ man page for full details.
 
 *rrqnet_remote* _remote_::
 
@@ -78,6 +79,20 @@ made a "port" of the nominated preceding +bridge+ interface. The same
 things is achieved by including the +tap+ in the +bridge_ports+ list
 of the bridge, provided that the +tap+ is created before the bridge.
 
+*rrqnet_dhcp* _method args_::
+
+This IFACE option is used for attaching a DHCP client to the
+interface. The +method+ identifies the DHCP client method, and
+currently only the +dhclient+ method is defined, which is run as
+follows:
++
+----
+dhclient -pf $PIDFILE $DHCPARGS -lf $LEASES $IFACE
+----
++
+The given +args+ if non-empty replaces +$DHCPARGS+, which by default
+are "-4 -cf /dev/null". Refer to the +dhclient+ man page for details.
+
 EXAMPLES
 --------
 
@@ -117,14 +132,20 @@ tunnel traffic. The tunnel packets will have a UDP header in addition
 to the orignal packet, which means that packets grow with some 28/48
 (ipv4/6) bytes.
 
+
 SEE ALSO
 --------
 
- *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
+
+*dhclient(8)* - Dynamic Host Configuration Protocol Client
+
+*interfaces(5)* - network interface configuration for ifup and ifdown
+
+*rrqnet(8)* - packet tunneling over UDP, multiple channels
+
 AUTHOR
 ------
 Ralph Rönnquist <ralph.ronnquist@gmail.com>