summaryrefslogtreecommitdiff
path: root/doc/man
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/man
parent1b7f6eea0a06abab9b75b30f021aa6313fccfcd4 (diff)
separate service for autoconfiguration from NAT traversal
Diffstat (limited to 'doc/man')
-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 = \
gnunet-namestore.1 \
gnunet-namestore-fcfsd.1 \
gnunet-nat.1 \
+ gnunet-nat-auto.1 \
gnunet-nat-server.1 \
gnunet-peerinfo.1 \
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 @@
+.TH GNUNET\-NAT\-AUTO 1 "6 Jan 2017" "GNUnet"
+
+.SH NAME
+gnunet\-nat\-auto \- autoconfigure and test NAT traversal
+
+.SH SYNOPSIS
+.B gnunet\-nat\-auto
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+
+This tool allows testing various NAT traversal functions, as well
+as attempting auto\-configuration.
+
+.SH OPTIONS
+.B
+.IP "\-a, \-\-auto"
+Attempt auto\-configuration for NAT traversal.
+
+.B
+.IP "\-b ADDRESS, \-\-bind=ADDRESS"
+Assume that the service is (locally) bound to ADDRESS.
+
+.B
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Use the configuration file FILENAME.
+
+.B
+.IP "\-e ADDRESS, \-\-external=ADDRESS"
+Assume that ADDRESS is the globally visible address of the peer.
+
+.IP "\-t, \-\-tcp"
+Use TCP.
+
+.B
+.IP "\-u, \-\-udp"
+Use UDP.
+
+.B
+.IP "\-w, \-\-write"
+Write configuration to configuration file, useful in combination with autoconfiguration (\-a).
+
+.SH EXAMPLES
+.PP
+
+\fBAutomatic configuration:\fR
+
+Probe and write result to configuration:
+
+ # gnunet\-nat\-auto \-aw
+
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+
+.SH SEE ALSO
+gnunet\-transport(1) gnunet\-nat(1)
+
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
as attempting auto\-configuration.
.SH OPTIONS
-.B
-.IP "\-a, \-\-auto"
-Attempt auto\-configuration for NAT traversal.
.B
.IP "\-b ADDRESS, \-\-bind=ADDRESS"
@@ -55,10 +52,6 @@ Use TCP.
Use UDP.
.B
-.IP "\-w, \-\-write"
-Write configuration to configuration file, useful in combination with autoconfiguration (\-a).
-
-.B
.IP "\-W, \-\-watch"
Watch for connection reversal requests.
@@ -103,12 +96,6 @@ XXX:
# gnunet-nat FIXME -s
-\fBAutomatic configuration:\fR
-
-Probe and write result to configuration:
-
- # gnunet-nat -aw
-
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>