diff options
author | ng0 <ng0@n0.is> | 2019-04-20 13:22:40 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-04-20 13:22:40 +0000 |
commit | e704e562dcad7262c34da0212fa4a612c5f62b5e (patch) | |
tree | f55b547a0405e71eea01197a8ce188eb3a709d76 /doc/man/gnunet-nat.1 | |
parent | e30ddefa3bc2ac45c0fd4d0450ffecb7449ec0d4 (diff) | |
download | gnunet-e704e562dcad7262c34da0212fa4a612c5f62b5e.tar.gz gnunet-e704e562dcad7262c34da0212fa4a612c5f62b5e.zip |
gnunet-nat.1
Diffstat (limited to 'doc/man/gnunet-nat.1')
-rw-r--r-- | doc/man/gnunet-nat.1 | 202 |
1 files changed, 117 insertions, 85 deletions
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1 index fe9272ea5..1a99d60fe 100644 --- a/doc/man/gnunet-nat.1 +++ b/doc/man/gnunet-nat.1 | |||
@@ -1,99 +1,131 @@ | |||
1 | .TH GNUNET\-NAT 1 "October 26, 2018" "GNUnet" | 1 | .\" This file is part of GNUnet. |
2 | .SH NAME | 2 | .\" Copyright (C) 2001-2019 GNUnet e.V. |
3 | gnunet\-nat \- interact with the NAT service | 3 | .\" |
4 | .SH SYNOPSIS | 4 | .\" Permission is granted to copy, distribute and/or modify this document |
5 | .B gnunet\-nat | 5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or |
6 | .RI [ options ] | 6 | .\" any later version published by the Free Software Foundation; with no |
7 | .SH DESCRIPTION | 7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A |
8 | This tool allows testing various NAT traversal functions, as well as | 8 | .\" copy of the license is included in the file |
9 | attempting auto\-configuration. | 9 | .\" ``FDL-1.3''. |
10 | .SH OPTIONS | 10 | .\" |
11 | .IP "\-b ADDRESS, \-\-bind=ADDRESS" | 11 | .\" A copy of the license is also available from the Free Software |
12 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}. | ||
13 | .\" | ||
14 | .\" Alternately, this document is also available under the General | ||
15 | .\" Public License, version 3 or later, as published by the Free Software | ||
16 | .\" Foundation. A copy of the license is included in the file | ||
17 | .\" ``GPL3''. | ||
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}. | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
24 | .Dd October 26, 2018 | ||
25 | .Dt GNUNET-NAT 1 | ||
26 | .Os | ||
27 | .Sh NAME | ||
28 | .Nm gnunet-nat | ||
29 | .Nd | ||
30 | interact with the NAT service | ||
31 | .Sh SYNOPSIS | ||
32 | .Nm | ||
33 | .Op Fl b Ar ADDRESS | Fl \-bind= Ns Ar ADDRESS | ||
34 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
35 | .Op Fl e Ar ADDRESS | Fl \-external= Ns Ar ADDRESS | ||
36 | .Op Fl i Ar ADDRESS | Fl \-in= Ns Ar ADDRESS | ||
37 | .Op Fl r Ar ADDRESS | Fl \-remote= Ns Ar ADDRESS | ||
38 | .Op Fl S Ar NAME | Fl \-section= Ns Ar NAME | ||
39 | .Op Fl s | \-stun | ||
40 | .Op Fl t | \-tcp | ||
41 | .Op Fl u | \-udp | ||
42 | .Op Fl W | \-watch | ||
43 | .Sh DESCRIPTION | ||
44 | This tool allows testing various NAT traversal functions, as well as attempting auto-configuration. | ||
45 | .Sh OPTIONS | ||
46 | .Bl -tag -width Ds | ||
47 | .It Fl b Ar ADDRESS | Fl \-bind= Ns Ar ADDRESS | ||
12 | Assume that the service is (locally) bound to ADDRESS. | 48 | Assume that the service is (locally) bound to ADDRESS. |
13 | .IP "\-c FILENAME, \-\-config=FILENAME" | 49 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
14 | Use the configuration file FILENAME. | 50 | Use the configuration file FILENAME. |
15 | .IP "\-e ADDRESS, \-\-external=ADDRESS" | 51 | .It Fl e Ar ADDRESS | Fl \-external= Ns Ar ADDRESS |
16 | Assume that ADDRESS is the globally visible address of the peer. | 52 | Assume that ADDRESS is the globally visible address of the peer. |
17 | .IP "\-i ADDRESS, \-\-in=ADDRESS" | 53 | .It Fl i Ar ADDRESS | Fl \-in= Ns Ar ADDRESS |
18 | Assuming we are listening at ADDRESS for connection reversal requests. | 54 | Assuming we are listening at ADDRESS for connection reversal requests. |
19 | .IP "\-r ADDRESS, \-\-remote=ADDRESS" | 55 | .It Fl r Ar ADDRESS | Fl \-remote= Ns Ar ADDRESS |
20 | Ask the peer at ADDRESS for connection reversal, using the local | 56 | Ask the peer at ADDRESS for connection reversal, using the local address for the target address of the reversal. |
21 | address for the target address of the reversal. | 57 | .It Fl S Ar NAME | Fl \-section= Ns Ar NAME |
22 | .IP "\-S NAME, \-\-section=NAME" | ||
23 | Name of section in configuration file to use for additional options. | 58 | Name of section in configuration file to use for additional options. |
24 | .IP "\-s, \-\-stun" | 59 | .It Fl s | \-stun |
25 | Enable processing of STUN requests. | 60 | Enable processing of STUN requests. |
26 | Will try to read UDP packets from the bind address and handle the | 61 | Will try to read UDP packets from the bind address and handle the packets if they are STUN packets. |
27 | packets if they are STUN packets. | ||
28 | Will only work with UDP. | 62 | Will only work with UDP. |
29 | .IP "\-t, \-\-tcp" | 63 | .It Fl t | \-tcp |
30 | Use TCP. | 64 | Use TCP. |
31 | .IP "\-u, \-\-udp" | 65 | .It Fl u | \-udp |
32 | Use UDP. | 66 | Use UDP. |
33 | .IP "\-W, \-\-watch" | 67 | .It Fl W | \-watch |
34 | Watch for connection reversal requests. | 68 | Watch for connection reversal requests. |
35 | .SH EXAMPLES | 69 | .El |
36 | .PP | 70 | .Sh EXAMPLES |
37 | \fBBasic examples\fR | 71 | .Ss Basic examples |
38 | .TP | 72 | .Pp |
39 | # gnunet-nat -i 0.0.0.0:8080 -u | 73 | .Dl # 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 | 74 | .Pp |
41 | applicable IP addresses. | 75 | We are bound to "0.0.0.0:8080" on UDP and want to obtain all applicable IP addresses. |
42 | .TP | 76 | .Pp |
43 | # gnunet-nat -i '[::0]':8080 -t | 77 | .Dl # gnunet-nat -i '[::0]':8080 -t |
44 | We are bound to "::0" on port 8080 on TCP and want to obtain all | 78 | .Pp |
45 | applicable IP addresses. | 79 | We are bound to "::0" on port 8080 on TCP and want to obtain all applicable IP addresses. |
46 | .TP | 80 | .Pp |
47 | # gnunet-nat -i 127.0.0.1:8080 -u | 81 | .Dl # 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 | 82 | .Pp |
49 | applicable IP addresses: | 83 | We are bound to "127.0.0.1:8080" on UDP and want to obtain all applicable IP addresses: |
50 | .PP | 84 | .Ss ICMP-based NAT traversal |
51 | \fBICMP-based NAT traversal:\fR | 85 | .Pp |
52 | .TP | 86 | .Dl # gnunet-nat -Wt -i 192.168.178.12:8080 |
53 | # gnunet-nat -Wt -i 192.168.178.12:8080 | 87 | .Pp |
54 | Watch for connection reversal request (you must be bound to NAT range | 88 | Watch for connection reversal request (you must be bound to NAT range or to wildcard, 0.0.0.0), only works for IPv4: |
55 | or to wildcard, 0.0.0.0), only works for IPv4: | 89 | .Pp |
56 | .TP | 90 | .Dl # gnunet-nat -t -r 1.2.3.4:8080 -i 2.3.4.5:8080 |
57 | # gnunet-nat -t -r 1.2.3.4:8080 -i 2.3.4.5:8080 | 91 | .Pp Initiate connection reversal request from peer at external IPv4 address 1.2.3.4, while we are running ourselves at 2.3.4.5:8080 (must use IPv4 addresses): |
58 | Initiate connection reversal request from peer at external IPv4 | 92 | .Pp |
59 | address 1.2.3.4, while we are running ourselves at 2.3.4.5:8080 (must | 93 | .Dl # gnunet-nat -t -r 1.2.3.4:8080 -i 0.0.0.0:8080 |
60 | use IPv4 addresses): | 94 | .Pp |
61 | .TP | 95 | Initiate connection reversal request from peer at external IPv4 address 1.2.3.4, and let the kernel fill in whatever IPv4 address we happen to have: |
62 | # gnunet-nat -t -r 1.2.3.4:8080 -i 0.0.0.0:8080 | 96 | .Ss Manual hole punching |
63 | Initiate connection reversal request from peer at external IPv4 | 97 | .Pp |
64 | address 1.2.3.4, and let the kernel fill in whatever IPv4 address we | 98 | .Dl # gnunet-nat -t -p AUTO:8080 |
65 | happen to have: | 99 | .Pp |
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: | 100 | Assume manually punched NAT, but determine external IP automatically: |
71 | .PP | 101 | .Ss STUN-based XXX: |
72 | \fBSTUN-based XXX:\fR | 102 | .Pp |
73 | .TP | 103 | .Dl # gnunet-nat FIXME -s |
74 | # gnunet-nat FIXME -s | 104 | .Pp |
75 | XXX | 105 | XXX |
76 | .SH BUGS | 106 | .Sh SEE ALSO |
77 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | 107 | .Xr gnunet-transport 1 |
78 | electronic mail to <gnunet\-developers@gnu.org> | 108 | .sp |
79 | .SH SEE ALSO | 109 | The full documentation for gnunet is maintained as a Texinfo manual. |
80 | gnunet\-transport(1) | 110 | If the |
81 | The full documentation for | 111 | .Xr info 1 |
82 | .B gnunet | 112 | and gnunet programs are properly installed at your site, the command |
83 | is maintained as a Texinfo manual. If the | 113 | .Pp |
84 | .B info | 114 | .Dl info gnunet |
85 | and | 115 | .Pp |
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, | 116 | should give you access to the complete handbook, |
92 | .IP | 117 | .Pp |
93 | .B info gnunet-c-tutorial | 118 | .Dl info gnunet-c-tutorial |
94 | .PP | 119 | .Pp |
95 | will give you access to a tutorial for developers. | 120 | will give you access to a tutorial for developers. |
96 | .PP | 121 | .sp |
97 | Depending on your installation, this information is also | 122 | Depending on your installation, this information is also available in |
98 | available in | 123 | .Xr gnunet 7 and |
99 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 124 | .Xr gnunet-c-tutorial 7 . |
125 | .\".Sh HISTORY | ||
126 | .\".Sh AUTHORS | ||
127 | .Sh BUGS | ||
128 | Report bugs by using | ||
129 | .Lk https://bugs.gnunet.org | ||
130 | or by sending electronic mail to | ||
131 | .Aq Mt gnunet-developers@gnu.org . | ||