summaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/Makefile.am1
-rw-r--r--doc/man/gnunet-nat-auto.169
-rw-r--r--doc/man/gnunet-nat.129
-rw-r--r--doc/man/gnunet-transport.13
4 files changed, 80 insertions, 22 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index ff1e462b7..c40363b59 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -25,6 +25,7 @@ man_MANS = \
25 gnunet-namestore.1 \ 25 gnunet-namestore.1 \
26 gnunet-namestore-fcfsd.1 \ 26 gnunet-namestore-fcfsd.1 \
27 gnunet-nat.1 \ 27 gnunet-nat.1 \
28 gnunet-nat-auto.1 \
28 gnunet-nat-server.1 \ 29 gnunet-nat-server.1 \
29 gnunet-peerinfo.1 \ 30 gnunet-peerinfo.1 \
30 gnunet-publish.1 \ 31 gnunet-publish.1 \
diff --git a/doc/man/gnunet-nat-auto.1 b/doc/man/gnunet-nat-auto.1
new file mode 100644
index 000000000..249d54da4
--- /dev/null
+++ b/doc/man/gnunet-nat-auto.1
@@ -0,0 +1,69 @@
1.TH GNUNET\-NAT\-AUTO 1 "6 Jan 2017" "GNUnet"
2
3.SH NAME
4gnunet\-nat\-auto \- autoconfigure and test NAT traversal
5
6.SH SYNOPSIS
7.B gnunet\-nat\-auto
8.RI [ options ]
9.br
10
11.SH DESCRIPTION
12
13This tool allows testing various NAT traversal functions, as well
14as attempting auto\-configuration.
15
16.SH OPTIONS
17.B
18.IP "\-a, \-\-auto"
19Attempt auto\-configuration for NAT traversal.
20
21.B
22.IP "\-c FILENAME, \-\-config=FILENAME"
23Use the configuration file FILENAME.
24
25.B
26.IP "\-S NAME, \-\-section=NAME"
27Name of the configuration section with details about the configuration to test. For example "transport-tcp".
28
29.IP "\-t, \-\-tcp"
30Use TCP.
31
32.B
33.IP "\-u, \-\-udp"
34Use UDP.
35
36.B
37.IP "\-w, \-\-write"
38Write configuration to configuration file, useful in combination with autoconfiguration (\-a).
39
40.SH EXAMPLES
41.PP
42
43\fBAutomatic configuration:\fR
44
45Probe and write result to configuration:
46
47 # gnunet\-nat\-auto \-aw
48
49
50\fBTest configuration:\fR
51
52Test TCP configuration:
53
54 # gnunet\-nat\-auto -t \-S transport-tcp
55
56Test HTTP configuration:
57
58 # gnunet\-nat\-auto -t \-S transport-http
59
60Test UDP configuration:
61
62 # gnunet\-nat\-auto -u \-S transport-udp
63
64
65.SH BUGS
66Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
67
68.SH SEE ALSO
69gnunet\-transport(1) gnunet\-nat(1)
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1
index 5bdbb21eb..0a9053444 100644
--- a/doc/man/gnunet-nat.1
+++ b/doc/man/gnunet-nat.1
@@ -14,9 +14,6 @@ This tool allows testing various NAT traversal functions, as well
14as attempting auto\-configuration. 14as attempting auto\-configuration.
15 15
16.SH OPTIONS 16.SH OPTIONS
17.B
18.IP "\-a, \-\-auto"
19Attempt auto\-configuration for NAT traversal.
20 17
21.B 18.B
22.IP "\-b ADDRESS, \-\-bind=ADDRESS" 19.IP "\-b ADDRESS, \-\-bind=ADDRESS"
@@ -39,8 +36,8 @@ Assuming we are listening at ADDRESS for connection reversal requests.
39Ask the peer at ADDRESS for connection reversal, using the local address for the target address of the reversal. 36Ask the peer at ADDRESS for connection reversal, using the local address for the target address of the reversal.
40 37
41.B 38.B
42.IP "\-p ADDRESS, \-\-punch=ADDRESS" 39.IP "\-S NAME, \-\-section=NAME"
43A hole was punched manually through the NAT. We should use ADDRESS as our external hostname and port for advertising for incoming requests. The special hostname 'AUTO' can be used to indicate that GNUnet should determine the external IP address by other means (such as upnpc), and just take the port number from ADDRESS. 40Name of section in configuration file to use for additional options.
44 41
45.B 42.B
46.IP "\-s, \-\-stun" 43.IP "\-s, \-\-stun"
@@ -55,10 +52,6 @@ Use TCP.
55Use UDP. 52Use UDP.
56 53
57.B 54.B
58.IP "\-w, \-\-write"
59Write configuration to configuration file, useful in combination with autoconfiguration (\-a).
60
61.B
62.IP "\-W, \-\-watch" 55.IP "\-W, \-\-watch"
63Watch for connection reversal requests. 56Watch for connection reversal requests.
64 57
@@ -81,13 +74,17 @@ We are bound to "127.0.0.1:8080" on UDP and want to obtain all applicable IP add
81 74
82\fBICMP-based NAT traversal:\fR 75\fBICMP-based NAT traversal:\fR
83 76
84Watch for connection reversal request: 77Watch for connection reversal request (you must be bound to NAT range or to wildcard, 0.0.0.0), only works for IPv4:
78
79 # gnunet-nat -Wt -i 192.168.178.12:8080
85 80
86 # gnunet-nat FIXME 81Initiate 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):
87 82
88Initiate connection reversal request: 83 # gnunet-nat -t -r 1.2.3.4:8080 -i 2.3.4.5:8080
89 84
90 # gnunet-nat FIXME 85Initiate 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:
86
87 # gnunet-nat -t -r 1.2.3.4:8080 -i 0.0.0.0:8080
91 88
92\fBManual hole punching:\fR 89\fBManual hole punching:\fR
93 90
@@ -101,12 +98,6 @@ XXX:
101 98
102 # gnunet-nat FIXME -s 99 # gnunet-nat FIXME -s
103 100
104\fBAutomatic configuration:\fR
105
106Probe and write result to configuration:
107
108 # gnunet-nat -aw
109
110 101
111.SH BUGS 102.SH BUGS
112Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 103Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1
index 691448157..1680f9cf7 100644
--- a/doc/man/gnunet-transport.1
+++ b/doc/man/gnunet-transport.1
@@ -48,9 +48,6 @@ monitor session state of transport plugins
48\fB\-s\fR, \fB\-\-send\fR 48\fB\-s\fR, \fB\-\-send\fR
49transmit (dummy) traffic as quickly as possible to the peer specified with the \-p option. The rate will still be limited by the quota(s) determined by the peers (ATS subsystem). Will run until CTRL\-C is pressed or until the connection to the other peer is disrupted. 49transmit (dummy) traffic as quickly as possible to the peer specified with the \-p option. The rate will still be limited by the quota(s) determined by the peers (ATS subsystem). Will run until CTRL\-C is pressed or until the connection to the other peer is disrupted.
50.TP 50.TP
51\fB\-t\fR, \fB\-\-test\fR
52test transport configuration. With this flag, the tool will check if each of the configured transport plugins has a working address. Plugins that do not have a listen port configured will be ignored. The test is performed with the help of an external server (by default running on gnunet.org) which tries to contact the local machine. The test can only work if the local GNUnet peer is not yet running.
53.TP
54\fB\-v\fR, \fB\-\-version\fR 51\fB\-v\fR, \fB\-\-version\fR
55print the version number 52print the version number
56.TP 53.TP