doc/man/gnunet-vpn.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 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 http://www.gnu.org/licenses/gpl.html
  21 .\"
  22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
  23 .\"
  24 .Dd February 25, 2012
  25 .Dt GNUNET-VPN 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-vpn
  29 .Nd manually setup a GNUnet VPN tunnel
  30 .Sh SYNOPSIS
  31 .Nm
  32 .Op Fl 4 | \-ipv4
  33 .Op Fl 6 | \-ipv6
  34 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  35 .Op Fl d Ar TIME | Fl \-duration Ar TIME
  36 .Op Fl h | \-help
  37 .Op Fl i Ar IP | Fl \-ip Ar IP
  38 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  39 .Op Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
  40 .Op Fl s Ar NAME | Fl \-service= Ns Ar NAME
  41 .Op Fl t | \-tcp
  42 .Op Fl u | \-udp
  43 .Op Fl V | \-verbose
  44 .Op Fl v | \-version
  45 .Sh DESCRIPTION
  46 .Nm
  47 can be used to manually setup a VPN tunnel via the GNUnet network.
  48 There are two main types of tunnels.
  49 Tunnels to an exit node which routes the traffic to the global Internet, and tunnels to a node that runs a service only within GNUnet.
  50 Depending on the type of tunnel, gnunet-vpn takes different options.
  51 The
  52 .Fl i
  53 option is required for tunnels to an exit node, whereas the
  54 .Fl p
  55 and
  56 .Fl s
  57 options in conjunction with either
  58 .Fl u
  59 or
  60 .Fl t
  61 are required for tunnels to services.
  62 For exit tunnels, both UDP and TCP traffic will be redirected.
  63 For service tunnels, either UDP
  64 .Pq Fl u
  65 or TCP
  66 .Pq Fl t
  67 traffic will be redirected.
  68 The tool will display the IP address for this end of the tunnel.
  69 The address can be displayed as soon as it has been allocated, or only after
  70 .Pq Fl a
  71 the tunnel has been created.
  72 .Bl -tag -width indent
  73 .It Fl 4 | \-ipv4
  74 Desired IP address on this end of the tunnel should be an IPv4 address.
  75 .It Fl 6 | \-ipv6
  76 Desired IP address on this end of the tunnel should be an IPv6 address.
  77 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  78 Use the configuration file FILENAME.
  79 .It Fl d Ar TIME | Fl \-duration Ar TIME
  80 The mapping should be established for TIME.
  81 The value given must be a number followed by a space and a time unit, for example "500 ms".
  82 Note that the quotes are required on the shell.
  83 The default vaue is 5 minutes.
  84 .It Fl h | \-help
  85 Print short help on options.
  86 .It Fl i Ar IP | Fl \-ip Ar IP
  87 Tunnel should be to an exit node and connect to the given IPv4 or IPv6
  88 IP address.
  89 Note that you can specify an IPv6 address as the target here, even in
  90 combination with "\-4" (4to6) and similarly you can specify an IPv4
  91 address in combination with "\-6" (6to4).
  92 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  93 Use LOGLEVEL for logging.
  94 Valid values are DEBUG, INFO, WARNING and ERROR.
  95 .It Fl p Ar PEERID | Fl \-peer= Ns Ar PEERID
  96 Name of the peer offering the service to connect to.
  97 Cannot be used in conjunction with
  98 .Fl i ,
  99 requires
 100 .Fl s .
 101 .It Fl s Ar NAME | Fl \-service= Ns Ar NAME
 102 Name of the service running on the target peer.
 103 Cannot be used in conjunction with
 104 .Fl i ,
 105 requires
 106 .Fl p .
 107 .It Fl t | \-tcp
 108 Service runs TCP.
 109 Either
 110 .Fl t
 111 or
 112 .Fl u
 113 must be specified when using
 114 .Fl s .
 115 .It Fl u | \-udp
 116 Service runs UDP.
 117 Either
 118 .Fl t
 119 or
 120 .Fl u
 121 must be specified when using
 122 .Fl s .
 123 .It Fl V | \-verbose
 124 Be verbose.
 125 .It Fl v | \-version
 126 Print GNUnet version number.
 127 .El
 128 .Sh SEE ALSO
 129 .Xr gnunet-setup 1
 130 .sp
 131 The full documentation for gnunet is maintained as a Texinfo manual.
 132 If the
 133 .Xr info 1
 134 and gnunet programs are properly installed at your site, the command
 135 .Pp
 136 .Dl info gnunet
 137 .Pp
 138 should give you access to the complete handbook,
 139 .Pp
 140 .Dl info gnunet-c-tutorial
 141 .Pp
 142 will give you access to a tutorial for developers.
 143 .sp
 144 Depending on your installation, this information is also available in
 145 .Xr gnunet 7 and
 146 .Xr gnunet-c-tutorial 7 .
 147 .\".Sh HISTORY
 148 .\".Sh AUTHORS
 149 .Sh BUGS
 150 Report bugs by using
 151 .Lk https://bugs.gnunet.org
 152 or by sending electronic mail to
 153 .Aq Mt gnunet-developers@gnu.org .