Browse Source

add natdiscovery to make-man.sh and README.turnutils

Mészáros Mihály 9 years ago
parent
commit
7b2575fe25
2 changed files with 46 additions and 4 deletions
  1. 42 1
      README.turnutils
  2. 4 3
      make-man.sh

+ 42 - 1
README.turnutils

@@ -25,7 +25,6 @@ The compiled binary image of this program is located in bin/ subdirectory.
 STUN/TURN protocol implementation. This utility is used only for the compilation
 check procedure, it is not copied to the installation destination.
 
-
 In the "examples/scripts" subdirectory, you will find the examples of command lines to be used 
 to run the programs. The scripts are meant to be run from examples/ subdirectory, for example:
 
@@ -33,6 +32,11 @@ $ cd examples
 
 $ ./scripts/secure_relay.sh
 
+5.	turnutils_natdiscovery: a utility that provides NAT behavior discovery 
+according RFC5780. This utility discovers the actual NAT Mapping and Filtering 
+behavior. Be aweare that at least two different listening IP addresses should 
+be configured to be able to work properly!
+
 =====================================
     
   NAME
@@ -230,6 +234,43 @@ Usage:
 
 $ turnutils_rfc5769check
 
+=====================================
+
+  NAME
+
+turnutils_natdiscovery - a utility that discovers NAT mapping and filtering 
+behavior according RFC5780.
+
+  SYNOPSIS
+
+$ turnutils_natdiscovery [options] <STUN-Server-FQDN-or-IP-address>
+
+  DESCRIPTION
+
+turnutils_natdiscovery discovers the NAT Mapping and Filtering behavior, to 
+determine if that NAT is currently using Endpoint-Independent, 
+Address-Dependent, or Address and Port-Dependent Mapping and/or to determine if 
+that NAT is currently using Endpoint-Independent, Address-Dependent, or Address 
+and Port-Dependent Filtering. 
+
+Use either -m and/or -f flag to discover NAT Mapping and/or Filtering.
+
+Flags:
+
+-m  NAT mapping behavior discovery
+
+-f  NAT filtering behavior discovery
+
+Options with required values:
+
+-p  STUN server port (Default: 3478)
+
+-L  Local address to use (optional)
+
+Usage:
+
+$ turnutils_natdiscovery -m -f stun.example.com
+
 ===================================
  
 DOCS

+ 4 - 3
make-man.sh

@@ -2,14 +2,15 @@
 
 rm -rf man/man1/*
 
-txt2man -s 1 -t TURN -I turnserver -I turnadmin -I turnutils -I turnutils_uclient -I turnutils_stunclient -I turnutils_rfc5769check -I turnutils_peer -B "TURN Server" README.turnserver | sed -e 's/-/\\-/g' > man/man1/turnserver.1
+txt2man -s 1 -t TURN -I turnserver -I turnadmin -I turnutils -I turnutils_uclient -I turnutils_stunclient -I turnutils_rfc5769check -I turnutils_peer -I turnutils_natdiscovery -B "TURN Server" README.turnserver | sed -e 's/-/\\-/g' > man/man1/turnserver.1
 
-txt2man -s 1 -t TURN -I turnserver -I turnadmin -I turnutils -I turnutils_uclient -I turnutils_stunclient -I turnutils_rfc5769check -I turnutils_peer -B "TURN Server" README.turnadmin | sed -e 's/-/\\-/g'> man/man1/turnadmin.1
+txt2man -s 1 -t TURN -I turnserver -I turnadmin -I turnutils -I turnutils_uclient -I turnutils_stunclient -I turnutils_rfc5769check -I turnutils_peer -I turnutils_natdiscovery -B "TURN Server" README.turnadmin | sed -e 's/-/\\-/g'> man/man1/turnadmin.1
 
-txt2man -s 1 -t TURN -I turnserver -I turnadmin -I turnutils -I turnutils_uclient -I turnutils_stunclient -I turnutils_rfc5769check -I turnutils_peer -B "TURN Server" README.turnutils | sed -e 's/-/\\-/g' > man/man1/turnutils.1
+txt2man -s 1 -t TURN -I turnserver -I turnadmin -I turnutils -I turnutils_uclient -I turnutils_stunclient -I turnutils_rfc5769check -I turnutils_peer -I turnutils_natdiscovery -B "TURN Server" README.turnutils | sed -e 's/-/\\-/g' > man/man1/turnutils.1
 
 cd man/man1; ln -s turnutils.1 turnutils_uclient.1;cd ../..
 cd man/man1; ln -s turnutils.1 turnutils_peer.1;cd ../..
 cd man/man1; ln -s turnutils.1 turnutils_stunclient.1;cd ../..
+cd man/man1; ln -s turnutils.1 turnutils_natdiscovery.1;cd ../..
 cd man/man1; ln -s turnserver.1 coturn.1;cd ../..