doc/man/gnunet-vpn.1

   1 .TH GNUNET\-VPN 1 "25 Feb 2012" "GNUnet"
   2
   3 .SH NAME
   4 gnunet\-vpn \- manually setup a GNUnet VPN tunnel
   5
   6 .SH SYNOPSIS
   7 .B gnunet\-vpn
   8 .RI [ options ]
   9 .br
  10
  11 .SH DESCRIPTION
  12 \fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the
  13 GNUnet network.  There are two main types of tunnels.  Tunnels to an
  14 exit node which routes the traffic to the global Internet, and tunnels
  15 to a node that runs a service only within GNUnet.  Depending on the
  16 type of tunnel, gnunet\-vpn takes different options.  The "\-i" option
  17 is required for tunnels to an exit node, whereas the "\-p" and "\-s"
  18 options in conjunction with either "\-u" or "\-t" are required for
  19 tunnels to services.  For exit tunnels, both UDP and TCP traffic will
  20 be redirected.  For service tunnels, either UDP ("\-u") or TCP ("\-t")
  21 traffic will be redirected.
  22
  23 The tool will display the IP address for this end of the tunnel.  The
  24 address can be displayed as soon as it has been allocated, or only
  25 after ("\-a") the tunnel has been created.
  26
  27 .SH OPTIONS
  28 .B
  29 .IP "\-4, \-\-ipv4"
  30 Desired IP address on this end of the tunnel should be an IPv4 address.
  31 .B
  32 .IP "\-6, \-\-ipv6"
  33 Desired IP address on this end of the tunnel should be an IPv6 address.
  34 .B
  35 .IP "\-c FILENAME,  \-\-config=FILENAME"
  36 Use the configuration file FILENAME.
  37 .B
  38 .IP "\-d TIME, \-\-duration TIME"
  39 The mapping should be established for TIME.  The value given must be a
  40 number followed by a space and a time unit, for example "500 ms".
  41 Note that the quotes are required on the shell. Default is 5 minutes.
  42 .B
  43 .IP "\-h, \-\-help"
  44 Print short help on options.
  45 .B
  46 .IP "\-i IP, \-\-ip IP"
  47 Tunnel should be to an exit node and connect to the given IPv4 or IPv6
  48 IP address.  Note that you can specify an IPv6 address as the target
  49 here, even in combination with "\-4" (4to6) and similarly you can
  50 specify an IPv4 address in combination with "\-6" (6to4).
  51 .B
  52 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
  53 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
  54 .B
  55 .IP "\-p PEERID,  \-\-peer=PEERID"
  56 Name of the peer offering the service to connect to.  Cannot be used
  57 in conjunction with "\-i", requires "\-s".
  58 .B
  59 .IP "\-s NAME,  \-\-service=NAME"
  60 Name of the service running on the target peer.  Cannot be used in
  61 conjunction with "\-i", requires "\-p".
  62 .B
  63 .IP "\-t, \-\-tcp"
  64 Service runs TCP.  Either "\-t" or "\-u" must be specified when using "\-s".
  65 .B
  66 .IP "\-u, \-\-udp"
  67 Service runs UDP.  Either "\-t" or "\-u" must be specified when using "\-s".
  68 .B
  69 .IP "\-V, \-\-verbose"
  70 Be verbose.
  71 .B
  72 .IP "\-v, \-\-version"
  73 Print GNUnet version number.
  74
  75
  76 .SH BUGS
  77 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
  78
  79 .SH SEE ALSO
  80 gnunet\-setup(1)
  81 The full documentation for
  82 .B gnunet
  83 is maintained as a Texinfo manual.  If the
  84 .B info
  85 and
  86 .B gnunet
  87 programs are properly installed at your site, the command
  88 .IP
  89 .B info gnunet
  90 .PP
  91 should give you access to the complete handbook,
  92 .IP
  93 .B info gnunet-c-tutorial
  94 .PP
  95 will give you access to a tutorial for developers.
  96 .PP
  97 Depending on your installation, this information is also
  98 available in
  99 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).