aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2017-01-06 13:26:38 +0100
committerChristian Grothoff <christian@grothoff.org>2017-01-06 13:26:38 +0100
commit80e1315b56f559db60499f5373e90c293c5ab065 (patch)
tree3b279e6ac8e6298d7d9d96d12868f628a413939b /doc
parent1b7f6eea0a06abab9b75b30f021aa6313fccfcd4 (diff)
downloadgnunet-80e1315b56f559db60499f5373e90c293c5ab065.tar.gz
gnunet-80e1315b56f559db60499f5373e90c293c5ab065.zip
separate service for autoconfiguration from NAT traversal
Diffstat (limited to 'doc')
-rw-r--r--doc/man/Makefile.am1
-rw-r--r--doc/man/gnunet-nat-auto.159
-rw-r--r--doc/man/gnunet-nat.113
3 files changed, 60 insertions, 13 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..310f14d43
--- /dev/null
+++ b/doc/man/gnunet-nat-auto.1
@@ -0,0 +1,59 @@
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 "\-b ADDRESS, \-\-bind=ADDRESS"
23Assume that the service is (locally) bound to ADDRESS.
24
25.B
26.IP "\-c FILENAME, \-\-config=FILENAME"
27Use the configuration file FILENAME.
28
29.B
30.IP "\-e ADDRESS, \-\-external=ADDRESS"
31Assume that ADDRESS is the globally visible address of the peer.
32
33.IP "\-t, \-\-tcp"
34Use TCP.
35
36.B
37.IP "\-u, \-\-udp"
38Use UDP.
39
40.B
41.IP "\-w, \-\-write"
42Write configuration to configuration file, useful in combination with autoconfiguration (\-a).
43
44.SH EXAMPLES
45.PP
46
47\fBAutomatic configuration:\fR
48
49Probe and write result to configuration:
50
51 # gnunet\-nat\-auto \-aw
52
53
54.SH BUGS
55Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
56
57.SH SEE ALSO
58gnunet\-transport(1) gnunet\-nat(1)
59
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1
index 01e0267a4..a8a82883b 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"
@@ -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
@@ -103,12 +96,6 @@ XXX:
103 96
104 # gnunet-nat FIXME -s 97 # gnunet-nat FIXME -s
105 98
106\fBAutomatic configuration:\fR
107
108Probe and write result to configuration:
109
110 # gnunet-nat -aw
111
112 99
113.SH BUGS 100.SH BUGS
114Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> 101Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>