doc/man/gnunet-vpn.1

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