make html in doc/man using mandoc (sans Toc feature)
[oweals/gnunet.git] / doc / man / gnunet-nat-auto.1
1 .TH GNUNET-NAT-AUTO 1 "January 6, 2017" "GNUnet"
2 .SH NAME
3 gnunet\-nat\-auto \- autoconfigure and test NAT traversal
4 .SH SYNOPSIS
5 .B gnunet\-nat\-auto
6 .RI [ options ]
7 .SH DESCRIPTION
8 This tool allows testing various NAT traversal functions, as well
9 as attempting auto\-configuration.
10 .SH OPTIONS
11 .IP "\-a,  \-\-auto"
12 Attempt auto\-configuration for NAT traversal.
13 .IP "\-c FILENAME,  \-\-config=FILENAME"
14 Use the configuration file FILENAME.
15 .IP "\-S NAME,  \-\-section=NAME"
16 Name of the configuration section with details about the configuration
17 to test. For example "transport-tcp".
18 .IP "\-t,  \-\-tcp"
19 Use TCP.
20 .IP "\-u,  \-\-udp"
21 Use UDP.
22 .IP "\-w,  \-\-write"
23 Write configuration to configuration file, useful in combination with
24 autoconfiguration (\-a).
25 .SH EXAMPLES
26 .PP
27 \fBAutomatic configuration:\fR
28 .TP
29 # gnunet\-nat\-auto \-aw
30 Probe and write result to configuration
31 .PP
32 \fBTest configuration:\fR
33 .TP
34 # gnunet\-nat\-auto -t \-S transport-tcp
35 Test TCP configuration
36 .TP
37 # gnunet\-nat\-auto -t \-S transport-http
38 Test HTTP configuration
39 .TP
40 # gnunet\-nat\-auto -u \-S transport-udp
41 Test UDP configuration
42 .SH BUGS
43 Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending
44 electronic mail to <gnunet\-developers@gnu.org>
45 .SH SEE ALSO
46 gnunet\-transport(1) gnunet\-nat(1)
47 .PP
48 The full documentation for
49 .B gnunet
50 is maintained as a Texinfo manual.
51 If the
52 .B info
53 and
54 .B gnunet
55 programs are properly installed at your site, the command
56 .IP
57 .B info gnunet
58 .PP
59 should give you access to the complete handbook,
60 .IP
61 .B info gnunet-c-tutorial
62 .PP
63 will give you access to a tutorial for developers.
64 .PP
65 Depending on your installation, this information is also
66 available in
67 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).