summaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2016-12-25 00:45:42 +0100
committerChristian Grothoff <christian@grothoff.org>2016-12-25 00:45:42 +0100
commit0bd19eb0fe8f039a0a90a742b2abcc917ba17e35 (patch)
tree56625363eae56dad23c666ac65c1ab451ba962b3 /doc/man
parent21fbcd668581c72ebb7bdc01908a4cdb11ad3d25 (diff)
start to list relevant cases in man page, document current limitations
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/gnunet-nat.139
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1
index 14b8e1509..484537eb0 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 <gnunet\-developers@gnu.org>