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