diff options
author | Nils Gillmann <ng0@n0.is> | 2018-05-04 19:57:38 +0000 |
---|---|---|
committer | Nils Gillmann <ng0@n0.is> | 2018-05-04 19:57:38 +0000 |
commit | c3c9fef22fa6e4657c3fc862bad365b440ee2305 (patch) | |
tree | a19406f086fd3a1c059c66b6916b78148f83d5bb /doc/man/gnunet-nat.1 | |
parent | 295384b197a85ebfb1cb7bbe5d1b02af4c40d342 (diff) | |
download | gnunet-c3c9fef22fa6e4657c3fc862bad365b440ee2305.tar.gz gnunet-c3c9fef22fa6e4657c3fc862bad365b440ee2305.zip |
Follow-up commit to format most of the other man pages code.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc/man/gnunet-nat.1')
-rw-r--r-- | doc/man/gnunet-nat.1 | 31 |
1 files changed, 21 insertions, 10 deletions
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1 index 0a9053444..fe9d8af3e 100644 --- a/doc/man/gnunet-nat.1 +++ b/doc/man/gnunet-nat.1 | |||
@@ -33,7 +33,8 @@ Assuming we are listening at ADDRESS for connection reversal requests. | |||
33 | 33 | ||
34 | .B | 34 | .B |
35 | .IP "\-r ADDRESS, \-\-remote=ADDRESS" | 35 | .IP "\-r ADDRESS, \-\-remote=ADDRESS" |
36 | Ask the peer at ADDRESS for connection reversal, using the local address for the target address of the reversal. | 36 | Ask the peer at ADDRESS for connection reversal, using the local |
37 | address for the target address of the reversal. | ||
37 | 38 | ||
38 | .B | 39 | .B |
39 | .IP "\-S NAME, \-\-section=NAME" | 40 | .IP "\-S NAME, \-\-section=NAME" |
@@ -41,7 +42,9 @@ Name of section in configuration file to use for additional options. | |||
41 | 42 | ||
42 | .B | 43 | .B |
43 | .IP "\-s, \-\-stun" | 44 | .IP "\-s, \-\-stun" |
44 | Enable processing of STUN requests. Will try to read UDP packets from the bind address and handle the packets if they are STUN packets. Will only work with UDP. | 45 | Enable processing of STUN requests. Will try to read UDP packets from |
46 | the bind address and handle the packets if they are STUN packets. Will | ||
47 | only work with UDP. | ||
45 | 48 | ||
46 | .B | 49 | .B |
47 | .IP "\-t, \-\-tcp" | 50 | .IP "\-t, \-\-tcp" |
@@ -53,38 +56,46 @@ Use UDP. | |||
53 | 56 | ||
54 | .B | 57 | .B |
55 | .IP "\-W, \-\-watch" | 58 | .IP "\-W, \-\-watch" |
56 | Watch for connection reversal requests. | 59 | Watch for connection reversal requests. |
57 | 60 | ||
58 | .SH EXAMPLES | 61 | .SH EXAMPLES |
59 | .PP | 62 | .PP |
60 | 63 | ||
61 | \fBBasic examples\fR | 64 | \fBBasic examples\fR |
62 | 65 | ||
63 | We are bound to "0.0.0.0:8080" on UDP and want to obtain all applicable IP addresses: | 66 | We are bound to "0.0.0.0:8080" on UDP and want to obtain all |
67 | applicable IP addresses: | ||
64 | 68 | ||
65 | # gnunet-nat -i 0.0.0.0:8080 -u | 69 | # gnunet-nat -i 0.0.0.0:8080 -u |
66 | 70 | ||
67 | We are bound to "::0" on port 8080 on TCP and want to obtain all applicable IP addresses: | 71 | We are bound to "::0" on port 8080 on TCP and want to obtain all |
72 | applicable IP addresses: | ||
68 | 73 | ||
69 | # gnunet-nat -i '[::0]':8080 -t | 74 | # gnunet-nat -i '[::0]':8080 -t |
70 | 75 | ||
71 | We are bound to "127.0.0.1:8080" on UDP and want to obtain all applicable IP addresses: | 76 | We are bound to "127.0.0.1:8080" on UDP and want to obtain all |
77 | applicable IP addresses: | ||
72 | 78 | ||
73 | # gnunet-nat -i 127.0.0.1:8080 -u | 79 | # gnunet-nat -i 127.0.0.1:8080 -u |
74 | 80 | ||
75 | \fBICMP-based NAT traversal:\fR | 81 | \fBICMP-based NAT traversal:\fR |
76 | 82 | ||
77 | Watch for connection reversal request (you must be bound to NAT range or to wildcard, 0.0.0.0), only works for IPv4: | 83 | Watch for connection reversal request (you must be bound to NAT range |
84 | or to wildcard, 0.0.0.0), only works for IPv4: | ||
78 | 85 | ||
79 | # gnunet-nat -Wt -i 192.168.178.12:8080 | 86 | # gnunet-nat -Wt -i 192.168.178.12:8080 |
80 | 87 | ||
81 | 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): | 88 | 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 | ||
90 | use IPv4 addresses): | ||
82 | 91 | ||
83 | # gnunet-nat -t -r 1.2.3.4:8080 -i 2.3.4.5:8080 | 92 | # gnunet-nat -t -r 1.2.3.4:8080 -i 2.3.4.5:8080 |
84 | 93 | ||
85 | 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: | 94 | 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 | ||
96 | happen to have: | ||
86 | 97 | ||
87 | # gnunet-nat -t -r 1.2.3.4:8080 -i 0.0.0.0:8080 | 98 | # gnunet-nat -t -r 1.2.3.4:8080 -i 0.0.0.0:8080 |
88 | 99 | ||
89 | \fBManual hole punching:\fR | 100 | \fBManual hole punching:\fR |
90 | 101 | ||