gnunet

commit 48aa183b408caaa59ad6120fb10c5ed6a5254f6f
parent c30f9fe5daf92a89849f7d6d22eacb603918b42d
Author: Christian Grothoff <christian@grothoff.org>
Date:   Sun, 27 Nov 2016 14:52:10 +0100

add draft man page for gnunet-nat

Diffstat:
M
doc/man/Makefile.am
 | 
1
+
A
doc/man/gnunet-nat.1
 | 
67
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
M
src/nat/gnunet-nat.c
 | 
2
+-

3 files changed, 69 insertions(+), 1 deletion(-)
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
@@ -24,6 +24,7 @@ man_MANS = \
   gnunet-namecache.1 \
   gnunet-namestore.1 \
   gnunet-namestore-fcfsd.1 \
+  gnunet-nat.1 \
   gnunet-nat-server.1 \
   gnunet-peerinfo.1 \
   gnunet-publish.1 \
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1
@@ -0,0 +1,67 @@
+.TH GNUNET\-NAT 1 "27 Nov 2016" "GNUnet"
+
+.SH NAME
+gnunet\-nat \- interact with the NAT service
+
+.SH SYNOPSIS
+.B gnunet\-nat
+.RI [ options ]
+.RI PORT
+.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 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.
+
+.B
+.IP "\-l ADDRESS,  \-\-local=ADDRESS"
+Assuming we are listening at ADDRESS for connection reversal requests.
+
+.B
+.IP "\-r ADDRESS,  \-\-remote=ADDRESS"
+Ask the peer at ADDRESS for connection reversal.
+
+.B
+.IP "\-L,  \-\-listen"
+Listen for connection reversal requests.  
+
+.B
+.IP "\-p PORT,  \-\-port=PORT"
+Use PORT as our external port for advertising for incoming requests.
+
+.B
+.IP "\-s,  \-\-stun"
+Enable processing of STUN requests. (Not implemented).
+
+.B
+.IP "\-t,  \-\-tcp"
+Use TCP.
+
+.B
+.IP "\-u,  \-\-udp"
+Use UDP.
+
+.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)
+
diff --git a/src/nat/gnunet-nat.c b/src/nat/gnunet-nat.c
@@ -20,7 +20,7 @@
 
 /**
  * @file src/nat/gnunet-nat.c
- * @brief Daemon to auto configure nat
+ * @brief Command-line tool to interact with the NAT service
  * @author Christian Grothoff
  * @author Bruno Cabral
  */