Merge pull request 'version' (#10) from rrq/rrqnet:suites/unstable into suites/unstable

[rrq/rrqnet.git] / rrqnet.8.adoc

diff --git a/rrqnet.8.adoc b/rrqnet.8.adoc
index e3dc8e3489be49c0e68b24e5cc0bc7bd1914e342..ccc35c10107b982bc6d9ab8cdc70e5a4a98e8f8a 100644 (file)
--- a/rrqnet.8.adoc
+++ b/rrqnet.8.adoc
@@ -23,9 +23,9 @@ the remotes it may communicate with.
 OPTIONS
 -------
 
-Note that any options must be given in the fixed order:
+Note that any options must be given or omitted in the fixed order:
 
-    [-v] [-4] [-B n] [-T n] [-m mcast] [-t tap]
+  [-v] [-tpg] [-4] [-B n] [-T n] [-m mcast] [-t tap] [-S source]
 
 *-v*::
 
@@ -33,6 +33,13 @@ This tells *rrqnet* to log its operation on +stderr+. Use *-vv* to
 also see logs about connections and messaging, or *-vvv* for *rrqnet*
 to be insanely verbose on +stderr+ about virtually everything.
 
+*-tpg*::
+
+This enables a special UDP transport quirk where *rrqnet* expands any
+packet in the range [1461,1477] bytes to be of 1478 bytes instead. It
+is a work-around for an observed problem in a NAT traversal case for
+certain packet sizes in that range.
+
 *-4*::
 
 This directs *rrqnet* to use an ipv4-only socket for its UDP. By
@@ -72,6 +79,14 @@ networking channel in a format compatible with VDE plugs.
 * Without a *-t* argument, *rrqnet* will operate merely as a virtual
 cable switch among its channels.
 
+*-S* _source_::
+
+This tells which source address to use for outgoing UDP messages.
+
+port::
+
+This non-optional argument tells which UDP port to use.
+
 _address-block[:port][=cryptfile]_ [ *-i* _mac_[,_mac_]* ]::
 
 Remotes are declared as +ipv4+ or +ipv6+ network address blocks