doc/man/gnunet-nat-auto.1

   1 .\" This file is part of GNUnet.
   2 .\" Copyright (C) 2001-2019 GNUnet e.V.
   3 .\"
   4 .\" Permission is granted to copy, distribute and/or modify this document
   5 .\" under the terms of the GNU Free Documentation License, Version 1.3 or
   6 .\" any later version published by the Free Software Foundation; with no
   7 .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
   8 .\" copy of the license is included in the file
   9 .\" ``FDL-1.3''.
  10 .\"
  11 .\" A copy of the license is also available from the Free Software
  12 .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
  13 .\"
  14 .\" Alternately, this document is also available under the General
  15 .\" Public License, version 3 or later, as published by the Free Software
  16 .\" Foundation.  A copy of the license is included in the file
  17 .\" ``GPL3''.
  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
  29 autoconfigure 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
  40 allows testing various NAT traversal functions, as well as attempting auto-configuration.
  41 The options are as follows:
  42 .Bl -tag -width Ds
  43 .It Fl a | \-auto
  44 Attempt auto-configuration for NAT traversal.
  45 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  46 Use the configuration file
  47 .Ar FILENAME .
  48 .It Fl S Ar NAME | Fl \-section= Ns Ar NAME
  49 Name of the configuration section with details about the configuration to test.
  50 For example "transport-tcp".
  51 .It Fl t | \-tcp
  52 Use TCP.
  53 .It Fl u | \-udp
  54 Use UDP.
  55 .It Fl w | \-write
  56 Write configuration to configuration file, useful in combination with auto-configuration
  57 .Pq Fl a .
  58 .El
  59 .Sh EXAMPLES
  60 .Ss Automatic configuration:
  61 .Pp
  62 .Dl # gnunet-nat-auto -aw
  63 .Pp
  64 Probe and write result to configuration
  65 .Ss Test configuration:
  66 .Pp
  67 .Pp
  68 .Dl # gnunet-nat-auto -t -S transport-tcp
  69 .Pp
  70 Test TCP configuration
  71 .Pp
  72 .Dl # gnunet-nat-auto -t -S transport-http
  73 .Pp
  74 Test HTTP configuration
  75 .Pp
  76 .Dl # gnunet-nat-auto -u -S transport-udp
  77 .Pp
  78 Test UDP configuration
  79 .\".Sh FILES
  80 .Sh SEE ALSO
  81 .Xr gnunet-nat 1 ,
  82 .Xr gnunet-transport 1
  83 .sp
  84 The full documentation for gnunet is maintained as a Texinfo manual.
  85 If the
  86 .Xr info 1
  87 and gnunet programs are properly installed at your site, the command
  88 .Pp
  89 .Dl info gnunet
  90 .Pp
  91 should give you access to the complete handbook,
  92 .Pp
  93 .Dl info gnunet-c-tutorial
  94 .Pp
  95 will give you access to a tutorial for developers.
  96 .sp
  97 Depending on your installation, this information is also available in
  98 .Xr gnunet 7 and
  99 .Xr gnunet-c-tutorial 7 .
 100 .\".Sh HISTORY
 101 .\".Sh AUTHORS
 102 .Sh BUGS
 103 Report bugs by using
 104 .Lk https://bugs.gnunet.org
 105 or by sending electronic mail to
 106 .Aq Mt gnunet-developers@gnu.org .