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 .Os
  27 .Sh NAME
  28 .Nm gnunet-nat-auto
  29 .Nd
  30 autoconfigure and test NAT traversal
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Op Fl a | \-auto
  34 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  35 .Op Fl S Ar NAME | Fl \-section= Ns Ar NAME
  36 .Op Fl t | \-tcp
  37 .Op Fl u | \-udp
  38 .Op Fl w | \-write
  39 .Sh DESCRIPTION
  40 .Nm
  41 allows testing various NAT traversal functions, as well as attempting auto-configuration.
  42 The options are as follows:
  43 .Bl -tag -width Ds
  44 .It Fl a | \-auto
  45 Attempt auto-configuration for NAT traversal.
  46 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  47 Use the configuration file
  48 .Ar FILENAME .
  49 .It Fl S Ar NAME | Fl \-section= Ns Ar NAME
  50 Name of the configuration section with details about the configuration to test.
  51 For example "transport-tcp".
  52 .It Fl t | \-tcp
  53 Use TCP.
  54 .It Fl u | \-udp
  55 Use UDP.
  56 .It Fl w | \-write
  57 Write configuration to configuration file, useful in combination with auto-configuration
  58 .Pq Fl a .
  59 .El
  60 .Sh EXAMPLES
  61 .Ss Automatic configuration:
  62 .Pp
  63 .Dl # gnunet-nat-auto -aw
  64 .Pp
  65 Probe and write result to configuration
  66 .Ss Test configuration:
  67 .Pp
  68 .Pp
  69 .Dl # gnunet-nat-auto -t -S transport-tcp
  70 .Pp
  71 Test TCP configuration
  72 .Pp
  73 .Dl # gnunet-nat-auto -t -S transport-http
  74 .Pp
  75 Test HTTP configuration
  76 .Pp
  77 .Dl # gnunet-nat-auto -u -S transport-udp
  78 .Pp
  79 Test UDP configuration
  80 .\".Sh FILES
  81 .Sh SEE ALSO
  82 .Xr gnunet-nat 1 ,
  83 .Xr gnunet-transport 1
  84 .sp
  85 The full documentation for gnunet is maintained as a Texinfo manual.
  86 If the
  87 .Xr info 1
  88 and gnunet programs are properly installed at your site, the command
  89 .Pp
  90 .Dl info gnunet
  91 .Pp
  92 should give you access to the complete handbook,
  93 .Pp
  94 .Dl info gnunet-c-tutorial
  95 .Pp
  96 will give you access to a tutorial for developers.
  97 .sp
  98 Depending on your installation, this information is also available in
  99 .Xr gnunet 7 and
 100 .Xr gnunet-c-tutorial 7 .
 101 .\".Sh HISTORY
 102 .\".Sh AUTHORS
 103 .Sh BUGS
 104 Report bugs by using
 105 .Lk https://bugs.gnunet.org
 106 or by sending electronic mail to
 107 .Aq Mt gnunet-developers@gnu.org .