diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/Makefile.am | 1 | ||||
-rw-r--r-- | doc/man/gnunet-nat.1 | 67 |
2 files changed, 68 insertions, 0 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 8431ac305..ff1e462b7 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am | |||
@@ -24,6 +24,7 @@ man_MANS = \ | |||
24 | gnunet-namecache.1 \ | 24 | gnunet-namecache.1 \ |
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-server.1 \ | 28 | gnunet-nat-server.1 \ |
28 | gnunet-peerinfo.1 \ | 29 | gnunet-peerinfo.1 \ |
29 | gnunet-publish.1 \ | 30 | gnunet-publish.1 \ |
diff --git a/doc/man/gnunet-nat.1 b/doc/man/gnunet-nat.1 new file mode 100644 index 000000000..01d96afb1 --- /dev/null +++ b/doc/man/gnunet-nat.1 | |||
@@ -0,0 +1,67 @@ | |||
1 | .TH GNUNET\-NAT 1 "27 Nov 2016" "GNUnet" | ||
2 | |||
3 | .SH NAME | ||
4 | gnunet\-nat \- interact with the NAT service | ||
5 | |||
6 | .SH SYNOPSIS | ||
7 | .B gnunet\-nat | ||
8 | .RI [ options ] | ||
9 | .RI PORT | ||
10 | .br | ||
11 | |||
12 | .SH DESCRIPTION | ||
13 | |||
14 | This tool allows testing various NAT traversal functions, as well | ||
15 | as attempting auto\-configuration. | ||
16 | |||
17 | .SH OPTIONS | ||
18 | .B | ||
19 | .IP "\-a, \-\-auto" | ||
20 | Attempt auto\-configuration for NAT traversal. | ||
21 | |||
22 | .B | ||
23 | .IP "\-b ADDRESS, \-\-bind=ADDRESS" | ||
24 | Assume that the service is bound to ADDRESS. | ||
25 | |||
26 | .B | ||
27 | .IP "\-c FILENAME, \-\-config=FILENAME" | ||
28 | Use the configuration file FILENAME. | ||
29 | |||
30 | .B | ||
31 | .IP "\-e ADDRESS, \-\-external=ADDRESS" | ||
32 | Assume that ADDRESS is the globally visible address of the peer. | ||
33 | |||
34 | .B | ||
35 | .IP "\-l ADDRESS, \-\-local=ADDRESS" | ||
36 | Assuming we are listening at ADDRESS for connection reversal requests. | ||
37 | |||
38 | .B | ||
39 | .IP "\-r ADDRESS, \-\-remote=ADDRESS" | ||
40 | Ask the peer at ADDRESS for connection reversal. | ||
41 | |||
42 | .B | ||
43 | .IP "\-L, \-\-listen" | ||
44 | Listen for connection reversal requests. | ||
45 | |||
46 | .B | ||
47 | .IP "\-p PORT, \-\-port=PORT" | ||
48 | Use PORT as our external port for advertising for incoming requests. | ||
49 | |||
50 | .B | ||
51 | .IP "\-s, \-\-stun" | ||
52 | Enable processing of STUN requests. (Not implemented). | ||
53 | |||
54 | .B | ||
55 | .IP "\-t, \-\-tcp" | ||
56 | Use TCP. | ||
57 | |||
58 | .B | ||
59 | .IP "\-u, \-\-udp" | ||
60 | Use UDP. | ||
61 | |||
62 | .SH BUGS | ||
63 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | ||
64 | |||
65 | .SH SEE ALSO | ||
66 | gnunet\-transport(1) | ||
67 | |||