aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-nat-server.1
diff options
context:
space:
mode:
authorNils Gillmann <ng0@n0.is>2018-10-27 20:29:27 +0000
committerNils Gillmann <ng0@n0.is>2018-10-27 20:29:27 +0000
commitd269419d23e8c4c062e21e5bd88cdee66a1680b0 (patch)
treec9661262fee4604bd83b0bc739e7223c8cddfb0a /doc/man/gnunet-nat-server.1
parent4be442739c7f6745848a2f5544a59592f06a6cb3 (diff)
downloadgnunet-d269419d23e8c4c062e21e5bd88cdee66a1680b0.tar.gz
gnunet-d269419d23e8c4c062e21e5bd88cdee66a1680b0.zip
doc/man: More fixes.
Signed-off-by: Nils Gillmann <ng0@n0.is>
Diffstat (limited to 'doc/man/gnunet-nat-server.1')
-rw-r--r--doc/man/gnunet-nat-server.122
1 files changed, 8 insertions, 14 deletions
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1
index a97768340..1fdf1e265 100644
--- a/doc/man/gnunet-nat-server.1
+++ b/doc/man/gnunet-nat-server.1
@@ -1,23 +1,18 @@
1.TH GNUNET\-NAT\-SERVER 1 "25 Feb 2012" "GNUnet" 1.TH GNUNET-NAT-SERVER 1 "February 25, 2012" "GNUnet"
2
3.SH NAME 2.SH NAME
4gnunet\-nat\-server \- help GNUnet setup test network setup with NAT 3gnunet\-nat\-server \- help GNUnet setup test network setup with NAT
5
6.SH SYNOPSIS 4.SH SYNOPSIS
7.B gnunet\-nat\-server 5.B gnunet\-nat\-server
8.RI [ options ] 6.RI [ options ]
9.RI PORT 7.RI PORT
10.br
11
12.SH DESCRIPTION 8.SH DESCRIPTION
13
14Normal GNUnet end-users should not concern themselves with 9Normal GNUnet end-users should not concern themselves with
15gnunet\-nat\-server. In fact, distributions are encouraged to 10gnunet\-nat\-server. In fact, distributions are encouraged to
16consider not shipping it at all. Running gnunet\-nat\-server's is 11consider not shipping it at all. Running gnunet\-nat\-server's is
17similar to running hostlist servers: it is a special service to the 12similar to running hostlist servers: it is a special service to the
18community with special requirements and no benefit to those running 13community with special requirements and no benefit to those running
19the service. 14the service.
20 15.PP
21This program will listen on the specified PORT for incoming requests 16This program will listen on the specified PORT for incoming requests
22to test a peer's network connectivity. Incoming requests can ask it 17to test a peer's network connectivity. Incoming requests can ask it
23to connect to a given IPv4 address (and port) using TCP or UDP and to 18to connect to a given IPv4 address (and port) using TCP or UDP and to
@@ -25,41 +20,40 @@ send a 2-byte test message using the specified address. The program
25can also be asked to send a "fake" ICMP response message to a given 20can also be asked to send a "fake" ICMP response message to a given
26IPv4 address (for autonomous NAT traversal \-\-\- see the description 21IPv4 address (for autonomous NAT traversal \-\-\- see the description
27in the respective research paper). 22in the respective research paper).
28 23.PP
29The idea is that gnunet\-nat\-server will be run on some trusted hosts 24The idea is that gnunet\-nat\-server will be run on some trusted hosts
30with unrestricted connectivity to allow GNUnet users to test their 25with unrestricted connectivity to allow GNUnet users to test their
31network configuration. As written, the code allows any user on the 26network configuration. As written, the code allows any user on the
32Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary 27Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary
33data to any TCP or UDP port at any address. We believe that this is 28data to any TCP or UDP port at any address. We believe that this is
34generally harmless. 29generally harmless.
35 30.PP
36When running gnunet\-nat\-server, make sure to use a configuration 31When running gnunet\-nat\-server, make sure to use a configuration
37that disables most NAT options but enables 'enable_nat_client' and 32that disables most NAT options but enables 'enable_nat_client' and
38sets 'internal_address' to the global IP address of your local host. 33sets 'internal_address' to the global IP address of your local host.
39Also, the gnunet\-helper\-nat\-client should be installed locally and 34Also, the gnunet\-helper\-nat\-client should be installed locally and
40run with root privileges (SUID), otherwise the gnunet\-nat\-server 35run with root privileges (SUID), otherwise the gnunet\-nat\-server
41will not work properly. 36will not work properly.
42 37.PP
43Note that gnunet\-nat\-server could be run via gnunet\-arm but 38Note that gnunet\-nat\-server could be run via gnunet\-arm but
44typically is not. Also, the name of the host and port that 39typically is not. Also, the name of the host and port that
45gnunet\-nat\-server is run on should be specified in the NATSERVER 40gnunet\-nat\-server is run on should be specified in the NATSERVER
46option in the [setup] section of the configuration file of hosts that 41option in the [setup] section of the configuration file of hosts that
47are supposed to autoconfigure with this server. 42are supposed to autoconfigure with this server.
48
49
50.SH OPTIONS 43.SH OPTIONS
51.B 44.B
52.IP "\-c FILENAME, \-\-config=FILENAME" 45.IP "\-c FILENAME, \-\-config=FILENAME"
53Use the configuration file FILENAME. 46Use the configuration file FILENAME.
54
55.SH BUGS 47.SH BUGS
56Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending 48Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
57electronic mail to <gnunet\-developers@gnu.org> 49electronic mail to <gnunet\-developers@gnu.org>
58.SH SEE ALSO 50.SH SEE ALSO
59gnunet\-transport(1) 51gnunet\-transport(1)
52.PP
60The full documentation for 53The full documentation for
61.B gnunet 54.B gnunet
62is maintained as a Texinfo manual. If the 55is maintained as a Texinfo manual.
56If the
63.B info 57.B info
64and 58and
65.B gnunet 59.B gnunet