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