path: root/doc
diff options
authorChristian Grothoff <>2012-01-07 20:41:38 +0000
committerChristian Grothoff <>2012-01-07 20:41:38 +0000
commit75bfc02cd9753b664e4799b2f837c1de9ab2e2dc (patch)
tree748a86e230511cf4ce4ae191260204f4fbace726 /doc
parentb89c033494de27537c6b936e2effdea975d75075 (diff)
-finishing gnunet-vpn tool and man page
Diffstat (limited to 'doc')
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/man/gnunet-vpn.1 b/doc/man/gnunet-vpn.1
new file mode 100644
index 000000000..4d07c5ad9
--- /dev/null
+++ b/doc/man/gnunet-vpn.1
@@ -0,0 +1,65 @@
+.TH GNUNET\-VPN 1 "Jan 7, 2012" "GNUnet"
+gnunet\-vpn \- manually setup a GNUnet VPN tunnel
+.B gnunet\-vpn
+.RI [ options ]
+\fBgnunet\-vpn\fP can be used to manually setup a VPN tunnel via the GNUnet network. There are two main types of tunnels. 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. Depending on the type of tunnel, gnunet\-vpn takes different options. The "\-i" option is required for tunnels to an exit node, whereas the "\-p" and "\-s" options in conjuction with either "\-u" or "\-t" are required for tunnels to services. For exit tunnels, both UDP and TCP traffic will be redirected. For service tunnels, either UDP ("\-u") or TCP ("\-t") traffic will be redirected.
+The tool will display the IP address for this end of the tunnel. The address can be displayed as soon as it has been allocated, or only after ("\-a") the tunnel has been created.
+.IP "\-4, \-\-ipv4"
+Desired IP address on this end of the tunnel should be an IPv4 address.
+.IP "\-6, \-\-ipv6"
+Desired IP address on this end of the tunnel should be an IPv6 address.
+.IP "\-a, \-\-after\-connect"
+Display IP address only after the tunnel is fully connected.
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Use the configuration file FILENAME.
+.IP "\-d SEC, \-\-duration SEC"
+The mapping should be established for SEC seconds. Default is 5 minutes.
+.IP "\-h, \-\-help"
+Print short help on options.
+.IP "\-i IP, \-\-ip IP"
+Tunnel should be to an exit node and connect to the given IPv4 or IPv6 IP address. Note that you can specify an IPv6 address as the target here, even in combination with "\-4" (4to6) and similarly you can specify an IPv4 address in combination with "\-6" (6to4).
+.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
+Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
+.IP "\-p PEERID, \-\-peer=PEERID"
+Name of the peer offering the service to connect to. Cannot be used in conjunction with "\-i", requires "\-s".
+.IP "\-s NAME, \-\-service=NAME"
+Name of the service running on the target peer. Cannot be used in conjunction with "\-i", requires "\-p".
+.IP "\-t, \-\-tcp"
+Service runs TCP. Either "\-t" or \"-u" must be specified when using "\-s".
+.IP "\-u, \-\-udp"
+Service runs UDP. Either "\-t" or \"-u" must be specified when using "\-s".
+.IP "\-V, \-\-verbose"
+Be verbose.
+.IP "\-v, \-\-version"
+Print GNUnet version number.
+Report bugs by using Mantis <> or by sending electronic mail to <gnunet\>