[GNUnet-SVN] [gnunet] branch master updated: start to list relevant cases in man page, document current limitations

[gnunet]

This is an automated email from the git hooks/post-receive script.

grothoff pushed a commit to branch master
in repository gnunet.

The following commit(s) were added to refs/heads/master by this push:
     new 0bd19eb  start to list relevant cases in man page, document current 
limitations
0bd19eb is described below

commit 0bd19eb0fe8f039a0a90a742b2abcc917ba17e35
Author: Christian Grothoff <address@hidden>
AuthorDate: Sun Dec 25 00:45:42 2016 +0100

    start to list relevant cases in man page, document current limitations
---
 doc/man/gnunet-nat.1 | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1
index 14b8e15..484537e 100644
--- a/doc/man/gnunet-nat.1
+++ b/doc/man/gnunet-nat.1
@@ -62,6 +62,45 @@ Write configuration to configuration file, useful in 
combination with autoconfig
 .IP "\-W,  \-\-watch"
 Watch for connection reversal requests.  
 
+.SH EXAMPLES
+.PP
+
+\fBBasic examples\fR
+
+We are bound to "0.0.0.0:8080" on UDP and want to obtain all applicable IP 
addresses (BUG: sometimes upnpc fails to create mapping, cause unclear):
+
+  # gnunet-nat -i 0.0.0.0:8080 -u
+
+We are bound to "::0" on port 8080 on TCP and want to obtain all applicable IP 
addresses:
+
+  # gnunet-nat -i '[::0]':8080 -t
+
+We are bound to "127.0.0.1:8080" on UDP and want to obtain all applicable IP 
addresses (BUG: currently fails, also gives IPs from other interfaces in 
output!):
+
+  # gnunet-nat -i 127.0.0.1:8080 -u
+
+\fBICMP-based NAT traversal:\fR
+
+Watch for connection reversal request:
+
+  # gnunet-nat FIXME
+
+Initiate connection reversal request:
+
+  # gnunet-nat FIXME
+
+\fBSTUN-based XXX:\fR
+
+XXX:
+
+  # gnunet-nat FIXME -s
+
+\fBAutomatic configuration:\fR
+
+Probe and write result to configuration:
+
+  # gnunet-nat -aw
+  
 
 .SH BUGS
 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 
electronic mail to <address@hidden>

-- 
To stop receiving notification emails like this one, please contact
address@hidden