doc/man/gnunet-nat.1

   1 .TH GNUNET\-NAT 1 "October 26, 2018" "GNUnet"
   2 .SH NAME
   3 gnunet\-nat \- interact with the NAT service
   4 .SH SYNOPSIS
   5 .B gnunet\-nat
   6 .RI [ options ]
   7 .SH DESCRIPTION
   8 This tool allows testing various NAT traversal functions, as well as
   9 attempting auto\-configuration.
  10 .SH OPTIONS
  11 .IP "\-b ADDRESS,  \-\-bind=ADDRESS"
  12 Assume that the service is (locally) bound to ADDRESS.
  13 .IP "\-c FILENAME,  \-\-config=FILENAME"
  14 Use the configuration file FILENAME.
  15 .IP "\-e ADDRESS,  \-\-external=ADDRESS"
  16 Assume that ADDRESS is the globally visible address of the peer.
  17 .IP "\-i ADDRESS,  \-\-in=ADDRESS"
  18 Assuming we are listening at ADDRESS for connection reversal requests.
  19 .IP "\-r ADDRESS,  \-\-remote=ADDRESS"
  20 Ask the peer at ADDRESS for connection reversal, using the local
  21 address for the target address of the reversal.
  22 .IP "\-S NAME,  \-\-section=NAME"
  23 Name of section in configuration file to use for additional options.
  24 .IP "\-s,  \-\-stun"
  25 Enable processing of STUN requests.
  26 Will try to read UDP packets from the bind address and handle the
  27 packets if they are STUN packets.
  28 Will only work with UDP.
  29 .IP "\-t,  \-\-tcp"
  30 Use TCP.
  31 .IP "\-u,  \-\-udp"
  32 Use UDP.
  33 .IP "\-W,  \-\-watch"
  34 Watch for connection reversal requests.
  35 .SH EXAMPLES
  36 .PP
  37 \fBBasic examples\fR
  38 .TP
  39 # gnunet-nat -i 0.0.0.0:8080 -u
  40 We are bound to "0.0.0.0:8080" on UDP and want to obtain all
  41 applicable IP addresses.
  42 .TP
  43 # gnunet-nat -i '[::0]':8080 -t
  44 We are bound to "::0" on port 8080 on TCP and want to obtain all
  45 applicable IP addresses.
  46 .TP
  47 # gnunet-nat -i 127.0.0.1:8080 -u
  48 We are bound to "127.0.0.1:8080" on UDP and want to obtain all
  49 applicable IP addresses:
  50 .PP
  51 \fBICMP-based NAT traversal:\fR
  52 .TP
  53 # gnunet-nat -Wt -i 192.168.178.12:8080
  54 Watch for connection reversal request (you must be bound to NAT range
  55 or to wildcard, 0.0.0.0), only works for IPv4:
  56 .TP
  57 # gnunet-nat -t -r 1.2.3.4:8080 -i 2.3.4.5:8080
  58 Initiate connection reversal request from peer at external IPv4
  59 address 1.2.3.4, while we are running ourselves at 2.3.4.5:8080 (must
  60 use IPv4 addresses):
  61 .TP
  62 # gnunet-nat -t -r 1.2.3.4:8080 -i 0.0.0.0:8080
  63 Initiate connection reversal request from peer at external IPv4
  64 address 1.2.3.4, and let the kernel fill in whatever IPv4 address we
  65 happen to have:
  66 .PP
  67 \fBManual hole punching:\fR
  68 .TP
  69 # gnunet-nat -t -p AUTO:8080
  70 Assume manually punched NAT, but determine external IP automatically:
  71 .PP
  72 \fBSTUN-based XXX:\fR
  73 .TP
  74 # gnunet-nat FIXME -s
  75 XXX
  76 .SH BUGS
  77 Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
  78 electronic mail to <gnunet\-developers@gnu.org>
  79 .SH SEE ALSO
  80 gnunet\-transport(1)
  81 The full documentation for
  82 .B gnunet
  83 is maintained as a Texinfo manual.  If the
  84 .B info
  85 and
  86 .B gnunet
  87 programs are properly installed at your site, the command
  88 .IP
  89 .B info gnunet
  90 .PP
  91 should give you access to the complete handbook,
  92 .IP
  93 .B info gnunet-c-tutorial
  94 .PP
  95 will give you access to a tutorial for developers.
  96 .PP
  97 Depending on your installation, this information is also
  98 available in
  99 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).