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