aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-nat-auto.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-nat-auto.1')
-rw-r--r--doc/man/gnunet-nat-auto.1155
1 files changed, 97 insertions, 58 deletions
diff --git a/doc/man/gnunet-nat-auto.1 b/doc/man/gnunet-nat-auto.1
index efd4b5df1..405020e37 100644
--- a/doc/man/gnunet-nat-auto.1
+++ b/doc/man/gnunet-nat-auto.1
@@ -1,67 +1,106 @@
1.TH GNUNET-NAT-AUTO 1 "January 6, 2017" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-nat\-auto \- autoconfigure and test NAT traversal 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-nat\-auto 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.RI [ options ] 6.\" any later version published by the Free Software Foundation; with no
7.SH DESCRIPTION 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8This tool allows testing various NAT traversal functions, as well 8.\" copy of the license is included in the file
9as attempting auto\-configuration. 9.\" ``FDL-1.3''.
10.SH OPTIONS 10.\"
11.IP "\-a, \-\-auto" 11.\" A copy of the license is also available from the Free Software
12Attempt auto\-configuration for NAT traversal. 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13.IP "\-c FILENAME, \-\-config=FILENAME" 13.\"
14Use the configuration file FILENAME. 14.\" Alternately, this document is also available under the General
15.IP "\-S NAME, \-\-section=NAME" 15.\" Public License, version 3 or later, as published by the Free Software
16Name of the configuration section with details about the configuration 16.\" Foundation. A copy of the license is included in the file
17to test. For example "transport-tcp". 17.\" ``GPL3''.
18.IP "\-t, \-\-tcp" 18.\"
19.\" A copy of the license is also available from the Free Software
20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21.\"
22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.\"
24.Dd January 6, 2017
25.Dt GNUNET-NAT-AUTO 1
26.Sh NAME
27.Nm gnunet-nat-auto
28.Nd
29autoconfigure and test NAT traversal
30.Sh SYNOPSIS
31.Nm
32.Op Fl a | \-auto
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34.Op Fl S Ar NAME | Fl \-section= Ns Ar NAME
35.Op Fl t | \-tcp
36.Op Fl u | \-udp
37.Op Fl w | \-write
38.Sh DESCRIPTION
39.Nm
40allows testing various NAT traversal functions, as well as attempting auto-configuration.
41The options are as follows:
42.Bl -tag -width Ds
43.It Fl a | \-auto
44Attempt auto-configuration for NAT traversal.
45.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
46Use the configuration file
47.Ar FILENAME .
48.It Fl S Ar NAME | Fl \-section= Ns Ar NAME
49Name of the configuration section with details about the configuration to test.
50For example "transport-tcp".
51.It Fl t | \-tcp
19Use TCP. 52Use TCP.
20.IP "\-u, \-\-udp" 53.It Fl u | \-udp
21Use UDP. 54Use UDP.
22.IP "\-w, \-\-write" 55.It Fl w | \-write
23Write configuration to configuration file, useful in combination with 56Write configuration to configuration file, useful in combination with auto-configuration
24autoconfiguration (\-a). 57.Pq Fl a .
25.SH EXAMPLES 58.El
26.PP 59.Sh EXAMPLES
27\fBAutomatic configuration:\fR 60.Ss Automatic configuration:
28.TP 61.Pp
29# gnunet\-nat\-auto \-aw 62.Dl # gnunet-nat-auto -aw
63.Pp
30Probe and write result to configuration 64Probe and write result to configuration
31.PP 65.Ss Test configuration:
32\fBTest configuration:\fR 66.Pp
33.TP 67.Pp
34# gnunet\-nat\-auto -t \-S transport-tcp 68.Dl # gnunet-nat-auto -t -S transport-tcp
69.Pp
35Test TCP configuration 70Test TCP configuration
36.TP 71.Pp
37# gnunet\-nat\-auto -t \-S transport-http 72.Dl # gnunet-nat-auto -t -S transport-http
73.Pp
38Test HTTP configuration 74Test HTTP configuration
39.TP 75.Pp
40# gnunet\-nat\-auto -u \-S transport-udp 76.Dl # gnunet-nat-auto -u -S transport-udp
77.Pp
41Test UDP configuration 78Test UDP configuration
42.SH BUGS 79.\".Sh FILES
43Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 80.Sh SEE ALSO
44electronic mail to <gnunet\-developers@gnu.org> 81.Xr gnunet-nat 1 ,
45.SH SEE ALSO 82.Xr gnunet-transport 1
46gnunet\-transport(1) gnunet\-nat(1) 83.sp
47.PP 84The full documentation for gnunet is maintained as a Texinfo manual.
48The full documentation for
49.B gnunet
50is maintained as a Texinfo manual.
51If the 85If the
52.B info 86.Xr info 1
53and 87and gnunet programs are properly installed at your site, the command
54.B gnunet 88.Pp
55programs are properly installed at your site, the command 89.Dl info gnunet
56.IP 90.Pp
57.B info gnunet
58.PP
59should give you access to the complete handbook, 91should give you access to the complete handbook,
60.IP 92.Pp
61.B info gnunet-c-tutorial 93.Dl info gnunet-c-tutorial
62.PP 94.Pp
63will give you access to a tutorial for developers. 95will give you access to a tutorial for developers.
64.PP 96.sp
65Depending on your installation, this information is also 97Depending on your installation, this information is also available in
66available in 98.Xr gnunet 7 and
67\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 99.Xr gnunet-c-tutorial 7 .
100.\".Sh HISTORY
101.\".Sh AUTHORS
102.Sh BUGS
103Report bugs by using
104.Lk https://bugs.gnunet.org
105or by sending electronic mail to
106.Aq Mt gnunet-developers@gnu.org .
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-27 05:05:53 +0000