doc/man/gnunet-vpn.1

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